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