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