NetBSD/include/db.h

235 lines
8.3 KiB
C
Raw Normal View History

1998-11-16 15:07:43 +03:00
/* $NetBSD: db.h,v 1.15 1998/11/16 12:07:43 christos Exp $ */
1994-10-26 03:55:40 +03:00
1993-03-21 12:45:37 +03:00
/*-
1994-08-18 02:58:56 +04:00
* Copyright (c) 1990, 1993, 1994
* The Regents of the University of California. All rights reserved.
1993-03-21 12:45:37 +03:00
*
* 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.
*
1994-08-18 02:58:56 +04:00
* @(#)db.h 8.7 (Berkeley) 6/16/94
1993-03-21 12:45:37 +03:00
*/
#ifndef _DB_H_
#define _DB_H_
1993-04-19 01:48:37 +04:00
#include <sys/types.h>
1993-03-21 12:45:37 +03:00
#include <sys/cdefs.h>
1993-09-09 06:41:04 +04:00
#include <limits.h>
1993-03-21 12:45:37 +03:00
1993-04-19 01:48:37 +04:00
#define RET_ERROR -1 /* Return values. */
#define RET_SUCCESS 0
#define RET_SPECIAL 1
1993-03-21 12:45:37 +03:00
1994-08-18 02:58:56 +04:00
#ifndef __BIT_TYPES_DEFINED__
#define __BIT_TYPES_DEFINED__
typedef __signed char int8_t;
typedef unsigned char u_int8_t;
typedef short int16_t;
typedef unsigned short u_int16_t;
typedef int int32_t;
typedef unsigned int u_int32_t;
#ifdef WE_DONT_NEED_QUADS
typedef long long int64_t;
typedef unsigned long long u_int64_t;
#endif
#endif
#define MAX_PAGE_NUMBER 0xffffffff /* >= # of pages in a file */
typedef u_int32_t pgno_t;
#define MAX_PAGE_OFFSET 65535 /* >= # of bytes in a page */
typedef u_int16_t indx_t;
#define MAX_REC_NUMBER 0xffffffff /* >= # of records in a tree */
typedef u_int32_t recno_t;
1993-03-21 12:45:37 +03:00
1993-04-19 01:48:37 +04:00
/* Key/data structure -- a Data-Base Thang. */
1993-03-21 12:45:37 +03:00
typedef struct {
1993-04-19 01:48:37 +04:00
void *data; /* data */
size_t size; /* data length */
1993-03-21 12:45:37 +03:00
} DBT;
1993-04-19 01:48:37 +04:00
/* Routine flags. */
#define R_CURSOR 1 /* del, put, seq */
1993-05-27 23:54:30 +04:00
#define __R_UNUSED 2 /* UNUSED */
1993-04-19 01:48:37 +04:00
#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) */
1993-05-27 23:54:30 +04:00
#define R_RECNOSYNC 11 /* sync (RECNO) */
1993-04-19 01:48:37 +04:00
typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
1993-09-09 06:41:04 +04:00
/*
* !!!
* 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
1994-08-18 02:58:56 +04:00
#define DB_LOCK 0x2000 /* Do locking. */
#define DB_SHMEM 0x4000 /* Use shared memory. */
#define DB_TXN 0x8000 /* Do transactions. */
1993-09-09 06:41:04 +04:00
#endif
1993-04-19 01:48:37 +04:00
/* Access method description structure. */
1993-03-21 12:45:37 +03:00
typedef struct __db {
1993-09-09 06:41:04 +04:00
DBTYPE type; /* Underlying db type. */
1993-04-19 01:48:37 +04:00
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));
1993-05-27 23:54:30 +04:00
int (*sync) __P((const struct __db *, u_int));
1993-10-20 10:25:53 +03:00
void *internal; /* Access method private. */
int (*fd) __P((const struct __db *));
1993-03-21 12:45:37 +03:00
} DB;
#define BTREEMAGIC 0x053162
1993-04-19 01:48:37 +04:00
#define BTREEVERSION 3
1993-03-21 12:45:37 +03:00
1993-04-19 01:48:37 +04:00
/* Structure used to pass parameters to the btree routines. */
1993-03-21 12:45:37 +03:00
typedef struct {
#define R_DUP 0x01 /* duplicate keys */
1994-08-18 02:58:56 +04:00
u_long flags;
u_int cachesize; /* bytes to cache */
int maxkeypage; /* maximum keys per page */
int minkeypage; /* minimum keys per page */
u_int psize; /* page size */
int (*compare) /* comparison function */
__P((const DBT *, const DBT *));
size_t (*prefix) /* prefix function */
__P((const DBT *, const DBT *));
int lorder; /* byte order */
1993-03-21 12:45:37 +03:00
} BTREEINFO;
#define HASHMAGIC 0x061561
1993-04-19 01:48:37 +04:00
#define HASHVERSION 2
1993-03-21 12:45:37 +03:00
1993-04-19 01:48:37 +04:00
/* Structure used to pass parameters to the hashing routines. */
1993-03-21 12:45:37 +03:00
typedef struct {
1994-08-18 02:58:56 +04:00
u_int bsize; /* bucket size */
u_int ffactor; /* fill factor */
u_int nelem; /* number of elements */
u_int cachesize; /* bytes to cache */
u_int32_t /* hash function */
(*hash) __P((const void *, size_t));
int lorder; /* byte order */
1993-03-21 12:45:37 +03:00
} HASHINFO;
1993-04-19 01:48:37 +04:00
/* Structure used to pass parameters to the record routines. */
1993-03-21 12:45:37 +03:00
typedef struct {
#define R_FIXEDLEN 0x01 /* fixed-length records */
1993-04-19 01:48:37 +04:00
#define R_NOKEY 0x02 /* key not required */
#define R_SNAPSHOT 0x04 /* snapshot the input */
1994-08-18 02:58:56 +04:00
u_long flags;
u_int cachesize; /* bytes to cache */
u_int psize; /* page size */
int lorder; /* byte order */
size_t reclen; /* record length (fixed-length records) */
u_char bval; /* delimiting byte (variable-length records */
1993-05-27 23:54:30 +04:00
char *bfname; /* btree file name */
1993-03-21 12:45:37 +03:00
} RECNOINFO;
1994-08-18 02:58:56 +04:00
#ifdef __DBINTERFACE_PRIVATE
1993-04-19 01:48:37 +04:00
/*
1994-08-18 02:58:56 +04:00
* Little endian <==> big endian 32-bit swap macros.
* M_32_SWAP swap a memory location
* P_32_SWAP swap a referenced memory location
* P_32_COPY swap from one location to another
1993-04-19 01:48:37 +04:00
*/
1994-08-18 02:58:56 +04:00
#define M_32_SWAP(a) { \
u_int32_t _tmp = a; \
1998-11-16 15:07:43 +03:00
((char *)(void *)&a)[0] = ((char *)(void *)&_tmp)[3]; \
((char *)(void *)&a)[1] = ((char *)(void *)&_tmp)[2]; \
((char *)(void *)&a)[2] = ((char *)(void *)&_tmp)[1]; \
((char *)(void *)&a)[3] = ((char *)(void *)&_tmp)[0]; \
1993-05-27 23:54:30 +04:00
}
1994-08-18 02:58:56 +04:00
#define P_32_SWAP(a) { \
u_int32_t _tmp = *(u_int32_t *)a; \
1998-11-16 15:07:43 +03:00
((char *)(void *)a)[0] = ((char *)(void *)&_tmp)[3]; \
((char *)(void *)a)[1] = ((char *)(void *)&_tmp)[2]; \
((char *)(void *)a)[2] = ((char *)(void *)&_tmp)[1]; \
((char *)(void *)a)[3] = ((char *)(void *)&_tmp)[0]; \
1993-05-27 23:54:30 +04:00
}
1994-08-18 02:58:56 +04:00
#define P_32_COPY(a, b) { \
1998-11-16 15:07:43 +03:00
((char *)(void *)&(b))[0] = ((char *)(void *)&(a))[3]; \
((char *)(void *)&(b))[1] = ((char *)(void *)&(a))[2]; \
((char *)(void *)&(b))[2] = ((char *)(void *)&(a))[1]; \
((char *)(void *)&(b))[3] = ((char *)(void *)&(a))[0]; \
1993-05-27 23:54:30 +04:00
}
1993-04-19 01:48:37 +04:00
/*
1994-08-18 02:58:56 +04:00
* Little endian <==> big endian 16-bit swap macros.
* M_16_SWAP swap a memory location
* P_16_SWAP swap a referenced memory location
* P_16_COPY swap from one location to another
1993-04-19 01:48:37 +04:00
*/
1994-08-18 02:58:56 +04:00
#define M_16_SWAP(a) { \
u_int16_t _tmp = a; \
1998-11-16 15:07:43 +03:00
((char *)(void *)&a)[0] = ((char *)(void *)&_tmp)[1]; \
((char *)(void *)&a)[1] = ((char *)(void *)&_tmp)[0]; \
1993-05-27 23:54:30 +04:00
}
1994-08-18 02:58:56 +04:00
#define P_16_SWAP(a) { \
u_int16_t _tmp = *(u_int16_t *)a; \
1998-11-16 15:07:43 +03:00
((char *)(void *)a)[0] = ((char *)(void *)&_tmp)[1]; \
((char *)(void *)a)[1] = ((char *)(void *)&_tmp)[0]; \
1993-05-27 23:54:30 +04:00
}
1994-08-18 02:58:56 +04:00
#define P_16_COPY(a, b) { \
1998-11-16 15:07:43 +03:00
((char *)(void *)&(b))[0] = ((char *)(void *)&(a))[1]; \
((char *)(void *)&(b))[1] = ((char *)(void *)&(a))[0]; \
1993-05-27 23:54:30 +04:00
}
1994-08-18 02:58:56 +04:00
#endif
1993-03-21 12:45:37 +03:00
__BEGIN_DECLS
DB *dbopen __P((const char *, int, mode_t, DBTYPE, const void *));
1993-04-19 01:48:37 +04:00
#ifdef __DBINTERFACE_PRIVATE
DB *__bt_open __P((const char *, int, mode_t, const BTREEINFO *, int));
DB *__hash_open __P((const char *, int, mode_t, const HASHINFO *, int));
DB *__rec_open __P((const char *, int, mode_t, const RECNOINFO *, int));
1993-04-19 01:48:37 +04:00
void __dbpanic __P((DB *dbp));
#endif
1993-03-21 12:45:37 +03:00
__END_DECLS
#endif /* !_DB_H_ */