db_int.h
上传用户:tsgydb
上传日期:2007-04-14
资源大小:10674k
文件大小:13k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. /* DO NOT EDIT: automatically built by dist/s_win32. */
  2. /*-
  3.  * See the file LICENSE for redistribution information.
  4.  *
  5.  * Copyright (c) 1996, 1997, 1998, 1999, 2000
  6.  * Sleepycat Software.  All rights reserved.
  7.  *
  8.  * $Id: db_int.src,v 11.42 2001/01/11 17:49:17 krinsky Exp $
  9.  */
  10. #ifndef _DB_INTERNAL_H_
  11. #define _DB_INTERNAL_H_
  12. /*******************************************************
  13.  * General includes.
  14.  *******************************************************/
  15. #include "db.h"
  16. #ifndef NO_SYSTEM_INCLUDES
  17. #if defined(__STDC__) || defined(__cplusplus)
  18. #include <stdarg.h>
  19. #else
  20. #include <varargs.h>
  21. #endif
  22. #include <errno.h>
  23. #endif
  24. #include "queue.h"
  25. #include "shqueue.h"
  26. #if defined(__cplusplus)
  27. extern "C" {
  28. #endif
  29. /*******************************************************
  30.  * General purpose constants and macros.
  31.  *******************************************************/
  32. #define UINT16_T_MAX     0xffff /* Maximum 16 bit unsigned. */
  33. #define UINT32_T_MAX 0xffffffff /* Maximum 32 bit unsigned. */
  34. #define MEGABYTE 1048576
  35. #define GIGABYTE 1073741824
  36. #define MS_PER_SEC 1000 /* Milliseconds in a second. */
  37. #define USEC_PER_MS 1000 /* Microseconds in a millisecond. */
  38. #define DB_MIN_PGSIZE 0x000200 /* Minimum page size (512). */
  39. #define DB_MAX_PGSIZE 0x010000 /* Maximum page size (65536). */
  40. #define RECNO_OOB 0 /* Illegal record number. */
  41. /*
  42.  * If we are unable to determine the underlying filesystem block size, use
  43.  * 8K on the grounds that most OS's use less than 8K for a VM page size.
  44.  */
  45. #define DB_DEF_IOSIZE (8 * 1024)
  46. /*
  47.  * Aligning items to particular sizes or in pages or memory.
  48.  *
  49.  * db_align_t --
  50.  * Largest integral type, used to align structures in memory.  We don't store
  51.  * floating point types in structures, so integral types should be sufficient
  52.  * (and we don't have to worry about systems that store floats in other than
  53.  * power-of-2 numbers of bytes).  Additionally this fixes compiler that rewrite
  54.  * structure assignments and ANSI C memcpy calls to be in-line instructions
  55.  * that happen to require alignment.  Note: this alignment isn't sufficient for
  56.  * mutexes, which depend on things like cache line alignment.  Mutex alignment
  57.  * is handled separately, in mutex.h.
  58.  *
  59.  * db_alignp_t --
  60.  * Integral type that's the same size as a pointer.  There are places where
  61.  * DB modifies pointers by discarding the bottom bits to guarantee alignment.
  62.  * We can't use db_align_t, it may be larger than the pointer, and compilers
  63.  * get upset about that.  So far we haven't run on any machine where there
  64.  * isn't an integral type the same size as a pointer -- here's hoping.
  65.  */
  66. typedef unsigned long db_align_t;
  67. typedef unsigned long db_alignp_t;
  68. /* Align an integer to a specific boundary. */
  69. #undef ALIGN
  70. #define ALIGN(value, bound) 
  71.     (((value) + (bound) - 1) & ~(((u_int)bound) - 1))
  72. /* Align a pointer to a specific boundary. */
  73. #undef ALIGNP
  74. #define ALIGNP(value, bound) ALIGN((db_alignp_t)value, bound)
  75. /*
  76.  * There are several on-page structures that are declared to have a number of
  77.  * fields followed by a variable length array of items.  The structure size
  78.  * without including the variable length array or the address of the first of
  79.  * those elements can be found using SSZ.
  80.  *
  81.  * This macro can also be used to find the offset of a structure element in a
  82.  * structure.  This is used in various places to copy structure elements from
  83.  * unaligned memory references, e.g., pointers into a packed page.
  84.  *
  85.  * There are two versions because compilers object if you take the address of
  86.  * an array.
  87.  */
  88. #undef SSZ
  89. #define SSZ(name, field) ((int)&(((name *)0)->field))
  90. #undef SSZA
  91. #define SSZA(name, field) ((int)&(((name *)0)->field[0]))
  92. /*
  93.  * Print an address as a u_long (a u_long is the largest type we can print
  94.  * portably).  Most 64-bit systems have made longs 64-bits, so this should
  95.  * work.
  96.  */
  97. #define P_TO_ULONG(p) ((u_long)(db_alignp_t)(p))
  98. /* Structure used to print flag values. */
  99. typedef struct __fn {
  100. u_int32_t mask; /* Flag value. */
  101. const char *name; /* Flag name. */
  102. } FN;
  103. /* Set, clear and test flags. */
  104. #define FLD_CLR(fld, f) (fld) &= ~(f)
  105. #define FLD_ISSET(fld, f) ((fld) & (f))
  106. #define FLD_SET(fld, f) (fld) |= (f)
  107. #define F_CLR(p, f) (p)->flags &= ~(f)
  108. #define F_ISSET(p, f) ((p)->flags & (f))
  109. #define F_SET(p, f) (p)->flags |= (f)
  110. #define LF_CLR(f) (flags &= ~(f))
  111. #define LF_ISSET(f) (flags & (f))
  112. #define LF_SET(f) (flags |= (f))
  113. /* Display separator string. */
  114. #undef DB_LINE
  115. #define DB_LINE "=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-="
  116. /* Unused, or not-used-yet variable.  "Shut that bloody compiler up!" */
  117. #define COMPQUIET(n, v) (n) = (v)
  118. /*******************************************************
  119.  * Files.
  120.  *******************************************************/
  121.  /*
  122.   * We use 1024 as the maximum path length.  It's too hard to figure out what
  123.   * the real path length is, as it was traditionally stored in <sys/param.h>,
  124.   * and that file isn't always available.
  125.   */
  126. #undef MAXPATHLEN
  127. #define MAXPATHLEN 1024
  128. #define PATH_DOT "." /* Current working directory. */
  129. #define PATH_SEPARATOR "\/:" /* Path separator character. */
  130. /*
  131.  * Flags understood by __os_open.
  132.  */
  133. #define DB_OSO_CREATE 0x001 /* POSIX: O_CREAT */
  134. #define DB_OSO_EXCL 0x002 /* POSIX: O_EXCL */
  135. #define DB_OSO_LOG 0x004 /* Opening a log file. */
  136. #define DB_OSO_RDONLY 0x008 /* POSIX: O_RDONLY */
  137. #define DB_OSO_REGION 0x010 /* Opening a region file. */
  138. #define DB_OSO_SEQ 0x020 /* Expected sequential access. */
  139. #define DB_OSO_TEMP 0x040 /* Remove after last close. */
  140. #define DB_OSO_TRUNC 0x080 /* POSIX: O_TRUNC */
  141. /*
  142.  * Seek options understood by __os_seek.
  143.  */
  144. typedef enum {
  145. DB_OS_SEEK_CUR, /* POSIX: SEEK_CUR */
  146. DB_OS_SEEK_END, /* POSIX: SEEK_END */
  147. DB_OS_SEEK_SET /* POSIX: SEEK_SET */
  148. } DB_OS_SEEK;
  149. /*******************************************************
  150.  * Environment.
  151.  *******************************************************/
  152. /* Type passed to __db_appname(). */
  153. typedef enum {
  154. DB_APP_NONE=0, /* No type (region). */
  155. DB_APP_DATA, /* Data file. */
  156. DB_APP_LOG, /* Log file. */
  157. DB_APP_TMP /* Temporary file. */
  158. } APPNAME;
  159. /*
  160.  * CDB_LOCKING CDB product locking.
  161.  * LOCKING_ON Locking has been configured.
  162.  * LOGGING_ON Logging has been configured.
  163.  * MPOOL_ON Memory pool has been configured.
  164.  * TXN_ON Transactions have been configured.
  165.  */
  166. #define CDB_LOCKING(dbenv) F_ISSET(dbenv, DB_ENV_CDB)
  167. #define LOCKING_ON(dbenv) ((dbenv)->lk_handle != NULL)
  168. #define LOGGING_ON(dbenv) ((dbenv)->lg_handle != NULL)
  169. #define MPOOL_ON(dbenv) ((dbenv)->mp_handle != NULL)
  170. #define TXN_ON(dbenv) ((dbenv)->tx_handle != NULL)
  171. /*
  172.  * STD_LOCKING Standard locking, that is, locking was configured and CDB
  173.  * was not.  We do not do locking in off-page duplicate trees,
  174.  * so we check for that in the cursor first.
  175.  */
  176. #define STD_LOCKING(dbc)
  177. (!F_ISSET(dbc, DBC_OPD) &&
  178.     !CDB_LOCKING((dbc)->dbp->dbenv) && LOCKING_ON((dbc)->dbp->dbenv))
  179. /*
  180.  * IS_RECOVERING The system is running recovery.
  181.  */
  182. #define IS_RECOVERING(dbenv)
  183. (LOGGING_ON(dbenv) &&
  184.     F_ISSET((DB_LOG *)(dbenv)->lg_handle, DBLOG_RECOVER))
  185. /* Most initialization methods cannot be called after open is called. */
  186. #define ENV_ILLEGAL_AFTER_OPEN(dbenv, name)
  187. if (F_ISSET((dbenv), DB_ENV_OPEN_CALLED))
  188. return (__db_mi_open(dbenv, name, 1));
  189. /* We're not actually user hostile, honest. */
  190. #define ENV_REQUIRES_CONFIG(dbenv, handle, subsystem)
  191. if (handle == NULL)
  192. return (__db_env_config(dbenv, subsystem));
  193. /*******************************************************
  194.  * Database Access Methods.
  195.  *******************************************************/
  196. /*
  197.  * DB_IS_THREADED --
  198.  * The database handle is free-threaded (was opened with DB_THREAD).
  199.  */
  200. #define DB_IS_THREADED(dbp)
  201. ((dbp)->mutexp != NULL)
  202. /* Initialization methods are often illegal before/after open is called. */
  203. #define DB_ILLEGAL_AFTER_OPEN(dbp, name)
  204. if (F_ISSET((dbp), DB_OPEN_CALLED))
  205. return (__db_mi_open(dbp->dbenv, name, 1));
  206. #define DB_ILLEGAL_BEFORE_OPEN(dbp, name)
  207. if (!F_ISSET((dbp), DB_OPEN_CALLED))
  208. return (__db_mi_open(dbp->dbenv, name, 0));
  209. /* Some initialization methods are illegal if environment isn't local. */
  210. #define DB_ILLEGAL_IN_ENV(dbp, name)
  211. if (!F_ISSET(dbp->dbenv, DB_ENV_DBLOCAL))
  212. return (__db_mi_env(dbp->dbenv, name));
  213. #define DB_ILLEGAL_METHOD(dbp, flags) {
  214. int __ret;
  215. if ((__ret = __dbh_am_chk(dbp, flags)) != 0)
  216. return (__ret);
  217. }
  218. /*
  219.  * Common DBC->internal fields.  Each access method adds additional fields
  220.  * to this list, but the initial fields are common.
  221.  */
  222. #define __DBC_INTERNAL
  223. DBC  *opd; /* Off-page duplicate cursor. */
  224. void  *page; /* Referenced page. */
  225. db_pgno_t root; /* Tree root. */
  226. db_pgno_t pgno; /* Referenced page number. */
  227. db_indx_t indx; /* Referenced key item index. */
  228. DB_LOCK lock; /* Cursor lock. */
  229. db_lockmode_t lock_mode; /* Lock mode. */
  230. struct __dbc_internal {
  231. __DBC_INTERNAL
  232. };
  233. /*
  234.  * Access-method-common macro for determining whether a cursor
  235.  * has been initialized.
  236.  */
  237. #define IS_INITIALIZED(dbc) ((dbc)->internal->pgno != PGNO_INVALID)
  238. /*******************************************************
  239.  * Mpool.
  240.  *******************************************************/
  241. /*
  242.  * File types for DB access methods.  Negative numbers are reserved to DB.
  243.  */
  244. #define DB_FTYPE_SET -1 /* Call pgin/pgout functions. */
  245. #define DB_FTYPE_NOTSET  0 /* Don't call... */
  246. /* Structure used as the DB pgin/pgout pgcookie. */
  247. typedef struct __dbpginfo {
  248. size_t db_pagesize; /* Underlying page size. */
  249. int needswap; /* If swapping required. */
  250. } DB_PGINFO;
  251. /*******************************************************
  252.  * Log.
  253.  *******************************************************/
  254. /* Initialize an LSN to 'zero'. */
  255. #define ZERO_LSN(LSN) do {
  256. (LSN).file = 0;
  257. (LSN).offset = 0;
  258. } while (0)
  259. /* Return 1 if LSN is a 'zero' lsn, otherwise return 0. */
  260. #define IS_ZERO_LSN(LSN) ((LSN).file == 0)
  261. /* Test if we need to log a change. */
  262. #define DB_LOGGING(dbc)
  263. (LOGGING_ON((dbc)->dbp->dbenv) && !F_ISSET(dbc, DBC_RECOVER))
  264. /* Internal flag for use with internal __log_unregister. */
  265. #define DB_LOGONLY 0x01
  266. /*******************************************************
  267.  * Txn.
  268.  *******************************************************/
  269. #define DB_NONBLOCK(C) ((C)->txn != NULL && F_ISSET((C)->txn, TXN_NOWAIT))
  270. #define IS_SUBTRANSACTION(txn) 
  271. ((txn) != NULL && (txn)->parent != NULL)
  272. /*******************************************************
  273.  * Global variables.
  274.  *******************************************************/
  275. #ifdef HAVE_VXWORKS
  276. #include "semLib.h"
  277. #endif
  278. /*
  279.  * DB global variables.  Done in a single structure to minimize the name-space
  280.  * pollution.
  281.  */
  282. typedef struct __db_globals {
  283. u_int32_t db_pageyield; /* db_set_pageyield */
  284. u_int32_t db_panic; /* db_set_panic */
  285. u_int32_t db_region_init; /* db_set_region_init */
  286. u_int32_t db_tas_spins; /* db_set_tas_spins */
  287. #ifdef HAVE_VXWORKS
  288. u_int32_t db_global_init; /* VxWorks: inited */
  289. SEM_ID db_global_lock; /* VxWorks: global semaphore */
  290. #endif
  291. /* XA: list of opened environments. */
  292. TAILQ_HEAD(__db_envq, __db_env) db_envq;
  293. } DB_GLOBALS;
  294. #ifdef DB_INITIALIZE_DB_GLOBALS
  295. DB_GLOBALS __db_global_values = {
  296. 0, /* db_set_pageyield */
  297. 1, /* db_set_panic */
  298. 0, /* db_set_region_init */
  299. 0, /* db_set_tas_spins */
  300. #ifdef HAVE_VXWORKS
  301. 0, /* db_global_init */
  302. NULL, /* db_global_lock */
  303. #endif
  304. /* XA environment queue */
  305. {NULL, &__db_global_values.db_envq.tqh_first}
  306. };
  307. #else
  308. extern DB_GLOBALS __db_global_values;
  309. #endif
  310. #define DB_GLOBAL(v) __db_global_values.v
  311. /* Forward structure declarations. */
  312. struct __db_reginfo_t; typedef struct __db_reginfo_t REGINFO;
  313. struct __mutex_t; typedef struct __mutex_t MUTEX;
  314. struct __vrfy_childinfo; typedef struct __vrfy_childinfo VRFY_CHILDINFO;
  315. struct __vrfy_dbinfo;   typedef struct __vrfy_dbinfo VRFY_DBINFO;
  316. struct __vrfy_pageinfo; typedef struct __vrfy_pageinfo VRFY_PAGEINFO;
  317. struct __db_txnlist; typedef struct __db_txnlist DB_TXNLIST;
  318. struct __db_txnhead; typedef struct __db_txnhead DB_TXNHEAD;
  319. typedef enum {
  320. TXNLIST_DELETE,
  321. TXNLIST_LSN,
  322. TXNLIST_TXNID,
  323. TXNLIST_PGNO
  324. } db_txnlist_type;
  325. /*
  326.  * Currently, region offsets are limited to 32-bits.  I expect that's going
  327.  * to have to be fixed in the not-too-distant future, since we won't want to
  328.  * split 100Gb memory pools into that many different regions.  It's typedef'd
  329.  * so it won't be too painful to upgrade.
  330.  */
  331. typedef u_int32_t roff_t;
  332. #if defined(__cplusplus)
  333. }
  334. #endif
  335. /*******************************************************
  336.  * More general includes.
  337.  *******************************************************/
  338. #include "debug.h"
  339. #include "mutex.h"
  340. #include "region.h"
  341. #include "mutex_ext.h"
  342. #include "env_ext.h"
  343. #include "os.h"
  344. #include "os_ext.h"
  345. #include "common_ext.h"
  346. #endif /* !_DB_INTERNAL_H_ */