MySQL  8.0.27
Source Code Documentation
rpl_source.cc File Reference
#include "sql/rpl_source.h"
#include <fcntl.h>
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include <memory>
#include <unordered_map>
#include <utility>
#include "m_ctype.h"
#include "m_string.h"
#include "map_helpers.h"
#include "mutex_lock.h"
#include "my_byteorder.h"
#include "my_command.h"
#include "my_dbug.h"
#include "my_io.h"
#include "my_loglevel.h"
#include "my_macros.h"
#include "my_psi_config.h"
#include "my_sys.h"
#include "mysql/components/services/bits/psi_bits.h"
#include "mysql/components/services/log_builtins.h"
#include "mysql/components/services/mysql_mutex_bits.h"
#include "mysql/components/services/psi_mutex_bits.h"
#include "mysql/psi/mysql_file.h"
#include "mysql/psi/mysql_mutex.h"
#include "mysql/service_mysql_alloc.h"
#include "mysqld_error.h"
#include "sql/auth/auth_acls.h"
#include "sql/auth/auth_common.h"
#include "sql/binlog.h"
#include "sql/current_thd.h"
#include "sql/debug_sync.h"
#include "sql/item.h"
#include "sql/item_func.h"
#include "sql/log.h"
#include "sql/mysqld.h"
#include "sql/mysqld_thd_manager.h"
#include "sql/protocol.h"
#include "sql/protocol_classic.h"
#include "sql/psi_memory_key.h"
#include "sql/rpl_binlog_sender.h"
#include "sql/rpl_filter.h"
#include "sql/rpl_group_replication.h"
#include "sql/rpl_gtid.h"
#include "sql/rpl_handler.h"
#include "sql/rpl_utility.h"
#include "sql/sql_class.h"
#include "sql/sql_lex.h"
#include "sql/sql_list.h"
#include "sql/system_variables.h"
#include "sql_string.h"
#include "thr_mutex.h"
#include "typelib.h"

Classes

class  Find_zombie_dump_thread
 Callback function used by kill_zombie_dump_threads() function to to find zombie dump thread from the thd list. More...
 

Macros

#define get_object(p, obj, msg)
 
#define CHECK_PACKET_SIZE(BYTES)
 If there are less than BYTES bytes left to read in the packet, report error. More...
 
#define READ(DECODE, BYTES)
 Auxiliary macro used to define READ_INT and READ_STRING. More...
 
#define READ_INT(VAR, BYTES)    READ(VAR = uint##BYTES##korr(packet_position), BYTES)
 Check that there are at least BYTES more bytes to read, then read the bytes and decode them into the given integer VAR, then advance the reading position. More...
 
#define READ_STRING(VAR, BYTES, BUFFER_SIZE)
 Check that there are at least BYTES more bytes to read and that BYTES+1 is not greater than BUFFER_SIZE, then read the bytes into the given variable VAR, then advance the reading position. More...
 

Functions

int register_slave (THD *thd, uchar *packet, size_t packet_length)
 Register slave in 'slave_list' hash table. More...
 
void unregister_slave (THD *thd, bool only_mine, bool need_lock_slave_list)
 
bool show_slave_hosts (THD *thd)
 Execute a SHOW SLAVE HOSTS statement. More...
 
bool com_binlog_dump (THD *thd, char *packet, size_t packet_length)
 Process a COM_BINLOG_DUMP packet. More...
 
bool com_binlog_dump_gtid (THD *thd, char *packet, size_t packet_length)
 Process a COM_BINLOG_DUMP_GTID packet. More...
 
void mysql_binlog_send (THD *thd, char *log_ident, my_off_t pos, Gtid_set *slave_gtid_executed, uint32 flags)
 Low-level function where the dump thread iterates over the binary log and sends events to the slave. More...
 
const user_var_entryget_user_var_from_alternatives (const THD *thd, const std::string alt1, const std::string alt2)
 Read a user variable that may exist under two different names. More...
 
Stringget_replica_uuid (THD *thd, String *value)
 An auxiliary function extracts slave UUID. More...
 
void kill_zombie_dump_threads (THD *thd)
 
bool reset_master (THD *thd, bool unlock_global_read_lock)
 Execute a RESET MASTER statement. More...
 
bool show_master_status (THD *thd)
 Execute a SHOW MASTER STATUS statement. More...
 
bool show_binlogs (THD *thd)
 Execute a SHOW BINARY LOGS statement. More...
 

Variables

int max_binlog_dump_events = 0
 
bool opt_sporadic_binlog_dump_fail = false
 
malloc_unordered_map< uint32, unique_ptr_my_free< SLAVE_INFO > > slave_list
 
TYPELIB binlog_checksum_typelib
 

Macro Definition Documentation

◆ CHECK_PACKET_SIZE

#define CHECK_PACKET_SIZE (   BYTES)
Value:
do { \
if (packet_bytes_todo < BYTES) goto error_malformed_packet; \
} while (0)

If there are less than BYTES bytes left to read in the packet, report error.

◆ get_object

#define get_object (   p,
  obj,
  msg 
)
Value:
{ \
uint len; \
if (p >= p_end) { \
my_error(ER_MALFORMED_PACKET, MYF(0)); \
return 1; \
} \
if (p + len > p_end || len >= sizeof(obj)) { \
errmsg = msg; \
goto err; \
} \
strmake(obj, (char *)p, len); \
p += len; \
}
const char * p
Definition: ctype-mb.cc:1236
#define MYF(v)
Definition: my_inttypes.h:96
uint64_t net_field_length_ll(unsigned char **packet)
Definition: pack.cc:89
static Value err()
Create a Value object that represents an error condition.
Definition: json_binary.cc:908

◆ READ

#define READ (   DECODE,
  BYTES 
)
Value:
do { \
CHECK_PACKET_SIZE(BYTES); \
DECODE; \
packet_position += BYTES; \
packet_bytes_todo -= BYTES; \
} while (0)

Auxiliary macro used to define READ_INT and READ_STRING.

Check that there are at least BYTES more bytes to read, then read the bytes using the given DECODER, then advance the reading position.

◆ READ_INT

#define READ_INT (   VAR,
  BYTES 
)     READ(VAR = uint##BYTES##korr(packet_position), BYTES)

Check that there are at least BYTES more bytes to read, then read the bytes and decode them into the given integer VAR, then advance the reading position.

◆ READ_STRING

#define READ_STRING (   VAR,
  BYTES,
  BUFFER_SIZE 
)
Value:
do { \
if (BUFFER_SIZE <= BYTES) goto error_malformed_packet; \
READ(memcpy(VAR, packet_position, BYTES), BYTES); \
VAR[BYTES] = '\0'; \
} while (0)
Definition: mysqltest.cc:393

Check that there are at least BYTES more bytes to read and that BYTES+1 is not greater than BUFFER_SIZE, then read the bytes into the given variable VAR, then advance the reading position.

Function Documentation

◆ com_binlog_dump()

bool com_binlog_dump ( THD thd,
char *  packet,
size_t  packet_length 
)

Process a COM_BINLOG_DUMP packet.

This function parses the packet and then calls mysql_binlog_send.

Parameters
thdThe dump thread.
packetThe COM_BINLOG_DUMP packet.
packet_lengthThe length of the packet in bytes.
Return values
trueError
falseSuccess

◆ com_binlog_dump_gtid()

bool com_binlog_dump_gtid ( THD thd,
char *  packet,
size_t  packet_length 
)

Process a COM_BINLOG_DUMP_GTID packet.

This function parses the packet and then calls mysql_binlog_send.

Parameters
thdThe dump thread.
packetThe COM_BINLOG_DUMP_GTID packet.
packet_lengthThe length of the packet in bytes.
Return values
trueError
falseSuccess

◆ get_replica_uuid()

String* get_replica_uuid ( THD thd,
String value 
)

An auxiliary function extracts slave UUID.

Parameters
[in]thdTHD to access a user variable
[out]valueString to return UUID value.
Returns
if success value is returned else NULL is returned.

◆ get_user_var_from_alternatives()

const user_var_entry* get_user_var_from_alternatives ( const THD thd,
const std::string  alt1,
const std::string  alt2 
)

Read a user variable that may exist under two different names.

Parameters
thdThe session to read from.
alt1The first variable name alternative.
alt2The second variable name alternative.
Return values
Ifthere exists a user variable in the current session with the first name, return that. Otherwise, if the second one exists, return that. Otherwise, return NULL.

◆ kill_zombie_dump_threads()

void kill_zombie_dump_threads ( THD thd)

◆ mysql_binlog_send()

void mysql_binlog_send ( THD thd,
char *  log_ident,
my_off_t  pos,
Gtid_set gtid_set,
uint32  flags 
)

Low-level function where the dump thread iterates over the binary log and sends events to the slave.

This function is common for both COM_BINLOG_DUMP and COM_BINLOG_DUMP_GTID.

Parameters
thdThe dump thread.
log_identThe filename of the binary log, as given in the COM_BINLOG_DUMP[_GTID] packet. If this is is an empty string (first character is '\0'), we start with the oldest binary log.
posThe offset in the binary log, as given in the COM_BINLOG_DUMP[_GTID] packet. This must be at least 4 and at most the size of the binary log file.
gtid_setThe gtid_set that the slave sent, or NULL if the protocol is COM_BINLOG_DUMP.
flagsflags in COM_BINLOG_DUMP[_GTID] packets.
Note
This function will start reading at the given (filename, offset), or from the oldest log if filename[0]==0. It will send all events from that position; but if gtid_set!=NULL, it will skip all events in that set.

◆ register_slave()

int register_slave ( THD thd,
uchar packet,
size_t  packet_length 
)

Register slave in 'slave_list' hash table.

Returns
0 ok
1 Error. Error message sent to client

◆ reset_master()

bool reset_master ( THD thd,
bool  unlock_global_read_lock 
)

Execute a RESET MASTER statement.

Parameters
thdPointer to THD object of the client thread executing the statement.
unlock_global_read_lockUnlock the global read lock aquired by RESET MASTER.
Return values
falsesuccess
trueerror

◆ show_binlogs()

bool show_binlogs ( THD thd)

Execute a SHOW BINARY LOGS statement.

Parameters
thdPointer to THD object for the client thread executing the statement.
Return values
falsesuccess
truefailure

◆ show_master_status()

bool show_master_status ( THD thd)

Execute a SHOW MASTER STATUS statement.

Parameters
thdPointer to THD object for the client thread executing the statement.
Return values
falsesuccess
truefailure

◆ show_slave_hosts()

bool show_slave_hosts ( THD thd)

Execute a SHOW SLAVE HOSTS statement.

Parameters
thdPointer to THD object for the client thread executing the statement.
Return values
falsesuccess
truefailure

◆ unregister_slave()

void unregister_slave ( THD thd,
bool  only_mine,
bool  need_lock_slave_list 
)

Variable Documentation

◆ max_binlog_dump_events

int max_binlog_dump_events = 0

◆ opt_sporadic_binlog_dump_fail

bool opt_sporadic_binlog_dump_fail = false

◆ slave_list

Initial value:
{
PSI_memory_key key_memory_REPLICA_INFO
Definition: psi_memory_key.cc:76