开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数据库系统 > MySQL数据库 > 查看源码
db.h
资源名称：mysql-4.1.16-win-src.zip　[点击查看]
上传用户：romrleung
上传日期：2022-05-23
资源大小：18897k
文件大小：75k
源码类别：

MySQL数据库

开发平台：

Visual C++

db.h：源码内容
  1. /* DO NOT EDIT: automatically built by dist/s_win32. */
  2. /*
  3.  * See the file LICENSE for redistribution information.
  4.  *
  5.  * Copyright (c) 1996-2002
  6.  * Sleepycat Software.  All rights reserved.
  7.  *
  8.  * $Id: db.in,v 11.323 2002/09/03 17:27:16 bostic Exp $
  9.  *
  10.  * db.h include file layout:
  11.  * General.
  12.  * Database Environment.
  13.  * Locking subsystem.
  14.  * Logging subsystem.
  15.  * Shared buffer cache (mpool) subsystem.
  16.  * Transaction subsystem.
  17.  * Access methods.
  18.  * Access method cursors.
  19.  * Dbm/Ndbm, Hsearch historic interfaces.
  20.  */
  22. #ifndef _DB_H_
  23. #define _DB_H_
  25. #ifndef __NO_SYSTEM_INCLUDES
  26. #include <sys/types.h>
  28. #include <stdio.h>
  29. #endif
  31. #if defined(__cplusplus)
  32. extern "C" {
  33. #endif
  35. /*
  36.  * XXX
  37.  * Handle function prototypes and the keyword "const".  This steps on name
  38.  * space that DB doesn't control, but all of the other solutions are worse.
  39.  *
  40.  * XXX
  41.  * While Microsoft's compiler is ANSI C compliant, it doesn't have _STDC_
  42.  * defined by default, you specify a command line flag or #pragma to turn
  43.  * it on.  Don't do that, however, because some of Microsoft's own header
  44.  * files won't compile.
  45.  */
  46. #undef __P
  47. #if defined(__STDC__) || defined(__cplusplus) || defined(_MSC_VER)
  48. #define __P(protos) protos /* ANSI C prototypes */
  49. #else
  50. #define const
  51. #define __P(protos) () /* K&R C preprocessor */
  52. #endif
  54. /*
  55.  * Berkeley DB version information.
  56.  */
  57. #define DB_VERSION_MAJOR 4
  58. #define DB_VERSION_MINOR 1
  59. #define DB_VERSION_PATCH 24
  60. #define DB_VERSION_STRING "Sleepycat Software: Berkeley DB 4.1.24: (November 30, 2005)"
  62. /*
  63.  * !!!
  64.  * Berkeley DB uses specifically sized types.  If they're not provided by
  65.  * the system, typedef them here.
  66.  *
  67.  * We protect them against multiple inclusion using __BIT_TYPES_DEFINED__,
  68.  * as does BIND and Kerberos, since we don't know for sure what #include
  69.  * files the user is using.
  70.  *
  71.  * !!!
  72.  * We also provide the standard u_int, u_long etc., if they're not provided
  73.  * by the system.
  74.  */
  75. #ifndef __BIT_TYPES_DEFINED__
  76. #define __BIT_TYPES_DEFINED__
  77. typedef unsigned char u_int8_t;
  78. typedef short int16_t;
  79. typedef unsigned short u_int16_t;
  80. typedef int int32_t;
  81. typedef unsigned int u_int32_t;
  82. #endif
  84. #if !defined(_WINSOCKAPI_)
  85. typedef unsigned char u_char;
  86. typedef unsigned short u_short;
  87. typedef unsigned int u_int;
  88. typedef unsigned long u_long;
  89. #endif
  90. #if defined(_WIN64)
  91. typedef __int64 ssize_t;
  92. #else
  93. typedef int ssize_t;
  94. #endif
  96. /* Basic types that are exported or quasi-exported. */
  97. typedef u_int32_t db_pgno_t; /* Page number type. */
  98. typedef u_int16_t db_indx_t; /* Page offset type. */
  99. #define DB_MAX_PAGES 0xffffffff /* >= # of pages in a file */
  101. typedef u_int32_t db_recno_t; /* Record number type. */
  102. #define DB_MAX_RECORDS 0xffffffff /* >= # of records in a tree */
  104. typedef u_int32_t db_timeout_t; /* Type of a timeout. */
  106. /*
  107.  * Region offsets are currently limited to 32-bits.  I expect that's going
  108.  * to have to be fixed in the not-too-distant future, since we won't want to
  109.  * split 100Gb memory pools into that many different regions.
  110.  */
  111. typedef u_int32_t roff_t;
  113. /*
  114.  * Forward structure declarations, so we can declare pointers and
  115.  * applications can get type checking.
  116.  */
  117. struct __db; typedef struct __db DB;
  118. struct __db_bt_stat; typedef struct __db_bt_stat DB_BTREE_STAT;
  119. struct __db_cipher; typedef struct __db_cipher DB_CIPHER;
  120. struct __db_dbt; typedef struct __db_dbt DBT;
  121. struct __db_env; typedef struct __db_env DB_ENV;
  122. struct __db_h_stat; typedef struct __db_h_stat DB_HASH_STAT;
  123. struct __db_ilock; typedef struct __db_ilock DB_LOCK_ILOCK;
  124. struct __db_lock_stat; typedef struct __db_lock_stat DB_LOCK_STAT;
  125. struct __db_lock_u; typedef struct __db_lock_u DB_LOCK;
  126. struct __db_lockreq; typedef struct __db_lockreq DB_LOCKREQ;
  127. struct __db_log_cursor; typedef struct __db_log_cursor DB_LOGC;
  128. struct __db_log_stat; typedef struct __db_log_stat DB_LOG_STAT;
  129. struct __db_lsn; typedef struct __db_lsn DB_LSN;
  130. struct __db_mpool; typedef struct __db_mpool DB_MPOOL;
  131. struct __db_mpool_fstat;typedef struct __db_mpool_fstat DB_MPOOL_FSTAT;
  132. struct __db_mpool_stat; typedef struct __db_mpool_stat DB_MPOOL_STAT;
  133. struct __db_mpoolfile; typedef struct __db_mpoolfile DB_MPOOLFILE;
  134. struct __db_preplist; typedef struct __db_preplist DB_PREPLIST;
  135. struct __db_qam_stat; typedef struct __db_qam_stat DB_QUEUE_STAT;
  136. struct __db_rep; typedef struct __db_rep DB_REP;
  137. struct __db_rep_stat; typedef struct __db_rep_stat DB_REP_STAT;
  138. struct __db_txn; typedef struct __db_txn DB_TXN;
  139. struct __db_txn_active; typedef struct __db_txn_active DB_TXN_ACTIVE;
  140. struct __db_txn_stat; typedef struct __db_txn_stat DB_TXN_STAT;
  141. struct __db_txnmgr; typedef struct __db_txnmgr DB_TXNMGR;
  142. struct __dbc; typedef struct __dbc DBC;
  143. struct __dbc_internal; typedef struct __dbc_internal DBC_INTERNAL;
  144. struct __fh_t; typedef struct __fh_t DB_FH;
  145. struct __fname; typedef struct __fname FNAME;
  146. struct __key_range; typedef struct __key_range DB_KEY_RANGE;
  147. struct __mpoolfile; typedef struct __mpoolfile MPOOLFILE;
  148. struct __mutex_t; typedef struct __mutex_t DB_MUTEX;
  150. /* Key/data structure -- a Data-Base Thang. */
  151. struct __db_dbt {
  152. /*
  153.  * data/size must be fields 1 and 2 for DB 1.85 compatibility.
  154.  */
  155. void  *data; /* Key/data */
  156. u_int32_t size; /* key/data length */
  158. u_int32_t ulen; /* RO: length of user buffer. */
  159. u_int32_t dlen; /* RO: get/put record length. */
  160. u_int32_t doff; /* RO: get/put record offset. */
  162. void *app_private; /* Application-private handle. */
  164. #define DB_DBT_APPMALLOC 0x001 /* Callback allocated memory. */
  165. #define DB_DBT_ISSET 0x002 /* Lower level calls set value. */
  166. #define DB_DBT_MALLOC 0x004 /* Return in malloc'd memory. */
  167. #define DB_DBT_PARTIAL 0x008 /* Partial put/get. */
  168. #define DB_DBT_REALLOC 0x010 /* Return in realloc'd memory. */
  169. #define DB_DBT_USERMEM 0x020 /* Return in user's memory. */
  170. #define DB_DBT_DUPOK 0x040 /* Insert if duplicate. */
  171. u_int32_t flags;
  172. };
  174. /*
  175.  * Common flags --
  176.  * Interfaces which use any of these common flags should never have
  177.  * interface specific flags in this range.
  178.  */
  179. #define DB_CREATE       0x000001 /* Create file as necessary. */
  180. #define DB_CXX_NO_EXCEPTIONS  0x000002 /* C++: return error values. */
  181. #define DB_FORCE       0x000004 /* Force (anything). */
  182. #define DB_NOMMAP       0x000008 /* Don't mmap underlying file. */
  183. #define DB_RDONLY       0x000010 /* Read-only (O_RDONLY). */
  184. #define DB_RECOVER       0x000020 /* Run normal recovery. */
  185. #define DB_THREAD       0x000040 /* Applications are threaded. */
  186. #define DB_TRUNCATE       0x000080 /* Discard existing DB (O_TRUNC). */
  187. #define DB_TXN_NOSYNC       0x000100 /* Do not sync log on commit. */
  188. #define DB_USE_ENVIRON       0x000200 /* Use the environment. */
  189. #define DB_USE_ENVIRON_ROOT   0x000400 /* Use the environment if root. */
  191. /*
  192.  * Common flags --
  193.  * Interfaces which use any of these common flags should never have
  194.  * interface specific flags in this range.
  195.  *
  196.  * DB_AUTO_COMMIT:
  197.  * DB_ENV->set_flags, DB->associate, DB->del, DB->put, DB->open,
  198.  * DB->remove, DB->rename, DB->truncate
  199.  * DB_DIRTY_READ:
  200.  * DB->cursor, DB->get, DB->join, DB->open, DBcursor->c_get,
  201.  * DB_ENV->txn_begin
  202.  *
  203.  *    Shared flags up to 0x000400 */
  204. #define DB_AUTO_COMMIT     0x00800000 /* Implied transaction. */
  205. #define DB_DIRTY_READ     0x01000000 /* Dirty Read. */
  207. /*
  208.  * Flags private to db_env_create.
  209.  */
  210. #define DB_CLIENT       0x000001 /* Open for a client environment. */
  212. /*
  213.  * Flags private to db_create.
  214.  */
  215. #define DB_XA_CREATE       0x000001 /* Open in an XA environment. */
  217. /*
  218.  * Flags private to DB_ENV->open.
  219.  *    Shared flags up to 0x000400 */
  220. #define DB_INIT_CDB       0x000800 /* Concurrent Access Methods. */
  221. #define DB_INIT_LOCK       0x001000 /* Initialize locking. */
  222. #define DB_INIT_LOG       0x002000 /* Initialize logging. */
  223. #define DB_INIT_MPOOL       0x004000 /* Initialize mpool. */
  224. #define DB_INIT_TXN       0x008000 /* Initialize transactions. */
  225. #define DB_JOINENV       0x010000 /* Initialize all subsystems present. */
  226. #define DB_LOCKDOWN       0x020000 /* Lock memory into physical core. */
  227. #define DB_PRIVATE       0x040000 /* DB_ENV is process local. */
  228. #define DB_RECOVER_FATAL      0x080000 /* Run catastrophic recovery. */
  229. #define DB_SYSTEM_MEM       0x100000 /* Use system-backed memory. */
  231. /*
  232.  * Flags private to DB->open.
  233.  *    Shared flags up to 0x000400 */
  234. #define DB_EXCL       0x000800 /* Exclusive open (O_EXCL). */
  235. #define DB_FCNTL_LOCKING      0x001000 /* UNDOC: fcntl(2) locking. */
  236. #define DB_RDWRMASTER       0x002000 /* UNDOC: allow subdb master open R/W */
  237. #define DB_WRITEOPEN       0x004000 /* UNDOC: open with write lock. */
  239. /*
  240.  * Flags private to DB_ENV->txn_begin.
  241.  *    Shared flags up to 0x000400 */
  242. #define DB_TXN_NOWAIT       0x000800 /* Do not wait for locks in this TXN. */
  243. #define DB_TXN_SYNC       0x001000 /* Always sync log on commit. */
  245. /*
  246.  * Flags private to DB_ENV->set_encrypt.
  247.  */
  248. #define DB_ENCRYPT_AES       0x000001 /* AES, assumes SHA1 checksum */
  250. /*
  251.  * Flags private to DB_ENV->set_flags.
  252.  *    Shared flags up to 0x000400 */
  253. #define DB_CDB_ALLDB       0x000800 /* Set CDB locking per environment. */
  254. #define DB_DIRECT_DB       0x001000 /* Don't buffer databases in the OS. */
  255. #define DB_DIRECT_LOG       0x002000 /* Don't buffer log files in the OS. */
  256. #define DB_NOLOCKING       0x004000 /* Set locking/mutex behavior. */
  257. #define DB_NOPANIC       0x008000 /* Set panic state per DB_ENV. */
  258. #define DB_OVERWRITE       0x010000 /* Overwrite unlinked region files. */
  259. #define DB_PANIC_ENVIRONMENT  0x020000 /* Set panic state per environment. */
  260. #define DB_REGION_INIT       0x040000 /* Page-fault regions on open. */
  261. #define DB_TXN_WRITE_NOSYNC   0x080000 /* Write, don't sync, on txn commit. */
  262. #define DB_YIELDCPU       0x100000 /* Yield the CPU (a lot). */
  264. /*
  265.  * Flags private to DB->set_feedback's callback.
  266.  */
  267. #define DB_UPGRADE       0x000001 /* Upgrading. */
  268. #define DB_VERIFY       0x000002 /* Verifying. */
  270. /*
  271.  * Flags private to DB_MPOOLFILE->open.
  272.  *    Shared flags up to 0x000400 */
  273. #define DB_DIRECT       0x000800 /* Don't buffer the file in the OS. */
  274. #define DB_EXTENT       0x001000 /* UNDOC: dealing with an extent. */
  275. #define DB_ODDFILESIZE       0x002000 /* Truncate file to N * pgsize. */
  277. /*
  278.  * Flags private to DB->set_flags.
  279.  */
  280. #define DB_CHKSUM_SHA1       0x000001 /* Use SHA1 checksumming */
  281. #define DB_DUP       0x000002 /* Btree, Hash: duplicate keys. */
  282. #define DB_DUPSORT       0x000004 /* Btree, Hash: duplicate keys. */
  283. #define DB_ENCRYPT       0x000008 /* Btree, Hash: duplicate keys. */
  284. #define DB_RECNUM       0x000010 /* Btree: record numbers. */
  285. #define DB_RENUMBER       0x000020 /* Recno: renumber on insert/delete. */
  286. #define DB_REVSPLITOFF       0x000040 /* Btree: turn off reverse splits. */
  287. #define DB_SNAPSHOT       0x000080 /* Recno: snapshot the input. */
  289. /*
  290.  * Flags private to the DB->stat methods.
  291.  */
  292. #define DB_STAT_CLEAR       0x000001 /* Clear stat after returning values. */
  294. /*
  295.  * Flags private to DB->join.
  296.  */
  297. #define DB_JOIN_NOSORT       0x000001 /* Don't try to optimize join. */
  299. /*
  300.  * Flags private to DB->verify.
  301.  */
  302. #define DB_AGGRESSIVE       0x000001 /* Salvage whatever could be data.*/
  303. #define DB_NOORDERCHK       0x000002 /* Skip sort order/hashing check. */
  304. #define DB_ORDERCHKONLY       0x000004 /* Only perform the order check. */
  305. #define DB_PR_PAGE       0x000008 /* Show page contents (-da). */
  306. #define DB_PR_RECOVERYTEST    0x000010 /* Recovery test (-dr). */
  307. #define DB_PRINTABLE       0x000020 /* Use printable format for salvage. */
  308. #define DB_SALVAGE       0x000040 /* Salvage what looks like data. */
  309. /*
  310.  * !!!
  311.  * These must not go over 0x8000, or they will collide with the flags
  312.  * used by __bam_vrfy_subtree.
  313.  */
  315. /*
  316.  * Flags private to DB->set_rep_transport's send callback.
  317.  */
  318. #define DB_REP_PERMANENT 0x0001 /* Important--app. may want to flush. */
  320. /*******************************************************
  321.  * Locking.
  322.  *******************************************************/
  323. #define DB_LOCKVERSION 1
  325. #define DB_FILE_ID_LEN 20 /* Unique file ID length. */
  327. /*
  328.  * Deadlock detector modes; used in the DB_ENV structure to configure the
  329.  * locking subsystem.
  330.  */
  331. #define DB_LOCK_NORUN 0
  332. #define DB_LOCK_DEFAULT 1 /* Default policy. */
  333. #define DB_LOCK_EXPIRE 2 /* Only expire locks, no detection. */
  334. #define DB_LOCK_MAXLOCKS 3 /* Abort txn with maximum # of locks. */
  335. #define DB_LOCK_MINLOCKS 4 /* Abort txn with minimum # of locks. */
  336. #define DB_LOCK_MINWRITE 5 /* Abort txn with minimum writelocks. */
  337. #define DB_LOCK_OLDEST 6 /* Abort oldest transaction. */
  338. #define DB_LOCK_RANDOM 7 /* Abort random transaction. */
  339. #define DB_LOCK_YOUNGEST 8 /* Abort youngest transaction. */
  341. /* Flag values for lock_vec(), lock_get(). */
  342. #define DB_LOCK_FREE_LOCKER 0x001 /* Internal: Free locker as well. */
  343. #define DB_LOCK_NOWAIT 0x002 /* Don't wait on unavailable lock. */
  344. #define DB_LOCK_RECORD 0x004 /* Internal: record lock. */
  345. #define DB_LOCK_REMOVE 0x008 /* Internal: flag object removed. */
  346. #define DB_LOCK_SET_TIMEOUT 0x010 /* Internal: set lock timeout. */
  347. #define DB_LOCK_SWITCH 0x020 /* Internal: switch existing lock. */
  348. #define DB_LOCK_UPGRADE 0x040 /* Internal: upgrade existing lock. */
  350. /*
  351.  * Simple R/W lock modes and for multi-granularity intention locking.
  352.  *
  353.  * !!!
  354.  * These values are NOT random, as they are used as an index into the lock
  355.  * conflicts arrays, i.e., DB_LOCK_IWRITE must be == 3, and DB_LOCK_IREAD
  356.  * must be == 4.
  357.  */
  358. typedef enum {
  359. DB_LOCK_NG=0, /* Not granted. */
  360. DB_LOCK_READ=1, /* Shared/read. */
  361. DB_LOCK_WRITE=2, /* Exclusive/write. */
  362. DB_LOCK_WAIT=3, /* Wait for event */
  363. DB_LOCK_IWRITE=4, /* Intent exclusive/write. */
  364. DB_LOCK_IREAD=5, /* Intent to share/read. */
  365. DB_LOCK_IWR=6, /* Intent to read and write. */
  366. DB_LOCK_DIRTY=7, /* Dirty Read. */
  367. DB_LOCK_WWRITE=8 /* Was Written. */
  368. } db_lockmode_t;
  370. /*
  371.  * Request types.
  372.  */
  373. typedef enum {
  374. DB_LOCK_DUMP=0, /* Display held locks. */
  375. DB_LOCK_GET=1, /* Get the lock. */
  376. DB_LOCK_GET_TIMEOUT=2, /* Get lock with a timeout. */
  377. DB_LOCK_INHERIT=3, /* Pass locks to parent. */
  378. DB_LOCK_PUT=4, /* Release the lock. */
  379. DB_LOCK_PUT_ALL=5, /* Release locker's locks. */
  380. DB_LOCK_PUT_OBJ=6, /* Release locker's locks on obj. */
  381. DB_LOCK_PUT_READ=7, /* Release locker's read locks. */
  382. DB_LOCK_TIMEOUT=8, /* Force a txn to timeout. */
  383. DB_LOCK_TRADE=9, /* Trade locker ids on a lock. */
  384. DB_LOCK_UPGRADE_WRITE=10 /* Upgrade writes for dirty reads. */
  385. } db_lockop_t;
  387. /*
  388.  * Status of a lock.
  389.  */
  390. typedef enum  {
  391. DB_LSTAT_ABORTED=1, /* Lock belongs to an aborted txn. */
  392. DB_LSTAT_ERR=2, /* Lock is bad. */
  393. DB_LSTAT_EXPIRED=3, /* Lock has expired. */
  394. DB_LSTAT_FREE=4, /* Lock is unallocated. */
  395. DB_LSTAT_HELD=5, /* Lock is currently held. */
  396. DB_LSTAT_NOTEXIST=6, /* Object on which lock was waiting
  397.  * was removed */
  398. DB_LSTAT_PENDING=7, /* Lock was waiting and has been
  399.  * promoted; waiting for the owner
  400.  * to run and upgrade it to held. */
  401. DB_LSTAT_WAITING=8 /* Lock is on the wait queue. */
  402. }db_status_t;
  404. /* Lock statistics structure. */
  405. struct __db_lock_stat {
  406. u_int32_t st_id; /* Last allocated locker ID. */
  407. u_int32_t st_cur_maxid; /* Current maximum unused ID. */
  408. u_int32_t st_maxlocks; /* Maximum number of locks in table. */
  409. u_int32_t st_maxlockers; /* Maximum num of lockers in table. */
  410. u_int32_t st_maxobjects; /* Maximum num of objects in table. */
  411. u_int32_t st_nmodes; /* Number of lock modes. */
  412. u_int32_t st_nlocks; /* Current number of locks. */
  413. u_int32_t st_maxnlocks; /* Maximum number of locks so far. */
  414. u_int32_t st_nlockers; /* Current number of lockers. */
  415. u_int32_t st_maxnlockers; /* Maximum number of lockers so far. */
  416. u_int32_t st_nobjects; /* Current number of objects. */
  417. u_int32_t st_maxnobjects; /* Maximum number of objects so far. */
  418. u_int32_t st_nconflicts; /* Number of lock conflicts. */
  419. u_int32_t st_nrequests; /* Number of lock gets. */
  420. u_int32_t st_nreleases; /* Number of lock puts. */
  421. u_int32_t st_nnowaits; /* Number of requests that would have
  422.    waited, but NOWAIT was set. */
  423. u_int32_t st_ndeadlocks; /* Number of lock deadlocks. */
  424. db_timeout_t st_locktimeout; /* Lock timeout. */
  425. u_int32_t st_nlocktimeouts; /* Number of lock timeouts. */
  426. db_timeout_t st_txntimeout; /* Transaction timeout. */
  427. u_int32_t st_ntxntimeouts; /* Number of transaction timeouts. */
  428. u_int32_t st_region_wait; /* Region lock granted after wait. */
  429. u_int32_t st_region_nowait; /* Region lock granted without wait. */
  430. u_int32_t st_regsize; /* Region size. */
  431. };
  433. /*
  434.  * DB_LOCK_ILOCK --
  435.  * Internal DB access method lock.
  436.  */
  437. struct __db_ilock {
  438. db_pgno_t pgno; /* Page being locked. */
  439. u_int8_t fileid[DB_FILE_ID_LEN];/* File id. */
  440. #define DB_HANDLE_LOCK 1
  441. #define DB_RECORD_LOCK 2
  442. #define DB_PAGE_LOCK 3
  443. #define DB_TXN_LOCK 4
  444. u_int32_t type; /* Type of lock. */
  445. };
  447. /*
  448.  * DB_LOCK --
  449.  * The structure is allocated by the caller and filled in during a
  450.  * lock_get request (or a lock_vec/DB_LOCK_GET).
  451.  */
  452. struct __db_lock_u {
  453. size_t off; /* Offset of the lock in the region */
  454. u_int32_t ndx; /* Index of the object referenced by
  455.  * this lock; used for locking. */
  456. u_int32_t gen; /* Generation number of this lock. */
  457. db_lockmode_t mode; /* mode of this lock. */
  458. };
  460. /* Lock request structure. */
  461. struct __db_lockreq {
  462. db_lockop_t  op; /* Operation. */
  463. db_lockmode_t  mode; /* Requested mode. */
  464. db_timeout_t  timeout; /* Time to expire lock. */
  465. DBT *obj; /* Object being locked. */
  466. DB_LOCK  lock; /* Lock returned. */
  467. };
  469. /*******************************************************
  470.  * Logging.
  471.  *******************************************************/
  472. #define DB_LOGVERSION 7 /* Current log version. */
  473. #define DB_LOGOLDVER 7 /* Oldest log version supported. */
  474. #define DB_LOGMAGIC 0x040988
  476. /* Flag values for log_archive(). */
  477. #define DB_ARCH_ABS 0x001 /* Absolute pathnames. */
  478. #define DB_ARCH_DATA 0x002 /* Data files. */
  479. #define DB_ARCH_LOG 0x004 /* Log files. */
  481. /*
  482.  * A DB_LSN has two parts, a fileid which identifies a specific file, and an
  483.  * offset within that file.  The fileid is an unsigned 4-byte quantity that
  484.  * uniquely identifies a file within the log directory -- currently a simple
  485.  * counter inside the log.  The offset is also an unsigned 4-byte value.  The
  486.  * log manager guarantees the offset is never more than 4 bytes by switching
  487.  * to a new log file before the maximum length imposed by an unsigned 4-byte
  488.  * offset is reached.
  489.  */
  490. struct __db_lsn {
  491. u_int32_t file; /* File ID. */
  492. u_int32_t offset; /* File offset. */
  493. };
  495. /*
  496.  * DB_LOGC --
  497.  * Log cursor.
  498.  */
  499. struct __db_log_cursor {
  500. DB_ENV  *dbenv; /* Enclosing dbenv. */
  502. DB_FH  *c_fh; /* File handle. */
  503. DB_LSN   c_lsn; /* Cursor: LSN */
  504. u_int32_t c_len; /* Cursor: record length */
  505. u_int32_t c_prev; /* Cursor: previous record's offset */
  507. DBT   c_dbt; /* Return DBT. */
  509. #define DB_LOGC_BUF_SIZE (32 * 1024)
  510. u_int8_t *bp; /* Allocated read buffer. */
  511. u_int32_t bp_size; /* Read buffer length in bytes. */
  512. u_int32_t bp_rlen; /* Read buffer valid data length. */
  513. DB_LSN   bp_lsn; /* Read buffer first byte LSN. */
  515. u_int32_t bp_maxrec; /* Max record length in the log file. */
  517. /* Methods. */
  518. int (*close) __P((DB_LOGC *, u_int32_t));
  519. int (*get) __P((DB_LOGC *, DB_LSN *, DBT *, u_int32_t));
  521. #define DB_LOG_DISK 0x01 /* Log record came from disk. */
  522. #define DB_LOG_LOCKED 0x02 /* Log region already locked */
  523. #define DB_LOG_SILENT_ERR 0x04 /* Turn-off error messages. */
  524. u_int32_t flags;
  525. };
  527. /* Log statistics structure. */
  528. struct __db_log_stat {
  529. u_int32_t st_magic; /* Log file magic number. */
  530. u_int32_t st_version; /* Log file version number. */
  531. int st_mode; /* Log file mode. */
  532. u_int32_t st_lg_bsize; /* Log buffer size. */
  533. u_int32_t st_lg_size; /* Log file size. */
  534. u_int32_t st_w_bytes; /* Bytes to log. */
  535. u_int32_t st_w_mbytes; /* Megabytes to log. */
  536. u_int32_t st_wc_bytes; /* Bytes to log since checkpoint. */
  537. u_int32_t st_wc_mbytes; /* Megabytes to log since checkpoint. */
  538. u_int32_t st_wcount; /* Total writes to the log. */
  539. u_int32_t st_wcount_fill; /* Overflow writes to the log. */
  540. u_int32_t st_scount; /* Total syncs to the log. */
  541. u_int32_t st_region_wait; /* Region lock granted after wait. */
  542. u_int32_t st_region_nowait; /* Region lock granted without wait. */
  543. u_int32_t st_cur_file; /* Current log file number. */
  544. u_int32_t st_cur_offset; /* Current log file offset. */
  545. u_int32_t st_disk_file; /* Known on disk log file number. */
  546. u_int32_t st_disk_offset; /* Known on disk log file offset. */
  547. u_int32_t st_regsize; /* Region size. */
  548. u_int32_t st_maxcommitperflush; /* Max number of commits in a flush. */
  549. u_int32_t st_mincommitperflush; /* Min number of commits in a flush. */
  550. };
  552. /*******************************************************
  553.  * Shared buffer cache (mpool).
  554.  *******************************************************/
  555. /* Flag values for DB_MPOOLFILE->get. */
  556. #define DB_MPOOL_CREATE 0x001 /* Create a page. */
  557. #define DB_MPOOL_LAST 0x002 /* Return the last page. */
  558. #define DB_MPOOL_NEW 0x004 /* Create a new page. */
  560. /* Flag values for DB_MPOOLFILE->put, DB_MPOOLFILE->set. */
  561. #define DB_MPOOL_CLEAN 0x001 /* Page is not modified. */
  562. #define DB_MPOOL_DIRTY 0x002 /* Page is modified. */
  563. #define DB_MPOOL_DISCARD 0x004 /* Don't cache the page. */
  565. /* Priority values for DB_MPOOLFILE->set_priority. */
  566. typedef enum {
  567. DB_PRIORITY_VERY_LOW=1,
  568. DB_PRIORITY_LOW=2,
  569. DB_PRIORITY_DEFAULT=3,
  570. DB_PRIORITY_HIGH=4,
  571. DB_PRIORITY_VERY_HIGH=5
  572. } DB_CACHE_PRIORITY;
  574. /* Per-process DB_MPOOLFILE information. */
  575. struct __db_mpoolfile {
  576. /* These fields need to be protected for multi-threaded support. */
  577. DB_MUTEX *mutexp; /* Structure thread lock. */
  579. DB_FH   *fhp; /* Underlying file handle. */
  581. u_int32_t  ref; /* Reference count. */
  583. /*
  584.  * !!!
  585.  * The pinref and q fields are protected by the region lock, not the
  586.  * DB_MPOOLFILE structure mutex.  We don't use the structure mutex
  587.  * because then I/O (which holds the structure lock held because of
  588.  * the race between the seek and write of the file descriptor) would
  589.  * block any other put/get calls using this DB_MPOOLFILE structure.
  590.  */
  591. u_int32_t pinref; /* Pinned block reference count. */
  593. /*
  594.  * !!!
  595.  * Explicit representations of structures from queue.h.
  596.  * TAILQ_ENTRY(__db_mpoolfile) q;
  597.  */
  598. struct {
  599. struct __db_mpoolfile *tqe_next;
  600. struct __db_mpoolfile **tqe_prev;
  601. } q; /* Linked list of DB_MPOOLFILE's. */
  603. /*
  604.  * These fields are not thread-protected because they are initialized
  605.  * when the file is opened and never modified.
  606.  */
  607. int   ftype; /* File type. */
  608. DBT  *pgcookie; /* Byte-string passed to pgin/pgout. */
  609. u_int8_t *fileid; /* Unique file ID. */
  610. int32_t   lsn_offset; /* LSN offset in page. */
  611. u_int32_t clear_len; /* Cleared length on created pages. */
  613. DB_MPOOL  *dbmp; /* Overlying DB_MPOOL. */
  614. MPOOLFILE *mfp; /* Underlying MPOOLFILE. */
  616. void   *addr; /* Address of mmap'd region. */
  617. size_t    len; /* Length of mmap'd region. */
  619. /* Methods. */
  620. int  (*close) __P((DB_MPOOLFILE *, u_int32_t));
  621. int  (*get) __P((DB_MPOOLFILE *, db_pgno_t *, u_int32_t, void *));
  622. void (*get_fileid) __P((DB_MPOOLFILE *, u_int8_t *));
  623. void (*last_pgno) __P((DB_MPOOLFILE *, db_pgno_t *));
  624. int  (*open)__P((DB_MPOOLFILE *, const char *, u_int32_t, int, size_t));
  625. int  (*put) __P((DB_MPOOLFILE *, void *, u_int32_t));
  626. void (*refcnt) __P((DB_MPOOLFILE *, db_pgno_t *));
  627. int  (*set) __P((DB_MPOOLFILE *, void *, u_int32_t));
  628. int  (*set_clear_len) __P((DB_MPOOLFILE *, u_int32_t));
  629. int  (*set_fileid) __P((DB_MPOOLFILE *, u_int8_t *));
  630. int  (*set_ftype) __P((DB_MPOOLFILE *, int));
  631. int  (*set_lsn_offset) __P((DB_MPOOLFILE *, int32_t));
  632. int  (*set_pgcookie) __P((DB_MPOOLFILE *, DBT *));
  633. int  (*set_priority) __P((DB_MPOOLFILE *, DB_CACHE_PRIORITY));
  634. void (*set_unlink) __P((DB_MPOOLFILE *, int));
  635. int  (*sync) __P((DB_MPOOLFILE *));
  637. /*
  638.  * MP_OPEN_CALLED and MP_READONLY do not need to be thread protected
  639.  * because they are initialized when the file is opened, and never
  640.  * modified.
  641.  *
  642.  * MP_FLUSH, MP_UPGRADE and MP_UPGRADE_FAIL are thread protected
  643.  * becase they are potentially read by multiple threads of control.
  644.  */
  645. #define MP_FLUSH 0x001 /* Was opened to flush a buffer. */
  646. #define MP_OPEN_CALLED 0x002 /* File opened. */
  647. #define MP_READONLY 0x004 /* File is readonly. */
  648. #define MP_UPGRADE 0x008 /* File descriptor is readwrite. */
  649. #define MP_UPGRADE_FAIL 0x010 /* Upgrade wasn't possible. */
  650. u_int32_t  flags;
  651. };
  653. /*
  654.  * Mpool statistics structure.
  655.  */
  656. struct __db_mpool_stat {
  657. u_int32_t st_gbytes; /* Total cache size: GB. */
  658. u_int32_t st_bytes; /* Total cache size: B. */
  659. u_int32_t st_ncache; /* Number of caches. */
  660. u_int32_t st_regsize; /* Cache size. */
  661. u_int32_t st_map; /* Pages from mapped files. */
  662. u_int32_t st_cache_hit; /* Pages found in the cache. */
  663. u_int32_t st_cache_miss; /* Pages not found in the cache. */
  664. u_int32_t st_page_create; /* Pages created in the cache. */
  665. u_int32_t st_page_in; /* Pages read in. */
  666. u_int32_t st_page_out; /* Pages written out. */
  667. u_int32_t st_ro_evict; /* Clean pages forced from the cache. */
  668. u_int32_t st_rw_evict; /* Dirty pages forced from the cache. */
  669. u_int32_t st_page_trickle; /* Pages written by memp_trickle. */
  670. u_int32_t st_pages; /* Total number of pages. */
  671. u_int32_t st_page_clean; /* Clean pages. */
  672. u_int32_t st_page_dirty; /* Dirty pages. */
  673. u_int32_t st_hash_buckets; /* Number of hash buckets. */
  674. u_int32_t st_hash_searches; /* Total hash chain searches. */
  675. u_int32_t st_hash_longest; /* Longest hash chain searched. */
  676. u_int32_t st_hash_examined; /* Total hash entries searched. */
  677. u_int32_t st_hash_nowait; /* Hash lock granted with nowait. */
  678. u_int32_t st_hash_wait; /* Hash lock granted after wait. */
  679. u_int32_t st_hash_max_wait; /* Max hash lock granted after wait. */
  680. u_int32_t st_region_nowait; /* Region lock granted with nowait. */
  681. u_int32_t st_region_wait; /* Region lock granted after wait. */
  682. u_int32_t st_alloc; /* Number of page allocations. */
  683. u_int32_t st_alloc_buckets; /* Buckets checked during allocation. */
  684. u_int32_t st_alloc_max_buckets; /* Max checked during allocation. */
  685. u_int32_t st_alloc_pages; /* Pages checked during allocation. */
  686. u_int32_t st_alloc_max_pages; /* Max checked during allocation. */
  687. };
  689. /* Mpool file statistics structure. */
  690. struct __db_mpool_fstat {
  691. char *file_name; /* File name. */
  692. size_t st_pagesize; /* Page size. */
  693. u_int32_t st_map; /* Pages from mapped files. */
  694. u_int32_t st_cache_hit; /* Pages found in the cache. */
  695. u_int32_t st_cache_miss; /* Pages not found in the cache. */
  696. u_int32_t st_page_create; /* Pages created in the cache. */
  697. u_int32_t st_page_in; /* Pages read in. */
  698. u_int32_t st_page_out; /* Pages written out. */
  699. };
  701. /*******************************************************
  702.  * Transactions and recovery.
  703.  *******************************************************/
  704. #define DB_TXNVERSION 1
  706. typedef enum {
  707. DB_TXN_ABORT=0, /* Public. */
  708. DB_TXN_APPLY=1, /* Public. */
  709. DB_TXN_BACKWARD_ALLOC=2, /* Internal. */
  710. DB_TXN_BACKWARD_ROLL=3, /* Public. */
  711. DB_TXN_FORWARD_ROLL=4, /* Public. */
  712. DB_TXN_GETPGNOS=5, /* Internal. */
  713. DB_TXN_OPENFILES=6, /* Internal. */
  714. DB_TXN_POPENFILES=7, /* Internal. */
  715. DB_TXN_PRINT=8 /* Public. */
  716. } db_recops;
  718. /*
  719.  * BACKWARD_ALLOC is used during the forward pass to pick up any aborted
  720.  * allocations for files that were created during the forward pass.
  721.  * The main difference between _ALLOC and _ROLL is that the entry for
  722.  * the file not exist during the rollforward pass.
  723.  */
  724. #define DB_UNDO(op) ((op) == DB_TXN_ABORT ||
  725. (op) == DB_TXN_BACKWARD_ROLL || (op) == DB_TXN_BACKWARD_ALLOC)
  726. #define DB_REDO(op) ((op) == DB_TXN_FORWARD_ROLL || (op) == DB_TXN_APPLY)
  728. struct __db_txn {
  729. DB_TXNMGR *mgrp; /* Pointer to transaction manager. */
  730. DB_TXN *parent; /* Pointer to transaction's parent. */
  731. DB_LSN last_lsn; /* Lsn of last log write. */
  732. u_int32_t txnid; /* Unique transaction id. */
  733. roff_t off; /* Detail structure within region. */
  734. db_timeout_t lock_timeout; /* Timeout for locks for this txn. */
  735. db_timeout_t expire; /* Time this txn expires. */
  736. void *txn_list; /* Undo information for parent. */
  738. /*
  739.  * !!!
  740.  * Explicit representations of structures from queue.h.
  741.  * TAILQ_ENTRY(__db_txn) links;
  742.  */
  743. struct {
  744. struct __db_txn *tqe_next;
  745. struct __db_txn **tqe_prev;
  746. } links; /* Links transactions off manager. */
  748. /*
  749.  * !!!
  750.  * Explicit representations of structures from queue.h.
  751.  * TAILQ_HEAD(__events, __txn_event) events;
  752.  */
  753. struct {
  754. struct __txn_event *tqh_first;
  755. struct __txn_event **tqh_last;
  756. } events;
  758. /*
  759.  * !!!
  760.  * Explicit representations of structures from queue.h.
  761.  * TAILQ_HEAD(__kids, __db_txn) kids;
  762.  */
  763. struct __kids {
  764. struct __db_txn *tqh_first;
  765. struct __db_txn **tqh_last;
  766. } kids;
  768. /*
  769.  * !!!
  770.  * Explicit representations of structures from queue.h.
  771.  * TAILQ_ENTRY(__db_txn) klinks;
  772.  */
  773. struct {
  774. struct __db_txn *tqe_next;
  775. struct __db_txn **tqe_prev;
  776. } klinks;
  778. /* API-private structure: used by C++ */
  779. void *api_internal;
  781. u_int32_t cursors; /* Number of cursors open for txn */
  783. /* Methods. */
  784. int   (*abort) __P((DB_TXN *));
  785. int   (*commit) __P((DB_TXN *, u_int32_t));
  786. int   (*discard) __P((DB_TXN *, u_int32_t));
  787. u_int32_t (*id) __P((DB_TXN *));
  788. int   (*prepare) __P((DB_TXN *, u_int8_t *));
  789. int   (*set_timeout) __P((DB_TXN *, db_timeout_t, u_int32_t));
  791. #define TXN_CHILDCOMMIT 0x01 /* Transaction that has committed. */
  792. #define TXN_COMPENSATE 0x02 /* Compensating transaction. */
  793. #define TXN_DIRTY_READ 0x04 /* Transaction does dirty reads. */
  794. #define TXN_LOCKTIMEOUT 0x08 /* Transaction has a lock timeout. */
  795. #define TXN_MALLOC 0x10 /* Structure allocated by TXN system. */
  796. #define TXN_NOSYNC 0x20 /* Do not sync on prepare and commit. */
  797. #define TXN_NOWAIT 0x40 /* Do not wait on locks. */
  798. #define TXN_SYNC 0x80 /* Sync on prepare and commit. */
  799. u_int32_t flags;
  800. };
  802. /* Transaction statistics structure. */
  803. struct __db_txn_active {
  804. u_int32_t txnid; /* Transaction ID */
  805. u_int32_t parentid; /* Transaction ID of parent */
  806. DB_LSN lsn; /* LSN when transaction began */
  807. };
  809. struct __db_txn_stat {
  810. DB_LSN   st_last_ckp; /* lsn of the last checkpoint */
  811. time_t   st_time_ckp; /* time of last checkpoint */
  812. u_int32_t st_last_txnid; /* last transaction id given out */
  813. u_int32_t st_maxtxns; /* maximum txns possible */
  814. u_int32_t st_naborts; /* number of aborted transactions */
  815. u_int32_t st_nbegins; /* number of begun transactions */
  816. u_int32_t st_ncommits; /* number of committed transactions */
  817. u_int32_t st_nactive; /* number of active transactions */
  818. u_int32_t st_nrestores; /* number of restored transactions
  819.    after recovery. */
  820. u_int32_t st_maxnactive; /* maximum active transactions */
  821. DB_TXN_ACTIVE *st_txnarray; /* array of active transactions */
  822. u_int32_t st_region_wait; /* Region lock granted after wait. */
  823. u_int32_t st_region_nowait; /* Region lock granted without wait. */
  824. u_int32_t st_regsize; /* Region size. */
  825. };
  827. /*
  828.  * Structure used for two phase commit interface.  Berkeley DB support for two
  829.  * phase commit is compatible with the X/open XA interface.  The xa #define
  830.  * XIDDATASIZE defines the size of a global transaction ID.  We have our own
  831.  * version here which must have the same value.
  832.  */
  833. #define DB_XIDDATASIZE 128
  834. struct __db_preplist {
  835. DB_TXN *txn;
  836. u_int8_t gid[DB_XIDDATASIZE];
  837. };
  839. /*******************************************************
  840.  * Replication.
  841.  *******************************************************/
  842. /* Special, out-of-band environment IDs. */
  843. #define DB_EID_BROADCAST -1
  844. #define DB_EID_INVALID -2
  846. /* rep_start flags values */
  847. #define DB_REP_CLIENT 0x001
  848. #define DB_REP_LOGSONLY 0x002
  849. #define DB_REP_MASTER 0x004
  851. /* Replication statistics. */
  852. struct __db_rep_stat {
  853. /* !!!
  854.  * Many replication statistics fields cannot be protected by a mutex
  855.  * without an unacceptable performance penalty, since most message
  856.  * processing is done without the need to hold a region-wide lock.
  857.  * Fields whose comments end with a '+' may be updated without holding
  858.  * the replication or log mutexes (as appropriate), and thus may be
  859.  * off somewhat (or, on unreasonable architectures under unlucky
  860.  * circumstances, garbaged).
  861.  */
  862. u_int32_t st_status; /* Current replication status. */
  863. DB_LSN st_next_lsn; /* Next LSN to use or expect. */
  864. DB_LSN st_waiting_lsn; /* LSN we're awaiting, if any. */
  866. u_int32_t st_dupmasters; /* # of times a duplicate master
  867.    condition was detected.+ */
  868. int st_env_id; /* Current environment ID. */
  869. int st_env_priority; /* Current environment priority. */
  870. u_int32_t st_gen; /* Current generation number. */
  871. u_int32_t st_log_duplicated; /* Log records received multiply.+ */
  872. u_int32_t st_log_queued; /* Log records currently queued.+ */
  873. u_int32_t st_log_queued_max; /* Max. log records queued at once.+ */
  874. u_int32_t st_log_queued_total; /* Total # of log recs. ever queued.+ */
  875. u_int32_t st_log_records; /* Log records received and put.+ */
  876. u_int32_t st_log_requested; /* Log recs. missed and requested.+ */
  877. int st_master; /* Env. ID of the current master. */
  878. u_int32_t st_master_changes; /* # of times we've switched masters. */
  879. u_int32_t st_msgs_badgen; /* Messages with a bad generation #.+ */
  880. u_int32_t st_msgs_processed; /* Messages received and processed.+ */
  881. u_int32_t st_msgs_recover; /* Messages ignored because this site
  882.    was a client in recovery.+ */
  883. u_int32_t st_msgs_send_failures;/* # of failed message sends.+ */
  884. u_int32_t st_msgs_sent; /* # of successful message sends.+ */
  885. u_int32_t st_newsites; /* # of NEWSITE msgs. received.+ */
  886. int st_nsites; /* Current number of sites we will
  887.    assume during elections. */
  888. u_int32_t st_nthrottles; /* # of times we were throttled. */
  889. u_int32_t st_outdated; /* # of times we detected and returned
  890.    an OUTDATED condition.+ */
  891. u_int32_t st_txns_applied; /* # of transactions applied.+ */
  893. /* Elections generally. */
  894. u_int32_t st_elections; /* # of elections held.+ */
  895. u_int32_t st_elections_won; /* # of elections won by this site.+ */
  897. /* Statistics about an in-progress election. */
  898. int st_election_cur_winner; /* Current front-runner. */
  899. u_int32_t st_election_gen; /* Election generation number. */
  900. DB_LSN st_election_lsn; /* Max. LSN of current winner. */
  901. int st_election_nsites; /* # of "registered voters". */
  902. int st_election_priority; /* Current election priority. */
  903. int st_election_status; /* Current election status. */
  904. int st_election_tiebreaker; /* Election tiebreaker value. */
  905. int st_election_votes; /* Votes received in this round. */
  906. };
  908. /*******************************************************
  909.  * Access methods.
  910.  *******************************************************/
  911. typedef enum {
  912. DB_BTREE=1,
  913. DB_HASH=2,
  914. DB_RECNO=3,
  915. DB_QUEUE=4,
  916. DB_UNKNOWN=5 /* Figure it out on open. */
  917. } DBTYPE;
  919. #define DB_RENAMEMAGIC 0x030800 /* File has been renamed. */
  921. #define DB_BTREEVERSION 9 /* Current btree version. */
  922. #define DB_BTREEOLDVER 8 /* Oldest btree version supported. */
  923. #define DB_BTREEMAGIC 0x053162
  925. #define DB_HASHVERSION 8 /* Current hash version. */
  926. #define DB_HASHOLDVER 7 /* Oldest hash version supported. */
  927. #define DB_HASHMAGIC 0x061561
  929. #define DB_QAMVERSION 4 /* Current queue version. */
  930. #define DB_QAMOLDVER 3 /* Oldest queue version supported. */
  931. #define DB_QAMMAGIC 0x042253
  933. /*
  934.  * DB access method and cursor operation values.  Each value is an operation
  935.  * code to which additional bit flags are added.
  936.  */
  937. #define DB_AFTER  1 /* c_put() */
  938. #define DB_APPEND  2 /* put() */
  939. #define DB_BEFORE  3 /* c_put() */
  940. #define DB_CACHED_COUNTS  4 /* stat() */
  941. #define DB_COMMIT  5 /* log_put() (internal) */
  942. #define DB_CONSUME  6 /* get() */
  943. #define DB_CONSUME_WAIT  7 /* get() */
  944. #define DB_CURRENT  8 /* c_get(), c_put(), DB_LOGC->get() */
  945. #define DB_FAST_STAT  9 /* stat() */
  946. #define DB_FIRST 10 /* c_get(), DB_LOGC->get() */
  947. #define DB_GET_BOTH 11 /* get(), c_get() */
  948. #define DB_GET_BOTHC 12 /* c_get() (internal) */
  949. #define DB_GET_BOTH_RANGE 13 /* get(), c_get() */
  950. #define DB_GET_RECNO 14 /* c_get() */
  951. #define DB_JOIN_ITEM 15 /* c_get(); do not do primary lookup */
  952. #define DB_KEYFIRST 16 /* c_put() */
  953. #define DB_KEYLAST 17 /* c_put() */
  954. #define DB_LAST 18 /* c_get(), DB_LOGC->get() */
  955. #define DB_NEXT 19 /* c_get(), DB_LOGC->get() */
  956. #define DB_NEXT_DUP 20 /* c_get() */
  957. #define DB_NEXT_NODUP 21 /* c_get() */
  958. #define DB_NODUPDATA 22 /* put(), c_put() */
  959. #define DB_NOOVERWRITE 23 /* put() */
  960. #define DB_NOSYNC 24 /* close() */
  961. #define DB_POSITION 25 /* c_dup() */
  962. #define DB_POSITIONI 26 /* c_dup() (internal) */
  963. #define DB_PREV 27 /* c_get(), DB_LOGC->get() */
  964. #define DB_PREV_NODUP 28 /* c_get(), DB_LOGC->get() */
  965. #define DB_RECORDCOUNT 29 /* stat() */
  966. #define DB_SET 30 /* c_get(), DB_LOGC->get() */
  967. #define DB_SET_LOCK_TIMEOUT 31 /* set_timout() */
  968. #define DB_SET_RANGE 32 /* c_get() */
  969. #define DB_SET_RECNO 33 /* get(), c_get() */
  970. #define DB_SET_TXN_NOW 34 /* set_timout() (internal) */
  971. #define DB_SET_TXN_TIMEOUT 35 /* set_timout() */
  972. #define DB_UPDATE_SECONDARY 36 /* c_get(), c_del() (internal) */
  973. #define DB_WRITECURSOR 37 /* cursor() */
  974. #define DB_WRITELOCK 38 /* cursor() (internal) */
  976. /* This has to change when the max opcode hits 255. */
  977. #define DB_OPFLAGS_MASK 0x000000ff /* Mask for operations flags. */
  978. /* DB_DIRTY_READ 0x01000000    Dirty Read. */
  979. #define DB_FLUSH 0x02000000 /* Flush data to disk. */
  980. #define DB_MULTIPLE 0x04000000 /* Return multiple data values. */
  981. #define DB_MULTIPLE_KEY 0x08000000 /* Return multiple data/key pairs. */
  982. #define DB_NOCOPY 0x10000000 /* Don't copy data */
  983. #define DB_PERMANENT 0x20000000 /* Flag record with REP_PERMANENT. */
  984. #define DB_RMW 0x40000000 /* Acquire write flag immediately. */
  985. #define DB_WRNOSYNC 0x80000000 /* Private: write, don't sync log_put */
  987. /*
  988.  * DB (user visible) error return codes.
  989.  *
  990.  * !!!
  991.  * For source compatibility with DB 2.X deadlock return (EAGAIN), use the
  992.  * following:
  993.  * #include <errno.h>
  994.  * #define DB_LOCK_DEADLOCK EAGAIN
  995.  *
  996.  * !!!
  997.  * We don't want our error returns to conflict with other packages where
  998.  * possible, so pick a base error value that's hopefully not common.  We
  999.  * document that we own the error name space from -30,800 to -30,999.
  1000.  */
  1001. /* DB (public) error return codes. */
  1002. #define DB_DONOTINDEX (-30999)/* "Null" return from 2ndary callbk. */
  1003. #define DB_KEYEMPTY (-30998)/* Key/data deleted or never created. */
  1004. #define DB_KEYEXIST (-30997)/* The key/data pair already exists. */
  1005. #define DB_LOCK_DEADLOCK (-30996)/* Deadlock. */
  1006. #define DB_LOCK_NOTGRANTED (-30995)/* Lock unavailable. */
  1007. #define DB_NOSERVER (-30994)/* Server panic return. */
  1008. #define DB_NOSERVER_HOME (-30993)/* Bad home sent to server. */
  1009. #define DB_NOSERVER_ID (-30992)/* Bad ID sent to server. */
  1010. #define DB_NOTFOUND (-30991)/* Key/data pair not found (EOF). */
  1011. #define DB_OLD_VERSION (-30990)/* Out-of-date version. */
  1012. #define DB_PAGE_NOTFOUND (-30989)/* Requested page not found. */
  1013. #define DB_REP_DUPMASTER (-30988)/* There are two masters. */
  1014. #define DB_REP_HOLDELECTION (-30987)/* Time to hold an election. */
  1015. #define DB_REP_NEWMASTER (-30986)/* We have learned of a new master. */
  1016. #define DB_REP_NEWSITE (-30985)/* New site entered system. */
  1017. #define DB_REP_OUTDATED (-30984)/* Site is too far behind master. */
  1018. #define DB_REP_UNAVAIL (-30983)/* Site cannot currently be reached. */
  1019. #define DB_RUNRECOVERY (-30982)/* Panic return. */
  1020. #define DB_SECONDARY_BAD (-30981)/* Secondary index corrupt. */
  1021. #define DB_VERIFY_BAD (-30980)/* Verify failed; bad format. */
  1023. /* DB (private) error return codes. */
  1024. #define DB_ALREADY_ABORTED (-30899)
  1025. #define DB_DELETED (-30898)/* Recovery file marked deleted. */
  1026. #define DB_JAVA_CALLBACK (-30897)/* Exception during a java callback. */
  1027. #define DB_LOCK_NOTEXIST (-30896)/* Object to lock is gone. */
  1028. #define DB_NEEDSPLIT (-30895)/* Page needs to be split. */
  1029. #define DB_SURPRISE_KID (-30894)/* Child commit where parent
  1030.    didn't know it was a parent. */
  1031. #define DB_SWAPBYTES (-30893)/* Database needs byte swapping. */
  1032. #define DB_TIMEOUT (-30892)/* Timed out waiting for election. */
  1033. #define DB_TXN_CKP (-30891)/* Encountered ckp record in log. */
  1034. #define DB_VERIFY_FATAL (-30890)/* DB->verify cannot proceed. */
  1036. /* Database handle. */
  1037. struct __db {
  1038. /*******************************************************
  1039.  * Public: owned by the application.
  1040.  *******************************************************/
  1041. u_int32_t pgsize; /* Database logical page size. */
  1043. /* Callbacks. */
  1044. int (*db_append_recno) __P((DB *, DBT *, db_recno_t));
  1045. void (*db_feedback) __P((DB *, int, int));
  1046. int (*dup_compare) __P((DB *, const DBT *, const DBT *));
  1048. void *app_private; /* Application-private handle. */
  1050. /*******************************************************
  1051.  * Private: owned by DB.
  1052.  *******************************************************/
  1053. DB_ENV *dbenv; /* Backing environment. */
  1055. DBTYPE  type; /* DB access method type. */
  1057. DB_MPOOLFILE *mpf; /* Backing buffer pool. */
  1058. DB_CACHE_PRIORITY priority; /* Priority in the buffer pool. */
  1060. DB_MUTEX *mutexp; /* Synchronization for free threading */
  1062. u_int8_t fileid[DB_FILE_ID_LEN];/* File's unique ID for locking. */
  1064. u_int32_t adj_fileid; /* File's unique ID for curs. adj. */
  1066. #define DB_LOGFILEID_INVALID -1
  1067. FNAME *log_filename; /* File's naming info for logging. */
  1069. db_pgno_t meta_pgno; /* Meta page number */
  1070. u_int32_t lid; /* Locker id for handle locking. */
  1071. u_int32_t cur_lid; /* Current handle lock holder. */
  1072. u_int32_t associate_lid; /* Locker id for DB->associate call. */
  1073. DB_LOCK handle_lock; /* Lock held on this handle. */
  1075. long  cl_id; /* RPC: remote client id. */
  1077. /*
  1078.  * Returned data memory for DB->get() and friends.
  1079.  */
  1080. DBT  my_rskey; /* Secondary key. */
  1081. DBT  my_rkey; /* [Primary] key. */
  1082. DBT  my_rdata; /* Data. */
  1084. /*
  1085.  * !!!
  1086.  * Some applications use DB but implement their own locking outside of
  1087.  * DB.  If they're using fcntl(2) locking on the underlying database
  1088.  * file, and we open and close a file descriptor for that file, we will
  1089.  * discard their locks.  The DB_FCNTL_LOCKING flag to DB->open is an
  1090.  * undocumented interface to support this usage which leaves any file
  1091.  * descriptors we open until DB->close.  This will only work with the
  1092.  * DB->open interface and simple caches, e.g., creating a transaction
  1093.  * thread may open/close file descriptors this flag doesn't protect.
  1094.  * Locking with fcntl(2) on a file that you don't own is a very, very
  1095.  * unsafe thing to do.  'Nuff said.
  1096.  */
  1097. DB_FH *saved_open_fhp; /* Saved file handle. */
  1099. /*
  1100.  * Linked list of DBP's, linked from the DB_ENV, used to keep track
  1101.  * of all open db handles for cursor adjustment.
  1102.  *
  1103.  * !!!
  1104.  * Explicit representations of structures from queue.h.
  1105.  * LIST_ENTRY(__db) dblistlinks;
  1106.  */
  1107. struct {
  1108. struct __db *le_next;
  1109. struct __db **le_prev;
  1110. } dblistlinks;
  1112. /*
  1113.  * Cursor queues.
  1114.  *
  1115.  * !!!
  1116.  * Explicit representations of structures from queue.h.
  1117.  * TAILQ_HEAD(__cq_fq, __dbc) free_queue;
  1118.  * TAILQ_HEAD(__cq_aq, __dbc) active_queue;
  1119.  * TAILQ_HEAD(__cq_jq, __dbc) join_queue;
  1120.  */
  1121. struct __cq_fq {
  1122. struct __dbc *tqh_first;
  1123. struct __dbc **tqh_last;
  1124. } free_queue;
  1125. struct __cq_aq {
  1126. struct __dbc *tqh_first;
  1127. struct __dbc **tqh_last;
  1128. } active_queue;
  1129. struct __cq_jq {
  1130. struct __dbc *tqh_first;
  1131. struct __dbc **tqh_last;
  1132. } join_queue;
  1134. /*
  1135.  * Secondary index support.
  1136.  *
  1137.  * Linked list of secondary indices -- set in the primary.
  1138.  *
  1139.  * !!!
  1140.  * Explicit representations of structures from queue.h.
  1141.  * LIST_HEAD(s_secondaries, __db);
  1142.  */
  1143. struct {
  1144. struct __db *lh_first;
  1145. } s_secondaries;
  1147. /*
  1148.  * List entries for secondaries, and reference count of how
  1149.  * many threads are updating this secondary (see __db_c_put).
  1150.  *
  1151.  * !!!
  1152.  * Note that these are synchronized by the primary's mutex, but
  1153.  * filled in in the secondaries.
  1154.  *
  1155.  * !!!
  1156.  * Explicit representations of structures from queue.h.
  1157.  * LIST_ENTRY(__db) s_links;
  1158.  */
  1159. struct {
  1160. struct __db *le_next;
  1161. struct __db **le_prev;
  1162. } s_links;
  1163. u_int32_t s_refcnt;
  1165. /* Secondary callback and free functions -- set in the secondary. */
  1166. int (*s_callback) __P((DB *, const DBT *, const DBT *, DBT *));
  1168. /* Reference to primary -- set in the secondary. */
  1169. DB *s_primary;
  1171. /* API-private structure: used by DB 1.85, C++, Java, Perl and Tcl */
  1172. void *api_internal;
  1174. /* Subsystem-private structure. */
  1175. void *bt_internal; /* Btree/Recno access method. */
  1176. void *h_internal; /* Hash access method. */
  1177. void *q_internal; /* Queue access method. */
  1178. void *xa_internal; /* XA. */
  1180. /* Methods. */
  1181. int  (*associate) __P((DB *, DB_TXN *, DB *, int (*)(DB *, const DBT *,
  1182. const DBT *, DBT *), u_int32_t));
  1183. int  (*close) __P((DB *, u_int32_t));
  1184. int  (*cursor) __P((DB *, DB_TXN *, DBC **, u_int32_t));
  1185. int  (*del) __P((DB *, DB_TXN *, DBT *, u_int32_t));
  1186. void (*err) __P((DB *, int, const char *, ...));
  1187. void (*errx) __P((DB *, const char *, ...));
  1188. int  (*fd) __P((DB *, int *));
  1189. int  (*get) __P((DB *, DB_TXN *, DBT *, DBT *, u_int32_t));
  1190. int  (*pget) __P((DB *, DB_TXN *, DBT *, DBT *, DBT *, u_int32_t));
  1191. int  (*get_byteswapped) __P((DB *, int *));
  1192. int  (*get_type) __P((DB *, DBTYPE *));
  1193. int  (*join) __P((DB *, DBC **, DBC **, u_int32_t));
  1194. int  (*key_range) __P((DB *,
  1195. DB_TXN *, DBT *, DB_KEY_RANGE *, u_int32_t));
  1196. int  (*open) __P((DB *, DB_TXN *,
  1197. const char *, const char *, DBTYPE, u_int32_t, int));
  1198. int  (*put) __P((DB *, DB_TXN *, DBT *, DBT *, u_int32_t));
  1199. int  (*remove) __P((DB *, const char *, const char *, u_int32_t));
  1200. int  (*rename) __P((DB *,
  1201.     const char *, const char *, const char *, u_int32_t));
  1202. int  (*truncate) __P((DB *, DB_TXN *, u_int32_t *, u_int32_t));
  1203. int  (*set_append_recno) __P((DB *, int (*)(DB *, DBT *, db_recno_t)));
  1204. int  (*set_alloc) __P((DB *, void *(*)(size_t),
  1205. void *(*)(void *, size_t), void (*)(void *)));
  1206. int  (*set_cachesize) __P((DB *, u_int32_t, u_int32_t, int));
  1207. int  (*set_cache_priority) __P((DB *, DB_CACHE_PRIORITY));
  1208. int  (*set_dup_compare) __P((DB *,
  1209.     int (*)(DB *, const DBT *, const DBT *)));
  1210. int  (*set_encrypt) __P((DB *, const char *, u_int32_t));
  1211. void (*set_errcall) __P((DB *, void (*)(const char *, char *)));
  1212. void (*set_errfile) __P((DB *, FILE *));
  1213. void (*set_errpfx) __P((DB *, const char *));
  1214. int  (*set_feedback) __P((DB *, void (*)(DB *, int, int)));
  1215. int  (*set_flags) __P((DB *, u_int32_t));
  1216. int  (*set_lorder) __P((DB *, int));
  1217. int  (*set_pagesize) __P((DB *, u_int32_t));
  1218. int  (*set_paniccall) __P((DB *, void (*)(DB_ENV *, int)));
  1219. int  (*stat) __P((DB *, void *, u_int32_t));
  1220. int  (*sync) __P((DB *, u_int32_t));
  1221. int  (*upgrade) __P((DB *, const char *, u_int32_t));
  1222. int  (*verify) __P((DB *,
  1223.     const char *, const char *, FILE *, u_int32_t));
  1225. int  (*set_bt_compare) __P((DB *,
  1226.     int (*)(DB *, const DBT *, const DBT *)));
  1227. int  (*set_bt_maxkey) __P((DB *, u_int32_t));
  1228. int  (*set_bt_minkey) __P((DB *, u_int32_t));
  1229. int  (*set_bt_prefix) __P((DB *,
  1230.     size_t (*)(DB *, const DBT *, const DBT *)));
  1232. int  (*set_h_ffactor) __P((DB *, u_int32_t));
  1233. int  (*set_h_hash) __P((DB *,
  1234.     u_int32_t (*)(DB *, const void *, u_int32_t)));
  1235. int  (*set_h_nelem) __P((DB *, u_int32_t));
  1237. int  (*set_re_delim) __P((DB *, int));
  1238. int  (*set_re_len) __P((DB *, u_int32_t));
  1239. int  (*set_re_pad) __P((DB *, int));
  1240. int  (*set_re_source) __P((DB *, const char *));
  1241. int  (*set_q_extentsize) __P((DB *, u_int32_t));
  1243. int  (*db_am_remove) __P((DB *,
  1244.     DB_TXN *, const char *, const char *, DB_LSN *));
  1245. int  (*db_am_rename) __P((DB *, DB_TXN *,
  1246.     const char *, const char *, const char *));
  1248. /*
  1249.  * Never called; these are a place to save function pointers
  1250.  * so that we can undo an associate.
  1251.  */
  1252. int  (*stored_get) __P((DB *, DB_TXN *, DBT *, DBT *, u_int32_t));
  1253. int  (*stored_close) __P((DB *, u_int32_t));
  1255. #define DB_OK_BTREE 0x01
  1256. #define DB_OK_HASH 0x02
  1257. #define DB_OK_QUEUE 0x04
  1258. #define DB_OK_RECNO 0x08
  1259. u_int32_t am_ok; /* Legal AM choices. */
  1261. #define DB_AM_CHKSUM 0x00000001 /* Checksumming. */
  1262. #define DB_AM_CL_WRITER 0x00000002 /* Allow writes in client replica. */
  1263. #define DB_AM_COMPENSATE 0x00000004 /* Created by compensating txn. */
  1264. #define DB_AM_CREATED 0x00000008 /* Database was created upon open. */
  1265. #define DB_AM_CREATED_MSTR 0x00000010 /* Encompassing file was created. */
  1266. #define DB_AM_DBM_ERROR 0x00000020 /* Error in DBM/NDBM database. */
  1267. #define DB_AM_DELIMITER 0x00000040 /* Variable length delimiter set. */
  1268. #define DB_AM_DIRTY 0x00000080 /* Support Dirty Reads. */
  1269. #define DB_AM_DISCARD 0x00000100 /* Discard any cached pages. */
  1270. #define DB_AM_DUP 0x00000200 /* DB_DUP. */
  1271. #define DB_AM_DUPSORT 0x00000400 /* DB_DUPSORT. */
  1272. #define DB_AM_ENCRYPT 0x00000800 /* Encryption. */
  1273. #define DB_AM_FIXEDLEN 0x00001000 /* Fixed-length records. */
  1274. #define DB_AM_INMEM 0x00002000 /* In-memory; no sync on close. */
  1275. #define DB_AM_IN_RENAME 0x00004000 /* File is being renamed. */
  1276. #define DB_AM_OPEN_CALLED 0x00008000 /* DB->open called. */
  1277. #define DB_AM_PAD 0x00010000 /* Fixed-length record pad. */
  1278. #define DB_AM_PGDEF 0x00020000 /* Page size was defaulted. */
  1279. #define DB_AM_RDONLY 0x00040000 /* Database is readonly. */
  1280. #define DB_AM_RECNUM 0x00080000 /* DB_RECNUM. */
  1281. #define DB_AM_RECOVER 0x00100000 /* DB opened by recovery routine. */
  1282. #define DB_AM_RENUMBER 0x00200000 /* DB_RENUMBER. */
  1283. #define DB_AM_REVSPLITOFF 0x00400000 /* DB_REVSPLITOFF. */
  1284. #define DB_AM_SECONDARY 0x00800000 /* Database is a secondary index. */
  1285. #define DB_AM_SNAPSHOT 0x01000000 /* DB_SNAPSHOT. */
  1286. #define DB_AM_SUBDB 0x02000000 /* Subdatabases supported. */
  1287. #define DB_AM_SWAP 0x04000000 /* Pages need to be byte-swapped. */
  1288. #define DB_AM_TXN 0x08000000 /* Opened in a transaction. */
  1289. #define DB_AM_VERIFYING 0x10000000 /* DB handle is in the verifier. */
  1290. u_int32_t flags;
  1291. };
  1293. /*
  1294.  * Macros for bulk get.  Note that wherever we use a DBT *, we explicitly
  1295.  * cast it; this allows the same macros to work with C++ Dbt *'s, as Dbt
  1296.  * is a subclass of struct DBT in C++.
  1297.  */
  1298. #define DB_MULTIPLE_INIT(pointer, dbt)
  1299. (pointer = (u_int8_t *)((DBT *)(dbt))->data +
  1300.     ((DBT *)(dbt))->ulen - sizeof(u_int32_t))
  1301. #define DB_MULTIPLE_NEXT(pointer, dbt, retdata, retdlen)
  1302. do {
  1303. if (*((u_int32_t *)(pointer)) == (u_int32_t)-1) {
  1304. retdata = NULL;
  1305. pointer = NULL;
  1306. break;
  1307. }
  1308. retdata = (u_int8_t *)
  1309.     ((DBT *)(dbt))->data + *(u_int32_t *)(pointer);
  1310. (pointer) = (u_int32_t *)(pointer) - 1;
  1311. retdlen = *(u_int32_t *)(pointer);
  1312. (pointer) = (u_int32_t *)(pointer) - 1;
  1313. if (retdlen == 0 &&
  1314.     retdata == (u_int8_t *)((DBT *)(dbt))->data)
  1315. retdata = NULL;
  1316. } while (0)
  1317. #define DB_MULTIPLE_KEY_NEXT(pointer, dbt, retkey, retklen, retdata, retdlen) 
  1318. do {
  1319. if (*((u_int32_t *)(pointer)) == (u_int32_t)-1) {
  1320. retdata = NULL;
  1321. retkey = NULL;
  1322. pointer = NULL;
  1323. break;
  1324. }
  1325. retkey = (u_int8_t *)
  1326.     ((DBT *)(dbt))->data + *(u_int32_t *)(pointer);
  1327. (pointer) = (u_int32_t *)(pointer) - 1;
  1328. retklen = *(u_int32_t *)(pointer);
  1329. (pointer) = (u_int32_t *)(pointer) - 1;
  1330. retdata = (u_int8_t *)
  1331.     ((DBT *)(dbt))->data + *(u_int32_t *)(pointer);
  1332. (pointer) = (u_int32_t *)(pointer) - 1;
  1333. retdlen = *(u_int32_t *)(pointer);
  1334. (pointer) = (u_int32_t *)(pointer) - 1;
  1335. } while (0)
  1337. #define DB_MULTIPLE_RECNO_NEXT(pointer, dbt, recno, retdata, retdlen)   
  1338. do {
  1339. if (*((u_int32_t *)(pointer)) == (u_int32_t)0) {
  1340. recno = 0;
  1341. retdata = NULL;
  1342. pointer = NULL;
  1343. break;
  1344. }
  1345. recno = *(u_int32_t *)(pointer);
  1346. (pointer) = (u_int32_t *)(pointer) - 1;
  1347. retdata = (u_int8_t *)
  1348.     ((DBT *)(dbt))->data + *(u_int32_t *)(pointer);
  1349. (pointer) = (u_int32_t *)(pointer) - 1;
  1350. retdlen = *(u_int32_t *)(pointer);
  1351. (pointer) = (u_int32_t *)(pointer) - 1;
  1352. } while (0)
  1354. /*******************************************************
  1355.  * Access method cursors.
  1356.  *******************************************************/
  1357. struct __dbc {
  1358. DB *dbp; /* Related DB access method. */
  1359. DB_TXN  *txn; /* Associated transaction. */
  1361. /*
  1362.  * Active/free cursor queues.
  1363.  *
  1364.  * !!!
  1365.  * Explicit representations of structures from queue.h.
  1366.  * TAILQ_ENTRY(__dbc) links;
  1367.  */
  1368. struct {
  1369. DBC *tqe_next;
  1370. DBC **tqe_prev;
  1371. } links;
  1373. /*
  1374.  * The DBT *'s below are used by the cursor routines to return
  1375.  * data to the user when DBT flags indicate that DB should manage
  1376.  * the returned memory.  They point at a DBT containing the buffer
  1377.  * and length that will be used, and "belonging" to the handle that
  1378.  * should "own" this memory.  This may be a "my_*" field of this
  1379.  * cursor--the default--or it may be the corresponding field of
  1380.  * another cursor, a DB handle, a join cursor, etc.  In general, it
  1381.  * will be whatever handle the user originally used for the current
  1382.  * DB interface call.
  1383.  */
  1384. DBT  *rskey; /* Returned secondary key. */
  1385. DBT  *rkey; /* Returned [primary] key. */
  1386. DBT  *rdata; /* Returned data. */
  1388. DBT   my_rskey; /* Space for returned secondary key. */
  1389. DBT   my_rkey; /* Space for returned [primary] key. */
  1390. DBT   my_rdata; /* Space for returned data. */
  1392. u_int32_t lid; /* Default process' locker id. */
  1393. u_int32_t locker; /* Locker for this operation. */
  1394. DBT   lock_dbt; /* DBT referencing lock. */
  1395. DB_LOCK_ILOCK lock; /* Object to be locked. */
  1396. DB_LOCK   mylock; /* Lock held on this cursor. */
  1398. long   cl_id; /* Remote client id. */
  1400. DBTYPE   dbtype; /* Cursor type. */
  1402. DBC_INTERNAL *internal; /* Access method private. */
  1404. int (*c_close) __P((DBC *)); /* Methods: public. */
  1405. int (*c_count) __P((DBC *, db_recno_t *, u_int32_t));
  1406. int (*c_del) __P((DBC *, u_int32_t));
  1407. int (*c_dup) __P((DBC *, DBC **, u_int32_t));
  1408. int (*c_get) __P((DBC *, DBT *, DBT *, u_int32_t));
  1409. int (*c_pget) __P((DBC *, DBT *, DBT *, DBT *, u_int32_t));
  1410. int (*c_put) __P((DBC *, DBT *, DBT *, u_int32_t));
  1412. /* Methods: private. */
  1413. int (*c_am_bulk) __P((DBC *, DBT *, u_int32_t));
  1414. int (*c_am_close) __P((DBC *, db_pgno_t, int *));
  1415. int (*c_am_del) __P((DBC *));
  1416. int (*c_am_destroy) __P((DBC *));
  1417. int (*c_am_get) __P((DBC *, DBT *, DBT *, u_int32_t, db_pgno_t *));
  1418. int (*c_am_put) __P((DBC *, DBT *, DBT *, u_int32_t, db_pgno_t *));
  1419. int (*c_am_writelock) __P((DBC *));
  1421. /* Private: for secondary indices. */
  1422. int (*c_real_get) __P((DBC *, DBT *, DBT *, u_int32_t));
  1424. #define DBC_ACTIVE  0x0001 /* Cursor in use. */
  1425. #define DBC_COMPENSATE  0x0002 /* Cursor compensating, don't lock. */
  1426. #define DBC_DIRTY_READ  0x0004 /* Cursor supports dirty reads. */
  1427. #define DBC_OPD  0x0008 /* Cursor references off-page dups. */
  1428. #define DBC_RECOVER  0x0010 /* Recovery cursor; don't log/lock. */
  1429. #define DBC_RMW  0x0020 /* Acquire write flag in read op. */
  1430. #define DBC_TRANSIENT  0x0040 /* Cursor is transient. */
  1431. #define DBC_WRITECURSOR  0x0080 /* Cursor may be used to write (CDB). */
  1432. #define DBC_WRITEDUP  0x0100 /* idup'ed DBC_WRITECURSOR (CDB). */
  1433. #define DBC_WRITER  0x0200 /* Cursor immediately writing (CDB). */
  1434. #define DBC_MULTIPLE  0x0400 /* Return Multiple data. */
  1435. #define DBC_MULTIPLE_KEY 0x0800 /* Return Multiple keys and data. */
  1436. #define DBC_OWN_LID  0x1000 /* Free lock id on destroy. */
  1437. u_int32_t flags;
  1438. };
  1440. /* Key range statistics structure */
  1441. struct __key_range {
  1442. double less;
  1443. double equal;
  1444. double greater;
  1445. };
  1447. /* Btree/Recno statistics structure. */
  1448. struct __db_bt_stat {
  1449. u_int32_t bt_magic; /* Magic number. */
  1450. u_int32_t bt_version; /* Version number. */
  1451. u_int32_t bt_metaflags; /* Metadata flags. */
  1452. u_int32_t bt_nkeys; /* Number of unique keys. */
  1453. u_int32_t bt_ndata; /* Number of data items. */
  1454. u_int32_t bt_pagesize; /* Page size. */
  1455. u_int32_t bt_maxkey; /* Maxkey value. */
  1456. u_int32_t bt_minkey; /* Minkey value. */
  1457. u_int32_t bt_re_len; /* Fixed-length record length. */
  1458. u_int32_t bt_re_pad; /* Fixed-length record pad. */
  1459. u_int32_t bt_levels; /* Tree levels. */
  1460. u_int32_t bt_int_pg; /* Internal pages. */
  1461. u_int32_t bt_leaf_pg; /* Leaf pages. */
  1462. u_int32_t bt_dup_pg; /* Duplicate pages. */
  1463. u_int32_t bt_over_pg; /* Overflow pages. */
  1464. u_int32_t bt_free; /* Pages on the free list. */
  1465. u_int32_t bt_int_pgfree; /* Bytes free in internal pages. */
  1466. u_int32_t bt_leaf_pgfree; /* Bytes free in leaf pages. */
  1467. u_int32_t bt_dup_pgfree; /* Bytes free in duplicate pages. */
  1468. u_int32_t bt_over_pgfree; /* Bytes free in overflow pages. */
  1469. };
  1471. /* Hash statistics structure. */
  1472. struct __db_h_stat {
  1473. u_int32_t hash_magic; /* Magic number. */
  1474. u_int32_t hash_version; /* Version number. */
  1475. u_int32_t hash_metaflags; /* Metadata flags. */
  1476. u_int32_t hash_nkeys; /* Number of unique keys. */
  1477. u_int32_t hash_ndata; /* Number of data items. */
  1478. u_int32_t hash_pagesize; /* Page size. */
  1479. u_int32_t hash_ffactor; /* Fill factor specified at create. */
  1480. u_int32_t hash_buckets; /* Number of hash buckets. */
  1481. u_int32_t hash_free; /* Pages on the free list. */
  1482. u_int32_t hash_bfree; /* Bytes free on bucket pages. */
  1483. u_int32_t hash_bigpages; /* Number of big key/data pages. */
  1484. u_int32_t hash_big_bfree; /* Bytes free on big item pages. */
  1485. u_int32_t hash_overflows; /* Number of overflow pages. */
  1486. u_int32_t hash_ovfl_free; /* Bytes free on ovfl pages. */
  1487. u_int32_t hash_dup; /* Number of dup pages. */
  1488. u_int32_t hash_dup_free; /* Bytes free on duplicate pages. */
  1489. };
  1491. /* Queue statistics structure. */
  1492. struct __db_qam_stat {
  1493. u_int32_t qs_magic; /* Magic number. */
  1494. u_int32_t qs_version; /* Version number. */
  1495. u_int32_t qs_metaflags; /* Metadata flags. */
  1496. u_int32_t qs_nkeys; /* Number of unique keys. */
  1497. u_int32_t qs_ndata; /* Number of data items. */
  1498. u_int32_t qs_pagesize; /* Page size. */
  1499. u_int32_t qs_extentsize; /* Pages per extent. */
  1500. u_int32_t qs_pages; /* Data pages. */
  1501. u_int32_t qs_re_len; /* Fixed-length record length. */
  1502. u_int32_t qs_re_pad; /* Fixed-length record pad. */
  1503. u_int32_t qs_pgfree; /* Bytes free in data pages. */
  1504. u_int32_t qs_first_recno; /* First not deleted record. */
  1505. u_int32_t qs_cur_recno; /* Next available record number. */
  1506. };
  1508. /*******************************************************
  1509.  * Environment.
  1510.  *******************************************************/
  1511. #define DB_REGION_MAGIC 0x120897 /* Environment magic number. */
  1513. typedef enum {
  1514. DB_NOTICE_LOGFILE_CHANGED
  1515. } db_notices;
  1517. /* Database Environment handle. */
  1518. struct __db_env {
  1519. /*******************************************************
  1520.  * Public: owned by the application.
  1521.  *******************************************************/
  1522. FILE *db_errfile; /* Error message file stream. */
  1523. const char *db_errpfx; /* Error message prefix. */
  1524. /* Callbacks. */
  1525. void (*db_errcall) __P((const char *, char *));
  1526. void (*db_feedback) __P((DB_ENV *, int, int));
  1527. void (*db_paniccall) __P((DB_ENV *, int));
  1528. void (*db_noticecall) __P((DB_ENV *, db_notices));
  1530. /* App-specified alloc functions. */
  1531. void *(*db_malloc) __P((size_t));
  1532. void *(*db_realloc) __P((void *, size_t));
  1533. void (*db_free) __P((void *));
  1535. /*
  1536.  * Currently, the verbose list is a bit field with room for 32
  1537.  * entries.  There's no reason that it needs to be limited, if
  1538.  * there are ever more than 32 entries, convert to a bit array.
  1539.  */
  1540. #define DB_VERB_CHKPOINT 0x0001 /* List checkpoints. */
  1541. #define DB_VERB_DEADLOCK 0x0002 /* Deadlock detection information. */
  1542. #define DB_VERB_RECOVERY 0x0004 /* Recovery information. */
  1543. #define DB_VERB_REPLICATION 0x0008 /* Replication information. */
  1544. #define DB_VERB_WAITSFOR 0x0010 /* Dump waits-for table. */
  1545. u_int32_t  verbose; /* Verbose output. */
  1547. void *app_private; /* Application-private handle. */
  1549. int (*app_dispatch) /* User-specified recovery dispatch. */
  1550.     __P((DB_ENV *, DBT *, DB_LSN *, db_recops));
  1552. /* Locking. */
  1553. u_int8_t *lk_conflicts; /* Two dimensional conflict matrix. */
  1554. u_int32_t  lk_modes; /* Number of lock modes in table. */
  1555. u_int32_t  lk_max; /* Maximum number of locks. */
  1556. u_int32_t  lk_max_lockers;/* Maximum number of lockers. */
  1557. u_int32_t  lk_max_objects;/* Maximum number of locked objects. */
  1558. u_int32_t  lk_detect; /* Deadlock detect on all conflicts. */
  1559. db_timeout_t  lk_timeout; /* Lock timeout period. */
  1561. /* Logging. */
  1562. u_int32_t  lg_bsize; /* Buffer size. */
  1563. u_int32_t  lg_size; /* Log file size. */
  1564. u_int32_t  lg_regionmax; /* Region size. */
  1566. /* Memory pool. */
  1567. u_int32_t  mp_gbytes; /* Cachesize: GB. */
  1568. u_int32_t  mp_bytes; /* Cachesize: Bytes. */
  1569. size_t  mp_size; /* DEPRECATED: Cachesize: bytes. */
  1570. int  mp_ncache; /* Number of cache regions. */
  1571. size_t  mp_mmapsize; /* Maximum file size for mmap. */
  1573. int  rep_eid; /* environment id. */
  1575. /* Transactions. */
  1576. u_int32_t  tx_max; /* Maximum number of transactions. */
  1577. time_t  tx_timestamp; /* Recover to specific timestamp. */
  1578. db_timeout_t  tx_timeout; /* Timeout for transactions. */
  1580. /*******************************************************
  1581.  * Private: owned by DB.
  1582.  *******************************************************/
  1583. int  panic_errval; /* Panic causing errno. */
  1585. /* User files, paths. */
  1586. char *db_home; /* Database home. */
  1587. char *db_log_dir; /* Database log file directory. */
  1588. char *db_tmp_dir; /* Database tmp file directory. */
  1590. char        **db_data_dir; /* Database data file directories. */
  1591. int  data_cnt; /* Database data file slots. */
  1592. int  data_next; /* Next Database data file slot. */
  1594. int  db_mode; /* Default open permissions. */
  1596. void *reginfo; /* REGINFO structure reference. */
  1597. DB_FH *lockfhp; /* fcntl(2) locking file handle. */
  1599. int       (**recover_dtab) /* Dispatch table for recover funcs. */
  1600.     __P((DB_ENV *, DBT *, DB_LSN *, db_recops, void *));
  1601. size_t  recover_dtab_size;
  1602. /* Slots in the dispatch table. */
  1604. void *cl_handle; /* RPC: remote client handle. */
  1605. long  cl_id; /* RPC: remote client env id. */
  1607. int  db_ref; /* DB reference count. */
  1609. long  shm_key; /* shmget(2) key. */
  1610. u_int32_t  tas_spins; /* test-and-set spins. */
  1612. /*
  1613.  * List of open DB handles for this DB_ENV, used for cursor
  1614.  * adjustment.  Must be protected for multi-threaded support.
  1615.  *
  1616.  * !!!
  1617.  * As this structure is allocated in per-process memory, the
  1618.  * mutex may need to be stored elsewhere on architectures unable
  1619.  * to support mutexes in heap memory, e.g. HP/UX 9.
  1620.  *
  1621.  * !!!
  1622.  * Explicit representation of structure in queue.h.
  1623.  * LIST_HEAD(dblist, __db);
  1624.  */
  1625. DB_MUTEX *dblist_mutexp; /* Mutex. */
  1626. struct {
  1627. struct __db *lh_first;
  1628. } dblist;
  1630. /*
  1631.  * XA support.
  1632.  *
  1633.  * !!!
  1634.  * Explicit representations of structures from queue.h.
  1635.  * TAILQ_ENTRY(__db_env) links;
  1636.  */
  1637. struct {
  1638. struct __db_env *tqe_next;
  1639. struct __db_env **tqe_prev;
  1640. } links;
  1641. int  xa_rmid; /* XA Resource Manager ID. */
  1642. DB_TXN *xa_txn; /* XA Current transaction. */
  1644. /* API-private structure. */
  1645. void *api1_internal; /* C++, Perl API private */
  1646. void *api2_internal; /* Java API private */
  1648. char *passwd; /* Cryptography support. */
  1649. size_t  passwd_len;
  1650. void *crypto_handle; /* Primary handle. */
  1651. DB_MUTEX *mt_mutexp; /* Mersenne Twister mutex. */
  1652. int  mti; /* Mersenne Twister index. */
  1653. u_long *mt; /* Mersenne Twister state vector. */
  1655. /* DB_ENV Methods. */
  1656. int  (*close) __P((DB_ENV *, u_int32_t));
  1657. int  (*dbremove) __P((DB_ENV *,
  1658.     DB_TXN *, const char *, const char *, u_int32_t));
  1659. int  (*dbrename) __P((DB_ENV *, DB_TXN *,
  1660.     const char *, const char *, const char *, u_int32_t));
  1661. void (*err) __P((const DB_ENV *, int, const char *, ...));
  1662. void (*errx) __P((const DB_ENV *, const char *, ...));
  1663. int  (*open) __P((DB_ENV *, const char *, u_int32_t, int));
  1664. int  (*remove) __P((DB_ENV *, const char *, u_int32_t));
  1665. int  (*set_data_dir) __P((DB_ENV *, const char *));
  1666. int  (*set_alloc) __P((DB_ENV *, void *(*)(size_t),
  1667. void *(*)(void *, size_t), void (*)(void *)));
  1668. int  (*set_app_dispatch) __P((DB_ENV *,
  1669. int (*)(DB_ENV *, DBT *, DB_LSN *, db_recops)));
  1670. int  (*set_encrypt) __P((DB_ENV *, const char *, u_int32_t));
  1671. void (*set_errcall) __P((DB_ENV *, void (*)(const char *, char *)));
  1672. void (*set_errfile) __P((DB_ENV *, FILE *));
  1673. void (*set_errpfx) __P((DB_ENV *, const char *));
  1674. int  (*set_feedback) __P((DB_ENV *, void (*)(DB_ENV *, int, int)));
  1675. int  (*set_flags) __P((DB_ENV *, u_int32_t, int));
  1676. void (*set_noticecall) __P((DB_ENV *, void (*)(DB_ENV *, db_notices)));
  1677. int  (*set_paniccall) __P((DB_ENV *, void (*)(DB_ENV *, int)));
  1678. int  (*set_rpc_server) __P((DB_ENV *,
  1679. void *, const char *, long, long, u_int32_t));
  1680. int  (*set_shm_key) __P((DB_ENV *, long));
  1681. int  (*set_tas_spins) __P((DB_ENV *, u_int32_t));
  1682. int  (*set_tmp_dir) __P((DB_ENV *, const char *));
  1683. int  (*set_verbose) __P((DB_ENV *, u_int32_t, int));
  1685. void *lg_handle; /* Log handle and methods. */
  1686. int  (*set_lg_bsize) __P((DB_ENV *, u_int32_t));
  1687. int  (*set_lg_dir) __P((DB_ENV *, const char *));
  1688. int  (*set_lg_max) __P((DB_ENV *, u_int32_t));
  1689. int  (*set_lg_regionmax) __P((DB_ENV *, u_int32_t));
  1690. int  (*log_archive) __P((DB_ENV *, char **[], u_int32_t));
  1691. int  (*log_cursor) __P((DB_ENV *, DB_LOGC **, u_int32_t));
  1692. int  (*log_file) __P((DB_ENV *, const DB_LSN *, char *, size_t));
  1693. int  (*log_flush) __P((DB_ENV *, const DB_LSN *));
  1694. int  (*log_put) __P((DB_ENV *, DB_LSN *, const DBT *, u_int32_t));
  1695. int  (*log_stat) __P((DB_ENV *, DB_LOG_STAT **, u_int32_t));
  1697. void *lk_handle; /* Lock handle and methods. */
  1698. int  (*set_lk_conflicts) __P((DB_ENV *, u_int8_t *, int));
  1699. int  (*set_lk_detect) __P((DB_ENV *, u_int32_t));
  1700. int  (*set_lk_max) __P((DB_ENV *, u_int32_t));
  1701. int  (*set_lk_max_locks) __P((DB_ENV *, u_int32_t));
  1702. int  (*set_lk_max_lockers) __P((DB_ENV *, u_int32_t));
  1703. int  (*set_lk_max_objects) __P((DB_ENV *, u_int32_t));
  1704. int  (*lock_detect) __P((DB_ENV *, u_int32_t, u_int32_t, int *));
  1705. int  (*lock_dump_region) __P((DB_ENV *, char *, FILE *));
  1706. int  (*lock_get) __P((DB_ENV *,
  1707. u_int32_t, u_int32_t, const DBT *, db_lockmode_t, DB_LOCK *));
  1708. int  (*lock_put) __P((DB_ENV *, DB_LOCK *));
  1709. int  (*lock_id) __P((DB_ENV *, u_int32_t *));
  1710. int  (*lock_id_free) __P((DB_ENV *, u_int32_t));
  1711. int  (*lock_id_set) __P((DB_ENV *, u_int32_t, u_int32_t));
  1712. int  (*lock_stat) __P((DB_ENV *, DB_LOCK_STAT **, u_int32_t));
  1713. int  (*lock_vec) __P((DB_ENV *,
  1714. u_int32_t, u_int32_t, DB_LOCKREQ *, int, DB_LOCKREQ **));
  1715. int  (*lock_downgrade) __P((DB_ENV *,
  1716. DB_LOCK *, db_lockmode_t, u_int32_t));
  1718. void *mp_handle; /* Mpool handle and methods. */
  1719. int  (*set_mp_mmapsize) __P((DB_ENV *, size_t));
  1720. int  (*set_cachesize) __P((DB_ENV *, u_int32_t, u_int32_t, int));
  1721. int  (*memp_dump_region) __P((DB_ENV *, char *, FILE *));
  1722. int  (*memp_fcreate) __P((DB_ENV *, DB_MPOOLFILE **, u_int32_t));
  1723. int  (*memp_nameop) __P((DB_ENV *,
  1724. u_int8_t *, const char *, const char *, const char *));
  1725. int  (*memp_register) __P((DB_ENV *, int,
  1726. int (*)(DB_ENV *, db_pgno_t, void *, DBT *),
  1727. int (*)(DB_ENV *, db_pgno_t, void *, DBT *)));
  1728. int  (*memp_stat) __P((DB_ENV *,
  1729. DB_MPOOL_STAT **, DB_MPOOL_FSTAT ***, u_int32_t));
  1730. int  (*memp_sync) __P((DB_ENV *, DB_LSN *));
  1731. int  (*memp_trickle) __P((DB_ENV *, int, int *));
  1733. void *rep_handle; /* Replication handle and methods. */
  1734. int  (*rep_elect) __P((DB_ENV *, int, int, u_int32_t, int *));
  1735. int  (*rep_flush) __P((DB_ENV *));
  1736. int  (*rep_process_message) __P((DB_ENV *, DBT *, DBT *, int *));
  1737. int  (*rep_start) __P((DB_ENV *, DBT *, u_int32_t));
  1738. int  (*rep_stat) __P((DB_ENV *, DB_REP_STAT **, u_int32_t));
  1739. int  (*set_rep_election) __P((DB_ENV *,
  1740. u_int32_t, u_int32_t, u_int32_t, u_int32_t));
  1741. int  (*set_rep_limit) __P((DB_ENV *, u_int32_t, u_int32_t));
  1742. int  (*set_rep_request) __P((DB_ENV *, u_int32_t, u_int32_t));
  1743. int  (*set_rep_timeout) __P((DB_ENV *, u_int32_t, u_int32_t));
  1744. int  (*set_rep_transport) __P((DB_ENV *, int,
  1745. int (*) (DB_ENV *, const DBT *, const DBT *, int, u_int32_t)));
  1747. void *tx_handle; /* Txn handle and methods. */
  1748. int  (*set_tx_max) __P((DB_ENV *, u_int32_t));
  1749. int  (*set_tx_timestamp) __P((DB_ENV *, time_t *));
  1750. int  (*txn_begin) __P((DB_ENV *, DB_TXN *, DB_TXN **, u_int32_t));
  1751. int  (*txn_checkpoint) __P((DB_ENV *, u_int32_t, u_int32_t, u_int32_t));
  1752. int  (*txn_id_set) __P((DB_ENV *, u_int32_t, u_int32_t));
  1753. int  (*txn_recover) __P((DB_ENV *,
  1754. DB_PREPLIST *, long, long *, u_int32_t));
  1755. int  (*txn_stat) __P((DB_ENV *, DB_TXN_STAT **, u_int32_t));
  1756. int  (*set_timeout) __P((DB_ENV *, db_timeout_t, u_int32_t));
  1758. #define DB_TEST_ELECTINIT  1 /* after __rep_elect_init */
  1759. #define DB_TEST_ELECTSEND  2 /* after REP_ELECT msgnit */
  1760. #define DB_TEST_ELECTVOTE1  3 /* after __rep_send_vote 1 */
  1761. #define DB_TEST_ELECTVOTE2  4 /* after __rep_wait */
  1762. #define DB_TEST_ELECTWAIT1  5 /* after REP_VOTE2 */
  1763. #define DB_TEST_ELECTWAIT2  6 /* after __rep_wait 2 */
  1764. #define DB_TEST_PREDESTROY  7 /* before destroy op */
  1765. #define DB_TEST_PREOPEN  8 /* before __os_open */
  1766. #define DB_TEST_POSTDESTROY  9 /* after destroy op */
  1767. #define DB_TEST_POSTLOG  10 /* after logging all pages */
  1768. #define DB_TEST_POSTLOGMETA  11 /* after logging meta in btree */
  1769. #define DB_TEST_POSTOPEN  12 /* after __os_open */
  1770. #define DB_TEST_POSTSYNC  13 /* after syncing the log */
  1771. #define DB_TEST_SUBDB_LOCKS  14 /* subdb locking tests */
  1772. int  test_abort; /* Abort value for testing. */
  1773. int  test_copy; /* Copy value for testing. */
  1775. #define DB_ENV_AUTO_COMMIT 0x0000001 /* DB_AUTO_COMMIT. */
  1776. #define DB_ENV_CDB 0x0000002 /* DB_INIT_CDB. */
  1777. #define DB_ENV_CDB_ALLDB 0x0000004 /* CDB environment wide locking. */
  1778. #define DB_ENV_CREATE 0x0000008 /* DB_CREATE set. */
  1779. #define DB_ENV_DBLOCAL 0x0000010 /* DB_ENV allocated for private DB. */
  1780. #define DB_ENV_DIRECT_DB 0x0000020 /* DB_DIRECT_DB set. */
  1781. #define DB_ENV_DIRECT_LOG 0x0000040 /* DB_DIRECT_LOG set. */
  1782. #define DB_ENV_FATAL 0x0000080 /* Doing fatal recovery in env. */
  1783. #define DB_ENV_LOCKDOWN 0x0000100 /* DB_LOCKDOWN set. */
  1784. #define DB_ENV_NOLOCKING 0x0000200 /* DB_NOLOCKING set. */
  1785. #define DB_ENV_NOMMAP 0x0000400 /* DB_NOMMAP set. */
  1786. #define DB_ENV_NOPANIC 0x0000800 /* Okay if panic set. */
  1787. #define DB_ENV_OPEN_CALLED 0x0001000 /* DB_ENV->open called. */
  1788. #define DB_ENV_OVERWRITE 0x0002000 /* DB_OVERWRITE set. */
  1789. #define DB_ENV_PRIVATE 0x0004000 /* DB_PRIVATE set. */
  1790. #define DB_ENV_REGION_INIT 0x0008000 /* DB_REGION_INIT set. */
  1791. #define DB_ENV_REP_CLIENT 0x0010000 /* Replication client. */
  1792. #define DB_ENV_REP_LOGSONLY 0x0020000 /* Log files only replication site. */
  1793. #define DB_ENV_REP_MASTER 0x0040000 /* Replication master. */
  1794. #define DB_ENV_RPCCLIENT 0x0080000 /* DB_CLIENT set. */
  1795. #define DB_ENV_RPCCLIENT_GIVEN 0x0100000 /* User-supplied RPC client struct */
  1796. #define DB_ENV_SYSTEM_MEM 0x0200000 /* DB_SYSTEM_MEM set. */
  1797. #define DB_ENV_THREAD 0x0400000 /* DB_THREAD set. */
  1798. #define DB_ENV_TXN_NOSYNC 0x0800000 /* DB_TXN_NOSYNC set. */
  1799. #define DB_ENV_TXN_WRITE_NOSYNC 0x1000000 /* DB_TXN_WRITE_NOSYNC set. */
  1800. #define DB_ENV_YIELDCPU 0x2000000 /* DB_YIELDCPU set. */
  1801. u_int32_t flags;
  1802. };
  1804. #ifndef DB_DBM_HSEARCH
  1805. #define DB_DBM_HSEARCH 0 /* No historic interfaces by default. */
  1806. #endif
  1807. #if DB_DBM_HSEARCH != 0
  1808. /*******************************************************
  1809.  * Dbm/Ndbm historic interfaces.
  1810.  *******************************************************/
  1811. typedef struct __db DBM;
  1813. #define DBM_INSERT 0 /* Flags to dbm_store(). */
  1814. #define DBM_REPLACE 1
  1816. /*
  1817.  * The DB support for ndbm(3) always appends this suffix to the
  1818.  * file name to avoid overwriting the user's original database.
  1819.  */
  1820. #define DBM_SUFFIX ".db"
  1822. #if defined(_XPG4_2)
  1823. typedef struct {
  1824. char *dptr;
  1825. size_t dsize;
  1826. } datum;
  1827. #else
  1828. typedef struct {
  1829. char *dptr;
  1830. int dsize;
  1831. } datum;
  1832. #endif
  1834. /*
  1835.  * Translate NDBM calls into DB calls so that DB doesn't step on the
  1836.  * application's name space.
  1837.  */
  1838. #define dbm_clearerr(a) __db_ndbm_clearerr(a)
  1839. #define dbm_close(a) __db_ndbm_close(a)
  1840. #define dbm_delete(a, b) __db_ndbm_delete(a, b)
  1841. #define dbm_dirfno(a) __db_ndbm_dirfno(a)
  1842. #define dbm_error(a) __db_ndbm_error(a)
  1843. #define dbm_fetch(a, b) __db_ndbm_fetch(a, b)
  1844. #define dbm_firstkey(a) __db_ndbm_firstkey(a)
  1845. #define dbm_nextkey(a) __db_ndbm_nextkey(a)
  1846. #define dbm_open(a, b, c) __db_ndbm_open(a, b, c)
  1847. #define dbm_pagfno(a) __db_ndbm_pagfno(a)
  1848. #define dbm_rdonly(a) __db_ndbm_rdonly(a)
  1849. #define dbm_store(a, b, c, d) 
  1850. __db_ndbm_store(a, b, c, d)
  1852. /*
  1853.  * Translate DBM calls into DB calls so that DB doesn't step on the
  1854.  * application's name space.
  1855.  *
  1856.  * The global variables dbrdonly, dirf and pagf were not retained when 4BSD
  1857.  * replaced the dbm interface with ndbm, and are not supported here.
  1858.  */
  1859. #define dbminit(a) __db_dbm_init(a)
  1860. #define dbmclose __db_dbm_close
  1861. #if !defined(__cplusplus)
  1862. #define delete(a) __db_dbm_delete(a)
  1863. #endif
  1864. #define fetch(a) __db_dbm_fetch(a)
  1865. #define firstkey __db_dbm_firstkey
  1866. #define nextkey(a) __db_dbm_nextkey(a)
  1867. #define store(a, b) __db_dbm_store(a, b)
  1869. /*******************************************************
  1870.  * Hsearch historic interface.
  1871.  *******************************************************/
  1872. typedef enum {
  1873. FIND, ENTER
  1874. } ACTION;
  1876. typedef struct entry {
  1877. char *key;
  1878. char *data;
  1879. } ENTRY;
  1881. #define hcreate(a) __db_hcreate(a)
  1882. #define hdestroy __db_hdestroy
  1883. #define hsearch(a, b) __db_hsearch(a, b)
  1885. #endif /* DB_DBM_HSEARCH */
  1887. #if defined(__cplusplus)
  1888. }
  1889. #endif
  1890. #endif /* !_DB_H_ */
  1892. /* DO NOT EDIT: automatically built by dist/s_rpc. */
  1893. #define DB_RPC_SERVERPROG 351457
  1894. #define DB_RPC_SERVERVERS 4001
  1896. /* DO NOT EDIT: automatically built by dist/s_include. */
  1897. #ifndef _DB_EXT_PROT_IN_
  1898. #define _DB_EXT_PROT_IN_
  1900. #if defined(__cplusplus)
  1901. extern "C" {
  1902. #endif
  1904. int db_create __P((DB **, DB_ENV *, u_int32_t));
  1905. char *db_strerror __P((int));
  1906. int db_env_create __P((DB_ENV **, u_int32_t));
  1907. char *db_version __P((int *, int *, int *));
  1908. int log_compare __P((const DB_LSN *, const DB_LSN *));
  1909. int db_env_set_func_close __P((int (*)(int)));
  1910. int db_env_set_func_dirfree __P((void (*)(char **, int)));
  1911. int db_env_set_func_dirlist __P((int (*)(const char *, char ***, int *)));
  1912. int db_env_set_func_exists __P((int (*)(const char *, int *)));
  1913. int db_env_set_func_free __P((void (*)(void *)));
  1914. int db_env_set_func_fsync __P((int (*)(int)));
  1915. int db_env_set_func_ioinfo __P((int (*)(const char *, int, u_int32_t *, u_int32_t *, u_int32_t *)));
  1916. int db_env_set_func_malloc __P((void *(*)(size_t)));
  1917. int db_env_set_func_map __P((int (*)(char *, size_t, int, int, void **)));
  1918. int db_env_set_func_open __P((int (*)(const char *, int, ...)));
  1919. int db_env_set_func_read __P((ssize_t (*)(int, void *, size_t)));
  1920. int db_env_set_func_realloc __P((void *(*)(void *, size_t)));
  1921. int db_env_set_func_rename __P((int (*)(const char *, const char *)));
  1922. int db_env_set_func_seek __P((int (*)(int, size_t, db_pgno_t, u_int32_t, int, int)));
  1923. int db_env_set_func_sleep __P((int (*)(u_long, u_long)));
  1924. int db_env_set_func_unlink __P((int (*)(const char *)));
  1925. int db_env_set_func_unmap __P((int (*)(void *, size_t)));
  1926. int db_env_set_func_write __P((ssize_t (*)(int, const void *, size_t)));
  1927. int db_env_set_func_yield __P((int (*)(void)));
  1928. int txn_abort __P((DB_TXN *));
  1929. int txn_begin __P((DB_ENV *, DB_TXN *, DB_TXN **, u_int32_t));
  1930. int txn_commit __P((DB_TXN *, u_int32_t));
  1931. #if DB_DBM_HSEARCH != 0
  1932. int  __db_ndbm_clearerr __P((DBM *));
  1933. void  __db_ndbm_close __P((DBM *));
  1934. int  __db_ndbm_delete __P((DBM *, datum));
  1935. int  __db_ndbm_dirfno __P((DBM *));
  1936. int  __db_ndbm_error __P((DBM *));
  1937. datum __db_ndbm_fetch __P((DBM *, datum));
  1938. datum __db_ndbm_firstkey __P((DBM *));
  1939. datum __db_ndbm_nextkey __P((DBM *));
  1940. DBM *__db_ndbm_open __P((const char *, int, int));
  1941. int  __db_ndbm_pagfno __P((DBM *));
  1942. int  __db_ndbm_rdonly __P((DBM *));
  1943. int  __db_ndbm_store __P((DBM *, datum, datum, int));
  1944. int  __db_dbm_close __P((void));
  1945. int  __db_dbm_dbrdonly __P((void));
  1946. int  __db_dbm_delete __P((datum));
  1947. int  __db_dbm_dirf __P((void));
  1948. datum __db_dbm_fetch __P((datum));
  1949. datum __db_dbm_firstkey __P((void));
  1950. int  __db_dbm_init __P((char *));
  1951. datum __db_dbm_nextkey __P((datum));
  1952. int  __db_dbm_pagf __P((void));
  1953. int  __db_dbm_store __P((datum, datum));
  1954. #endif
  1955. #if DB_DBM_HSEARCH != 0
  1956. int __db_hcreate __P((size_t));
  1957. ENTRY *__db_hsearch __P((ENTRY, ACTION));
  1958. void __db_hdestroy __P((void));
  1959. #endif
  1961. #if defined(__cplusplus)
  1962. }
  1963. #endif
  1964. #endif /* !_DB_EXT_PROT_IN_ */