ext/SDBM_File/sdbm.h

   1 /*
   2  * sdbm - ndbm work-alike hashed database library
   3  * based on Per-Ake Larson's Dynamic Hashing algorithms. BIT 18 (1978).
   4  * author: oz@nexus.yorku.ca
   5  * status: public domain.
   6  */
   7 #define DBLKSIZ 4096
   8 #define PBLKSIZ 1024
   9 #define PAIRMAX 1008                    /* arbitrary on PBLKSIZ-N */
  10 #define SPLTMAX 10                      /* maximum allowed splits */
  11                                         /* for a single insertion */
  12 #ifdef VMS
  13 #define DIRFEXT ".sdbm_dir"
  14 #else
  15 #define DIRFEXT ".dir"
  16 #endif
  17 #define PAGFEXT ".pag"
  18
  19 typedef struct {
  20         int dirf;                      /* directory file descriptor */
  21         int pagf;                      /* page file descriptor */
  22         int flags;                     /* status/error flags, see below */
  23         long maxbno;                   /* size of dirfile in bits */
  24         long curbit;                   /* current bit number */
  25         long hmask;                    /* current hash mask */
  26         long blkptr;                   /* current block for nextkey */
  27         int keyptr;                    /* current key for nextkey */
  28         long blkno;                    /* current page to read/write */
  29         long pagbno;                   /* current page in pagbuf */
  30         char pagbuf[PBLKSIZ];          /* page file block buffer */
  31         long dirbno;                   /* current block in dirbuf */
  32         char dirbuf[DBLKSIZ];          /* directory file block buffer */
  33 } DBM;
  34
  35 #define DBM_RDONLY      0x1            /* data base open read-only */
  36 #define DBM_IOERR       0x2            /* data base I/O error */
  37
  38 /*
  39  * utility macros
  40  */
  41 #define sdbm_rdonly(db)         ((db)->flags & DBM_RDONLY)
  42 #define sdbm_error(db)          ((db)->flags & DBM_IOERR)
  43
  44 #define sdbm_clearerr(db)       ((db)->flags &= ~DBM_IOERR)  /* ouch */
  45
  46 #define sdbm_dirfno(db) ((db)->dirf)
  47 #define sdbm_pagfno(db) ((db)->pagf)
  48
  49 typedef struct {
  50         const char *dptr;
  51         int dsize;
  52 } datum;
  53
  54 extern const datum nullitem;
  55
  56 /*
  57  * flags to sdbm_store
  58  */
  59 #define DBM_INSERT      0
  60 #define DBM_REPLACE     1
  61
  62 /*
  63  * ndbm interface
  64  */
  65 extern DBM *sdbm_open(char *, int, int);
  66 extern void sdbm_close(DBM *);
  67 extern datum sdbm_fetch(DBM *, datum);
  68 extern int sdbm_delete(DBM *, datum);
  69 extern int sdbm_store(DBM *, datum, datum, int);
  70 extern datum sdbm_firstkey(DBM *);
  71 extern datum sdbm_nextkey(DBM *);
  72 extern int sdbm_exists(DBM *, datum);
  73
  74 /*
  75  * other
  76  */
  77 extern DBM *sdbm_prep(char *, char *, int, int);
  78 extern long sdbm_hash(const char *, int);
  79
  80 #ifndef SDBM_ONLY
  81 #define dbm_open sdbm_open
  82 #define dbm_close sdbm_close
  83 #define dbm_fetch sdbm_fetch
  84 #define dbm_store sdbm_store
  85 #define dbm_delete sdbm_delete
  86 #define dbm_firstkey sdbm_firstkey
  87 #define dbm_nextkey sdbm_nextkey
  88 #define dbm_error sdbm_error
  89 #define dbm_clearerr sdbm_clearerr
  90 #endif
  91
  92 /* Most of the following is stolen from perl.h.  We don't include
  93    perl.h here because we just want the portability parts of perl.h,
  94    not everything else.
  95 */
  96 #ifndef H_PERL  /* Include guard */
  97 #include "embed.h"  /* Follow all the global renamings. */
  98
  99 /*
 100  * The following contortions are brought to you on behalf of all the
 101  * standards, semi-standards, de facto standards, not-so-de-facto standards
 102  * of the world, as well as all the other botches anyone ever thought of.
 103  * The basic theory is that if we work hard enough here, the rest of the
 104  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
 105  */
 106
 107 #include <errno.h>
 108 #ifdef HAS_SOCKET
 109 #   ifdef I_NET_ERRNO
 110 #     include <net/errno.h>
 111 #   endif
 112 #endif
 113
 114 #if defined(__STDC__) || defined(_AIX) || defined(__stdc__) || defined(__cplusplus)
 115 # define STANDARD_C 1
 116 #endif
 117
 118 #include <stdio.h>
 119 #include <ctype.h>
 120 #include <setjmp.h>
 121
 122 #if defined(I_UNISTD)
 123 #include <unistd.h>
 124 #endif
 125
 126 #ifdef VMS
 127 #  include <file.h>
 128 #  include <unixio.h>
 129 #endif
 130
 131 #ifdef I_SYS_PARAM
 132 #   if !defined(MSDOS) && !defined(WIN32) && !defined(VMS)
 133 #       ifdef PARAM_NEEDS_TYPES
 134 #           include <sys/types.h>
 135 #       endif
 136 #       include <sys/param.h>
 137 #   endif
 138 #endif
 139
 140 #ifndef _TYPES_         /* If types.h defines this it's easy. */
 141 #   ifndef major                /* Does everyone's types.h define this? */
 142 #       include <sys/types.h>
 143 #   endif
 144 #endif
 145
 146 #include <sys/stat.h>
 147
 148 #ifndef SEEK_SET
 149 # ifdef L_SET
 150 #  define SEEK_SET      L_SET
 151 # else
 152 #  define SEEK_SET      0  /* Wild guess. */
 153 # endif
 154 #endif
 155
 156 /* Use all the "standard" definitions */
 157 #include <stdlib.h>
 158
 159 #define MEM_SIZE Size_t
 160
 161 /* This comes after <stdlib.h> so we don't try to change the standard
 162  * library prototypes; we'll use our own instead. */
 163
 164 #if defined(MYMALLOC) && !defined(PERL_POLLUTE_MALLOC)
 165 #  define malloc  Perl_malloc
 166 #  define calloc  Perl_calloc
 167 #  define realloc Perl_realloc
 168 #  define free    Perl_mfree
 169
 170 #ifdef __cplusplus
 171 extern "C" {
 172 #endif
 173
 174 Malloc_t Perl_malloc(MEM_SIZE nbytes);
 175 Malloc_t Perl_calloc(MEM_SIZE elements, MEM_SIZE size);
 176 Malloc_t Perl_realloc(Malloc_t where, MEM_SIZE nbytes);
 177 Free_t   Perl_mfree(Malloc_t where);
 178
 179 #ifdef __cplusplus
 180 }
 181 #endif
 182
 183 #endif /* MYMALLOC */
 184
 185 #ifdef I_STRING
 186 # ifndef __ultrix__
 187 #  include <string.h>
 188 # endif
 189 #else
 190 # include <strings.h>
 191 #endif
 192
 193 #ifdef I_MEMORY
 194 #include <memory.h>
 195 #endif
 196
 197 #define memzero(d,l) memset(d,0,l)
 198
 199 #ifdef BUGGY_MSC
 200 #  pragma function(memcmp)
 201 #endif
 202
 203 #define memNE(s1,s2,l) (memcmp(s1,s2,l))
 204 #define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
 205
 206 #ifdef I_NETINET_IN
 207 #  ifdef VMS
 208 #    include <in.h>
 209 #  else
 210 #    include <netinet/in.h>
 211 #  endif
 212 #endif
 213
 214 #endif /* Include guard */
 215