1*0a6a1f1dSLionel Sambuc.\" $NetBSD: elf_hash.3,v 1.2 2014/03/09 16:58:04 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 4*0a6a1f1dSLionel Sambuc.\" 5*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 6*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 7*0a6a1f1dSLionel Sambuc.\" are met: 8*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 9*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 10*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 11*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 12*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 13*0a6a1f1dSLionel Sambuc.\" 14*0a6a1f1dSLionel Sambuc.\" This software is provided by Joseph Koshy ``as is'' and 15*0a6a1f1dSLionel Sambuc.\" any express or implied warranties, including, but not limited to, the 16*0a6a1f1dSLionel Sambuc.\" implied warranties of merchantability and fitness for a particular purpose 17*0a6a1f1dSLionel Sambuc.\" are disclaimed. in no event shall Joseph Koshy be liable 18*0a6a1f1dSLionel Sambuc.\" for any direct, indirect, incidental, special, exemplary, or consequential 19*0a6a1f1dSLionel Sambuc.\" damages (including, but not limited to, procurement of substitute goods 20*0a6a1f1dSLionel Sambuc.\" or services; loss of use, data, or profits; or business interruption) 21*0a6a1f1dSLionel Sambuc.\" however caused and on any theory of liability, whether in contract, strict 22*0a6a1f1dSLionel Sambuc.\" liability, or tort (including negligence or otherwise) arising in any way 23*0a6a1f1dSLionel Sambuc.\" out of the use of this software, even if advised of the possibility of 24*0a6a1f1dSLionel Sambuc.\" such damage. 25*0a6a1f1dSLionel Sambuc.\" 26*0a6a1f1dSLionel Sambuc.\" Id: elf_hash.3 189 2008-07-20 10:38:08Z jkoshy 27*0a6a1f1dSLionel Sambuc.\" 28*0a6a1f1dSLionel Sambuc.Dd August 15, 2006 29*0a6a1f1dSLionel Sambuc.Os 30*0a6a1f1dSLionel Sambuc.Dt ELF_HASH 3 31*0a6a1f1dSLionel Sambuc.Sh NAME 32*0a6a1f1dSLionel Sambuc.Nm elf_hash 33*0a6a1f1dSLionel Sambuc.Nd compute a hash value for a string 34*0a6a1f1dSLionel Sambuc.Sh LIBRARY 35*0a6a1f1dSLionel Sambuc.Lb libelf 36*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 37*0a6a1f1dSLionel Sambuc.In libelf.h 38*0a6a1f1dSLionel Sambuc.Ft "unsigned long" 39*0a6a1f1dSLionel Sambuc.Fn elf_hash "const char *name" 40*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 41*0a6a1f1dSLionel SambucFunction 42*0a6a1f1dSLionel Sambuc.Fn elf_hash 43*0a6a1f1dSLionel Sambuccomputes a portable hash value for the null terminated string 44*0a6a1f1dSLionel Sambucpointed to by argument 45*0a6a1f1dSLionel Sambuc.Ar name . 46*0a6a1f1dSLionel Sambuc.Pp 47*0a6a1f1dSLionel SambucThe hash value returned is will be identical across 48*0a6a1f1dSLionel Sambucmachines of different architectures. 49*0a6a1f1dSLionel SambucThis allows hash tables to be built on one machine and 50*0a6a1f1dSLionel Sambuccorrectly used on another of a different architecture. 51*0a6a1f1dSLionel SambucThe hash value returned is also guaranteed 52*0a6a1f1dSLionel Sambuc.Em not 53*0a6a1f1dSLionel Sambucto be the bit pattern of all ones (~0UL). 54*0a6a1f1dSLionel Sambuc.Sh IMPLEMENTATION NOTES 55*0a6a1f1dSLionel SambucThe library internally uses unsigned 32 bit arithmetic to compute 56*0a6a1f1dSLionel Sambucthe hash value. 57*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 58*0a6a1f1dSLionel Sambuc.Xr elf 3 , 59*0a6a1f1dSLionel Sambuc.Xr gelf 3 60