mp.h
上传用户:romrleung
上传日期:2022-05-23
资源大小:18897k
文件大小:10k
源码类别:

MySQL数据库

开发平台:

Visual C++

  1. /*-
  2.  * See the file LICENSE for redistribution information.
  3.  *
  4.  * Copyright (c) 1996-2002
  5.  * Sleepycat Software.  All rights reserved.
  6.  *
  7.  * $Id: mp.h,v 11.44 2002/08/06 06:11:21 bostic Exp $
  8.  */
  9. #ifndef _DB_MP_H_
  10. #define _DB_MP_H_
  11. struct __bh; typedef struct __bh BH;
  12. struct __db_mpool_hash; typedef struct __db_mpool_hash DB_MPOOL_HASH;
  13. struct __db_mpreg; typedef struct __db_mpreg DB_MPREG;
  14. struct __mpool; typedef struct __mpool MPOOL;
  15. /* We require at least 20KB of cache. */
  16. #define DB_CACHESIZE_MIN (20 * 1024)
  17. typedef enum {
  18. DB_SYNC_ALLOC, /* Flush for allocation. */
  19. DB_SYNC_CACHE, /* Checkpoint or flush entire cache. */
  20. DB_SYNC_FILE, /* Flush file. */
  21. DB_SYNC_TRICKLE /* Trickle sync. */
  22. } db_sync_op;
  23. /*
  24.  * DB_MPOOL --
  25.  * Per-process memory pool structure.
  26.  */
  27. struct __db_mpool {
  28. /* These fields need to be protected for multi-threaded support. */
  29. DB_MUTEX   *mutexp; /* Structure thread lock. */
  30. /* List of pgin/pgout routines. */
  31. LIST_HEAD(__db_mpregh, __db_mpreg) dbregq;
  32. /* List of DB_MPOOLFILE's. */
  33. TAILQ_HEAD(__db_mpoolfileh, __db_mpoolfile) dbmfq;
  34. /*
  35.  * The dbenv, nreg and reginfo fields are not thread protected,
  36.  * as they are initialized during mpool creation, and not modified
  37.  * again.
  38.  */
  39. DB_ENV    *dbenv; /* Enclosing environment. */
  40. u_int32_t   nreg; /* N underlying cache regions. */
  41. REGINFO    *reginfo; /* Underlying cache regions. */
  42. };
  43. /*
  44.  * DB_MPREG --
  45.  * DB_MPOOL registry of pgin/pgout functions.
  46.  */
  47. struct __db_mpreg {
  48. LIST_ENTRY(__db_mpreg) q; /* Linked list. */
  49. int32_t ftype; /* File type. */
  50. /* Pgin, pgout routines. */
  51. int (*pgin) __P((DB_ENV *, db_pgno_t, void *, DBT *));
  52. int (*pgout) __P((DB_ENV *, db_pgno_t, void *, DBT *));
  53. };
  54. /*
  55.  * NCACHE --
  56.  * Select a cache based on the file and the page number.  Assumes accesses
  57.  * are uniform across pages, which is probably OK.  What we really want to
  58.  * avoid is anything that puts all pages from any single file in the same
  59.  * cache, as we expect that file access will be bursty, and to avoid
  60.  * putting all page number N pages in the same cache as we expect access
  61.  * to the metapages (page 0) and the root of a btree (page 1) to be much
  62.  * more frequent than a random data page.
  63.  */
  64. #define NCACHE(mp, mf_offset, pgno)
  65. (((pgno) ^ ((mf_offset) >> 3)) % ((MPOOL *)mp)->nreg)
  66. /*
  67.  * NBUCKET --
  68.  *  We make the assumption that early pages of the file are more likely
  69.  *  to be retrieved than the later pages, which means the top bits will
  70.  *  be more interesting for hashing as they're less likely to collide.
  71.  *  That said, as 512 8K pages represents a 4MB file, so only reasonably
  72.  *  large files will have page numbers with any other than the bottom 9
  73.  *  bits set.  We XOR in the MPOOL offset of the MPOOLFILE that backs the
  74.  *  page, since that should also be unique for the page.  We don't want
  75.  *  to do anything very fancy -- speed is more important to us than using
  76.  *  good hashing.
  77.  */
  78. #define NBUCKET(mc, mf_offset, pgno)
  79. (((pgno) ^ ((mf_offset) << 9)) % (mc)->htab_buckets)
  80. /*
  81.  * MPOOL --
  82.  * Shared memory pool region.
  83.  */
  84. struct __mpool {
  85. /*
  86.  * The memory pool can be broken up into individual pieces/files.
  87.  * Not what we would have liked, but on Solaris you can allocate
  88.  * only a little more than 2GB of memory in a contiguous chunk,
  89.  * and I expect to see more systems with similar issues.
  90.  *
  91.  * While this structure is duplicated in each piece of the cache,
  92.  * the first of these pieces/files describes the entire pool, the
  93.  * second only describe a piece of the cache.
  94.  */
  95. /*
  96.  * The lsn field and list of underlying MPOOLFILEs are thread protected
  97.  * by the region lock.
  98.  */
  99. DB_LSN   lsn; /* Maximum checkpoint LSN. */
  100. SH_TAILQ_HEAD(__mpfq) mpfq; /* List of MPOOLFILEs. */
  101. /*
  102.  * The nreg, regids and maint_off fields are not thread protected,
  103.  * as they are initialized during mpool creation, and not modified
  104.  * again.
  105.  */
  106. u_int32_t nreg; /* Number of underlying REGIONS. */
  107. roff_t   regids; /* Array of underlying REGION Ids. */
  108. #ifdef HAVE_MUTEX_SYSTEM_RESOURCES
  109. roff_t     maint_off; /* Maintenance information offset */
  110. #endif
  111. /*
  112.  * The following structure fields only describe the per-cache portion
  113.  * of the region.
  114.  *
  115.  * The htab and htab_buckets fields are not thread protected as they
  116.  * are initialized during mpool creation, and not modified again.
  117.  *
  118.  * The last_checked and lru_count fields are thread protected by
  119.  * the region lock.
  120.  */
  121. int     htab_buckets; /* Number of hash table entries. */
  122. roff_t     htab; /* Hash table offset. */
  123. u_int32_t   last_checked; /* Last bucket checked for free. */
  124. u_int32_t   lru_count; /* Counter for buffer LRU */
  125. /*
  126.  * The stat fields are generally not thread protected, and cannot be
  127.  * trusted.  Note that st_pages is an exception, and is always updated
  128.  * inside a region lock (although it is sometimes read outside of the
  129.  * region lock).
  130.  */
  131. DB_MPOOL_STAT stat; /* Per-cache mpool statistics. */
  132. };
  133. struct __db_mpool_hash {
  134. DB_MUTEX hash_mutex; /* Per-bucket mutex. */
  135. DB_HASHTAB hash_bucket; /* Head of bucket. */
  136. u_int32_t hash_page_dirty;/* Count of dirty pages. */
  137. u_int32_t hash_priority; /* Minimum priority of bucket buffer. */
  138. };
  139. /*
  140.  * The base mpool priority is 1/4th of the name space, or just under 2^30.
  141.  * When the LRU counter wraps, we shift everybody down to a base-relative
  142.  * value.
  143.  */
  144. #define MPOOL_BASE_DECREMENT (UINT32_T_MAX - (UINT32_T_MAX / 4))
  145. /*
  146.  * Mpool priorities from low to high.  Defined in terms of fractions of the
  147.  * buffers in the pool.
  148.  */
  149. #define MPOOL_PRI_VERY_LOW -1 /* Dead duck.  Check and set to 0. */
  150. #define MPOOL_PRI_LOW -2 /* Low. */
  151. #define MPOOL_PRI_DEFAULT 0 /* No adjustment -- special case.*/
  152. #define MPOOL_PRI_HIGH 10 /* With the dirty buffers. */
  153. #define MPOOL_PRI_DIRTY 10 /* Dirty gets a 10% boost. */
  154. #define MPOOL_PRI_VERY_HIGH 1 /* Add number of buffers in pool. */
  155. /*
  156.  * MPOOLFILE_IGNORE --
  157.  * Discard an MPOOLFILE and any buffers it references: update the flags
  158.  * so we never try to write buffers associated with the file, nor can we
  159.  * find it when looking for files to join.  In addition, clear the ftype
  160.  * field, there's no reason to post-process pages, they can be discarded
  161.  * by any thread.
  162.  *
  163.  * Expects the MPOOLFILE mutex to be held.
  164.  */
  165. #define MPOOLFILE_IGNORE(mfp) {
  166. (mfp)->ftype = 0;
  167. F_SET(mfp, MP_DEADFILE);
  168. }
  169. /*
  170.  * MPOOLFILE --
  171.  * Shared DB_MPOOLFILE information.
  172.  */
  173. struct __mpoolfile {
  174. DB_MUTEX mutex;
  175. /* Protected by MPOOLFILE mutex. */
  176. u_int32_t mpf_cnt; /* Ref count: DB_MPOOLFILEs. */
  177. u_int32_t block_cnt; /* Ref count: blocks in cache. */
  178. roff_t   path_off; /* File name location. */
  179. /* Protected by mpool cache 0 region lock. */
  180. SH_TAILQ_ENTRY q; /* List of MPOOLFILEs */
  181. db_pgno_t last_pgno; /* Last page in the file. */
  182. db_pgno_t orig_last_pgno; /* Original last page in the file. */
  183. /*
  184.  * None of the following fields are thread protected.
  185.  *
  186.  * There are potential races with the ftype field because it's read
  187.  * without holding a lock.  However, it has to be set before adding
  188.  * any buffers to the cache that depend on it being set, so there
  189.  * would need to be incorrect operation ordering to have a problem.
  190.  *
  191.  * There are potential races with the priority field because it's read
  192.  * without holding a lock.  However, a collision is unlikely and if it
  193.  * happens is of little consequence.
  194.  *
  195.  * We do not protect the statistics in "stat" because of the cost of
  196.  * the mutex in the get/put routines.  There is a chance that a count
  197.  * will get lost.
  198.  *
  199.  * The remaining fields are initialized at open and never subsequently
  200.  * modified, except for the MP_DEADFILE, which is only set and never
  201.  * unset.  (If there was more than one flag that was subsequently set,
  202.  * there might be a race, but with a single flag there can't be.)
  203.  */
  204. int32_t   ftype; /* File type. */
  205. int32_t   priority; /* Priority when unpinning buffer. */
  206. DB_MPOOL_FSTAT stat; /* Per-file mpool statistics. */
  207. int32_t   lsn_off; /* Page's LSN offset. */
  208. u_int32_t clear_len; /* Bytes to clear on page create. */
  209. roff_t   fileid_off; /* File ID string location. */
  210. roff_t   pgcookie_len; /* Pgin/pgout cookie length. */
  211. roff_t   pgcookie_off; /* Pgin/pgout cookie location. */
  212. #define MP_CAN_MMAP 0x01 /* If the file can be mmap'd. */
  213. #define MP_DEADFILE 0x02 /* Dirty pages can simply be trashed. */
  214. #define MP_DIRECT 0x04 /* No OS buffering. */
  215. #define MP_EXTENT 0x08 /* Extent file. */
  216. #define MP_TEMP 0x10 /* Backing file is a temporary. */
  217. #define MP_UNLINK 0x20 /* Unlink file on last close. */
  218. u_int32_t  flags;
  219. };
  220. /*
  221.  * BH --
  222.  * Buffer header.
  223.  */
  224. struct __bh {
  225. DB_MUTEX mutex; /* Buffer thread/process lock. */
  226. u_int16_t ref; /* Reference count. */
  227. u_int16_t ref_sync; /* Sync wait-for reference count. */
  228. #define BH_CALLPGIN 0x001 /* Convert the page before use. */
  229. #define BH_DIRTY 0x002 /* Page was modified. */
  230. #define BH_DIRTY_CREATE 0x004 /* Page created, must be written. */
  231. #define BH_DISCARD 0x008 /* Page is useless. */
  232. #define BH_LOCKED 0x010 /* Page is locked (I/O in progress). */
  233. #define BH_TRASH 0x020 /* Page is garbage. */
  234. u_int16_t flags;
  235. u_int32_t priority; /* LRU priority. */
  236. SH_TAILQ_ENTRY hq; /* MPOOL hash bucket queue. */
  237. db_pgno_t pgno; /* Underlying MPOOLFILE page number. */
  238. roff_t   mf_offset; /* Associated MPOOLFILE offset. */
  239. /*
  240.  * !!!
  241.  * This array must be at least size_t aligned -- the DB access methods
  242.  * put PAGE and other structures into it, and then access them directly.
  243.  * (We guarantee size_t alignment to applications in the documentation,
  244.  * too.)
  245.  */
  246. u_int8_t   buf[1]; /* Variable length data. */
  247. };
  248. #include "dbinc_auto/mp_ext.h"
  249. #endif /* !_DB_MP_H_ */