Home | History | Annotate | Download | only in include
      1 /*-
      2  * Copyright (c) 1990, 1993, 1994
      3  *	The Regents of the University of California.  All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  * 1. Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  * 2. Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in the
     12  *    documentation and/or other materials provided with the distribution.
     13  * 3. All advertising materials mentioning features or use of this software
     14  *    must display the following acknowledgement:
     15  *	This product includes software developed by the University of
     16  *	California, Berkeley and its contributors.
     17  * 4. Neither the name of the University nor the names of its contributors
     18  *    may be used to endorse or promote products derived from this software
     19  *    without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     31  * SUCH DAMAGE.
     32  *
     33  *	@(#)db.h	8.8 (Berkeley) 11/2/95
     34  */
     35 
     36 #ifndef _DB_H_
     37 #define	_DB_H_
     38 
     39 #include <db-config.h>
     40 
     41 #include <sys/types.h>
     42 
     43 #define	RET_ERROR	-1		/* Return values. */
     44 #define	RET_SUCCESS	 0
     45 #define	RET_SPECIAL	 1
     46 
     47 /* Key/data structure -- a Data-Base Thang. */
     48 typedef struct {
     49 	void	*data;			/* data */
     50 	size_t	 size;			/* data length */
     51 } DBT;
     52 
     53 /* Routine flags. */
     54 #define	R_CURSOR	1		/* del, put, seq */
     55 #define	__R_UNUSED	2		/* UNUSED */
     56 #define	R_FIRST		3		/* seq */
     57 #define	R_IAFTER	4		/* put (RECNO) */
     58 #define	R_IBEFORE	5		/* put (RECNO) */
     59 #define	R_LAST		6		/* seq (BTREE, RECNO) */
     60 #define	R_NEXT		7		/* seq */
     61 #define	R_NOOVERWRITE	8		/* put */
     62 #define	R_PREV		9		/* seq (BTREE, RECNO) */
     63 #define	R_SETCURSOR	10		/* put (RECNO) */
     64 #define	R_RECNOSYNC	11		/* sync (RECNO) */
     65 
     66 typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
     67 
     68 /*
     69  * !!!
     70  * The following flags are included in the dbopen(3) call as part of the
     71  * open(2) flags.  In order to avoid conflicts with the open flags, start
     72  * at the top of the 16 or 32-bit number space and work our way down.  If
     73  * the open flags were significantly expanded in the future, it could be
     74  * a problem.  Wish I'd left another flags word in the dbopen call.
     75  *
     76  * !!!
     77  * None of this stuff is implemented yet.  The only reason that it's here
     78  * is so that the access methods can skip copying the key/data pair when
     79  * the DB_LOCK flag isn't set.
     80  */
     81 #if UINT_MAX >= 0xffffffffUL
     82 #define	DB_LOCK		0x20000000	/* Do locking. */
     83 #define	DB_SHMEM	0x40000000	/* Use shared memory. */
     84 #define	DB_TXN		0x80000000	/* Do transactions. */
     85 #else
     86 #define	DB_LOCK		    0x2000	/* Do locking. */
     87 #define	DB_SHMEM	    0x4000	/* Use shared memory. */
     88 #define	DB_TXN		    0x8000	/* Do transactions. */
     89 #endif
     90 
     91 /* deal with turning prototypes on and off */
     92 
     93 #ifndef __P
     94 #if defined(__STDC__) || defined(__cplusplus)
     95 #define	__P(protos)	protos		/* full-blown ANSI C */
     96 #else	/* !(__STDC__ || __cplusplus) */
     97 #define	__P(protos)	()		/* traditional C preprocessor */
     98 #endif
     99 #endif /* no __P from system */
    100 
    101 /* Access method description structure. */
    102 typedef struct __db {
    103 	DBTYPE type;			/* Underlying db type. */
    104 	int (*close)	__P((struct __db *));
    105 	int (*del)	__P((const struct __db *, const DBT *, u_int));
    106 	int (*get)	__P((const struct __db *, const DBT *, DBT *, u_int));
    107 	int (*put)	__P((const struct __db *, DBT *, const DBT *, u_int));
    108 	int (*seq)	__P((const struct __db *, DBT *, DBT *, u_int));
    109 	int (*sync)	__P((const struct __db *, u_int));
    110 	void *internal;			/* Access method private. */
    111 	int (*fd)	__P((const struct __db *));
    112 } DB;
    113 
    114 #define	BTREEMAGIC	0x053162
    115 #define	BTREEVERSION	3
    116 
    117 /* Structure used to pass parameters to the btree routines. */
    118 typedef struct {
    119 #define	R_DUP		0x01	/* duplicate keys */
    120 	u_long	flags;
    121 	u_int	cachesize;	/* bytes to cache */
    122 	int	maxkeypage;	/* maximum keys per page */
    123 	int	minkeypage;	/* minimum keys per page */
    124 	u_int	psize;		/* page size */
    125 	int	(*compare)	/* comparison function */
    126 	    __P((const DBT *, const DBT *));
    127 	size_t	(*prefix)	/* prefix function */
    128 	    __P((const DBT *, const DBT *));
    129 	int	lorder;		/* byte order */
    130 } BTREEINFO;
    131 
    132 #define	HASHMAGIC	0x061561
    133 #define	HASHVERSION	3
    134 
    135 /* Structure used to pass parameters to the hashing routines. */
    136 typedef struct {
    137 	u_int	bsize;		/* bucket size */
    138 	u_int	ffactor;	/* fill factor */
    139 	u_int	nelem;		/* number of elements */
    140 	u_int	cachesize;	/* bytes to cache */
    141 	u_int32_t		/* hash function */
    142 		(*hash) __P((const void *, size_t));
    143 	int	lorder;		/* byte order */
    144 } HASHINFO;
    145 
    146 /* Structure used to pass parameters to the record routines. */
    147 typedef struct {
    148 #define	R_FIXEDLEN	0x01	/* fixed-length records */
    149 #define	R_NOKEY		0x02	/* key not required */
    150 #define	R_SNAPSHOT	0x04	/* snapshot the input */
    151 	u_long	flags;
    152 	u_int	cachesize;	/* bytes to cache */
    153 	u_int	psize;		/* page size */
    154 	int	lorder;		/* byte order */
    155 	size_t	reclen;		/* record length (fixed-length records) */
    156 	u_char	bval;		/* delimiting byte (variable-length records */
    157 	char	*bfname;	/* btree file name */
    158 } RECNOINFO;
    159 
    160 #if defined(__cplusplus)
    161 #define	__BEGIN_DECLS	extern "C" {
    162 #define	__END_DECLS	};
    163 #else
    164 #define	__BEGIN_DECLS
    165 #define	__END_DECLS
    166 #endif
    167 
    168 #define dbopen	kdb2_dbopen
    169 #define bt_rseq		kdb2_bt_rseq /* XXX kludge */
    170 __BEGIN_DECLS
    171 DB *dbopen __P((const char *, int, int, DBTYPE, const void *));
    172 int	 bt_rseq(const DB*, DBT *, DBT *, void **, u_int); /* XXX kludge */
    173 __END_DECLS
    174 
    175 #endif /* !_DB_H_ */
    176