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

MySQL数据库

开发平台:

Visual C++

  1. /******************************************************
  2. The low-level file system
  3. (c) 1995 Innobase Oy
  4. Created 10/25/1995 Heikki Tuuri
  5. *******************************************************/
  6. #ifndef fil0fil_h
  7. #define fil0fil_h
  8. #include "univ.i"
  9. #include "sync0rw.h"
  10. #include "dict0types.h"
  11. #include "ibuf0types.h"
  12. #include "ut0byte.h"
  13. #include "os0file.h"
  14. /* 'null' (undefined) page offset in the context of file spaces */
  15. #define FIL_NULL ULINT32_UNDEFINED
  16. /* Space address data type; this is intended to be used when
  17. addresses accurate to a byte are stored in file pages. If the page part
  18. of the address is FIL_NULL, the address is considered undefined. */
  19. typedef byte fil_faddr_t; /* 'type' definition in C: an address
  20. stored in a file page is a string of bytes */
  21. #define FIL_ADDR_PAGE 0 /* first in address is the page offset */
  22. #define FIL_ADDR_BYTE 4 /* then comes 2-byte byte offset within page*/
  23. #define FIL_ADDR_SIZE 6 /* address size is 6 bytes */
  24. /* A struct for storing a space address FIL_ADDR, when it is used
  25. in C program data structures. */
  26. typedef struct fil_addr_struct fil_addr_t;
  27. struct fil_addr_struct{
  28. ulint page; /* page number within a space */
  29. ulint boffset; /* byte offset within the page */
  30. };
  31. /* Null file address */
  32. extern fil_addr_t fil_addr_null;
  33. /* The byte offsets on a file page for various variables */
  34. #define FIL_PAGE_SPACE 0 /* space id the page belongs to */
  35. #define FIL_PAGE_OFFSET 4 /* page offset inside space */
  36. #define FIL_PAGE_PREV 8 /* if there is a 'natural' predecessor
  37. of the page, its offset */
  38. #define FIL_PAGE_NEXT 12 /* if there is a 'natural' successor
  39. of the page, its offset */
  40. #define FIL_PAGE_LSN 16 /* lsn of the end of the newest
  41. modification log record to the page */
  42. #define FIL_PAGE_TYPE 24 /* file page type: FIL_PAGE_INDEX,...,
  43. 2 bytes */
  44. #define FIL_PAGE_FILE_FLUSH_LSN 26 /* this is only defined for the
  45. first page in a data file: the file
  46. has been flushed to disk at least up
  47. to this lsn */
  48. #define FIL_PAGE_ARCH_LOG_NO 34 /* this is only defined for the
  49. first page in a data file: the latest
  50. archived log file number when the
  51. flush lsn above was written */
  52. #define FIL_PAGE_DATA 38 /* start of the data on the page */
  53. /* File page trailer */
  54. #define FIL_PAGE_END_LSN 8 /* this should be same as
  55. FIL_PAGE_LSN */
  56. #define FIL_PAGE_DATA_END 8
  57. /* File page types */
  58. #define FIL_PAGE_INDEX 17855
  59. #define FIL_PAGE_UNDO_LOG 2
  60. /* Space types */
  61. #define FIL_TABLESPACE  501
  62. #define FIL_LOG 502
  63. /***********************************************************************
  64. Reserves a right to open a single file. The right must be released with
  65. fil_release_right_to_open. */
  66. void
  67. fil_reserve_right_to_open(void);
  68. /*===========================*/
  69. /***********************************************************************
  70. Releases a right to open a single file. */
  71. void
  72. fil_release_right_to_open(void);
  73. /*===========================*/
  74. /************************************************************************
  75. Returns TRUE if file address is undefined. */
  76. ibool
  77. fil_addr_is_null(
  78. /*=============*/
  79. /* out: TRUE if undefined */
  80. fil_addr_t addr); /* in: address */
  81. /********************************************************************
  82. Initializes the file system of this module. */
  83. void
  84. fil_init(
  85. /*=====*/
  86. ulint max_n_open); /* in: max number of open files */
  87. /********************************************************************
  88. Initializes the ibuf indexes at a database start. This can be called
  89. after the file space headers have been created and the dictionary system
  90. has been initialized. */
  91. void
  92. fil_ibuf_init_at_db_start(void);
  93. /*===========================*/
  94. /***********************************************************************
  95. Creates a space object and puts it to the file system. */
  96. void
  97. fil_space_create(
  98. /*=============*/
  99. char* name, /* in: space name */
  100. ulint id, /* in: space id */
  101. ulint purpose);/* in: FIL_TABLESPACE, or FIL_LOG if log */
  102. /********************************************************************
  103. Drops files from the start of a file space, so that its size is cut by
  104. the amount given. */
  105. void
  106. fil_space_truncate_start(
  107. /*=====================*/
  108. ulint id, /* in: space id */
  109. ulint trunc_len); /* in: truncate by this much; it is an error
  110. if this does not equal to the combined size of
  111. some initial files in the space */
  112. /***********************************************************************
  113. Frees a space object from a file system. Closes the files in the chain
  114. but does not delete them. */
  115. void
  116. fil_space_free(
  117. /*===========*/
  118. ulint id); /* in: space id */
  119. /***********************************************************************
  120. Returns the latch of a file space. */
  121. rw_lock_t*
  122. fil_space_get_latch(
  123. /*================*/
  124. /* out: latch protecting storage allocation */
  125. ulint id); /* in: space id */
  126. /***********************************************************************
  127. Returns the type of a file space. */
  128. ulint
  129. fil_space_get_type(
  130. /*===============*/
  131. /* out: FIL_TABLESPACE or FIL_LOG */
  132. ulint id); /* in: space id */
  133. /********************************************************************
  134. Writes the flushed lsn and the latest archived log number to the page
  135. header of the first page of each data file. */
  136. ulint
  137. fil_write_flushed_lsn_to_data_files(
  138. /*================================*/
  139. /* out: DB_SUCCESS or error number */
  140. dulint lsn, /* in: lsn to write */
  141. ulint arch_log_no); /* in: latest archived log file number */
  142. /***********************************************************************
  143. Reads the flushed lsn and arch no fields from a data file at database
  144. startup. */
  145. void
  146. fil_read_flushed_lsn_and_arch_log_no(
  147. /*=================================*/
  148. os_file_t data_file, /* in: open data file */
  149. ibool one_read_already, /* in: TRUE if min and max parameters
  150. below already contain sensible data */
  151. dulint* min_flushed_lsn, /* in/out: */
  152. ulint* min_arch_log_no, /* in/out: */
  153. dulint* max_flushed_lsn, /* in/out: */
  154. ulint* max_arch_log_no); /* in/out: */
  155. /***********************************************************************
  156. Returns the ibuf data of a file space. */
  157. ibuf_data_t*
  158. fil_space_get_ibuf_data(
  159. /*====================*/
  160. /* out: ibuf data for this space */
  161. ulint id); /* in: space id */
  162. /***********************************************************************
  163. Returns the size of the space in pages. */
  164. ulint
  165. fil_space_get_size(
  166. /*===============*/
  167. /* out: space size */
  168. ulint id); /* in: space id */
  169. /***********************************************************************
  170. Appends a new file to the chain of files of a space.
  171. File must be closed. */
  172. void
  173. fil_node_create(
  174. /*============*/
  175. char* name, /* in: file name (file must be closed) */
  176. ulint size, /* in: file size in database blocks, rounded downwards
  177. to an integer */
  178. ulint id); /* in: space id where to append */
  179. /************************************************************************
  180. Reads or writes data. This operation is asynchronous (aio). */
  181. void
  182. fil_io(
  183. /*===*/
  184. ulint type, /* in: OS_FILE_READ or OS_FILE_WRITE,
  185. ORed to OS_FILE_LOG, if a log i/o
  186. and ORed to OS_AIO_SIMULATED_WAKE_LATER
  187. if simulated aio and we want to post a
  188. batch of i/os; NOTE that a simulated batch
  189. may introduce hidden chances of deadlocks,
  190. because i/os are not actually handled until
  191. all have been posted: use with great
  192. caution! */
  193. ibool sync, /* in: TRUE if synchronous aio is desired */
  194. ulint space_id, /* in: space id */
  195. ulint block_offset, /* in: offset in number of blocks */
  196. ulint byte_offset, /* in: remainder of offset in bytes; in
  197. aio this must be divisible by the OS block
  198. size */
  199. ulint len, /* in: how many bytes to read; this must
  200. not cross a file boundary; in aio this must
  201. be a block size multiple */
  202. void* buf, /* in/out: buffer where to store read data
  203. or from where to write; in aio this must be
  204. appropriately aligned */
  205. void* message); /* in: message for aio handler if non-sync
  206. aio used, else ignored */
  207. /************************************************************************
  208. Reads data from a space to a buffer. Remember that the possible incomplete
  209. blocks at the end of a file are ignored: they are not taken into account when
  210. calculating the byte offset within a space. */
  211. void
  212. fil_read(
  213. /*=====*/
  214. ibool sync, /* in: TRUE if synchronous aio is desired */
  215. ulint space_id, /* in: space id */
  216. ulint block_offset, /* in: offset in number of blocks */
  217. ulint byte_offset, /* in: remainder of offset in bytes; in aio
  218. this must be divisible by the OS block size */
  219. ulint len, /* in: how many bytes to read; this must not
  220. cross a file boundary; in aio this must be a
  221. block size multiple */
  222. void* buf, /* in/out: buffer where to store data read;
  223. in aio this must be appropriately aligned */
  224. void* message); /* in: message for aio handler if non-sync
  225. aio used, else ignored */
  226. /************************************************************************
  227. Writes data to a space from a buffer. Remember that the possible incomplete
  228. blocks at the end of a file are ignored: they are not taken into account when
  229. calculating the byte offset within a space. */
  230. void
  231. fil_write(
  232. /*======*/
  233. ibool sync, /* in: TRUE if synchronous aio is desired */
  234. ulint space_id, /* in: space id */
  235. ulint block_offset, /* in: offset in number of blocks */
  236. ulint byte_offset, /* in: remainder of offset in bytes; in aio
  237. this must be divisible by the OS block size */
  238. ulint len, /* in: how many bytes to write; this must
  239. not cross a file boundary; in aio this must
  240. be a block size multiple */
  241. void* buf, /* in: buffer from which to write; in aio
  242. this must be appropriately aligned */
  243. void* message); /* in: message for aio handler if non-sync
  244. aio used, else ignored */
  245. /**************************************************************************
  246. Waits for an aio operation to complete. This function is used to write the
  247. handler for completed requests. The aio array of pending requests is divided
  248. into segments (see os0file.c for more info). The thread specifies which
  249. segment it wants to wait for. */
  250. void
  251. fil_aio_wait(
  252. /*=========*/
  253. ulint segment); /* in: the number of the segment in the aio
  254. array to wait for */ 
  255. /**************************************************************************
  256. Flushes to disk possible writes cached by the OS. */
  257. void
  258. fil_flush(
  259. /*======*/
  260. ulint space_id); /* in: file space id (this can be a group of
  261. log files or a tablespace of the database) */
  262. /**************************************************************************
  263. Flushes to disk writes in file spaces of the given type possibly cached by
  264. the OS. */
  265. void
  266. fil_flush_file_spaces(
  267. /*==================*/
  268. ulint purpose); /* in: FIL_TABLESPACE, FIL_LOG */
  269. /**********************************************************************
  270. Checks the consistency of the file system. */
  271. ibool
  272. fil_validate(void);
  273. /*==============*/
  274. /* out: TRUE if ok */
  275. /************************************************************************
  276. Accessor functions for a file page */
  277. ulint
  278. fil_page_get_prev(byte* page);
  279. ulint
  280. fil_page_get_next(byte* page);
  281. /*************************************************************************
  282. Sets the file page type. */
  283. void
  284. fil_page_set_type(
  285. /*==============*/
  286. byte*  page, /* in: file page */
  287. ulint type); /* in: type */
  288. /*************************************************************************
  289. Gets the file page type. */
  290. ulint
  291. fil_page_get_type(
  292. /*==============*/
  293. /* out: type; NOTE that if the type has not been
  294. written to page, the return value not defined */
  295. byte*  page); /* in: file page */
  296. /***********************************************************************
  297. Tries to reserve free extents in a file space. */
  298. ibool
  299. fil_space_reserve_free_extents(
  300. /*===========================*/
  301. /* out: TRUE if succeed */
  302. ulint id, /* in: space id */
  303. ulint n_free_now, /* in: number of free extents now */
  304. ulint n_to_reserve); /* in: how many one wants to reserve */
  305. /***********************************************************************
  306. Releases free extents in a file space. */
  307. void
  308. fil_space_release_free_extents(
  309. /*===========================*/
  310. ulint id, /* in: space id */
  311. ulint n_reserved); /* in: how many one reserved */
  312. typedef struct fil_space_struct fil_space_t;
  313. #endif