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

MySQL数据库

开发平台:

Visual C++

  1. /******************************************************
  2. Recovery
  3. (c) 1997 Innobase Oy
  4. Created 9/20/1997 Heikki Tuuri
  5. *******************************************************/
  6. #ifndef log0recv_h
  7. #define log0recv_h
  8. #include "univ.i"
  9. #include "ut0byte.h"
  10. #include "page0types.h"
  11. #include "hash0hash.h"
  12. #include "log0log.h"
  13. #ifdef UNIV_HOTBACKUP
  14. extern ibool recv_replay_file_ops;
  15. #endif /* UNIV_HOTBACKUP */
  16. /***********************************************************************
  17. Reads the checkpoint info needed in hot backup. */
  18. ibool
  19. recv_read_cp_info_for_backup(
  20. /*=========================*/
  21. /* out: TRUE if success */
  22. byte* hdr, /* in: buffer containing the log group header */
  23. dulint* lsn, /* out: checkpoint lsn */
  24. ulint* offset, /* out: checkpoint offset in the log group */
  25. ulint* fsp_limit,/* out: fsp limit of space 0, 1000000000 if the
  26. database is running with < version 3.23.50 of InnoDB */
  27. dulint* cp_no, /* out: checkpoint number */
  28. dulint* first_header_lsn);
  29. /* out: lsn of of the start of the first log file */
  30. /***********************************************************************
  31. Scans the log segment and n_bytes_scanned is set to the length of valid
  32. log scanned. */
  33. void
  34. recv_scan_log_seg_for_backup(
  35. /*=========================*/
  36. byte* buf, /* in: buffer containing log data */
  37. ulint buf_len, /* in: data length in that buffer */
  38. dulint* scanned_lsn, /* in/out: lsn of buffer start,
  39. we return scanned lsn */
  40. ulint* scanned_checkpoint_no,
  41. /* in/out: 4 lowest bytes of the
  42. highest scanned checkpoint number so
  43. far */
  44. ulint* n_bytes_scanned);/* out: how much we were able to
  45. scan, smaller than buf_len if log
  46. data ended here */
  47. /***********************************************************************
  48. Returns TRUE if recovery is currently running. */
  49. UNIV_INLINE
  50. ibool
  51. recv_recovery_is_on(void);
  52. /*=====================*/
  53. /***********************************************************************
  54. Returns TRUE if recovery from backup is currently running. */
  55. UNIV_INLINE
  56. ibool
  57. recv_recovery_from_backup_is_on(void);
  58. /*=================================*/
  59. /****************************************************************************
  60. Applies the hashed log records to the page, if the page lsn is less than the
  61. lsn of a log record. This can be called when a buffer page has just been
  62. read in, or also for a page already in the buffer pool. */
  63. void
  64. recv_recover_page(
  65. /*==============*/
  66. ibool recover_backup, /* in: TRUE if we are recovering a backup
  67. page: then we do not acquire any latches
  68. since the page was read in outside the
  69. buffer pool */
  70. ibool just_read_in, /* in: TRUE if the i/o-handler calls this for
  71. a freshly read page */
  72. page_t* page, /* in: buffer page */
  73. ulint space, /* in: space id */
  74. ulint page_no); /* in: page number */
  75. /************************************************************
  76. Recovers from a checkpoint. When this function returns, the database is able
  77. to start processing of new user transactions, but the function
  78. recv_recovery_from_checkpoint_finish should be called later to complete
  79. the recovery and free the resources used in it. */
  80. ulint
  81. recv_recovery_from_checkpoint_start(
  82. /*================================*/
  83. /* out: error code or DB_SUCCESS */
  84. ulint type, /* in: LOG_CHECKPOINT or LOG_ARCHIVE */
  85. dulint limit_lsn, /* in: recover up to this lsn if possible */
  86. dulint min_flushed_lsn,/* in: min flushed lsn from data files */
  87. dulint max_flushed_lsn);/* in: max flushed lsn from data files */
  88. /************************************************************
  89. Completes recovery from a checkpoint. */
  90. void
  91. recv_recovery_from_checkpoint_finish(void);
  92. /*======================================*/
  93. /***********************************************************
  94. Scans log from a buffer and stores new log data to the parsing buffer. Parses
  95. and hashes the log records if new data found. */
  96. ibool
  97. recv_scan_log_recs(
  98. /*===============*/
  99. /* out: TRUE if limit_lsn has been reached, or
  100. not able to scan any more in this log group */
  101. ibool apply_automatically,/* in: TRUE if we want this function to
  102. apply log records automatically when the
  103. hash table becomes full; in the hot backup tool
  104. the tool does the applying, not this
  105. function */
  106. ulint available_memory,/* in: we let the hash table of recs to grow
  107. to this size, at the maximum */
  108. ibool store_to_hash, /* in: TRUE if the records should be stored
  109. to the hash table; this is set to FALSE if just
  110. debug checking is needed */
  111. byte* buf, /* in: buffer containing a log segment or
  112. garbage */
  113. ulint len, /* in: buffer length */
  114. dulint start_lsn, /* in: buffer start lsn */
  115. dulint* contiguous_lsn, /* in/out: it is known that all log groups
  116. contain contiguous log data up to this lsn */
  117. dulint* group_scanned_lsn);/* out: scanning succeeded up to this lsn */
  118. /**********************************************************
  119. Resets the logs. The contents of log files will be lost! */
  120. void
  121. recv_reset_logs(
  122. /*============*/
  123. dulint lsn, /* in: reset to this lsn rounded up to
  124. be divisible by OS_FILE_LOG_BLOCK_SIZE,
  125. after which we add LOG_BLOCK_HDR_SIZE */
  126. #ifdef UNIV_LOG_ARCHIVE
  127. ulint arch_log_no, /* in: next archived log file number */
  128. #endif /* UNIV_LOG_ARCHIVE */
  129. ibool new_logs_created);/* in: TRUE if resetting logs is done
  130. at the log creation; FALSE if it is done
  131. after archive recovery */
  132. #ifdef UNIV_HOTBACKUP
  133. /**********************************************************
  134. Creates new log files after a backup has been restored. */
  135. void
  136. recv_reset_log_files_for_backup(
  137. /*============================*/
  138. const char* log_dir, /* in: log file directory path */
  139. ulint n_log_files, /* in: number of log files */
  140. ulint log_file_size, /* in: log file size */
  141. dulint lsn); /* in: new start lsn, must be
  142. divisible by OS_FILE_LOG_BLOCK_SIZE */
  143. #endif /* UNIV_HOTBACKUP */
  144. /************************************************************
  145. Creates the recovery system. */
  146. void
  147. recv_sys_create(void);
  148. /*=================*/
  149. /************************************************************
  150. Inits the recovery system for a recovery operation. */
  151. void
  152. recv_sys_init(
  153. /*==========*/
  154. ibool recover_from_backup, /* in: TRUE if this is called
  155. to recover from a hot backup */
  156. ulint available_memory); /* in: available memory in bytes */
  157. /***********************************************************************
  158. Empties the hash table of stored log records, applying them to appropriate
  159. pages. */
  160. void
  161. recv_apply_hashed_log_recs(
  162. /*=======================*/
  163. ibool allow_ibuf); /* in: if TRUE, also ibuf operations are
  164. allowed during the application; if FALSE,
  165. no ibuf operations are allowed, and after
  166. the application all file pages are flushed to
  167. disk and invalidated in buffer pool: this
  168. alternative means that no new log records
  169. can be generated during the application */
  170. #ifdef UNIV_HOTBACKUP
  171. /***********************************************************************
  172. Applies log records in the hash table to a backup. */
  173. void
  174. recv_apply_log_recs_for_backup(void);
  175. /*================================*/
  176. #endif
  177. #ifdef UNIV_LOG_ARCHIVE
  178. /************************************************************
  179. Recovers from archived log files, and also from log files, if they exist. */
  180. ulint
  181. recv_recovery_from_archive_start(
  182. /*=============================*/
  183. /* out: error code or DB_SUCCESS */
  184. dulint min_flushed_lsn,/* in: min flushed lsn field from the
  185. data files */
  186. dulint limit_lsn, /* in: recover up to this lsn if possible */
  187. ulint first_log_no); /* in: number of the first archived log file
  188. to use in the recovery; the file will be
  189. searched from INNOBASE_LOG_ARCH_DIR specified
  190. in server config file */
  191. /************************************************************
  192. Completes recovery from archive. */
  193. void
  194. recv_recovery_from_archive_finish(void);
  195. /*===================================*/
  196. #endif /* UNIV_LOG_ARCHIVE */
  197. /***********************************************************************
  198. Checks that a replica of a space is identical to the original space. */
  199. void
  200. recv_compare_spaces(
  201. /*================*/
  202. ulint space1, /* in: space id */
  203. ulint space2, /* in: space id */
  204. ulint n_pages);/* in: number of pages */
  205. /***********************************************************************
  206. Checks that a replica of a space is identical to the original space. Disables
  207. ibuf operations and flushes and invalidates the buffer pool pages after the
  208. test. This function can be used to check the recovery before dict or trx
  209. systems are initialized. */
  210. void
  211. recv_compare_spaces_low(
  212. /*====================*/
  213. ulint space1, /* in: space id */
  214. ulint space2, /* in: space id */
  215. ulint n_pages);/* in: number of pages */
  216. /* Block of log record data */
  217. typedef struct recv_data_struct recv_data_t;
  218. struct recv_data_struct{
  219. recv_data_t* next; /* pointer to the next block or NULL */
  220. /* the log record data is stored physically
  221. immediately after this struct, max amount
  222. RECV_DATA_BLOCK_SIZE bytes of it */
  223. };
  224. /* Stored log record struct */
  225. typedef struct recv_struct recv_t;
  226. struct recv_struct{
  227. byte type; /* log record type */
  228. ulint len; /* log record body length in bytes */
  229. recv_data_t* data; /* chain of blocks containing the log record
  230. body */
  231. dulint start_lsn;/* start lsn of the log segment written by
  232. the mtr which generated this log record: NOTE
  233. that this is not necessarily the start lsn of
  234. this log record */
  235. dulint end_lsn;/* end lsn of the log segment written by
  236. the mtr which generated this log record: NOTE
  237. that this is not necessarily the end lsn of
  238. this log record */
  239. UT_LIST_NODE_T(recv_t)
  240. rec_list;/* list of log records for this page */
  241. };
  242. /* Hashed page file address struct */
  243. typedef struct recv_addr_struct recv_addr_t;
  244. struct recv_addr_struct{
  245. ulint state; /* RECV_NOT_PROCESSED, RECV_BEING_PROCESSED,
  246. or RECV_PROCESSED */
  247. ulint space; /* space id */
  248. ulint page_no;/* page number */
  249. UT_LIST_BASE_NODE_T(recv_t)
  250. rec_list;/* list of log records for this page */
  251. hash_node_t addr_hash;
  252. };
  253. /* Recovery system data structure */
  254. typedef struct recv_sys_struct recv_sys_t;
  255. struct recv_sys_struct{
  256. mutex_t mutex; /* mutex protecting the fields apply_log_recs,
  257. n_addrs, and the state field in each recv_addr
  258. struct */
  259. ibool apply_log_recs;
  260. /* this is TRUE when log rec application to
  261. pages is allowed; this flag tells the
  262. i/o-handler if it should do log record
  263. application */
  264. ibool apply_batch_on;
  265. /* this is TRUE when a log rec application
  266. batch is running */
  267. dulint lsn; /* log sequence number */
  268. ulint last_log_buf_size;
  269. /* size of the log buffer when the database
  270. last time wrote to the log */
  271. byte* last_block;
  272. /* possible incomplete last recovered log
  273. block */
  274. byte* last_block_buf_start;
  275. /* the nonaligned start address of the
  276. preceding buffer */
  277. byte* buf; /* buffer for parsing log records */
  278. ulint len; /* amount of data in buf */
  279. dulint parse_start_lsn;
  280. /* this is the lsn from which we were able to
  281. start parsing log records and adding them to
  282. the hash table; ut_dulint_zero if a suitable
  283. start point not found yet */
  284. dulint scanned_lsn;
  285. /* the log data has been scanned up to this
  286. lsn */
  287. ulint scanned_checkpoint_no;
  288. /* the log data has been scanned up to this
  289. checkpoint number (lowest 4 bytes) */
  290. ulint recovered_offset;
  291. /* start offset of non-parsed log records in
  292. buf */
  293. dulint recovered_lsn;
  294. /* the log records have been parsed up to
  295. this lsn */
  296. dulint limit_lsn;/* recovery should be made at most up to this
  297. lsn */
  298. ibool found_corrupt_log;
  299. /* this is set to TRUE if we during log
  300. scan find a corrupt log block, or a corrupt
  301. log record, or there is a log parsing
  302. buffer overflow */
  303. log_group_t* archive_group;
  304. /* in archive recovery: the log group whose
  305. archive is read */
  306. mem_heap_t* heap; /* memory heap of log records and file
  307. addresses*/
  308. hash_table_t* addr_hash;/* hash table of file addresses of pages */
  309. ulint n_addrs;/* number of not processed hashed file
  310. addresses in the hash table */
  311. };
  312. extern recv_sys_t* recv_sys;
  313. extern ibool recv_recovery_on;
  314. extern ibool recv_no_ibuf_operations;
  315. extern ibool recv_needed_recovery;
  316. extern ibool            recv_lsn_checks_on;
  317. #ifdef UNIV_HOTBACKUP
  318. extern ibool recv_is_making_a_backup;
  319. #endif /* UNIV_HOTBACKUP */
  320. extern ulint recv_max_parsed_page_no;
  321. /* Size of the parsing buffer; it must accommodate RECV_SCAN_SIZE many
  322. times! */ 
  323. #define RECV_PARSING_BUF_SIZE (2 * 1024 * 1024)
  324. /* Size of block reads when the log groups are scanned forward to do a
  325. roll-forward */
  326. #define RECV_SCAN_SIZE (4 * UNIV_PAGE_SIZE)
  327. /* States of recv_addr_struct */
  328. #define RECV_NOT_PROCESSED 71
  329. #define RECV_BEING_READ 72
  330. #define RECV_BEING_PROCESSED 73
  331. #define RECV_PROCESSED 74
  332. /* The number which is added to a space id to obtain the replicate space
  333. in the debug version: spaces with an odd number as the id are replicate
  334. spaces */
  335. #define RECV_REPLICA_SPACE_ADD 1
  336. extern ulint recv_n_pool_free_frames;
  337. #ifndef UNIV_NONINL
  338. #include "log0recv.ic"
  339. #endif
  340. #endif