/* Copyright (C) 2018-2022 MariaDB Corporation AB
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
#include <mariadb/ma_io.h>
#define MARIADB_RPL_VERSION 0x0002
#define MARIADB_RPL_REQUIRED_VERSION 0x0002
#define RPL_BINLOG_MAGIC (const uchar*) "\xFE\x62\x69\x6E"
#define RPL_BINLOG_MAGIC_SIZE 4
#define MARIADB_RPL_BINLOG_DUMP_NON_BLOCK 1
#define MARIADB_RPL_BINLOG_SEND_ANNOTATE_ROWS 2
#define MARIADB_RPL_IGNORE_HEARTBEAT (1 << 17)
#define EVENT_HEADER_OFS 20
/* FL_STANDALONE is set in case there is no terminating COMMIT event. */
#define FL_STANDALONE 0x01
/* FL_GROUP_COMMIT_ID is set when event group is part of a group commit */
#define FL_GROUP_COMMIT_ID 0x02
/* FL_TRANSACTIONAL is set for an event group that can be safely rolled back
#define FL_TRANSACTIONAL 0x04
FL_ALLOW_PARALLEL reflects the (negation of the) value of
@@SESSION.skip_parallel_replication at the time of commit.
#define FL_ALLOW_PARALLEL 0x08;
FL_WAITED is set if a row lock wait (or other wait) is detected during the
execution of the transaction.
/* FL_DDL is set for event group containing DDL. */
/* FL_PREPARED_XA is set for XA transaction. */
#define FL_PREPARED_XA 0x40
/* FL_"COMMITTED or ROLLED-BACK"_XA is set for XA transaction. */
#define FL_COMPLETED_XA 0x80
/* SEMI SYNCHRONOUS REPLICATION */
#define SEMI_SYNC_INDICATOR 0xEF
#define SEMI_SYNC_ACK_REQ 0x01
enum mariadb_rpl_option {
MARIADB_RPL_FILENAME, /* Filename and length */
MARIADB_RPL_START, /* Start position */
MARIADB_RPL_SERVER_ID, /* Server ID */
MARIADB_RPL_FLAGS, /* Protocol flags */
MARIADB_RPL_GTID_CALLBACK, /* GTID callback function */
MARIADB_RPL_GTID_DATA, /* GTID data */
MARIADB_RPL_VERIFY_CHECKSUM,
MARIADB_RPL_EXTRACT_VALUES,
/* Event types: From MariaDB Server sql/log_event.h */
FORMAT_DESCRIPTION_EVENT= 15,
BEGIN_LOAD_QUERY_EVENT= 17,
EXECUTE_LOAD_QUERY_EVENT= 18,
PRE_GA_WRITE_ROWS_EVENT = 20, /* deprecated */
PRE_GA_UPDATE_ROWS_EVENT = 21, /* deprecated */
PRE_GA_DELETE_ROWS_EVENT = 22, /* deprecated */
WRITE_ROWS_EVENT_V1 = 23,
UPDATE_ROWS_EVENT_V1 = 24,
DELETE_ROWS_EVENT_V1 = 25,
ROWS_QUERY_LOG_EVENT= 29,
ANONYMOUS_GTID_LOG_EVENT= 34,
PREVIOUS_GTIDS_LOG_EVENT= 35,
TRANSACTION_CONTEXT_EVENT= 36,
XA_PREPARE_LOG_EVENT= 38,
PARTIAL_UPDATE_ROWS_EVENT = 39,
Add new events here - right above this comment!
Existing events (except ENUM_END_EVENT) should never change their numbers
/* New MySQL events are to be added right above this comment */
ANNOTATE_ROWS_EVENT= 160,
BINLOG_CHECKPOINT_EVENT= 161,
START_ENCRYPTION_EVENT= 164,
QUERY_COMPRESSED_EVENT = 165,
WRITE_ROWS_COMPRESSED_EVENT_V1 = 166,
UPDATE_ROWS_COMPRESSED_EVENT_V1 = 167,
DELETE_ROWS_COMPRESSED_EVENT_V1 = 168,
WRITE_ROWS_COMPRESSED_EVENT = 169,
UPDATE_ROWS_COMPRESSED_EVENT = 170,
DELETE_ROWS_COMPRESSED_EVENT = 171,
/* Add new MariaDB events here - right above this comment! */
ENUM_END_EVENT /* end marker */
#define NO_FOREIGN_KEY_CHECKS_F 0x02
#define RELAXED_UNIQUE_KEY_CHECKS_F 0x04
#define COMPLETE_ROWS_F 0x08
#define NO_CHECK_CONSTRAINT_CHECKS_F 0x80
enum mariadb_rpl_status_code {
Q_AUTO_INCREMENT_CODE= 0x03,
Q_LC_TIME_NAMES_CODE= 0x07,
Q_CHARSET_DATABASE_CODE= 0x08,
Q_TABLE_MAP_FOR_UPDATE_CODE= 0x09,
Q_MASTER_DATA_WRITTEN_CODE= 0x0A,
Q_UPDATED_DB_NAMES_CODE= 0x0C,
Q_MICROSECONDS_CODE= 0x0D,
Q_COMMIT_TS_CODE= 0x0E, /* unused */
Q_COMMIT_TS2_CODE= 0x0F, /* unused */
Q_EXPLICIT_DEFAULTS_FOR_TIMESTAMP_CODE= 0x10,
Q_DDL_LOGGED_WITH_XID_CODE= 0x11,
Q_DEFAULT_COLLATION_FOR_UTF8_CODE= 0x12,
Q_SQL_REQUIRE_PRIMARY_KEY_CODE= 0x13,
Q_DEFAULT_TABLE_ENCRYPTION_CODE= 0x14,
Q_HRNOW= 128, /* second part: 3 bytes */
Q_XID= 129 /* xid: 8 bytes */
enum opt_metadata_field_type
ENUM_AND_SET_DEFAULT_CHARSET,
ENUM_AND_SET_COLUMN_CHARSET
#define OPTION_AUTO_IS_NULL 0x00040000
#define OPTION_NOT_AUTOCOMMIT 0x00080000
#define OPTION_NO_FOREIGN_KEY_CHECKS 0x04000000
#define OPTION_RELAXED_UNIQUE_CHECKS 0x08000000
#define MODE_REAL_AS_FLOAT 0x00000001
#define MODE_PIPES_AS_CONCAT 0x00000002
#define MODE_ANSI_QUOTES 0x00000004
#define MODE_IGNORE_SPACE 0x00000008
#define MODE_NOT_USED 0x00000010
#define MODE_ONLY_FULL_GROUP_BY 0x00000020
#define MODE_NO_UNSIGNED_SUBTRACTION 0x00000040
#define MODE_NO_DIR_IN_CREATE 0x00000080
#define MODE_POSTGRESQL 0x00000100
#define MODE_ORACLE 0x00000200
#define MODE_MSSQL 0x00000400
#define MODE_DB2 0x00000800
#define MODE_MAXDB 0x00001000
#define MODE_NO_KEY_OPTIONS 0x00002000
#define MODE_NO_TABLE_OPTIONS 0x00004000
#define MODE_NO_FIELD_OPTIONS 0x00008000
#define MODE_MYSQL323 0x00010000
#define MODE_MYSQL40 0x00020000
#define MODE_ANSI 0x00040000
#define MODE_NO_AUTO_VALUE_ON_ZERO 0x00080000
#define MODE_NO_BACKSLASH_ESCAPES 0x00100000
#define MODE_STRICT_TRANS_TABLES 0x00200000
#define MODE_STRICT_ALL_TABLES 0x00400000
#define MODE_NO_ZERO_IN_DATE 0x00800000
#define MODE_NO_ZERO_DATE 0x01000000
#define MODE_INVALID_DATES 0x02000000
#define MODE_ERROR_FOR_DIVISION_BY_ZERO 0x04000000
#define MODE_TRADITIONAL 0x08000000
#define MODE_NO_AUTO_CREATE_USER 0x10000000
#define MODE_HIGH_NOT_PRECEDENCE 0x20000000
#define MODE_NO_ENGINE_SUBSTITUTION 0x40000000
#define MODE_PAD_CHAR_TO_FULL_LENGTH 0x80000000
/* used in FOMRAT_DESCRIPTION_EVENT. Indicates if it
is the active binary log.
Note: When reading data via COM_BINLOG_DUMP this
#define LOG_EVENT_BINLOG_IN_USE_F 0x0001
/* Looks like this flag is no longer in use */
#define LOG_EVENT_FORCED_ROTATE_F 0x0002
/* Log entry depends on thread, e.g. when using user variables
#define LOG_EVENT_THREAD_SPECIFIC_F 0x0004
/* Indicates that the USE command can be suppressed before
executing a statement: e.g. DRIP SCHEMA */
#define LOG_EVENT_SUPPRESS_USE_F 0x0008
#define LOG_EVENT_UPDATE_TABLE_MAP_F 0x0010
#define LOG_EVENT_ARTIFICIAL_F 0x0020
#define LOG_EVENT_RELAY_LOG_F 0x0040
/* If an event is not supported, and LOG_EVENT_IGNORABLE_F was not
set, an error will be reported. */
#define LOG_EVENT_IGNORABLE_F 0x0080
#define LOG_EVENT_NO_FILTER_F 0x0100
#define LOG_EVENT_MTS_ISOLATE_F 0x0200
/* if session variable @@skip_repliation was set, this flag will be
reported for events which should be skipped. */
#define LOG_EVENT_SKIP_REPLICATION_F 0x8000
enum mariadb_row_event_type {
/* Global transaction id */
typedef struct st_mariadb_gtid {
unsigned long long sequence_nr;
/* Generic replication handle */
typedef struct st_mariadb_rpl {
uint32_t filename_length;
unsigned long start_position;
uint8_t fd_header_len; /* header len from last format description event */
uint8_t artificial_checksum;
uint8_t post_header_len[ENUM_END_EVENT];
char error_msg[MYSQL_ERRMSG_SIZE];
typedef struct st_mariadb_rpl_value {
enum enum_field_types field_type;
typedef struct st_rpl_mariadb_row {
MARIADB_RPL_VALUE *columns;
struct st_rpl_mariadb_row *next;
struct st_mariadb_rpl_rotate_event {
unsigned long long position;
struct st_mariadb_rpl_query_event {
MARIADB_STRING statement;
struct st_mariadb_rpl_previous_gtid_event {
MARIADB_CONST_DATA content;
struct st_mariadb_rpl_gtid_list_event {
struct st_mariadb_rpl_format_description_event
MARIADB_STRING post_header_lengths;
struct st_mariadb_rpl_checkpoint_event {
struct st_mariadb_rpl_xid_event {
struct st_mariadb_rpl_gtid_event {
struct st_mariadb_rpl_annotate_rows_event {
MARIADB_STRING statement;
struct st_mariadb_rpl_table_map_event {
unsigned long long table_id;
MARIADB_STRING column_types;
unsigned char *null_indicator;
unsigned char *signed_indicator;
MARIADB_CONST_DATA column_names;
MARIADB_CONST_DATA geometry_types;
uint32_t default_charset;
MARIADB_CONST_DATA column_charsets;
MARIADB_CONST_DATA simple_primary_keys;
MARIADB_CONST_DATA prefixed_primary_keys;
MARIADB_CONST_DATA set_values;
MARIADB_CONST_DATA enum_values;
uint8_t enum_set_default_charset;
MARIADB_CONST_DATA enum_set_column_charsets;
struct st_mariadb_rpl_rand_event {
unsigned long long first_seed;
unsigned long long second_seed;
struct st_mariadb_rpl_intvar_event {
unsigned long long value;
struct st_mariadb_begin_load_query_event {
struct st_mariadb_start_encryption_event {
struct st_mariadb_execute_load_query_event {
MARIADB_STRING status_vars;
MARIADB_STRING statement;
struct st_mariadb_rpl_uservar_event {
struct st_mariadb_rpl_rows_event {
enum mariadb_row_event_type type;
unsigned char *column_bitmap;
unsigned char *column_update_bitmap;
unsigned char *null_bitmap;