Logo Search packages:      
Sourcecode: vigor version File versions  Download package

db.h

/*-
 * Copyright (c) 1990, 1993, 1994
 *    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.7 (Berkeley) 6/16/94
 */

#ifndef _DB_H_
#define     _DB_H_

#include <sys/types.h>

#ifdef __DBINTERFACE_PRIVATE
#include "config.h"
#include "port.h"
#endif

/*
 * XXX
 * We don't want to collide with an existing DB implementation in the
 * local libraries.  Some of them have diverged, and we don't include
 * the hash routines in any case.
 */
#define     __bt_close  nvi__bt_close
#define     __bt_cmp    nvi__bt_cmp
#define     __bt_defcmp nvi__bt_defcmp
#define     __bt_defpfx nvi__bt_defpfx
#define     __bt_delete nvi__bt_delete
#define     __bt_dleaf  nvi__bt_dleaf
#define     __bt_dmpage nvi__bt_dmpage
#define     __bt_dnpage nvi__bt_dnpage
#define     __bt_dpage  nvi__bt_dpage
#define     __bt_dump   nvi__bt_dump
#define     __bt_fd           nvi__bt_fd
#define     __bt_free   nvi__bt_free
#define     __bt_get    nvi__bt_get
#define     __bt_new    nvi__bt_new
#define     __bt_open   nvi__bt_open
#define     __bt_pgin   nvi__bt_pgin
#define     __bt_pgout  nvi__bt_pgout
#define     __bt_put    nvi__bt_put
#define     __bt_ret    nvi__bt_ret
#define     __bt_search nvi__bt_search
#define     __bt_seq    nvi__bt_seq
#define     __bt_setcur nvi__bt_setcur
#define     __bt_split  nvi__bt_split
#define     __bt_stat   nvi__bt_stat
#define     __bt_sync   nvi__bt_sync
#define     __dbpanic   nvi__dbpanic
#define     __ovfl_delete     nvi__ovfl_delete
#define     __ovfl_get  nvi__ovfl_get
#define     __ovfl_put  nvi__ovfl_put
#define     __rec_close nvi__rec_close
#define     __rec_delete      nvi__rec_delete
#define     __rec_dleaf nvi__rec_dleaf
#define     __rec_fd    nvi__rec_fd
#define     __rec_fmap  nvi__rec_fmap
#define     __rec_fpipe nvi__rec_fpipe
#define     __rec_get   nvi__rec_get
#define     __rec_iput  nvi__rec_iput
#define     __rec_open  nvi__rec_open
#define     __rec_put   nvi__rec_put
#define     __rec_ret   nvi__rec_ret
#define     __rec_search      nvi__rec_search
#define     __rec_seq   nvi__rec_seq
#define     __rec_sync  nvi__rec_sync
#define     __rec_vmap  nvi__rec_vmap
#define     __rec_vpipe nvi__rec_vpipe
#define     dbopen            nvidbopen
#define     mpool_close nvimpool_close
#define     mpool_filter      nvimpool_filter
#define     mpool_get   nvimpool_get
#define     mpool_new   nvimpool_new
#define     mpool_open  nvimpool_open
#define     mpool_put   nvimpool_put
#define     mpool_stat  nvimpool_stat
#define     mpool_sync  nvimpool_sync

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

#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;

/* 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;

/*
 * !!!
 * 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.
 */
#define     DB_LOCK               0x2000  /* Do locking. */
#define     DB_SHMEM        0x4000  /* Use shared memory. */
#define     DB_TXN                0x8000  /* Do transactions. */

/* 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;
      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 */
} BTREEINFO;

#define     HASHMAGIC   0x061561
#define     HASHVERSION 2

/* Structure used to pass parameters to the hashing routines. */
typedef struct {
      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 */
} 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;
      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 */
      char  *bfname;    /* btree file name */ 
} RECNOINFO;

#ifdef __DBINTERFACE_PRIVATE
/*
 * 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
 */
#define     M_32_SWAP(a) {                                        \
      u_int32_t _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     P_32_SWAP(a) {                                        \
      u_int32_t _tmp = *(u_int32_t *)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     P_32_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 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
 */
#define     M_16_SWAP(a) {                                        \
      u_int16_t _tmp = a;                                   \
      ((char *)&a)[0] = ((char *)&_tmp)[1];                       \
      ((char *)&a)[1] = ((char *)&_tmp)[0];                       \
}
#define     P_16_SWAP(a) {                                        \
      u_int16_t _tmp = *(u_int16_t *)a;                     \
      ((char *)a)[0] = ((char *)&_tmp)[1];                        \
      ((char *)a)[1] = ((char *)&_tmp)[0];                        \
}
#define     P_16_COPY(a, b) {                               \
      ((char *)&(b))[0] = ((char *)&(a))[1];                      \
      ((char *)&(b))[1] = ((char *)&(a))[0];                      \
}
#endif

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
#endif /* !_DB_H_ */

Generated by  Doxygen 1.6.0   Back to index