xref: /freebsd/include/ndbm.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Margo Seltzer.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)ndbm.h	8.1 (Berkeley) 6/2/93
35  */
36 
37 #ifndef _NDBM_H_
38 #define	_NDBM_H_
39 
40 #include <db.h>
41 
42 /* Map dbm interface onto db(3). */
43 #define DBM_RDONLY	O_RDONLY
44 
45 /* Flags to dbm_store(). */
46 #define DBM_INSERT      0
47 #define DBM_REPLACE     1
48 
49 /*
50  * The db(3) support for ndbm always appends this suffix to the
51  * file name to avoid overwriting the user's original database.
52  */
53 #define	DBM_SUFFIX	".db"
54 
55 typedef struct {
56 	void *dptr;
57 	int dsize;	/* XXX Should be size_t according to 1003.1-2008. */
58 } datum;
59 
60 typedef DB DBM;
61 #define	dbm_pagfno(a)	DBM_PAGFNO_NOT_AVAILABLE
62 
63 __BEGIN_DECLS
64 int	 dbm_clearerr(DBM *);
65 void	 dbm_close(DBM *);
66 int	 dbm_delete(DBM *, datum);
67 int	 dbm_error(DBM *);
68 datum	 dbm_fetch(DBM *, datum);
69 datum	 dbm_firstkey(DBM *);
70 #if __BSD_VISIBLE
71 long	 dbm_forder(DBM *, datum);
72 #endif
73 datum	 dbm_nextkey(DBM *);
74 DBM	*dbm_open(const char *, int, mode_t);
75 int	 dbm_store(DBM *, datum, datum, int);
76 #if __BSD_VISIBLE
77 int	 dbm_dirfno(DBM *);
78 #endif
79 __END_DECLS
80 
81 #endif /* !_NDBM_H_ */
82