Update from db-2.3.12.
[kopensolaris-gnu/glibc.git] / db2 / db_int.h
1 /*-
2  * See the file LICENSE for redistribution information.
3  *
4  * Copyright (c) 1996, 1997
5  *      Sleepycat Software.  All rights reserved.
6  *
7  *      @(#)db_int.h.src        10.36 (Sleepycat) 10/31/97
8  */
9
10 #ifndef _DB_INTERNAL_H_
11 #define _DB_INTERNAL_H_
12
13 #include "db.h"                         /* Standard DB include file. */
14 #include "queue.h"
15 #include "os_func.h"
16 #include "os_ext.h"
17
18 /*******************************************************
19  * General purpose constants and macros.
20  *******************************************************/
21 #define UINT32_T_MAX    0xffffffff      /* Maximum 32 bit unsigned. */
22 #define UINT16_T_MAX        0xffff      /* Maximum 16 bit unsigned. */
23
24 #define DB_MIN_PGSIZE   0x000200        /* Minimum page size. */
25 #define DB_MAX_PGSIZE   0x010000        /* Maximum page size. */
26
27 #define DB_MINCACHE     10              /* Minimum cached pages */
28
29 /*
30  * Aligning items to particular sizes or in pages or memory.  ALIGNP is a
31  * separate macro, as we've had to cast the pointer to different integral
32  * types on different architectures.
33  *
34  * We cast pointers into unsigned longs when manipulating them because C89
35  * guarantees that u_long is the largest available integral type and further,
36  * to never generate overflows.  However, neither C89 or C9X  requires that
37  * any integer type be large enough to hold a pointer, although C9X created
38  * the intptr_t type, which is guaranteed to hold a pointer but may or may
39  * not exist.  At some point in the future, we should test for intptr_t and
40  * use it where available.
41  */
42 #undef  ALIGNTYPE
43 #define ALIGNTYPE               u_long
44 #undef  ALIGNP
45 #define ALIGNP(value, bound)    ALIGN((ALIGNTYPE)value, bound)
46 #undef  ALIGN
47 #define ALIGN(value, bound)     (((value) + (bound) - 1) & ~((bound) - 1))
48
49 /*
50  * There are several on-page structures that are declared to have a number of
51  * fields followed by a variable length array of items.  The structure size
52  * without including the variable length array or the address of the first of
53  * those elements can be found using SSZ.
54  *
55  * This macro can also be used to find the offset of a structure element in a
56  * structure.  This is used in various places to copy structure elements from
57  * unaligned memory references, e.g., pointers into a packed page.
58  *
59  * There are two versions because compilers object if you take the address of
60  * an array.
61  */
62 #undef  SSZ
63 #define SSZ(name, field)        ((int)&(((name *)0)->field))
64
65 #undef  SSZA
66 #define SSZA(name, field)       ((int)&(((name *)0)->field[0]))
67
68 /* Macros to return per-process address, offsets based on shared regions. */
69 #define R_ADDR(base, offset)    ((void *)((u_int8_t *)((base)->addr) + offset))
70 #define R_OFFSET(base, p)       ((u_int8_t *)(p) - (u_int8_t *)(base)->addr)
71
72 /* Free and free-string macros that overwrite memory during debugging. */
73 #ifdef DEBUG
74 #undef  FREE
75 #define FREE(p, len) {                                                  \
76         memset(p, 0xff, len);                                           \
77         __db_free(p);                                                   \
78 }
79 #undef  FREES
80 #define FREES(p) {                                                      \
81         FREE(p, strlen(p));                                             \
82 }
83 #else
84 #undef  FREE
85 #define FREE(p, len) {                                                  \
86         __db_free(p);                                                   \
87 }
88 #undef  FREES
89 #define FREES(p) {                                                      \
90         __db_free(p);                                                   \
91 }
92 #endif
93
94 /* Structure used to print flag values. */
95 typedef struct __fn {
96         u_int32_t mask;                 /* Flag value. */
97         const char *name;               /* Flag name. */
98 } FN;
99
100 /* Set, clear and test flags. */
101 #define F_SET(p, f)     (p)->flags |= (f)
102 #define F_CLR(p, f)     (p)->flags &= ~(f)
103 #define F_ISSET(p, f)   ((p)->flags & (f))
104 #define LF_SET(f)       (flags |= (f))
105 #define LF_CLR(f)       (flags &= ~(f))
106 #define LF_ISSET(f)     (flags & (f))
107
108 /* Display separator string. */
109 #undef  DB_LINE
110 #define DB_LINE "=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-="
111
112 /*******************************************************
113  * Files.
114  *******************************************************/
115 #ifndef MAXPATHLEN              /* Maximum path length. */
116 #ifdef PATH_MAX
117 #define MAXPATHLEN      PATH_MAX
118 #else
119 #define MAXPATHLEN      1024
120 #endif
121 #endif
122
123 #define PATH_DOT        "."     /* Current working directory. */
124 #define PATH_SEPARATOR  "/"     /* Path separator character. */
125
126 #ifndef S_IRUSR                 /* UNIX specific file permissions. */
127 #define S_IRUSR 0000400         /* R for owner */
128 #define S_IWUSR 0000200         /* W for owner */
129 #define S_IRGRP 0000040         /* R for group */
130 #define S_IWGRP 0000020         /* W for group */
131 #define S_IROTH 0000004         /* R for other */
132 #define S_IWOTH 0000002         /* W for other */
133 #endif
134
135 #ifndef S_ISDIR                 /* UNIX specific: directory test. */
136 #define S_ISDIR(m)      ((m & 0170000) == 0040000)
137 #endif
138
139 /*******************************************************
140  * Mutex support.
141  *******************************************************/
142 typedef unsigned char tsl_t;
143
144
145
146 /*
147  * !!!
148  * Various systems require different alignments for mutexes (the worst we've
149  * seen so far is 16-bytes on some HP architectures).  The mutex (tsl_t) must
150  * be first in the db_mutex_t structure, which must itself be first in the
151  * region.  This ensures the alignment is as returned by mmap(2), which should
152  * be sufficient.  All other mutex users must ensure proper alignment locally.
153  */
154 #define MUTEX_ALIGNMENT 1
155
156 /*
157  * The offset of a mutex in memory.
158  */
159 #define MUTEX_LOCK_OFFSET(a, b) ((off_t)((u_int8_t *)b - (u_int8_t *)a))
160
161 typedef struct _db_mutex_t {
162 #ifdef HAVE_SPINLOCKS
163         tsl_t   tsl_resource;           /* Resource test and set. */
164 #ifdef DEBUG
165         u_long  pid;                    /* Lock holder: 0 or process pid. */
166 #endif
167 #else
168         off_t   off;                    /* Backing file offset. */
169         u_long  pid;                    /* Lock holder: 0 or process pid. */
170 #endif
171         u_int32_t mutex_set_wait;       /* Granted after wait. */
172         u_int32_t mutex_set_nowait;     /* Granted without waiting. */
173 } db_mutex_t;
174
175 #include "mutex_ext.h"
176
177 /*******************************************************
178  * Access methods.
179  *******************************************************/
180 /* Lock/unlock a DB thread. */
181 #define DB_THREAD_LOCK(dbp)                                             \
182         (F_ISSET(dbp, DB_AM_THREAD) ?                                   \
183             __db_mutex_lock((db_mutex_t *)(dbp)->mutexp, -1) : 0)
184 #define DB_THREAD_UNLOCK(dbp)                                           \
185         (F_ISSET(dbp, DB_AM_THREAD) ?                                   \
186             __db_mutex_unlock((db_mutex_t *)(dbp)->mutexp, -1) : 0)
187
188 /* Btree/recno local statistics structure. */
189 struct __db_bt_lstat;   typedef struct __db_bt_lstat DB_BTREE_LSTAT;
190 struct __db_bt_lstat {
191         u_int32_t bt_freed;             /* Pages freed for reuse. */
192         u_int32_t bt_pfxsaved;          /* Bytes saved by prefix compression. */
193         u_int32_t bt_split;             /* Total number of splits. */
194         u_int32_t bt_rootsplit;         /* Root page splits. */
195         u_int32_t bt_fastsplit;         /* Fast splits. */
196         u_int32_t bt_added;             /* Items added. */
197         u_int32_t bt_deleted;           /* Items deleted. */
198         u_int32_t bt_get;               /* Items retrieved. */
199         u_int32_t bt_cache_hit;         /* Hits in fast-insert code. */
200         u_int32_t bt_cache_miss;        /* Misses in fast-insert code. */
201 };
202
203 /*******************************************************
204  * Environment.
205  *******************************************************/
206 /* Type passed to __db_appname(). */
207 typedef enum {
208         DB_APP_NONE=0,                  /* No type (region). */
209         DB_APP_DATA,                    /* Data file. */
210         DB_APP_LOG,                     /* Log file. */
211         DB_APP_TMP                      /* Temporary file. */
212 } APPNAME;
213
214 /*******************************************************
215  * Regions.
216  *******************************************************/
217 /*
218  * The shared memory regions share an initial structure so that the general
219  * region code can handle races between the region being deleted and other
220  * processes waiting on the region mutex.
221  *
222  * !!!
223  * Note, the mutex must be the first entry in the region; see comment above.
224  */
225 typedef struct _rlayout {
226         db_mutex_t lock;                /* Region mutex. */
227         u_int32_t  refcnt;              /* Region reference count. */
228         size_t     size;                /* Region length. */
229         int        majver;              /* Major version number. */
230         int        minver;              /* Minor version number. */
231         int        patch;               /* Patch version number. */
232
233 #define DB_R_DELETED    0x01            /* Region was deleted. */
234         u_int32_t  flags;
235 } RLAYOUT;
236
237 /*******************************************************
238  * Mpool.
239  *******************************************************/
240 /*
241  * File types for DB access methods.  Negative numbers are reserved to DB.
242  */
243 #define DB_FTYPE_BTREE          -1      /* Btree. */
244 #define DB_FTYPE_HASH           -2      /* Hash. */
245
246 /* Structure used as the DB pgin/pgout pgcookie. */
247 typedef struct __dbpginfo {
248         size_t  db_pagesize;            /* Underlying page size. */
249         int     needswap;               /* If swapping required. */
250 } DB_PGINFO;
251
252 /*******************************************************
253  * Log.
254  *******************************************************/
255 /* Initialize an LSN to 'zero'. */
256 #define ZERO_LSN(LSN) {                                                 \
257         (LSN).file = 0;                                                 \
258         (LSN).offset = 0;                                               \
259 }
260
261 /* Return 1 if LSN is a 'zero' lsn, otherwise return 0. */
262 #define IS_ZERO_LSN(LSN)        ((LSN).file == 0)
263
264 /* Test if we need to log a change. */
265 #define DB_LOGGING(dbp)                                                 \
266         (F_ISSET(dbp, DB_AM_LOGGING) && !F_ISSET(dbp, DB_AM_RECOVER))
267
268 #ifdef DEBUG
269 /*
270  * Debugging macro to log operations.
271  *      If DEBUG_WOP is defined, log operations that modify the database.
272  *      If DEBUG_ROP is defined, log operations that read the database.
273  *
274  * D dbp
275  * T txn
276  * O operation (string)
277  * K key
278  * A data
279  * F flags
280  */
281 #define LOG_OP(D, T, O, K, A, F) {                                      \
282         DB_LSN _lsn;                                                    \
283         DBT _op;                                                        \
284         if (DB_LOGGING((D))) {                                          \
285                 memset(&_op, 0, sizeof(_op));                           \
286                 _op.data = O;                                           \
287                 _op.size = strlen(O) + 1;                               \
288                 (void)__db_debug_log((D)->dbenv->lg_info,               \
289                     T, &_lsn, 0, &_op, (D)->log_fileid, K, A, F);       \
290         }                                                               \
291 }
292 #ifdef DEBUG_ROP
293 #define DEBUG_LREAD(D, T, O, K, A, F)   LOG_OP(D, T, O, K, A, F)
294 #else
295 #define DEBUG_LREAD(D, T, O, K, A, F)
296 #endif
297 #ifdef DEBUG_WOP
298 #define DEBUG_LWRITE(D, T, O, K, A, F)  LOG_OP(D, T, O, K, A, F)
299 #else
300 #define DEBUG_LWRITE(D, T, O, K, A, F)
301 #endif
302 #else
303 #define DEBUG_LREAD(D, T, O, K, A, F)
304 #define DEBUG_LWRITE(D, T, O, K, A, F)
305 #endif /* DEBUG */
306
307 /*******************************************************
308  * Transactions and recovery.
309  *******************************************************/
310 /*
311  * Out of band value for a lock.  The locks are returned to callers as offsets
312  * into the lock regions.  Since the RLAYOUT structure begins all regions, an
313  * offset of 0 is guaranteed not to be a valid lock.
314  */
315 #define LOCK_INVALID    0
316
317 /* The structure allocated for every transaction. */
318 struct __db_txn {
319         DB_TXNMGR       *mgrp;          /* Pointer to transaction manager. */
320         DB_TXN          *parent;        /* Pointer to transaction's parent. */
321         DB_LSN          last_lsn;       /* Lsn of last log write. */
322         u_int32_t       txnid;          /* Unique transaction id. */
323         size_t          off;            /* Detail structure within region. */
324         TAILQ_ENTRY(__db_txn) links;
325 };
326 #endif /* !_DB_INTERNAL_H_ */