[unix-history] / include / db.h

/*-
 * Copyright (c) 1990, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)db.h	8.3 (Berkeley) 10/12/93
 */

#ifndef _DB_H_
#define	_DB_H_

#include <sys/types.h>
#include <sys/cdefs.h>
#include <machine/endian.h>

#include <limits.h>

#define	RET_ERROR	-1		/* Return values. */
#define	RET_SUCCESS	 0
#define	RET_SPECIAL	 1

#define	MAX_PAGE_NUMBER	ULONG_MAX	/* >= # of pages in a file */
typedef u_long	pgno_t;
#define	MAX_PAGE_OFFSET	USHRT_MAX	/* >= # of bytes in a page */
typedef u_short	indx_t;
#define	MAX_REC_NUMBER	ULONG_MAX	/* >= # of records in a tree */
typedef u_long	recno_t;

/* Key/data structure -- a Data-Base Thang. */
typedef struct {
	void	*data;			/* data */
	size_t	 size;			/* data length */
} DBT;

/* Routine flags. */
#define	R_CURSOR	1		/* del, put, seq */
#define	__R_UNUSED	2		/* UNUSED */
#define	R_FIRST		3		/* seq */
#define	R_IAFTER	4		/* put (RECNO) */
#define	R_IBEFORE	5		/* put (RECNO) */
#define	R_LAST		6		/* seq (BTREE, RECNO) */
#define	R_NEXT		7		/* seq */
#define	R_NOOVERWRITE	8		/* put */
#define	R_PREV		9		/* seq (BTREE, RECNO) */
#define	R_SETCURSOR	10		/* put (RECNO) */
#define	R_RECNOSYNC	11		/* sync (RECNO) */

typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;

/*
 * !!!
 * The following flags are included in the dbopen(3) call as part of the
 * open(2) flags.  In order to avoid conflicts with the open flags, start
 * at the top of the 16 or 32-bit number space and work our way down.  If
 * the open flags were significantly expanded in the future, it could be
 * a problem.  Wish I'd left another flags word in the dbopen call.
 *
 * !!!
 * None of this stuff is implemented yet.  The only reason that it's here
 * is so that the access methods can skip copying the key/data pair when
 * the DB_LOCK flag isn't set.
 */
#if UINT_MAX > 65535
#define	DB_LOCK		0x20000000	/* Do locking. */
#define	DB_SHMEM	0x40000000	/* Use shared memory. */
#define	DB_TXN		0x80000000	/* Do transactions. */
#else
#define	DB_LOCK		0x00002000	/* Do locking. */
#define	DB_SHMEM	0x00004000	/* Use shared memory. */
#define	DB_TXN		0x00008000	/* Do transactions. */
#endif

/* Access method description structure. */
typedef struct __db {
	DBTYPE type;			/* Underlying db type. */
	int (*close)	__P((struct __db *));
	int (*del)	__P((const struct __db *, const DBT *, u_int));
	int (*get)	__P((const struct __db *, const DBT *, DBT *, u_int));
	int (*put)	__P((const struct __db *, DBT *, const DBT *, u_int));
	int (*seq)	__P((const struct __db *, DBT *, DBT *, u_int));
	int (*sync)	__P((const struct __db *, u_int));
	void *internal;			/* Access method private. */
	int (*fd)	__P((const struct __db *));
} DB;

#define	BTREEMAGIC	0x053162
#define	BTREEVERSION	3

/* Structure used to pass parameters to the btree routines. */
typedef struct {
#define	R_DUP		0x01	/* duplicate keys */
	u_long	 flags;
	int	 cachesize;	/* bytes to cache */
	int	 maxkeypage;	/* maximum keys per page */
	int	 minkeypage;	/* minimum keys per page */
	int	 psize;		/* page size */
				/* comparison, prefix functions */
	int	 (*compare)	__P((const DBT *, const DBT *));
	int	 (*prefix)	__P((const DBT *, const DBT *));
	int	 lorder;	/* byte order */
} BTREEINFO;

#define	HASHMAGIC	0x061561
#define	HASHVERSION	2

/* Structure used to pass parameters to the hashing routines. */
typedef struct {
	int	 bsize;		/* bucket size */
	int	 ffactor;	/* fill factor */
	int	 nelem;		/* number of elements */
	int	 cachesize;	/* bytes to cache */
				/* hash function */
	int	 (*hash) __P((const void *, size_t));
	int	 lorder;	/* byte order */
} HASHINFO;

/* Structure used to pass parameters to the record routines. */
typedef struct {
#define	R_FIXEDLEN	0x01	/* fixed-length records */
#define	R_NOKEY		0x02	/* key not required */
#define	R_SNAPSHOT	0x04	/* snapshot the input */
	u_long	 flags;
	int	 cachesize;	/* bytes to cache */
	int	 psize;		/* page size */
	int	 lorder;	/* byte order */
	size_t	 reclen;	/* record length (fixed-length records) */
	u_char	 bval;		/* delimiting byte (variable-length records */
	char	*bfname;	/* btree file name */ 
} RECNOINFO;

/*
 * Little endian <==> big endian long swap macros.
 *	BLSWAP		swap a memory location
 *	BLPSWAP		swap a referenced memory location
 *	BLSWAP_COPY	swap from one location to another
 */
#define BLSWAP(a) {							\
	u_long _tmp = a;						\
	((char *)&a)[0] = ((char *)&_tmp)[3];				\
	((char *)&a)[1] = ((char *)&_tmp)[2];				\
	((char *)&a)[2] = ((char *)&_tmp)[1];				\
	((char *)&a)[3] = ((char *)&_tmp)[0];				\
}
#define	BLPSWAP(a) {							\
	u_long _tmp = *(u_long *)a;					\
	((char *)a)[0] = ((char *)&_tmp)[3];				\
	((char *)a)[1] = ((char *)&_tmp)[2];				\
	((char *)a)[2] = ((char *)&_tmp)[1];				\
	((char *)a)[3] = ((char *)&_tmp)[0];				\
}
#define	BLSWAP_COPY(a, b) {						\
	((char *)&(b))[0] = ((char *)&(a))[3];				\
	((char *)&(b))[1] = ((char *)&(a))[2];				\
	((char *)&(b))[2] = ((char *)&(a))[1];				\
	((char *)&(b))[3] = ((char *)&(a))[0];				\
}

/*
 * Little endian <==> big endian short swap macros.
 *	BSSWAP		swap a memory location
 *	BSPSWAP		swap a referenced memory location
 *	BSSWAP_COPY	swap from one location to another
 */
#define BSSWAP(a) {							\
	u_short _tmp = a;						\
	((char *)&a)[0] = ((char *)&_tmp)[1];				\
	((char *)&a)[1] = ((char *)&_tmp)[0];				\
}
#define BSPSWAP(a) {							\
	u_short _tmp = *(u_short *)a;					\
	((char *)a)[0] = ((char *)&_tmp)[1];				\
	((char *)a)[1] = ((char *)&_tmp)[0];				\
}
#define BSSWAP_COPY(a, b) {						\
	((char *)&(b))[0] = ((char *)&(a))[1];				\
	((char *)&(b))[1] = ((char *)&(a))[0];				\
}

__BEGIN_DECLS
DB *dbopen __P((const char *, int, int, DBTYPE, const void *));

#ifdef __DBINTERFACE_PRIVATE
DB	*__bt_open __P((const char *, int, int, const BTREEINFO *, int));
DB	*__hash_open __P((const char *, int, int, const HASHINFO *, int));
DB	*__rec_open __P((const char *, int, int, const RECNOINFO *, int));
void	 __dbpanic __P((DB *dbp));
#endif
__END_DECLS
#endif /* !_DB_H_ */
Commit	Line	Data
15637ed4	1	/*-
28e48405 RG	2	* Copyright (c) 1990, 1993
28e48405 RG	3	* The Regents of the University of California. All rights reserved.
15637ed4 RG	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	*
f6afd728	33	* @(#)db.h 8.3 (Berkeley) 10/12/93
15637ed4 RG	34	*/
	35
	36	#ifndef _DB_H_
	37	#define _DB_H_
	38
28e48405	39	#include <sys/types.h>
15637ed4	40	#include <sys/cdefs.h>
f6afd728	41	#include <machine/endian.h>
1539428f AM	42
1539428f AM	43	#include <limits.h>
15637ed4	44
28e48405 RG	45	#define RET_ERROR -1 /* Return values. */
	46	#define RET_SUCCESS 0
	47	#define RET_SPECIAL 1
15637ed4	48
28e48405 RG	49	#define MAX_PAGE_NUMBER ULONG_MAX /* >= # of pages in a file */
	50	typedef u_long pgno_t;
	51	#define MAX_PAGE_OFFSET USHRT_MAX /* >= # of bytes in a page */
	52	typedef u_short indx_t;
	53	#define MAX_REC_NUMBER ULONG_MAX /* >= # of records in a tree */
	54	typedef u_long recno_t;
15637ed4	55
28e48405	56	/* Key/data structure -- a Data-Base Thang. */
15637ed4	57	typedef struct {
28e48405 RG	58	void data; / data */
28e48405 RG	59	size_t size; /* data length */
15637ed4 RG	60	} DBT;
15637ed4 RG	61
28e48405 RG	62	/* Routine flags. */
	63	#define R_CURSOR 1 /* del, put, seq */
	64	#define __R_UNUSED 2 /* UNUSED */
	65	#define R_FIRST 3 /* seq */
	66	#define R_IAFTER 4 /* put (RECNO) */
	67	#define R_IBEFORE 5 /* put (RECNO) */
	68	#define R_LAST 6 /* seq (BTREE, RECNO) */
	69	#define R_NEXT 7 /* seq */
	70	#define R_NOOVERWRITE 8 /* put */
	71	#define R_PREV 9 /* seq (BTREE, RECNO) */
	72	#define R_SETCURSOR 10 /* put (RECNO) */
	73	#define R_RECNOSYNC 11 /* sync (RECNO) */
	74
	75	typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
	76
1539428f AM	77	/*
	78	* !!!
	79	* The following flags are included in the dbopen(3) call as part of the
	80	* open(2) flags. In order to avoid conflicts with the open flags, start
	81	* at the top of the 16 or 32-bit number space and work our way down. If
	82	* the open flags were significantly expanded in the future, it could be
	83	* a problem. Wish I'd left another flags word in the dbopen call.
	84	*
	85	* !!!
	86	* None of this stuff is implemented yet. The only reason that it's here
	87	* is so that the access methods can skip copying the key/data pair when
	88	* the DB_LOCK flag isn't set.
	89	*/
	90	#if UINT_MAX > 65535
	91	#define DB_LOCK 0x20000000 /* Do locking. */
	92	#define DB_SHMEM 0x40000000 /* Use shared memory. */
	93	#define DB_TXN 0x80000000 /* Do transactions. */
	94	#else
	95	#define DB_LOCK 0x00002000 /* Do locking. */
	96	#define DB_SHMEM 0x00004000 /* Use shared memory. */
	97	#define DB_TXN 0x00008000 /* Do transactions. */
	98	#endif
28e48405 RG	99
28e48405 RG	100	/* Access method description structure. */
15637ed4	101	typedef struct __db {
1539428f	102	DBTYPE type; /* Underlying db type. */
28e48405 RG	103	int (close) __P((struct __db ));
28e48405 RG	104	int (del) __P((const struct __db , const DBT *, u_int));
28e48405 RG	105	int (get) __P((const struct __db , const DBT , DBT , u_int));
	106	int (put) __P((const struct __db , DBT , const DBT , u_int));
	107	int (seq) __P((const struct __db , DBT , DBT , u_int));
	108	int (sync) __P((const struct __db , u_int));
f6afd728 JH	109	void internal; / Access method private. */
f6afd728 JH	110	int (fd) __P((const struct __db ));
15637ed4 RG	111	} DB;
	112
	113	#define BTREEMAGIC 0x053162
28e48405	114	#define BTREEVERSION 3
15637ed4	115
28e48405	116	/* Structure used to pass parameters to the btree routines. */
15637ed4 RG	117	typedef struct {
15637ed4 RG	118	#define R_DUP 0x01 /* duplicate keys */
28e48405 RG	119	u_long flags;
	120	int cachesize; /* bytes to cache */
	121	int maxkeypage; /* maximum keys per page */
	122	int minkeypage; /* minimum keys per page */
	123	int psize; /* page size */
	124	/* comparison, prefix functions */
	125	int (compare) __P((const DBT , const DBT *));
	126	int (prefix) __P((const DBT , const DBT *));
	127	int lorder; /* byte order */
15637ed4 RG	128	} BTREEINFO;
	129
	130	#define HASHMAGIC 0x061561
28e48405	131	#define HASHVERSION 2
15637ed4	132
28e48405	133	/* Structure used to pass parameters to the hashing routines. */
15637ed4	134	typedef struct {
28e48405 RG	135	int bsize; /* bucket size */
	136	int ffactor; /* fill factor */
	137	int nelem; /* number of elements */
	138	int cachesize; /* bytes to cache */
	139	/* hash function */
	140	int (hash) __P((const void , size_t));
	141	int lorder; /* byte order */
15637ed4 RG	142	} HASHINFO;
15637ed4 RG	143
28e48405	144	/* Structure used to pass parameters to the record routines. */
15637ed4 RG	145	typedef struct {
15637ed4 RG	146	#define R_FIXEDLEN 0x01 /* fixed-length records */
28e48405 RG	147	#define R_NOKEY 0x02 /* key not required */
	148	#define R_SNAPSHOT 0x04 /* snapshot the input */
	149	u_long flags;
	150	int cachesize; /* bytes to cache */
	151	int psize; /* page size */
	152	int lorder; /* byte order */
	153	size_t reclen; /* record length (fixed-length records) */
	154	u_char bval; /* delimiting byte (variable-length records */
	155	char bfname; / btree file name */
15637ed4 RG	156	} RECNOINFO;
15637ed4 RG	157
28e48405 RG	158	/*
	159	* Little endian <==> big endian long swap macros.
	160	* BLSWAP swap a memory location
	161	* BLPSWAP swap a referenced memory location
	162	* BLSWAP_COPY swap from one location to another
	163	*/
1539428f AM	164	#define BLSWAP(a) { \
	165	u_long _tmp = a; \
	166	((char )&a)[0] = ((char )&_tmp)[3]; \
	167	((char )&a)[1] = ((char )&_tmp)[2]; \
	168	((char )&a)[2] = ((char )&_tmp)[1]; \
	169	((char )&a)[3] = ((char )&_tmp)[0]; \
28e48405	170	}
1539428f AM	171	#define BLPSWAP(a) { \
	172	u_long _tmp = (u_long )a; \
	173	((char )a)[0] = ((char )&_tmp)[3]; \
	174	((char )a)[1] = ((char )&_tmp)[2]; \
	175	((char )a)[2] = ((char )&_tmp)[1]; \
	176	((char )a)[3] = ((char )&_tmp)[0]; \
28e48405	177	}
1539428f AM	178	#define BLSWAP_COPY(a, b) { \
	179	((char )&(b))[0] = ((char )&(a))[3]; \
	180	((char )&(b))[1] = ((char )&(a))[2]; \
	181	((char )&(b))[2] = ((char )&(a))[1]; \
	182	((char )&(b))[3] = ((char )&(a))[0]; \
28e48405 RG	183	}
	184
	185	/*
	186	* Little endian <==> big endian short swap macros.
	187	* BSSWAP swap a memory location
	188	* BSPSWAP swap a referenced memory location
	189	* BSSWAP_COPY swap from one location to another
	190	*/
1539428f AM	191	#define BSSWAP(a) { \
	192	u_short _tmp = a; \
	193	((char )&a)[0] = ((char )&_tmp)[1]; \
	194	((char )&a)[1] = ((char )&_tmp)[0]; \
28e48405	195	}
1539428f AM	196	#define BSPSWAP(a) { \
	197	u_short _tmp = (u_short )a; \
	198	((char )a)[0] = ((char )&_tmp)[1]; \
	199	((char )a)[1] = ((char )&_tmp)[0]; \
28e48405	200	}
1539428f AM	201	#define BSSWAP_COPY(a, b) { \
	202	((char )&(b))[0] = ((char )&(a))[1]; \
	203	((char )&(b))[1] = ((char )&(a))[0]; \
28e48405	204	}
15637ed4 RG	205
15637ed4 RG	206	__BEGIN_DECLS
28e48405 RG	207	DB dbopen __P((const char , int, int, DBTYPE, const void *));
	208
	209	#ifdef __DBINTERFACE_PRIVATE
1539428f AM	210	DB __bt_open __P((const char , int, int, const BTREEINFO *, int));
	211	DB __hash_open __P((const char , int, int, const HASHINFO *, int));
	212	DB __rec_open __P((const char , int, int, const RECNOINFO *, int));
28e48405 RG	213	void __dbpanic __P((DB *dbp));
28e48405 RG	214	#endif
15637ed4	215	__END_DECLS
15637ed4	216	#endif /* !_DB_H_ */