diff options
| -rw-r--r-- | lib/libc/db/man/hash.3 | 149 |
1 files changed, 79 insertions, 70 deletions
diff --git a/lib/libc/db/man/hash.3 b/lib/libc/db/man/hash.3 index fcdb1f3af12..2d40684e5c5 100644 --- a/lib/libc/db/man/hash.3 +++ b/lib/libc/db/man/hash.3 @@ -1,3 +1,4 @@ +.\" $OpenBSD: hash.3,v 1.3 1997/07/28 01:53:13 flipk Exp $ .\" $NetBSD: hash.3,v 1.6 1996/05/03 21:26:50 cgd Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -33,79 +34,80 @@ .\" .\" @(#)hash.3 8.6 (Berkeley) 8/18/94 .\" -.TH HASH 3 "August 18, 1994" -.UC 7 -.SH NAME -hash \- hash database access method -.SH SYNOPSIS -.nf -.ft B -#include <sys/types.h> -#include <db.h> -.ft R -.fi -.SH DESCRIPTION +.Dd August 18, 1994 +.Os OpenBSD +.Dt HASH 3 +.Sh NAME +.Nm hash +.Nd hash database access method +.Sh SYNOPSIS +.Fd #include <sys/types.h> +.Fd #include <db.h> +.Sh DESCRIPTION The routine -.IR dbopen +.Fn dbopen is the library interface to database files. One of the supported file formats is hash files. The general description of the database access methods is in -.IR dbopen (3), -this manual page describes only the hash specific information. -.PP +.Xr dbopen 3 . +This manual page describes only the hash specific information. +.Pp The hash data structure is an extensible, dynamic hashing scheme. -.PP +.Pp The access method specific data structure provided to -.I dbopen -is defined in the <db.h> include file as follows: -.sp +.Fn dbopen +is defined in the +.Em <db.h> +include file as follows: +.Pp +.Bl -item -compact typedef struct { -.RS +.It +.Bl -item -compact -inset -offset indent +.It u_int bsize; -.br +.It u_int ffactor; -.br +.It u_int nelem; -.br +.It u_int cachesize; -.br +.It u_int32_t (*hash)(const void *, size_t); -.br +.It int lorder; -.RE +.El +.It } HASHINFO; -.PP +.El +.Pp The elements of this structure are as follows: -.TP -bsize -.I Bsize +.Bl -tag -width XXXXXX -offset indent +.It bsize +.Em bsize defines the hash table bucket size, and is, by default, 256 bytes. It may be preferable to increase the page size for disk-resident tables and tables with large data items. -.TP -ffactor -.I Ffactor +.It ffactor +.Em Ffactor indicates a desired density within the hash table. It is an approximation of the number of keys allowed to accumulate in any one bucket, determining when the hash table grows or shrinks. The default value is 8. -.TP -nelem -.I Nelem +.It nelem +.Em Nelem is an estimate of the final size of the hash table. If not set or set too low, hash tables will expand gracefully as keys are entered, although a slight performance degradation may be noticed. The default value is 1. -.TP -cachesize +.It cachesize A suggested maximum size, in bytes, of the memory cache. This value is .B only advisory, and the access method will allocate more memory rather than fail. -.TP -hash -.I Hash +.It hash +.Em Hash is a user defined hash function. Since no hash function performs equally well on all possible data, the user may find that the built-in hash function does poorly on a particular @@ -113,49 +115,56 @@ data set. User specified hash functions must take two arguments (a pointer to a byte string and a length) and return a 32-bit quantity to be used as the hash value. -.TP -lorder +.It lorder The byte order for integers in the stored database metadata. The number should represent the order as an integer; for example, -big endian order would be the number 4,321. -If -.I lorder +big endian order would be the number 4,321. If +.Em lorder is 0 (no order is specified) the current host order is used. If the file already exists, the specified value is ignored and the value specified when the tree was created is used. -.PP -If the file already exists (and the O_TRUNC flag is not specified), the +.El +.Pp +If the file already exists (and the +.Dv O_TRUNC +flag is not specified), the values specified for the parameters bsize, ffactor, lorder and nelem are ignored and the values specified when the tree was created are used. -.PP +.Pp If a hash function is specified, -.I hash_open +.Em hash_open will attempt to determine if the hash function specified is the same as the one with which the database was created, and will fail if it is not. -.PP +.Pp Backward compatible interfaces to the routines described in -.IR dbm (3), +.Xr dbm 3 , and -.IR ndbm (3) +.Xr ndbm 3 are provided, however these interfaces are not compatible with previous file formats. -.SH ERRORS +.Sh ERRORS The -.I hash +.Nm access method routines may fail and set -.I errno +.Em errno for any of the errors specified for the library routine -.IR dbopen (3). -.SH "SEE ALSO" -.IR btree (3), -.IR dbopen (3), -.IR mpool (3), -.IR recno (3) -.sp -.IR "Dynamic Hash Tables" , -Per-Ake Larson, Communications of the ACM, April 1988. -.sp -.IR "A New Hash Package for UNIX" , -Margo Seltzer, USENIX Proceedings, Winter 1991. -.SH BUGS +.Xr dbopen 3 . +.Sh SEE ALSO +.Xr btree 3 , +.Xr dbopen 3 , +.Xr mpool 3 , +.Xr recno 3 +.Rs +.%T "Dynamic Hash Tables" +.%A Per-Ake Larson +.%J Communications of the ACM +.%D April 1988 +.Re +.Rs +.%T "A New Hash Package for UNIX" +.%A Margo Seltzer +.%J USENIX Proceedings +.%D Winter 1991 +.Re +.Sh BUGS Only big and little endian byte order is supported. |