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

MySQL数据库

开发平台:

Visual C++

  1. /******************************************************
  2. The memory management
  3. (c) 1994, 1995 Innobase Oy
  4. Created 6/9/1994 Heikki Tuuri
  5. *******************************************************/
  6. #ifndef mem0mem_h
  7. #define mem0mem_h
  8. #include "univ.i"
  9. #include "ut0mem.h"
  10. #include "ut0byte.h"
  11. #include "ut0ut.h"
  12. #include "ut0rnd.h"
  13. #include "sync0sync.h"
  14. #include "ut0lst.h"
  15. #include "mach0data.h"
  16. /* -------------------- MEMORY HEAPS ----------------------------- */
  17. /* The info structure stored at the beginning of a heap block */
  18. typedef struct mem_block_info_struct mem_block_info_t;
  19. /* A block of a memory heap consists of the info structure
  20. followed by an area of memory */
  21. typedef mem_block_info_t mem_block_t;
  22. /* A memory heap is a nonempty linear list of memory blocks */
  23. typedef mem_block_t mem_heap_t;
  24. /* Types of allocation for memory heaps: DYNAMIC means allocation from the
  25. dynamic memory pool of the C compiler, BUFFER means allocation from the index
  26. page buffer pool; the latter method is used for very big heaps */
  27. #define MEM_HEAP_DYNAMIC 0 /* the most common type */
  28. #define MEM_HEAP_BUFFER 1
  29. #define MEM_HEAP_BTR_SEARCH 2 /* this flag can be ORed to the
  30. previous */
  31. /* The following start size is used for the first block in the memory heap if
  32. the size is not specified, i.e., 0 is given as the parameter in the call of
  33. create. The standard size is the maximum (payload) size of the blocks used for
  34. allocations of small buffers. */
  35. #define MEM_BLOCK_START_SIZE            64
  36. #define MEM_BLOCK_STANDARD_SIZE         8000
  37. /* If a memory heap is allowed to grow into the buffer pool, the following
  38. is the maximum size for a single allocated buffer: */
  39. #define MEM_MAX_ALLOC_IN_BUF (UNIV_PAGE_SIZE - 200)
  40. /**********************************************************************
  41. Initializes the memory system. */
  42. void
  43. mem_init(
  44. /*=====*/
  45. ulint size); /* in: common pool size in bytes */
  46. /******************************************************************
  47. Use this macro instead of the corresponding function! Macro for memory
  48. heap creation. */
  49. #define mem_heap_create(N)    mem_heap_create_func(
  50. (N), NULL, MEM_HEAP_DYNAMIC,
  51. __FILE__, __LINE__)
  52. /******************************************************************
  53. Use this macro instead of the corresponding function! Macro for memory
  54. heap creation. */
  55. #define mem_heap_create_in_buffer(N) mem_heap_create_func(
  56. (N), NULL, MEM_HEAP_BUFFER,
  57. __FILE__, __LINE__)
  58. /******************************************************************
  59. Use this macro instead of the corresponding function! Macro for memory
  60. heap creation. */
  61. #define mem_heap_create_in_btr_search(N) mem_heap_create_func(
  62. (N), NULL, MEM_HEAP_BTR_SEARCH |
  63. MEM_HEAP_BUFFER,
  64. __FILE__, __LINE__)
  65. /******************************************************************
  66. Use this macro instead of the corresponding function! Macro for fast
  67. memory heap creation. An initial block of memory B is given by the
  68. caller, N is its size, and this memory block is not freed by
  69. mem_heap_free. See the parameter comment in mem_heap_create_func below. */
  70. #define mem_heap_fast_create(N, B) mem_heap_create_func(
  71. (N), (B), MEM_HEAP_DYNAMIC,
  72. __FILE__, __LINE__)
  73. /******************************************************************
  74. Use this macro instead of the corresponding function! Macro for memory
  75. heap freeing. */
  76. #define mem_heap_free(heap) mem_heap_free_func(
  77.   (heap), __FILE__, __LINE__)
  78. /*********************************************************************
  79. NOTE: Use the corresponding macros instead of this function. Creates a
  80. memory heap which allocates memory from dynamic space. For debugging
  81. purposes, takes also the file name and line as argument in the debug
  82. version. */
  83. UNIV_INLINE
  84. mem_heap_t*
  85. mem_heap_create_func(
  86. /*=================*/
  87. /* out, own: memory heap */
  88. ulint n, /* in: desired start block size,
  89. this means that a single user buffer
  90. of size n will fit in the block, 
  91. 0 creates a default size block;
  92. if init_block is not NULL, n tells
  93. its size in bytes */
  94. void* init_block, /* in: if very fast creation is
  95. wanted, the caller can reserve some
  96. memory from its stack, for example,
  97. and pass it as the the initial block
  98. to the heap: then no OS call of malloc
  99. is needed at the creation. CAUTION:
  100. the caller must make sure the initial
  101. block is not unintentionally erased
  102. (if allocated in the stack), before
  103. the memory heap is explicitly freed. */
  104. ulint type, /* in: MEM_HEAP_DYNAMIC
  105. or MEM_HEAP_BUFFER */ 
  106. const char* file_name, /* in: file name where created */
  107. ulint line /* in: line where created */
  108. );
  109. /*********************************************************************
  110. NOTE: Use the corresponding macro instead of this function. Frees the space
  111. occupied by a memory heap. In the debug version erases the heap memory
  112. blocks. */
  113. UNIV_INLINE
  114. void
  115. mem_heap_free_func(
  116. /*===============*/
  117. mem_heap_t*    heap,   /* in, own: heap to be freed */
  118. const char* file_name,  /* in: file name where freed */
  119. ulint     line); /* in: line where freed */
  120. /*******************************************************************
  121. Allocates n bytes of memory from a memory heap. */
  122. UNIV_INLINE
  123. void*
  124. mem_heap_alloc(
  125. /*===========*/
  126. /* out: allocated storage, NULL if
  127. did not succeed */
  128. mem_heap_t*    heap,  /* in: memory heap */
  129. ulint           n); /* in: number of bytes; if the heap is allowed
  130. to grow into the buffer pool, this must be
  131. <= MEM_MAX_ALLOC_IN_BUF */
  132. /*********************************************************************
  133. Returns a pointer to the heap top. */
  134. UNIV_INLINE
  135. byte*
  136. mem_heap_get_heap_top(
  137. /*==================*/     
  138. /* out: pointer to the heap top */
  139. mem_heap_t*    heap);  /* in: memory heap */
  140. /*********************************************************************
  141. Frees the space in a memory heap exceeding the pointer given. The
  142. pointer must have been acquired from mem_heap_get_heap_top. The first
  143. memory block of the heap is not freed. */
  144. UNIV_INLINE
  145. void
  146. mem_heap_free_heap_top(
  147. /*===================*/
  148. mem_heap_t*    heap, /* in: heap from which to free */
  149. byte* old_top);/* in: pointer to old top of heap */
  150. /*********************************************************************
  151. Empties a memory heap. The first memory block of the heap is not freed. */
  152. UNIV_INLINE
  153. void
  154. mem_heap_empty(
  155. /*===========*/
  156. mem_heap_t*    heap); /* in: heap to empty */
  157. /*********************************************************************
  158. Returns a pointer to the topmost element in a memory heap.
  159. The size of the element must be given. */
  160. UNIV_INLINE
  161. void*
  162. mem_heap_get_top(
  163. /*=============*/     
  164. /* out: pointer to the topmost element */
  165. mem_heap_t*    heap,  /* in: memory heap */
  166. ulint           n);     /* in: size of the topmost element */
  167. /*********************************************************************
  168. Frees the topmost element in a memory heap.
  169. The size of the element must be given. */
  170. UNIV_INLINE
  171. void
  172. mem_heap_free_top(
  173. /*==============*/     
  174. mem_heap_t*    heap,  /* in: memory heap */
  175. ulint           n);     /* in: size of the topmost element */
  176. /*********************************************************************
  177. Returns the space in bytes occupied by a memory heap. */
  178. UNIV_INLINE
  179. ulint
  180. mem_heap_get_size(
  181. /*==============*/
  182. mem_heap_t* heap);   /* in: heap */
  183. /******************************************************************
  184. Use this macro instead of the corresponding function!
  185. Macro for memory buffer allocation */
  186. #define mem_alloc(N)    mem_alloc_func((N), __FILE__, __LINE__)
  187. /******************************************************************
  188. Use this macro instead of the corresponding function!
  189. Macro for memory buffer allocation */
  190. #define mem_alloc_noninline(N)    mem_alloc_func_noninline(
  191.   (N), __FILE__, __LINE__)
  192. /*******************************************************************
  193. NOTE: Use the corresponding macro instead of this function.
  194. Allocates a single buffer of memory from the dynamic memory of
  195. the C compiler. Is like malloc of C. The buffer must be freed 
  196. with mem_free. */
  197. UNIV_INLINE
  198. void*
  199. mem_alloc_func(
  200. /*===========*/
  201. /* out, own: free storage, NULL
  202. if did not succeed */
  203. ulint n, /* in: desired number of bytes */
  204. const char* file_name, /* in: file name where created */
  205. ulint line /* in: line where created */
  206. );
  207. /*******************************************************************
  208. NOTE: Use the corresponding macro instead of this function.
  209. Allocates a single buffer of memory from the dynamic memory of
  210. the C compiler. Is like malloc of C. The buffer must be freed 
  211. with mem_free. */
  212. void*
  213. mem_alloc_func_noninline(
  214. /*=====================*/
  215. /* out, own: free storage,
  216. NULL if did not succeed */
  217. ulint n, /* in: desired number of bytes */
  218. const char* file_name, /* in: file name where created */
  219. ulint line /* in: line where created */
  220. );
  221. /******************************************************************
  222. Use this macro instead of the corresponding function!
  223. Macro for memory buffer freeing */
  224. #define mem_free(PTR)   mem_free_func((PTR), __FILE__, __LINE__)
  225. /*******************************************************************
  226. NOTE: Use the corresponding macro instead of this function.
  227. Frees a single buffer of storage from
  228. the dynamic memory of C compiler. Similar to free of C. */
  229. UNIV_INLINE
  230. void
  231. mem_free_func(
  232. /*==========*/
  233. void* ptr, /* in, own: buffer to be freed */
  234. const char* file_name, /* in: file name where created */
  235. ulint line /* in: line where created */
  236. );
  237. /**************************************************************************
  238. Duplicates a NUL-terminated string. */
  239. UNIV_INLINE
  240. char*
  241. mem_strdup(
  242. /*=======*/
  243. /* out, own: a copy of the string,
  244. must be deallocated with mem_free */
  245. const char* str); /* in: string to be copied */
  246. /**************************************************************************
  247. Makes a NUL-terminated copy of a nonterminated string. */
  248. UNIV_INLINE
  249. char*
  250. mem_strdupl(
  251. /*========*/
  252. /* out, own: a copy of the string,
  253. must be deallocated with mem_free */
  254. const char* str, /* in: string to be copied */
  255. ulint len); /* in: length of str, in bytes */
  256. /**************************************************************************
  257. Makes a NUL-terminated quoted copy of a NUL-terminated string. */
  258. UNIV_INLINE
  259. char*
  260. mem_strdupq(
  261. /*========*/
  262. /* out, own: a quoted copy of the string,
  263. must be deallocated with mem_free */
  264. const char* str, /* in: string to be copied */
  265. char q); /* in: quote character */
  266. /**************************************************************************
  267. Duplicates a NUL-terminated string, allocated from a memory heap. */
  268. char*
  269. mem_heap_strdup(
  270. /*============*/
  271. /* out, own: a copy of the string */
  272. mem_heap_t* heap, /* in: memory heap where string is allocated */
  273. const char* str); /* in: string to be copied */
  274. /**************************************************************************
  275. Makes a NUL-terminated copy of a nonterminated string,
  276. allocated from a memory heap. */
  277. UNIV_INLINE
  278. char*
  279. mem_heap_strdupl(
  280. /*=============*/
  281. /* out, own: a copy of the string */
  282. mem_heap_t* heap, /* in: memory heap where string is allocated */
  283. const char* str, /* in: string to be copied */
  284. ulint len); /* in: length of str, in bytes */
  285. #ifdef MEM_PERIODIC_CHECK
  286. /**********************************************************************
  287. Goes through the list of all allocated mem blocks, checks their magic
  288. numbers, and reports possible corruption. */
  289. void
  290. mem_validate_all_blocks(void);
  291. /*=========================*/
  292. #endif
  293. /*#######################################################################*/
  294. /* The info header of a block in a memory heap */
  295. struct mem_block_info_struct {
  296. ulint   magic_n;/* magic number for debugging */
  297. char file_name[8];/* file name where the mem heap was created */
  298. ulint line; /* line number where the mem heap was created */
  299. UT_LIST_BASE_NODE_T(mem_block_t) base; /* In the first block in the
  300. the list this is the base node of the list of blocks;
  301. in subsequent blocks this is undefined */
  302. UT_LIST_NODE_T(mem_block_t) list; /* This contains pointers to next
  303. and prev in the list. The first block allocated
  304. to the heap is also the first block in this list,
  305. though it also contains the base node of the list. */
  306. ulint   len;    /* physical length of this block in bytes */
  307. ulint  type;  /* type of heap: MEM_HEAP_DYNAMIC, or
  308. MEM_HEAP_BUF possibly ORed to MEM_HEAP_BTR_SEARCH */
  309. ibool init_block; /* TRUE if this is the first block used in fast
  310. creation of a heap: the memory will be freed
  311. by the creator, not by mem_heap_free */
  312. ulint   free;   /* offset in bytes of the first free position for
  313. user data in the block */
  314. ulint   start;  /* the value of the struct field 'free' at the 
  315. creation of the block */
  316. byte*  free_block;
  317. /* if the MEM_HEAP_BTR_SEARCH bit is set in type,
  318. and this is the heap root, this can contain an
  319. allocated buffer frame, which can be appended as a
  320. free block to the heap, if we need more space;
  321. otherwise, this is NULL */
  322. #ifdef MEM_PERIODIC_CHECK
  323. UT_LIST_NODE_T(mem_block_t) mem_block_list;
  324. /* List of all mem blocks allocated; protected
  325. by the mem_comm_pool mutex */
  326. #endif
  327. };
  328. #define MEM_BLOCK_MAGIC_N 764741555
  329. #define MEM_FREED_BLOCK_MAGIC_N 547711122
  330. /* Header size for a memory heap block */
  331. #define MEM_BLOCK_HEADER_SIZE   ut_calc_align(sizeof(mem_block_info_t),
  332. UNIV_MEM_ALIGNMENT)
  333. #include "mem0dbg.h"
  334. #ifndef UNIV_NONINL
  335. #include "mem0mem.ic"
  336. #endif
  337. #endif