1
/* DO NOT EDIT: automatically built by dist/distrib. */
3
* See the file LICENSE for redistribution information.
5
* Copyright (c) 1996, 1997, 1998
6
* Sleepycat Software. All rights reserved.
8
* @(#)db.h 10.174 (Sleepycat) 1/3/99
14
#ifndef __NO_SYSTEM_INCLUDES
15
#include <sys/types.h>
22
* MacOS: ensure that Metrowerks C makes enumeration types int sized.
25
#pragma enumsalwaysint on
30
* Handle function prototypes and the keyword "const". This steps on name
31
* space that DB doesn't control, but all of the other solutions are worse.
34
* While Microsoft's compiler is ANSI C compliant, it doesn't have _STDC_
35
* defined by default, you specify a command line flag or #pragma to turn
36
* it on. Don't do that, however, because some of Microsoft's own header
37
* files won't compile.
40
#if defined(__STDC__) || defined(__cplusplus) || defined(_MSC_VER)
41
#define __P(protos) protos /* ANSI C prototypes */
44
#define __P(protos) () /* K&R C preprocessor */
49
* DB needs basic information about specifically sized types. If they're
50
* not provided by the system, typedef them here.
52
* We protect them against multiple inclusion using __BIT_TYPES_DEFINED__,
53
* as does BIND and Kerberos, since we don't know for sure what #include
54
* files the user is using.
57
* We also provide the standard u_int, u_long etc., if they're not provided
60
#ifndef __BIT_TYPES_DEFINED__
61
#define __BIT_TYPES_DEFINED__
62
typedef unsigned char u_int8_t;
63
typedef short int16_t;
64
typedef unsigned short u_int16_t;
66
typedef unsigned int u_int32_t;
70
#define DB_VERSION_MAJOR 2
71
#define DB_VERSION_MINOR 7
72
#define DB_VERSION_PATCH 7
73
#define DB_VERSION_STRING "Sleepycat Software: Berkeley DB 2.7.7: (08/20/99)"
75
typedef u_int32_t db_pgno_t; /* Page number type. */
76
typedef u_int16_t db_indx_t; /* Page offset type. */
77
#define DB_MAX_PAGES 0xffffffff /* >= # of pages in a file */
79
typedef u_int32_t db_recno_t; /* Record number type. */
80
#define DB_MAX_RECORDS 0xffffffff /* >= # of records in a tree */
82
typedef size_t DB_LOCK; /* Object returned by lock manager. */
84
/* Forward structure declarations, so applications get type checking. */
85
struct __db; typedef struct __db DB;
87
typedef struct __db DBM;
89
struct __db_bt_stat; typedef struct __db_bt_stat DB_BTREE_STAT;
90
struct __db_dbt; typedef struct __db_dbt DBT;
91
struct __db_env; typedef struct __db_env DB_ENV;
92
struct __db_ilock; typedef struct __db_ilock DB_LOCK_ILOCK;
93
struct __db_info; typedef struct __db_info DB_INFO;
94
struct __db_lock_stat; typedef struct __db_lock_stat DB_LOCK_STAT;
95
struct __db_lockregion; typedef struct __db_lockregion DB_LOCKREGION;
96
struct __db_lockreq; typedef struct __db_lockreq DB_LOCKREQ;
97
struct __db_locktab; typedef struct __db_locktab DB_LOCKTAB;
98
struct __db_log; typedef struct __db_log DB_LOG;
99
struct __db_log_stat; typedef struct __db_log_stat DB_LOG_STAT;
100
struct __db_lsn; typedef struct __db_lsn DB_LSN;
101
struct __db_mpool; typedef struct __db_mpool DB_MPOOL;
102
struct __db_mpool_finfo;typedef struct __db_mpool_finfo DB_MPOOL_FINFO;
103
struct __db_mpool_fstat;typedef struct __db_mpool_fstat DB_MPOOL_FSTAT;
104
struct __db_mpool_stat; typedef struct __db_mpool_stat DB_MPOOL_STAT;
105
struct __db_mpoolfile; typedef struct __db_mpoolfile DB_MPOOLFILE;
106
struct __db_txn; typedef struct __db_txn DB_TXN;
107
struct __db_txn_active; typedef struct __db_txn_active DB_TXN_ACTIVE;
108
struct __db_txn_stat; typedef struct __db_txn_stat DB_TXN_STAT;
109
struct __db_txnmgr; typedef struct __db_txnmgr DB_TXNMGR;
110
struct __db_txnregion; typedef struct __db_txnregion DB_TXNREGION;
111
struct __dbc; typedef struct __dbc DBC;
113
/* Key/data structure -- a Data-Base Thang. */
115
void *data; /* key/data */
116
u_int32_t size; /* key/data length */
117
u_int32_t ulen; /* RO: length of user buffer. */
118
u_int32_t dlen; /* RO: get/put record length. */
119
u_int32_t doff; /* RO: get/put record offset. */
121
#define DB_DBT_INTERNAL 0x01 /* Ignore user's malloc (internal). */
122
#define DB_DBT_MALLOC 0x02 /* Return in allocated memory. */
123
#define DB_DBT_PARTIAL 0x04 /* Partial put/get. */
124
#define DB_DBT_USERMEM 0x08 /* Return in user's memory. */
129
* DB run-time interface configuration.
131
* There are a set of functions that the application can replace with its
132
* own versions, and some other knobs which can be turned at run-time.
134
#define DB_FUNC_CLOSE 1 /* POSIX 1003.1 close. */
135
#define DB_FUNC_DIRFREE 2 /* DB: free directory list. */
136
#define DB_FUNC_DIRLIST 3 /* DB: create directory list. */
137
#define DB_FUNC_EXISTS 4 /* DB: return if file exists. */
138
#define DB_FUNC_FREE 5 /* ANSI C free. */
139
#define DB_FUNC_FSYNC 6 /* POSIX 1003.1 fsync. */
140
#define DB_FUNC_IOINFO 7 /* DB: return file I/O information. */
141
#define DB_FUNC_MALLOC 8 /* ANSI C malloc. */
142
#define DB_FUNC_MAP 9 /* DB: map file into shared memory. */
143
#define DB_FUNC_OPEN 10 /* POSIX 1003.1 open. */
144
#define DB_FUNC_READ 11 /* POSIX 1003.1 read. */
145
#define DB_FUNC_REALLOC 12 /* ANSI C realloc. */
146
#define DB_FUNC_RUNLINK 13 /* DB: remove a shared region. */
147
#define DB_FUNC_SEEK 14 /* POSIX 1003.1 lseek. */
148
#define DB_FUNC_SLEEP 15 /* DB: sleep secs/usecs. */
149
#define DB_FUNC_UNLINK 16 /* POSIX 1003.1 unlink. */
150
#define DB_FUNC_UNMAP 17 /* DB: unmap shared memory file. */
151
#define DB_FUNC_WRITE 18 /* POSIX 1003.1 write. */
152
#define DB_FUNC_YIELD 19 /* DB: yield thread to scheduler. */
153
#define DB_MUTEXLOCKS 20 /* DB: turn off all mutex locks. */
154
#define DB_PAGEYIELD 21 /* DB: yield the CPU on pool get. */
155
#define DB_REGION_ANON 22 /* DB: anonymous, unnamed regions. */
156
#define DB_REGION_INIT 23 /* DB: page-fault regions in create. */
157
#define DB_REGION_NAME 24 /* DB: anonymous, named regions. */
158
#define DB_TSL_SPINS 25 /* DB: initialize spin count. */
161
* Database configuration and initialization.
164
* Flags understood by both db_open(3) and db_appinit(3).
166
#define DB_CREATE 0x000001 /* O_CREAT: create file as necessary. */
167
#define DB_NOMMAP 0x000002 /* Don't mmap underlying file. */
168
#define DB_THREAD 0x000004 /* Free-thread DB package handles. */
171
* Flags understood by db_appinit(3).
173
/* 0x000007 COMMON MASK. */
174
#define DB_INIT_CDB 0x000008 /* Concurrent Access Methods. */
175
#define DB_INIT_LOCK 0x000010 /* Initialize locking. */
176
#define DB_INIT_LOG 0x000020 /* Initialize logging. */
177
#define DB_INIT_MPOOL 0x000040 /* Initialize mpool. */
178
#define DB_INIT_TXN 0x000080 /* Initialize transactions. */
179
#define DB_MPOOL_PRIVATE 0x000100 /* Mpool: private memory pool. */
180
#define DB_RECOVER 0x000200 /* Run normal recovery. */
181
#define DB_RECOVER_FATAL 0x000400 /* Run catastrophic recovery. */
182
#define DB_TXN_NOSYNC 0x000800 /* Do not sync log on commit. */
183
#define DB_USE_ENVIRON 0x001000 /* Use the environment. */
184
#define DB_USE_ENVIRON_ROOT 0x002000 /* Use the environment if root. */
187
* Flags understood by db_open(3).
189
* DB_EXCL and DB_TEMPORARY are internal only, and are not documented.
190
* DB_SEQUENTIAL is currently internal, but may be exported some day.
192
/* 0x000007 COMMON MASK. */
193
/* 0x001fff ALREADY USED. */
194
#define DB_EXCL 0x002000 /* O_EXCL: exclusive open (internal). */
195
#define DB_RDONLY 0x004000 /* O_RDONLY: read-only. */
196
#define DB_SEQUENTIAL 0x008000 /* Sequential access (internal). */
197
#define DB_TEMPORARY 0x010000 /* Remove on last close (internal). */
198
#define DB_TRUNCATE 0x020000 /* O_TRUNCATE: replace existing DB. */
199
#define DB_FCNTL_LOCKING 0x040000 /* Undocumented: fcntl(2) locking. */
202
* Deadlock detector modes; used in the DBENV structure to configure the
205
#define DB_LOCK_NORUN 0
206
#define DB_LOCK_DEFAULT 1 /* Default policy. */
207
#define DB_LOCK_OLDEST 2 /* Abort oldest transaction. */
208
#define DB_LOCK_RANDOM 3 /* Abort random transaction. */
209
#define DB_LOCK_YOUNGEST 4 /* Abort youngest transaction. */
212
int db_lorder; /* Byte order. */
214
/* Error message callback. */
215
void (*db_errcall) __P((const char *, char *));
216
FILE *db_errfile; /* Error message file stream. */
217
const char *db_errpfx; /* Error message prefix. */
218
int db_verbose; /* Generate debugging messages. */
219
int db_panic; /* Panic flag, callback function. */
220
void (*db_paniccall) __P((DB_ENV *, int));
223
char *db_home; /* Database home. */
224
char *db_log_dir; /* Database log file directory. */
225
char *db_tmp_dir; /* Database tmp file directory. */
227
char **db_data_dir; /* Database data file directories. */
228
int data_cnt; /* Database data file slots. */
229
int data_next; /* Next Database data file slot. */
232
DB_LOCKTAB *lk_info; /* Return from lock_open(). */
233
const u_int8_t *lk_conflicts; /* Two dimensional conflict matrix. */
234
u_int32_t lk_modes; /* Number of lock modes in table. */
235
u_int32_t lk_max; /* Maximum number of locks. */
236
u_int32_t lk_detect; /* Deadlock detect on all conflicts. */
239
DB_LOG *lg_info; /* Return from log_open(). */
240
u_int32_t lg_max; /* Maximum file size. */
243
DB_MPOOL *mp_info; /* Return from memp_open(). */
244
size_t mp_mmapsize; /* Maximum file size for mmap. */
245
size_t mp_size; /* Bytes in the mpool cache. */
248
DB_TXNMGR *tx_info; /* Return from txn_open(). */
249
u_int32_t tx_max; /* Maximum number of transactions. */
250
int (*tx_recover) /* Dispatch function for recovery. */
251
__P((DB_LOG *, DBT *, DB_LSN *, int, void *));
257
* Explicit representations of structures in queue.h.
259
* TAILQ_ENTRY(__db_env);
262
struct __db_env *tqe_next;
263
struct __db_env **tqe_prev;
265
int xa_rmid; /* XA Resource Manager ID. */
266
DB_TXN *xa_txn; /* XA Current transaction. */
268
#define DB_ENV_APPINIT 0x01 /* Paths initialized by db_appinit(). */
269
#define DB_ENV_CDB 0x02 /* Concurrent DB product. */
270
#define DB_ENV_STANDALONE 0x04 /* Test: freestanding environment. */
271
#define DB_ENV_THREAD 0x08 /* DB_ENV is multi-threaded. */
272
u_int32_t flags; /* Flags. */
275
/*******************************************************
277
*******************************************************/
280
* Changes here must be reflected in java/src/com/sleepycat/db/Db.java.
283
DB_BTREE=1, /* B+tree. */
284
DB_HASH, /* Extended Linear Hashing. */
285
DB_RECNO, /* Fixed and variable-length records. */
286
DB_UNKNOWN /* Figure it out on open. */
289
#define DB_BTREEVERSION 6 /* Current btree version. */
290
#define DB_BTREEOLDVER 6 /* Oldest btree version supported. */
291
#define DB_BTREEMAGIC 0x053162
293
#define DB_HASHVERSION 5 /* Current hash version. */
294
#define DB_HASHOLDVER 4 /* Oldest hash version supported. */
295
#define DB_HASHMAGIC 0x061561
297
#define DB_LOGVERSION 2 /* Current log version. */
298
#define DB_LOGOLDVER 2 /* Oldest log version supported. */
299
#define DB_LOGMAGIC 0x040988
302
int db_lorder; /* Byte order. */
303
size_t db_cachesize; /* Underlying cache size. */
304
size_t db_pagesize; /* Underlying page size. */
306
/* Local heap allocation. */
307
void *(*db_malloc) __P((size_t));
308
int (*dup_compare) /* Duplicate compare function. */
309
__P((const DBT *, const DBT *));
311
/* Btree access method. */
312
u_int32_t bt_maxkey; /* Maximum keys per page. */
313
u_int32_t bt_minkey; /* Minimum keys per page. */
314
int (*bt_compare) /* Comparison function. */
315
__P((const DBT *, const DBT *));
316
size_t (*bt_prefix) /* Prefix function. */
317
__P((const DBT *, const DBT *));
319
/* Hash access method. */
320
u_int32_t h_ffactor; /* Fill factor. */
321
u_int32_t h_nelem; /* Number of elements. */
322
u_int32_t (*h_hash) /* Hash function. */
323
__P((const void *, u_int32_t));
325
/* Recno access method. */
326
int re_pad; /* Fixed-length padding byte. */
327
int re_delim; /* Variable-length delimiting byte. */
328
u_int32_t re_len; /* Length for fixed-length records. */
329
char *re_source; /* Source file name. */
331
#define DB_DELIMITER 0x0001 /* Recno: re_delim set. */
332
#define DB_DUP 0x0002 /* Btree, Hash: duplicate keys. */
333
#define DB_DUPSORT 0x0004 /* Btree, Hash: duplicate keys. */
334
#define DB_FIXEDLEN 0x0008 /* Recno: fixed-length records. */
335
#define DB_PAD 0x0010 /* Recno: re_pad set. */
336
#define DB_RECNUM 0x0020 /* Btree: record numbers. */
337
#define DB_RENUMBER 0x0040 /* Recno: renumber on insert/delete. */
338
#define DB_SNAPSHOT 0x0080 /* Recno: snapshot the input. */
343
* DB access method and cursor operation values. Each value is an operation
344
* code to which additional bit flags are added.
346
#define DB_AFTER 1 /* c_put() */
347
#define DB_APPEND 2 /* put() */
348
#define DB_BEFORE 3 /* c_put() */
349
#define DB_CHECKPOINT 4 /* log_put(), log_get() */
350
#define DB_CURLSN 5 /* log_put() */
351
#define DB_CURRENT 6 /* c_get(), c_put(), log_get() */
352
#define DB_FIRST 7 /* c_get(), log_get() */
353
#define DB_FLUSH 8 /* log_put() */
354
#define DB_GET_BOTH 9 /* get(), c_get() */
355
#define DB_GET_RECNO 10 /* c_get() */
356
#define DB_JOIN_ITEM 11 /* c_get(); do not do primary lookup */
357
#define DB_KEYFIRST 12 /* c_put() */
358
#define DB_KEYLAST 13 /* c_put() */
359
#define DB_LAST 14 /* c_get(), log_get() */
360
#define DB_NEXT 15 /* c_get(), log_get() */
361
#define DB_NEXT_DUP 16 /* c_get() */
362
#define DB_NOOVERWRITE 17 /* put() */
363
#define DB_NOSYNC 18 /* close() */
364
#define DB_PREV 19 /* c_get(), log_get() */
365
#define DB_RECORDCOUNT 20 /* stat() */
366
#define DB_SET 21 /* c_get(), log_get() */
367
#define DB_SET_RANGE 22 /* c_get() */
368
#define DB_SET_RECNO 23 /* get(), c_get() */
369
#define DB_WRITELOCK 24 /* cursor() (internal) */
371
#define DB_OPFLAGS_MASK 0x1f /* Mask for operations flags. */
372
#define DB_RMW 0x80000000 /* Acquire write flag immediately. */
375
* DB (user visible) error return codes.
378
* Changes to any of the user visible error return codes must be reflected
379
* in java/src/com/sleepycat/db/Db.java.
381
#define DB_INCOMPLETE ( -1) /* Sync didn't finish. */
382
#define DB_KEYEMPTY ( -2) /* The key/data pair was deleted or
383
was never created by the user. */
384
#define DB_KEYEXIST ( -3) /* The key/data pair already exists. */
385
#define DB_LOCK_DEADLOCK ( -4) /* Locker killed to resolve deadlock. */
386
#define DB_LOCK_NOTGRANTED ( -5) /* Lock unavailable, no-wait set. */
387
#define DB_LOCK_NOTHELD ( -6) /* Lock not held by locker. */
388
#define DB_NOTFOUND ( -7) /* Key/data pair not found (EOF). */
389
#define DB_RUNRECOVERY ( -8) /* Panic return. */
391
/* DB (private) error return codes. */
392
#define DB_DELETED ( -9) /* Recovery file marked deleted. */
393
#define DB_NEEDSPLIT (-10) /* Page needs to be split. */
394
#define DB_SWAPBYTES (-11) /* Database needs byte swapping. */
395
#define DB_TXN_CKP (-12) /* Encountered ckp record in log. */
397
#define DB_FILE_ID_LEN 20 /* DB file ID length. */
399
/* DB access method description structure. */
401
void *mutexp; /* Synchronization for free threading */
403
/* Documented, returned information. */
404
DBTYPE type; /* DB access method. */
405
int byteswapped; /* Database byte order is swapped. */
406
int saved_open_fd; /* For fcntl lock preservation. */
408
DB_ENV *dbenv; /* DB_ENV structure. */
409
DB_ENV *mp_dbenv; /* DB_ENV for local mpool creation. */
411
void *internal; /* Access method private. */
413
DB_MPOOL *mp; /* The access method's mpool. */
414
DB_MPOOLFILE *mpf; /* The access method's mpool file. */
418
* Explicit representations of structures in queue.h.
420
* TAILQ_HEAD(free_queue, __dbc);
421
* TAILQ_HEAD(active_queue, __dbc);
424
struct __dbc *tqh_first;
425
struct __dbc **tqh_last;
428
struct __dbc *tqh_first;
429
struct __dbc **tqh_last;
432
u_int8_t fileid[DB_FILE_ID_LEN]; /* Uniquely identify this file for
434
u_int32_t log_fileid; /* Logging file id. */
435
size_t pgsize; /* Logical page size of file. */
437
/* Local heap allocation. */
438
void *(*db_malloc) __P((size_t));
439
int (*dup_compare) /* Duplicate compare function. */
440
__P((const DBT *, const DBT *));
441
u_int32_t (*h_hash) /* Hash function. */
442
__P((const void *, u_int32_t));
445
int (*am_close) __P((DB *));
446
int (*close) __P((DB *, u_int32_t));
447
int (*cursor) __P((DB *, DB_TXN *, DBC **, u_int32_t));
448
int (*del) __P((DB *, DB_TXN *, DBT *, u_int32_t));
449
int (*fd) __P((DB *, int *));
450
int (*get) __P((DB *, DB_TXN *, DBT *, DBT *, u_int32_t));
451
int (*join) __P((DB *, DBC **, u_int32_t, DBC **));
452
int (*put) __P((DB *, DB_TXN *, DBT *, DBT *, u_int32_t));
453
int (*stat) __P((DB *, void *, void *(*)(size_t), u_int32_t));
454
int (*sync) __P((DB *, u_int32_t));
456
#define DB_AM_CDB 0x000001 /* Concurrent Access Methods. */
457
#define DB_AM_DUP 0x000002 /* DB_DUP (internal). */
458
#define DB_AM_INMEM 0x000004 /* In-memory; no sync on close. */
459
#define DB_AM_LOCKING 0x000008 /* Perform locking. */
460
#define DB_AM_LOGGING 0x000010 /* Perform logging. */
461
#define DB_AM_MLOCAL 0x000020 /* Database memory pool is local. */
462
#define DB_AM_PGDEF 0x000040 /* Page size was defaulted. */
463
#define DB_AM_RDONLY 0x000080 /* Database is readonly. */
464
#define DB_AM_SWAP 0x000100 /* Pages need to be byte-swapped. */
465
#define DB_AM_THREAD 0x000200 /* DB is multi-threaded. */
466
#define DB_BT_RECNUM 0x000400 /* DB_RECNUM (internal). */
467
#define DB_DBM_ERROR 0x000800 /* Error in DBM/NDBM database. */
468
#define DB_RE_DELIMITER 0x001000 /* DB_DELIMITER (internal). */
469
#define DB_RE_FIXEDLEN 0x002000 /* DB_FIXEDLEN (internal). */
470
#define DB_RE_PAD 0x004000 /* DB_PAD (internal). */
471
#define DB_RE_RENUMBER 0x008000 /* DB_RENUMBER (internal). */
472
#define DB_RE_SNAPSHOT 0x010000 /* DB_SNAPSHOT (internal). */
476
struct __db_ilock { /* Internal DB access method lock. */
477
db_pgno_t pgno; /* Page being locked. */
478
u_int8_t fileid[DB_FILE_ID_LEN];/* File id. */
481
/* Cursor description structure. */
483
DB *dbp; /* Related DB access method. */
484
DB_TXN *txn; /* Associated transaction. */
488
* Explicit representations of structures in queue.h.
490
* TAILQ_ENTRY(__dbc);
493
struct __dbc *tqe_next;
494
struct __dbc **tqe_prev;
497
u_int32_t lid; /* Default process' locker id. */
498
u_int32_t locker; /* Locker for this operation. */
499
DBT lock_dbt; /* DBT referencing lock. */
500
DB_LOCK_ILOCK lock; /* Object to be locked. */
501
DB_LOCK mylock; /* Lock held on this cursor. */
503
DBT rkey; /* Returned key. */
504
DBT rdata; /* Returned data. */
506
int (*c_am_close) __P((DBC *));
507
int (*c_am_destroy) __P((DBC *));
508
int (*c_close) __P((DBC *));
509
int (*c_del) __P((DBC *, u_int32_t));
510
int (*c_get) __P((DBC *, DBT *, DBT *, u_int32_t));
511
int (*c_put) __P((DBC *, DBT *, DBT *, u_int32_t));
513
void *internal; /* Access method private. */
515
#define DBC_CONTINUE 0x001 /* Continue dup search: next item. */
516
#define DBC_KEYSET 0x002 /* Continue dup search: current item. */
517
#define DBC_RECOVER 0x004 /* In recovery (do not log or lock). */
518
#define DBC_RMW 0x008 /* Acquire write flag in read op. */
519
#define DBC_WRITER 0x010 /* Cursor immediately writing (CDB). */
523
/* Btree/recno statistics structure. */
524
struct __db_bt_stat {
525
u_int32_t bt_flags; /* Open flags. */
526
u_int32_t bt_maxkey; /* Maxkey value. */
527
u_int32_t bt_minkey; /* Minkey value. */
528
u_int32_t bt_re_len; /* Fixed-length record length. */
529
u_int32_t bt_re_pad; /* Fixed-length record pad. */
530
u_int32_t bt_pagesize; /* Page size. */
531
u_int32_t bt_levels; /* Tree levels. */
532
u_int32_t bt_nrecs; /* Number of records. */
533
u_int32_t bt_int_pg; /* Internal pages. */
534
u_int32_t bt_leaf_pg; /* Leaf pages. */
535
u_int32_t bt_dup_pg; /* Duplicate pages. */
536
u_int32_t bt_over_pg; /* Overflow pages. */
537
u_int32_t bt_free; /* Pages on the free list. */
538
u_int32_t bt_int_pgfree; /* Bytes free in internal pages. */
539
u_int32_t bt_leaf_pgfree; /* Bytes free in leaf pages. */
540
u_int32_t bt_dup_pgfree; /* Bytes free in duplicate pages. */
541
u_int32_t bt_over_pgfree; /* Bytes free in overflow pages. */
542
u_int32_t bt_magic; /* Magic number. */
543
u_int32_t bt_version; /* Version number. */
546
/* Hash statistics structure. */
548
u_int32_t hash_accesses; /* Number of accesses to this table. */
549
u_int32_t hash_collisions; /* Number of collisions on search. */
550
u_int32_t hash_expansions; /* Number of times we added a bucket. */
551
u_int32_t hash_overflows; /* Number of overflow pages. */
552
u_int32_t hash_bigpages; /* Number of big key/data pages. */
553
u_int32_t hash_dup; /* Number of dup pages. */
554
u_int32_t hash_free; /* Pages on the free list. */
555
u_int32_t hash_bfree; /* Bytes free on bucket pages. */
556
u_int32_t hash_dup_free; /* Bytes free on duplicate pages. */
557
u_int32_t hash_big_bfree; /* Bytes free on big item pages. */
558
u_int32_t hash_buckets; /* Number of hash buckets. */
559
u_int32_t hash_put; /* Number of puts. */
560
u_int32_t hash_deleted; /* Number of deletes. */
561
u_int32_t hash_get; /* Number of gets. */
562
u_int32_t hash_magic; /* Magic number. */
563
u_int32_t hash_version; /* Version number. */
564
u_int32_t hash_pagesize; /* Page size. */
565
u_int32_t hash_nrecs; /* Number of records. */
568
#if defined(__cplusplus)
571
int db_appinit __P((const char *, char * const *, DB_ENV *, u_int32_t));
572
int db_appexit __P((DB_ENV *));
573
int db_jump_set __P((void *, int));
574
int db_open __P((const char *,
575
DBTYPE, u_int32_t, int, DB_ENV *, DB_INFO *, DB **));
576
int db_value_set __P((int, int));
577
char *db_version __P((int *, int *, int *));
578
int db_xa_open __P((const char *,
579
DBTYPE, u_int32_t, int, DB_INFO *, DB **));
580
#if defined(__cplusplus)
584
/*******************************************************
586
*******************************************************/
587
#define DB_LOCKVERSION 1
588
#define DB_LOCKMAGIC 0x090193
590
/* Flag values for lock_vec(), lock_get(). */
591
#define DB_LOCK_NOWAIT 0x01 /* Don't wait on unavailable lock. */
592
#define DB_LOCK_UPGRADE 0x02 /* Upgrade an existing lock instead
593
of granting a new one (internal). */
595
/* Flag values for lock_detect(). */
596
#define DB_LOCK_CONFLICT 0x01 /* Run on any conflict. */
602
* Changes here must be reflected in java/src/com/sleepycat/db/Db.java.
605
DB_LOCK_DUMP=0, /* Display held locks. */
606
DB_LOCK_GET, /* Get the lock. */
607
DB_LOCK_INHERIT, /* Pass locks to parent. */
608
DB_LOCK_PUT, /* Release the lock. */
609
DB_LOCK_PUT_ALL, /* Release locker's locks. */
610
DB_LOCK_PUT_OBJ /* Release locker's locks on obj. */
614
* Simple R/W lock modes and for multi-granularity intention locking.
617
* These values are NOT random, as they are used as an index into the lock
618
* conflicts arrays, i.e., DB_LOCK_IWRITE must be == 3, and DB_LOCK_IREAD
622
* Changes here must be reflected in java/src/com/sleepycat/db/Db.java.
625
DB_LOCK_NG=0, /* Not granted. */
626
DB_LOCK_READ, /* Shared/read. */
627
DB_LOCK_WRITE, /* Exclusive/write. */
628
DB_LOCK_IWRITE, /* Intent exclusive/write. */
629
DB_LOCK_IREAD, /* Intent to share/read. */
630
DB_LOCK_IWR /* Intent to read and write. */
637
DB_LSTAT_ABORTED, /* Lock belongs to an aborted txn. */
638
DB_LSTAT_ERR, /* Lock is bad. */
639
DB_LSTAT_FREE, /* Lock is unallocated. */
640
DB_LSTAT_HELD, /* Lock is currently held. */
641
DB_LSTAT_NOGRANT, /* Lock was not granted. */
642
DB_LSTAT_PENDING, /* Lock was waiting and has been
643
* promoted; waiting for the owner
644
* to run and upgrade it to held. */
645
DB_LSTAT_WAITING /* Lock is on the wait queue. */
648
/* Lock request structure. */
649
struct __db_lockreq {
650
db_lockop_t op; /* Operation. */
651
db_lockmode_t mode; /* Requested mode. */
652
u_int32_t locker; /* Locker identity. */
653
DBT *obj; /* Object being locked. */
654
DB_LOCK lock; /* Lock returned. */
658
* Commonly used conflict matrices.
660
* Standard Read/Write (or exclusive/shared) locks.
662
#define DB_LOCK_RW_N 3
663
extern const u_int8_t db_rw_conflicts[];
665
/* Multi-granularity locking. */
666
#define DB_LOCK_RIW_N 6
667
extern const u_int8_t db_riw_conflicts[];
669
struct __db_lock_stat {
670
u_int32_t st_magic; /* Lock file magic number. */
671
u_int32_t st_version; /* Lock file version number. */
672
u_int32_t st_maxlocks; /* Maximum number of locks in table. */
673
u_int32_t st_nmodes; /* Number of lock modes. */
674
u_int32_t st_numobjs; /* Number of objects. */
675
u_int32_t st_nlockers; /* Number of lockers. */
676
u_int32_t st_nconflicts; /* Number of lock conflicts. */
677
u_int32_t st_nrequests; /* Number of lock gets. */
678
u_int32_t st_nreleases; /* Number of lock puts. */
679
u_int32_t st_ndeadlocks; /* Number of lock deadlocks. */
680
u_int32_t st_region_wait; /* Region lock granted after wait. */
681
u_int32_t st_region_nowait; /* Region lock granted without wait. */
682
u_int32_t st_refcnt; /* Region reference count. */
683
u_int32_t st_regsize; /* Region size. */
686
#if defined(__cplusplus)
689
int lock_close __P((DB_LOCKTAB *));
690
int lock_detect __P((DB_LOCKTAB *, u_int32_t, u_int32_t));
691
int lock_get __P((DB_LOCKTAB *,
692
u_int32_t, u_int32_t, const DBT *, db_lockmode_t, DB_LOCK *));
693
int lock_id __P((DB_LOCKTAB *, u_int32_t *));
694
int lock_open __P((const char *,
695
u_int32_t, int, DB_ENV *, DB_LOCKTAB **));
696
int lock_put __P((DB_LOCKTAB *, DB_LOCK));
697
int lock_tget __P((DB_LOCKTAB *,
698
DB_TXN *, u_int32_t, const DBT *, db_lockmode_t, DB_LOCK *));
699
int lock_stat __P((DB_LOCKTAB *, DB_LOCK_STAT **, void *(*)(size_t)));
700
int lock_unlink __P((const char *, int, DB_ENV *));
701
int lock_vec __P((DB_LOCKTAB *,
702
u_int32_t, u_int32_t, DB_LOCKREQ *, int, DB_LOCKREQ **));
703
int lock_tvec __P((DB_LOCKTAB *,
704
DB_TXN *, u_int32_t, DB_LOCKREQ *, int, DB_LOCKREQ **));
705
#if defined(__cplusplus)
709
/*******************************************************
711
*******************************************************/
712
/* Flag values for log_archive(). */
713
#define DB_ARCH_ABS 0x001 /* Absolute pathnames. */
714
#define DB_ARCH_DATA 0x002 /* Data files. */
715
#define DB_ARCH_LOG 0x004 /* Log files. */
718
* A DB_LSN has two parts, a fileid which identifies a specific file, and an
719
* offset within that file. The fileid is an unsigned 4-byte quantity that
720
* uniquely identifies a file within the log directory -- currently a simple
721
* counter inside the log. The offset is also an unsigned 4-byte value. The
722
* log manager guarantees the offset is never more than 4 bytes by switching
723
* to a new log file before the maximum length imposed by an unsigned 4-byte
727
u_int32_t file; /* File ID. */
728
u_int32_t offset; /* File offset. */
731
/* Log statistics structure. */
732
struct __db_log_stat {
733
u_int32_t st_magic; /* Log file magic number. */
734
u_int32_t st_version; /* Log file version number. */
735
int st_mode; /* Log file mode. */
736
u_int32_t st_lg_max; /* Maximum log file size. */
737
u_int32_t st_w_bytes; /* Bytes to log. */
738
u_int32_t st_w_mbytes; /* Megabytes to log. */
739
u_int32_t st_wc_bytes; /* Bytes to log since checkpoint. */
740
u_int32_t st_wc_mbytes; /* Megabytes to log since checkpoint. */
741
u_int32_t st_wcount; /* Total syncs to the log. */
742
u_int32_t st_scount; /* Total writes to the log. */
743
u_int32_t st_region_wait; /* Region lock granted after wait. */
744
u_int32_t st_region_nowait; /* Region lock granted without wait. */
745
u_int32_t st_cur_file; /* Current log file number. */
746
u_int32_t st_cur_offset; /* Current log file offset. */
747
u_int32_t st_refcnt; /* Region reference count. */
748
u_int32_t st_regsize; /* Region size. */
751
#if defined(__cplusplus)
754
int log_archive __P((DB_LOG *, char **[], u_int32_t, void *(*)(size_t)));
755
int log_close __P((DB_LOG *));
756
int log_compare __P((const DB_LSN *, const DB_LSN *));
757
int log_file __P((DB_LOG *, const DB_LSN *, char *, size_t));
758
int log_flush __P((DB_LOG *, const DB_LSN *));
759
int log_get __P((DB_LOG *, DB_LSN *, DBT *, u_int32_t));
760
int log_open __P((const char *, u_int32_t, int, DB_ENV *, DB_LOG **));
761
int log_put __P((DB_LOG *, DB_LSN *, const DBT *, u_int32_t));
762
int log_register __P((DB_LOG *, DB *, const char *, DBTYPE, u_int32_t *));
763
int log_stat __P((DB_LOG *, DB_LOG_STAT **, void *(*)(size_t)));
764
int log_unlink __P((const char *, int, DB_ENV *));
765
int log_unregister __P((DB_LOG *, u_int32_t));
766
#if defined(__cplusplus)
770
/*******************************************************
772
*******************************************************/
773
/* Flag values for memp_fget(). */
774
#define DB_MPOOL_CREATE 0x001 /* Create a page. */
775
#define DB_MPOOL_LAST 0x002 /* Return the last page. */
776
#define DB_MPOOL_NEW 0x004 /* Create a new page. */
778
/* Flag values for memp_fput(), memp_fset(). */
779
#define DB_MPOOL_CLEAN 0x001 /* Clear modified bit. */
780
#define DB_MPOOL_DIRTY 0x002 /* Page is modified. */
781
#define DB_MPOOL_DISCARD 0x004 /* Don't cache the page. */
783
/* Mpool statistics structure. */
784
struct __db_mpool_stat {
785
size_t st_cachesize; /* Cache size. */
786
u_int32_t st_cache_hit; /* Pages found in the cache. */
787
u_int32_t st_cache_miss; /* Pages not found in the cache. */
788
u_int32_t st_map; /* Pages from mapped files. */
789
u_int32_t st_page_create; /* Pages created in the cache. */
790
u_int32_t st_page_in; /* Pages read in. */
791
u_int32_t st_page_out; /* Pages written out. */
792
u_int32_t st_ro_evict; /* Clean pages forced from the cache. */
793
u_int32_t st_rw_evict; /* Dirty pages forced from the cache. */
794
u_int32_t st_hash_buckets; /* Number of hash buckets. */
795
u_int32_t st_hash_searches; /* Total hash chain searches. */
796
u_int32_t st_hash_longest; /* Longest hash chain searched. */
797
u_int32_t st_hash_examined; /* Total hash entries searched. */
798
u_int32_t st_page_clean; /* Clean pages. */
799
u_int32_t st_page_dirty; /* Dirty pages. */
800
u_int32_t st_page_trickle; /* Pages written by memp_trickle. */
801
u_int32_t st_region_wait; /* Region lock granted after wait. */
802
u_int32_t st_region_nowait; /* Region lock granted without wait. */
803
u_int32_t st_refcnt; /* Region reference count. */
804
u_int32_t st_regsize; /* Region size. */
807
/* Mpool file open information structure. */
808
struct __db_mpool_finfo {
809
int ftype; /* File type. */
810
DBT *pgcookie; /* Byte-string passed to pgin/pgout. */
811
u_int8_t *fileid; /* Unique file ID. */
812
int32_t lsn_offset; /* LSN offset in page. */
813
u_int32_t clear_len; /* Cleared length on created pages. */
816
/* Mpool file statistics structure. */
817
struct __db_mpool_fstat {
818
char *file_name; /* File name. */
819
size_t st_pagesize; /* Page size. */
820
u_int32_t st_cache_hit; /* Pages found in the cache. */
821
u_int32_t st_cache_miss; /* Pages not found in the cache. */
822
u_int32_t st_map; /* Pages from mapped files. */
823
u_int32_t st_page_create; /* Pages created in the cache. */
824
u_int32_t st_page_in; /* Pages read in. */
825
u_int32_t st_page_out; /* Pages written out. */
828
#if defined(__cplusplus)
831
int memp_close __P((DB_MPOOL *));
832
int memp_fclose __P((DB_MPOOLFILE *));
833
int memp_fget __P((DB_MPOOLFILE *, db_pgno_t *, u_int32_t, void *));
834
int memp_fopen __P((DB_MPOOL *, const char *,
835
u_int32_t, int, size_t, DB_MPOOL_FINFO *, DB_MPOOLFILE **));
836
int memp_fput __P((DB_MPOOLFILE *, void *, u_int32_t));
837
int memp_fset __P((DB_MPOOLFILE *, void *, u_int32_t));
838
int memp_fsync __P((DB_MPOOLFILE *));
839
int memp_open __P((const char *, u_int32_t, int, DB_ENV *, DB_MPOOL **));
840
int memp_register __P((DB_MPOOL *, int,
841
int (*)(db_pgno_t, void *, DBT *),
842
int (*)(db_pgno_t, void *, DBT *)));
843
int memp_stat __P((DB_MPOOL *,
844
DB_MPOOL_STAT **, DB_MPOOL_FSTAT ***, void *(*)(size_t)));
845
int memp_sync __P((DB_MPOOL *, DB_LSN *));
846
int memp_trickle __P((DB_MPOOL *, int, int *));
847
int memp_unlink __P((const char *, int, DB_ENV *));
848
#if defined(__cplusplus)
852
/*******************************************************
854
*******************************************************/
855
#define DB_TXNVERSION 1
856
#define DB_TXNMAGIC 0x041593
858
/* Operations values to the tx_recover() function. */
859
#define DB_TXN_BACKWARD_ROLL 1 /* Read the log backwards. */
860
#define DB_TXN_FORWARD_ROLL 2 /* Read the log forwards. */
861
#define DB_TXN_OPENFILES 3 /* Read for open files. */
862
#define DB_TXN_REDO 4 /* Redo the operation. */
863
#define DB_TXN_UNDO 5 /* Undo the operation. */
865
/* Internal transaction status values. */
867
/* Transaction statistics structure. */
868
struct __db_txn_active {
869
u_int32_t txnid; /* Transaction ID */
870
DB_LSN lsn; /* Lsn of the begin record */
873
struct __db_txn_stat {
874
DB_LSN st_last_ckp; /* lsn of the last checkpoint */
875
DB_LSN st_pending_ckp; /* last checkpoint did not finish */
876
time_t st_time_ckp; /* time of last checkpoint */
877
u_int32_t st_last_txnid; /* last transaction id given out */
878
u_int32_t st_maxtxns; /* maximum number of active txns */
879
u_int32_t st_naborts; /* number of aborted transactions */
880
u_int32_t st_nbegins; /* number of begun transactions */
881
u_int32_t st_ncommits; /* number of committed transactions */
882
u_int32_t st_nactive; /* number of active transactions */
884
*st_txnarray; /* array of active transactions */
885
u_int32_t st_region_wait; /* Region lock granted after wait. */
886
u_int32_t st_region_nowait; /* Region lock granted without wait. */
887
u_int32_t st_refcnt; /* Region reference count. */
888
u_int32_t st_regsize; /* Region size. */
891
#if defined(__cplusplus)
894
int txn_abort __P((DB_TXN *));
895
int txn_begin __P((DB_TXNMGR *, DB_TXN *, DB_TXN **));
896
int txn_checkpoint __P((const DB_TXNMGR *, u_int32_t, u_int32_t));
897
int txn_commit __P((DB_TXN *));
898
int txn_close __P((DB_TXNMGR *));
899
u_int32_t txn_id __P((DB_TXN *));
900
int txn_open __P((const char *, u_int32_t, int, DB_ENV *, DB_TXNMGR **));
901
int txn_prepare __P((DB_TXN *));
902
int txn_stat __P((DB_TXNMGR *, DB_TXN_STAT **, void *(*)(size_t)));
903
int txn_unlink __P((const char *, int, DB_ENV *));
904
#if defined(__cplusplus)
908
#ifndef DB_DBM_HSEARCH
909
#define DB_DBM_HSEARCH 0 /* No historic interfaces by default. */
911
#if DB_DBM_HSEARCH != 0
912
/*******************************************************
913
* Dbm/Ndbm historic interfaces.
914
*******************************************************/
915
#define DBM_INSERT 0 /* Flags to dbm_store(). */
916
#define DBM_REPLACE 1
919
* The db(3) support for ndbm(3) always appends this suffix to the
920
* file name to avoid overwriting the user's original database.
922
#define DBM_SUFFIX ".db"
937
* Translate DBM calls into DB calls so that DB doesn't step on the
938
* application's name space.
940
* The global variables dbrdonly, dirf and pagf were not retained when
941
* 4BSD replaced the dbm interface with ndbm, and are not support here.
943
#define dbminit(a) __db_dbm_init(a)
944
#define dbmclose __db_dbm_close
945
#if !defined(__cplusplus)
946
#define delete(a) __db_dbm_delete(a)
948
#define fetch(a) __db_dbm_fetch(a)
949
#define firstkey __db_dbm_firstkey
950
#define nextkey(a) __db_dbm_nextkey(a)
951
#define store(a, b) __db_dbm_store(a, b)
953
/* Prototype the DB calls. */
954
#if defined(__cplusplus)
957
int __db_dbm_close __P((void));
958
int __db_dbm_dbrdonly __P((void));
959
int __db_dbm_delete __P((datum));
960
int __db_dbm_dirf __P((void));
961
datum __db_dbm_fetch __P((datum));
962
datum __db_dbm_firstkey __P((void));
963
int __db_dbm_init __P((char *));
964
datum __db_dbm_nextkey __P((datum));
965
int __db_dbm_pagf __P((void));
966
int __db_dbm_store __P((datum, datum));
967
#if defined(__cplusplus)
972
* Translate NDBM calls into DB calls so that DB doesn't step on the
973
* application's name space.
975
#define dbm_clearerr(a) __db_ndbm_clearerr(a)
976
#define dbm_close(a) __db_ndbm_close(a)
977
#define dbm_delete(a, b) __db_ndbm_delete(a, b)
978
#define dbm_dirfno(a) __db_ndbm_dirfno(a)
979
#define dbm_error(a) __db_ndbm_error(a)
980
#define dbm_fetch(a, b) __db_ndbm_fetch(a, b)
981
#define dbm_firstkey(a) __db_ndbm_firstkey(a)
982
#define dbm_nextkey(a) __db_ndbm_nextkey(a)
983
#define dbm_open(a, b, c) __db_ndbm_open(a, b, c)
984
#define dbm_pagfno(a) __db_ndbm_pagfno(a)
985
#define dbm_rdonly(a) __db_ndbm_rdonly(a)
986
#define dbm_store(a, b, c, d) __db_ndbm_store(a, b, c, d)
988
/* Prototype the DB calls. */
989
#if defined(__cplusplus)
992
int __db_ndbm_clearerr __P((DBM *));
993
void __db_ndbm_close __P((DBM *));
994
int __db_ndbm_delete __P((DBM *, datum));
995
int __db_ndbm_dirfno __P((DBM *));
996
int __db_ndbm_error __P((DBM *));
997
datum __db_ndbm_fetch __P((DBM *, datum));
998
datum __db_ndbm_firstkey __P((DBM *));
999
datum __db_ndbm_nextkey __P((DBM *));
1000
DBM *__db_ndbm_open __P((const char *, int, int));
1001
int __db_ndbm_pagfno __P((DBM *));
1002
int __db_ndbm_rdonly __P((DBM *));
1003
int __db_ndbm_store __P((DBM *, datum, datum, int));
1004
#if defined(__cplusplus)
1008
/*******************************************************
1009
* Hsearch historic interface.
1010
*******************************************************/
1015
typedef struct entry {
1021
* Translate HSEARCH calls into DB calls so that DB doesn't step on the
1022
* application's name space.
1024
#define hcreate(a) __db_hcreate(a)
1025
#define hdestroy __db_hdestroy
1026
#define hsearch(a, b) __db_hsearch(a, b)
1028
/* Prototype the DB calls. */
1029
#if defined(__cplusplus)
1032
int __db_hcreate __P((size_t));
1033
void __db_hdestroy __P((void));
1034
ENTRY *__db_hsearch __P((ENTRY, ACTION));
1035
#if defined(__cplusplus)
1038
#endif /* DB_DBM_HSEARCH */
1042
* MacOS: Reset Metrowerks C enum sizes.
1045
#pragma enumsalwaysint reset
1047
#endif /* !_DB_H_ */
added
removed
kernel/src_info/sn/snsrc/db-2.7.7/build_vms/db.h
