/* Copyright (C) 2007 MySQL AB & Sanja Belkin This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335 USA */ #ifndef _ma_loghandler_h #define _ma_loghandler_h #define MB (1024UL*1024) /* transaction log default cache size (TODO: make it global variable) */ #define TRANSLOG_PAGECACHE_SIZE (2*MB) /* transaction log default file size */ #define TRANSLOG_FILE_SIZE (1024U*MB) /* minimum possible transaction log size */ #define TRANSLOG_MIN_FILE_SIZE (8*MB) /* transaction log default flags (TODO: make it global variable) */ #define TRANSLOG_DEFAULT_FLAGS 0 /* Transaction log flags. We allow all kind protections to be switched on together for people who really unsure in their hardware/OS. */ #define TRANSLOG_PAGE_CRC 1U #define TRANSLOG_SECTOR_PROTECTION (1U<<1) #define TRANSLOG_RECORD_CRC (1U<<2) #define TRANSLOG_FLAGS_NUM ((TRANSLOG_PAGE_CRC | TRANSLOG_SECTOR_PROTECTION | \ TRANSLOG_RECORD_CRC) + 1) #define RECHEADER_READ_ERROR -1 #define RECHEADER_READ_EOF -2 /* Page size in transaction log It should be Power of 2 and multiple of DISK_DRIVE_SECTOR_SIZE (DISK_DRIVE_SECTOR_SIZE * 2^N) */ #define TRANSLOG_PAGE_SIZE (8U*1024) #include "ma_loghandler_lsn.h" #include "trnman_public.h" /* short transaction ID type */ typedef uint16 SHORT_TRANSACTION_ID; struct st_maria_handler; /* Changing one of the "SIZE" below will break backward-compatibility! */ /* Length of CRC at end of pages */ #define ROW_EXTENT_PAGE_SIZE 5 #define ROW_EXTENT_COUNT_SIZE 2 /* Size of file id in logs */ #define FILEID_STORE_SIZE 2 /* Size of page reference in log */ #define PAGE_STORE_SIZE ROW_EXTENT_PAGE_SIZE /* Size of page ranges in log */ #define PAGERANGE_STORE_SIZE ROW_EXTENT_COUNT_SIZE #define DIRPOS_STORE_SIZE 1 #define CLR_TYPE_STORE_SIZE 1 /* If table has live checksum we store its changes in UNDOs */ #define HA_CHECKSUM_STORE_SIZE 4 #define KEY_NR_STORE_SIZE 1 #define PAGE_LENGTH_STORE_SIZE 2 /* Store methods to match the above sizes */ #define fileid_store(T,A) int2store(T,A) #define page_store(T,A) int5store(T,((ulonglong)(A))) #define dirpos_store(T,A) ((*(uchar*) (T)) = A) #define pagerange_store(T,A) int2store(T,A) #define clr_type_store(T,A) ((*(uchar*) (T)) = A) #define key_nr_store(T, A) ((*(uchar*) (T)) = A) #define ha_checksum_store(T,A) int4store(T,A) #define fileid_korr(P) uint2korr(P) #define page_korr(P) uint5korr(P) #define dirpos_korr(P) (*(const uchar *) (P)) #define pagerange_korr(P) uint2korr(P) #define clr_type_korr(P) (*(const uchar *) (P)) #define key_nr_korr(P) (*(const uchar *) (P)) #define ha_checksum_korr(P) uint4korr(P) /* Length of disk drive sector size (we assume that writing it to disk is an atomic operation) */ #define DISK_DRIVE_SECTOR_SIZE 512U /* position reserved in an array of parts of a log record */ #define TRANSLOG_INTERNAL_PARTS 2 /* types of records in the transaction log */ /* TODO: Set numbers for these when we have all entries figured out */ enum translog_record_type { LOGREC_RESERVED_FOR_CHUNKS23= 0, LOGREC_REDO_INSERT_ROW_HEAD, LOGREC_REDO_INSERT_ROW_TAIL, LOGREC_REDO_NEW_ROW_HEAD, LOGREC_REDO_NEW_ROW_TAIL, LOGREC_REDO_INSERT_ROW_BLOBS, LOGREC_REDO_PURGE_ROW_HEAD, LOGREC_REDO_PURGE_ROW_TAIL, LOGREC_REDO_FREE_BLOCKS, LOGREC_REDO_FREE_HEAD_OR_TAIL, LOGREC_REDO_DELETE_ROW, /* unused */ LOGREC_REDO_UPDATE_ROW_HEAD, /* unused */ LOGREC_REDO_INDEX, LOGREC_REDO_INDEX_NEW_PAGE, LOGREC_REDO_INDEX_FREE_PAGE, LOGREC_REDO_UNDELETE_ROW, LOGREC_CLR_END, LOGREC_PURGE_END, LOGREC_UNDO_ROW_INSERT, LOGREC_UNDO_ROW_DELETE, LOGREC_UNDO_ROW_UPDATE, LOGREC_UNDO_KEY_INSERT, LOGREC_UNDO_KEY_INSERT_WITH_ROOT, LOGREC_UNDO_KEY_DELETE, LOGREC_UNDO_KEY_DELETE_WITH_ROOT, LOGREC_PREPARE, LOGREC_PREPARE_WITH_UNDO_PURGE, LOGREC_COMMIT, LOGREC_COMMIT_WITH_UNDO_PURGE, LOGREC_CHECKPOINT, LOGREC_REDO_CREATE_TABLE, LOGREC_REDO_RENAME_TABLE, LOGREC_REDO_DROP_TABLE, LOGREC_REDO_DELETE_ALL, LOGREC_REDO_REPAIR_TABLE, LOGREC_FILE_ID, LOGREC_LONG_TRANSACTION_ID, LOGREC_INCOMPLETE_LOG, LOGREC_INCOMPLETE_GROUP, LOGREC_UNDO_BULK_INSERT, LOGREC_REDO_BITMAP_NEW_PAGE, LOGREC_IMPORTED_TABLE, LOGREC_DEBUG_INFO, LOGREC_FIRST_FREE, LOGREC_RESERVED_FUTURE_EXTENSION= 63 }; #define LOGREC_NUMBER_OF_TYPES 64 /* Maximum, can't be extended */ /* Type of operations in LOGREC_REDO_INDEX */ enum en_key_op { KEY_OP_NONE, /* Not used */ KEY_OP_OFFSET, /* Set current position */ KEY_OP_SHIFT, /* Shift up/or down at current position */ KEY_OP_CHANGE, /* Change data at current position */ KEY_OP_ADD_PREFIX, /* Insert data at start of page */ KEY_OP_DEL_PREFIX, /* Delete data at start of page */ KEY_OP_ADD_SUFFIX, /* Insert data at end of page */ KEY_OP_DEL_SUFFIX, /* Delete data at end of page */ KEY_OP_CHECK, /* For debugging; CRC of used part of page */ KEY_OP_MULTI_COPY, /* List of memcpy()s with fixed-len sources in page */ KEY_OP_SET_PAGEFLAG, /* Set pageflag from next byte */ KEY_OP_COMPACT_PAGE, /* Compact key page */ KEY_OP_MAX_PAGELENGTH, /* Set page to max page length */ KEY_OP_DEBUG, /* Entry for storing what triggered redo_index */ KEY_OP_DEBUG_2 /* Entry for pagelengths */ }; enum en_key_debug { KEY_OP_DEBUG_RTREE_COMBINE, /* 0 */ KEY_OP_DEBUG_RTREE_SPLIT, /* 1 */ KEY_OP_DEBUG_RTREE_SET_KEY, /* 2 */ KEY_OP_DEBUG_FATHER_CHANGED_1, /* 3 */ KEY_OP_DEBUG_FATHER_CHANGED_2, /* 4 */ KEY_OP_DEBUG_LOG_SPLIT, /* 5 */ KEY_OP_DEBUG_LOG_ADD_1, /* 6 */ KEY_OP_DEBUG_LOG_ADD_2, /* 7 */ KEY_OP_DEBUG_LOG_ADD_3, /* 8 */ KEY_OP_DEBUG_LOG_ADD_4, /* 9 */ KEY_OP_DEBUG_LOG_PREFIX_1, /* 10 */ KEY_OP_DEBUG_LOG_PREFIX_2, /* 11 */ KEY_OP_DEBUG_LOG_PREFIX_3, /* 12 */ KEY_OP_DEBUG_LOG_PREFIX_4, /* 13 */ KEY_OP_DEBUG_LOG_PREFIX_5, /* 14 */ KEY_OP_DEBUG_LOG_DEL_CHANGE_1, /* 15 */ KEY_OP_DEBUG_LOG_DEL_CHANGE_2, /* 16 */ KEY_OP_DEBUG_LOG_DEL_CHANGE_3, /* 17 */ KEY_OP_DEBUG_LOG_DEL_CHANGE_RT, /* 18 */ KEY_OP_DEBUG_LOG_DEL_PREFIX, /* 19 */ KEY_OP_DEBUG_LOG_MIDDLE /* 20 */ }; enum translog_debug_info_type { LOGREC_DEBUG_INFO_QUERY }; /* Size of log file; One log file is restricted to 4G */ typedef uint32 translog_size_t; #define TRANSLOG_RECORD_HEADER_MAX_SIZE 1024U typedef struct st_translog_group_descriptor { TRANSLOG_ADDRESS addr; uint8 num; } TRANSLOG_GROUP; typedef struct st_translog_header_buffer { /* LSN of the read record */ LSN lsn; /* array of groups descriptors, can be used only if groups_no > 0 */ TRANSLOG_GROUP *groups; /* short transaction ID or 0 if it has no sense for the record */ SHORT_TRANSACTION_ID short_trid; /* The Record length in buffer (including read header, but excluding hidden part of record (type, short TrID, length) */ translog_size_t record_length; /* Buffer for write decoded header of the record (depend on the record type) */ uchar header[TRANSLOG_RECORD_HEADER_MAX_SIZE]; /* number of groups listed in */ uint groups_no; /* in multi-group number of chunk0 pages (valid only if groups_no > 0) */ uint chunk0_pages; /* type of the read record */ enum translog_record_type type; /* chunk 0 data address (valid only if groups_no > 0) */ TRANSLOG_ADDRESS chunk0_data_addr; /* Real compressed LSN(s) size economy (*7 - ) */ int16 compressed_LSN_economy; /* short transaction ID or 0 if it has no sense for the record */ uint16 non_header_data_start_offset; /* non read body data length in this first chunk */ uint16 non_header_data_len; /* chunk 0 data size (valid only if groups_no > 0) */ uint16 chunk0_data_len; } TRANSLOG_HEADER_BUFFER; typedef struct st_translog_scanner_data { uchar buffer[TRANSLOG_PAGE_SIZE]; /* buffer for page content */ TRANSLOG_ADDRESS page_addr; /* current page address */ /* end of the log which we saw last time */ TRANSLOG_ADDRESS horizon; TRANSLOG_ADDRESS last_file_page; /* Last page on in this file */ uchar *page; /* page content pointer */ /* direct link on the current page or NULL if not supported/requested */ PAGECACHE_BLOCK_LINK *direct_link; /* offset of the chunk in the page */ translog_size_t page_offset; /* set horizon only once at init */ my_bool fixed_horizon; /* try to get direct link on the page if it is possible */ my_bool use_direct_link; } TRANSLOG_SCANNER_DATA; typedef struct st_translog_reader_data { TRANSLOG_HEADER_BUFFER header; /* Header */ TRANSLOG_SCANNER_DATA scanner; /* chunks scanner */ translog_size_t body_offset; /* current chunk body offset */ /* data offset from the record beginning */ translog_size_t current_offset; /* number of bytes read in header */ uint16 read_header; uint16 chunk_size; /* current chunk size */ uint current_group; /* current group */ uint current_chunk; /* current chunk in the group */ my_bool eor; /* end of the record */ } TRANSLOG_READER_DATA; C_MODE_START /* Records types for unittests */ #define LOGREC_FIXED_RECORD_0LSN_EXAMPLE 1 #define LOGREC_VARIABLE_RECORD_0LSN_EXAMPLE 2 #define LOGREC_FIXED_RECORD_1LSN_EXAMPLE 3 #define LOGREC_VARIABLE_RECORD_1LSN_EXAMPLE 4 #define LOGREC_FIXED_RECORD_2LSN_EXAMPLE 5 #define LOGREC_VARIABLE_RECORD_2LSN_EXAMPLE 6 extern void translog_example_table_init(); extern void translog_table_init(); #define translog_init(D,M,V,I,C,F,R) \ translog_init_with_table(D,M,V,I,C,F,R,&translog_table_init,0) extern my_bool translog_init_with_table(const char *directory, uint32 log_file_max_size, uint32 server_version, uint32 server_id, PAGECACHE *pagecache, uint flags, my_bool readonly, void (*init_table_func)(), my_bool no_error); #ifndef DBUG_OFF void check_translog_description_table(int num); #endif extern my_bool translog_write_record(LSN *lsn, enum translog_record_type type, TRN *trn, MARIA_HA *tbl_info, translog_size_t rec_len, uint part_no, LEX_CUSTRING *parts_data, uchar *store_share_id, void *hook_arg); extern void translog_destroy(); extern int translog_read_record_header(LSN lsn, TRANSLOG_HEADER_BUFFER *buff); extern void translog_free_record_header(TRANSLOG_HEADER_BUFFER *buff); extern translog_size_t translog_read_record(LSN lsn, translog_size_t offset, translog_size_t length, uchar *buffer, struct st_translog_reader_data *data); extern my_bool translog_flush(TRANSLOG_ADDRESS lsn); extern my_bool translog_scanner_init(LSN lsn, my_bool fixed_horizon, struct st_translog_scanner_data *scanner, my_bool use_direct_link); extern void translog_destroy_scanner(TRANSLOG_SCANNER_DATA *scanner); extern int translog_read_next_record_header(TRANSLOG_SCANNER_DATA *scanner, TRANSLOG_HEADER_BUFFER *buff); extern LSN translog_get_file_max_lsn_stored(uint32 file); extern my_bool translog_purge(TRANSLOG_ADDRESS low); extern my_bool translog_is_file(uint file_no); extern void translog_lock(); extern void translog_unlock(); extern void translog_lock_handler_assert_owner(); extern TRANSLOG_ADDRESS translog_get_horizon(); extern TRANSLOG_ADDRESS translog_get_horizon_no_lock(); extern int translog_assign_id_to_share(struct st_maria_handler *tbl_info, TRN *trn); extern void translog_deassign_id_from_share(struct st_maria_share *share); extern void translog_assign_id_to_share_from_recovery(struct st_maria_share *share, uint16 id); extern my_bool translog_walk_filenames(const char *directory, my_bool (*callback)(const char *, const char *)); extern void dump_page(uchar *buffer, File handler); extern my_bool translog_log_debug_info(TRN *trn, enum translog_debug_info_type type, uchar *info, size_t length); extern void translog_disable_purge(void); extern void translog_enable_purge(void); enum enum_translog_status { TRANSLOG_UNINITED, /* no initialization done or error during initialization */ TRANSLOG_OK, /* transaction log is functioning */ TRANSLOG_READONLY, /* read only mode due to write errors */ TRANSLOG_SHUTDOWN /* going to shutdown the loghandler */ }; extern enum enum_translog_status translog_status; extern ulonglong translog_syncs; /* Number of sync()s */ void translog_soft_sync(my_bool mode); void translog_hard_group_commit(my_bool mode); int translog_soft_sync_start(void); void translog_soft_sync_end(void); void translog_sync(); void translog_set_group_commit_interval(uint32 interval); extern void check_skipped_lsn(MARIA_HA *info, LSN lsn, my_bool index_file, pgcache_page_no_t page); /* all the rest added because of recovery; should we make ma_loghandler_for_recovery.h ? */ /* Information from transaction log file header */ typedef struct st_loghandler_file_info { /* LSN_IMPOSSIBLE for current file (not finished file). Maximum LSN of the record which parts stored in the file. */ LSN max_lsn; ulonglong timestamp; /* Time stamp */ ulong maria_version; /* Version of maria loghandler */ ulong mysql_version; /* Version of mysql server */ ulong server_id; /* Server ID */ ulong page_size; /* Loghandler page size */ ulong file_number; /* Number of the file (from the file header) */ } LOGHANDLER_FILE_INFO; #define SHARE_ID_MAX 65535 /* array's size */ extern void translog_fill_overhead_table(); extern void translog_interpret_file_header(LOGHANDLER_FILE_INFO *desc, uchar *page_buff); extern LSN translog_first_lsn_in_log(); extern LSN translog_first_theoretical_lsn(); extern LSN translog_next_LSN(TRANSLOG_ADDRESS addr, TRANSLOG_ADDRESS horizon); extern my_bool translog_purge_at_flush(); extern uint32 translog_get_first_file(TRANSLOG_ADDRESS horizon); extern uint32 translog_get_first_needed_file(); extern char *translog_filename_by_fileno(uint32 file_no, char *path); extern void translog_set_file_size(uint32 size); /* record parts descriptor */ struct st_translog_parts { /* full record length */ translog_size_t record_length; /* full record length with chunk headers */ translog_size_t total_record_length; /* current part index */ uint current; /* total number of elements in parts */ uint elements; /* array of parts */ LEX_CUSTRING *parts; }; typedef my_bool(*prewrite_rec_hook) (enum translog_record_type type, TRN *trn, struct st_maria_handler *tbl_info, void *hook_arg); typedef my_bool(*inwrite_rec_hook) (enum translog_record_type type, TRN *trn, struct st_maria_handler *tbl_info, LSN *lsn, void *hook_arg); typedef uint16(*read_rec_hook) (enum translog_record_type type, uint16 read_length, uchar *read_buff, uchar *decoded_buff); /* record classes */ enum record_class { LOGRECTYPE_NOT_ALLOWED, LOGRECTYPE_VARIABLE_LENGTH, LOGRECTYPE_PSEUDOFIXEDLENGTH, LOGRECTYPE_FIXEDLENGTH }; enum enum_record_in_group { LOGREC_NOT_LAST_IN_GROUP= 0, LOGREC_LAST_IN_GROUP, LOGREC_IS_GROUP_ITSELF }; /* Descriptor of log record type */ typedef struct st_log_record_type_descriptor { /* internal class of the record */ enum record_class rclass; /* length for fixed-size record, pseudo-fixed record length with uncompressed LSNs */ uint16 fixed_length; /* how much record body (belonged to headers too) read with headers */ uint16 read_header_len; /* HOOK for writing the record called before lock */ prewrite_rec_hook prewrite_hook; /* HOOK for writing the record called when LSN is known, inside lock */ inwrite_rec_hook inwrite_hook; /* HOOK for reading headers */ read_rec_hook read_hook; /* For pseudo fixed records number of compressed LSNs followed by system header */ int16 compressed_LSN; /* the rest is for maria_read_log & Recovery */ /** @brief for debug error messages or "maria_read_log" command-line tool */ const char *name; enum enum_record_in_group record_in_group; /* a function to execute when we see the record during the REDO phase */ int (*record_execute_in_redo_phase)(const TRANSLOG_HEADER_BUFFER *); /* a function to execute when we see the record during the UNDO phase */ int (*record_execute_in_undo_phase)(const TRANSLOG_HEADER_BUFFER *, TRN *); } LOG_DESC; extern LOG_DESC log_record_type_descriptor[LOGREC_NUMBER_OF_TYPES]; typedef enum { TRANSLOG_GCOMMIT_NONE, TRANSLOG_GCOMMIT_HARD, TRANSLOG_GCOMMIT_SOFT } enum_maria_group_commit; extern ulong maria_group_commit; extern ulong maria_group_commit_interval; typedef enum { TRANSLOG_PURGE_IMMIDIATE, TRANSLOG_PURGE_EXTERNAL, TRANSLOG_PURGE_ONDEMAND } enum_maria_translog_purge_type; extern ulong log_purge_type; extern ulong log_file_size; extern uint log_purge_disabled; /* For backup */ typedef enum { TRANSLOG_SYNC_DIR_NEVER, TRANSLOG_SYNC_DIR_NEWFILE, TRANSLOG_SYNC_DIR_ALWAYS } enum_maria_sync_log_dir; extern ulong sync_log_dir; C_MODE_END #endif