[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.1 (Berkeley) 6/2/93
 */

#ifndef _DB_H_
#define	_DB_H_

#include <sys/types.h>
#include <sys/cdefs.h>
#include <machine/endian.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;

#define	__USE_OPEN_FLAGS \
	(O_CREAT|O_EXCL|O_EXLOCK|O_RDONLY|O_RDWR|O_SHLOCK|O_TRUNC)

/* 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 (*fd)	__P((const struct __db *));
	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 */
} 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 *));
DB	*__hash_open __P((const char *, int, int, const HASHINFO *));
DB	*__rec_open __P((const char *, int, int, const RECNOINFO *));
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	*
28e48405	33	* @(#)db.h 8.1 (Berkeley) 6/2/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>
28e48405	41	#include <machine/endian.h>
15637ed4	42
28e48405 RG	43	#define RET_ERROR -1 /* Return values. */
	44	#define RET_SUCCESS 0
	45	#define RET_SPECIAL 1
15637ed4	46
28e48405 RG	47	#define MAX_PAGE_NUMBER ULONG_MAX /* >= # of pages in a file */
	48	typedef u_long pgno_t;
	49	#define MAX_PAGE_OFFSET USHRT_MAX /* >= # of bytes in a page */
	50	typedef u_short indx_t;
	51	#define MAX_REC_NUMBER ULONG_MAX /* >= # of records in a tree */
	52	typedef u_long recno_t;
15637ed4	53
28e48405	54	/* Key/data structure -- a Data-Base Thang. */
15637ed4	55	typedef struct {
28e48405 RG	56	void data; / data */
28e48405 RG	57	size_t size; /* data length */
15637ed4 RG	58	} DBT;
15637ed4 RG	59
28e48405 RG	60	/* Routine flags. */
	61	#define R_CURSOR 1 /* del, put, seq */
	62	#define __R_UNUSED 2 /* UNUSED */
	63	#define R_FIRST 3 /* seq */
	64	#define R_IAFTER 4 /* put (RECNO) */
	65	#define R_IBEFORE 5 /* put (RECNO) */
	66	#define R_LAST 6 /* seq (BTREE, RECNO) */
	67	#define R_NEXT 7 /* seq */
	68	#define R_NOOVERWRITE 8 /* put */
	69	#define R_PREV 9 /* seq (BTREE, RECNO) */
	70	#define R_SETCURSOR 10 /* put (RECNO) */
	71	#define R_RECNOSYNC 11 /* sync (RECNO) */
	72
	73	typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
	74
	75	#define __USE_OPEN_FLAGS \
	76	(O_CREAT\|O_EXCL\|O_EXLOCK\|O_RDONLY\|O_RDWR\|O_SHLOCK\|O_TRUNC)
	77
	78	/* Access method description structure. */
15637ed4	79	typedef struct __db {
28e48405 RG	80	DBTYPE type; /* underlying db type */
	81	int (close) __P((struct __db ));
	82	int (del) __P((const struct __db , const DBT *, u_int));
	83	int (fd) __P((const struct __db ));
	84	int (get) __P((const struct __db , const DBT , DBT , u_int));
	85	int (put) __P((const struct __db , DBT , const DBT , u_int));
	86	int (seq) __P((const struct __db , DBT , DBT , u_int));
	87	int (sync) __P((const struct __db , u_int));
	88	void internal; / access method private */
15637ed4 RG	89	} DB;
	90
	91	#define BTREEMAGIC 0x053162
28e48405	92	#define BTREEVERSION 3
15637ed4	93
28e48405	94	/* Structure used to pass parameters to the btree routines. */
15637ed4 RG	95	typedef struct {
15637ed4 RG	96	#define R_DUP 0x01 /* duplicate keys */
28e48405 RG	97	u_long flags;
	98	int cachesize; /* bytes to cache */
	99	int maxkeypage; /* maximum keys per page */
	100	int minkeypage; /* minimum keys per page */
	101	int psize; /* page size */
	102	/* comparison, prefix functions */
	103	int (compare) __P((const DBT , const DBT *));
	104	int (prefix) __P((const DBT , const DBT *));
	105	int lorder; /* byte order */
15637ed4 RG	106	} BTREEINFO;
	107
	108	#define HASHMAGIC 0x061561
28e48405	109	#define HASHVERSION 2
15637ed4	110
28e48405	111	/* Structure used to pass parameters to the hashing routines. */
15637ed4	112	typedef struct {
28e48405 RG	113	int bsize; /* bucket size */
	114	int ffactor; /* fill factor */
	115	int nelem; /* number of elements */
	116	int cachesize; /* bytes to cache */
	117	/* hash function */
	118	int (hash) __P((const void , size_t));
	119	int lorder; /* byte order */
15637ed4 RG	120	} HASHINFO;
15637ed4 RG	121
28e48405	122	/* Structure used to pass parameters to the record routines. */
15637ed4 RG	123	typedef struct {
15637ed4 RG	124	#define R_FIXEDLEN 0x01 /* fixed-length records */
28e48405 RG	125	#define R_NOKEY 0x02 /* key not required */
	126	#define R_SNAPSHOT 0x04 /* snapshot the input */
	127	u_long flags;
	128	int cachesize; /* bytes to cache */
	129	int psize; /* page size */
	130	int lorder; /* byte order */
	131	size_t reclen; /* record length (fixed-length records) */
	132	u_char bval; /* delimiting byte (variable-length records */
	133	char bfname; / btree file name */
15637ed4 RG	134	} RECNOINFO;
15637ed4 RG	135
28e48405 RG	136	/*
	137	* Little endian <==> big endian long swap macros.
	138	* BLSWAP swap a memory location
	139	* BLPSWAP swap a referenced memory location
	140	* BLSWAP_COPY swap from one location to another
	141	*/
	142	#define BLSWAP(a) { \
	143	u_long _tmp = a; \
	144	((char )&a)[0] = ((char )&_tmp)[3]; \
	145	((char )&a)[1] = ((char )&_tmp)[2]; \
	146	((char )&a)[2] = ((char )&_tmp)[1]; \
	147	((char )&a)[3] = ((char )&_tmp)[0]; \
	148	}
	149	#define BLPSWAP(a) { \
	150	u_long _tmp = (u_long )a; \
	151	((char )a)[0] = ((char )&_tmp)[3]; \
	152	((char )a)[1] = ((char )&_tmp)[2]; \
	153	((char )a)[2] = ((char )&_tmp)[1]; \
	154	((char )a)[3] = ((char )&_tmp)[0]; \
	155	}
	156	#define BLSWAP_COPY(a, b) { \
	157	((char )&(b))[0] = ((char )&(a))[3]; \
	158	((char )&(b))[1] = ((char )&(a))[2]; \
	159	((char )&(b))[2] = ((char )&(a))[1]; \
	160	((char )&(b))[3] = ((char )&(a))[0]; \
	161	}
	162
	163	/*
	164	* Little endian <==> big endian short swap macros.
	165	* BSSWAP swap a memory location
	166	* BSPSWAP swap a referenced memory location
	167	* BSSWAP_COPY swap from one location to another
	168	*/
	169	#define BSSWAP(a) { \
	170	u_short _tmp = a; \
	171	((char )&a)[0] = ((char )&_tmp)[1]; \
	172	((char )&a)[1] = ((char )&_tmp)[0]; \
	173	}
	174	#define BSPSWAP(a) { \
	175	u_short _tmp = (u_short )a; \
	176	((char )a)[0] = ((char )&_tmp)[1]; \
	177	((char )a)[1] = ((char )&_tmp)[0]; \
	178	}
	179	#define BSSWAP_COPY(a, b) { \
	180	((char )&(b))[0] = ((char )&(a))[1]; \
	181	((char )&(b))[1] = ((char )&(a))[0]; \
	182	}
15637ed4 RG	183
15637ed4 RG	184	__BEGIN_DECLS
28e48405 RG	185	DB dbopen __P((const char , int, int, DBTYPE, const void *));
	186
	187	#ifdef __DBINTERFACE_PRIVATE
	188	DB __bt_open __P((const char , int, int, const BTREEINFO *));
	189	DB __hash_open __P((const char , int, int, const HASHINFO *));
	190	DB __rec_open __P((const char , int, int, const RECNOINFO *));
	191	void __dbpanic __P((DB *dbp));
	192	#endif
15637ed4	193	__END_DECLS
15637ed4	194	#endif /* !_DB_H_ */