MySQL  8.0.27
Source Code Documentation
rpl_source.h
Go to the documentation of this file.
1 #ifndef RPL_SOURCE_H_INCLUDED
2 #define RPL_SOURCE_H_INCLUDED
3 
4 /* Copyright (c) 2010, 2021, Oracle and/or its affiliates.
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License, version 2.0,
8  as published by the Free Software Foundation.
9 
10  This program is also distributed with certain software (including
11  but not limited to OpenSSL) that is licensed under separate terms,
12  as designated in a particular file or component or in included license
13  documentation. The authors of MySQL hereby grant you an additional
14  permission to link the program and your derivative works with the
15  separately licensed software that they have included with MySQL.
16 
17  This program is distributed in the hope that it will be useful,
18  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  GNU General Public License, version 2.0, for more details.
21 
22  You should have received a copy of the GNU General Public License
23  along with this program; if not, write to the Free Software
24  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
25 
26 #include <stddef.h>
27 #include <string> // std::string
28 
29 #include "my_hostname.h" // HOSTNAME_LENGTH
30 #include "my_inttypes.h"
31 #include "mysql_com.h" // USERNAME_LENGTH
32 #include "sql/sql_const.h" // MAX_PASSWORD_LENGTH
33 
34 class Gtid_set;
35 class String;
36 class THD;
37 
38 extern bool server_id_supplied;
39 extern int max_binlog_dump_events;
41 extern bool opt_show_replica_auth_info;
42 
43 struct SLAVE_INFO {
46  char host[HOSTNAME_LENGTH + 1];
47  char user[USERNAME_LENGTH + 1];
50  THD *thd;
51 };
52 
53 int register_slave(THD *thd, uchar *packet, size_t packet_length);
54 void unregister_slave(THD *thd, bool only_mine, bool need_lock_slave_list);
55 bool show_slave_hosts(THD *thd);
57 bool show_master_status(THD *thd);
58 bool show_binlogs(THD *thd);
59 void kill_zombie_dump_threads(THD *thd);
60 
61 /**
62  Process a COM_BINLOG_DUMP_GTID packet.
63 
64  This function parses the packet and then calls mysql_binlog_send.
65 
66  @param thd The dump thread.
67  @param packet The COM_BINLOG_DUMP_GTID packet.
68  @param packet_length The length of the packet in bytes.
69  @retval true Error
70  @retval false Success
71 */
72 bool com_binlog_dump_gtid(THD *thd, char *packet, size_t packet_length);
73 
74 /**
75  Process a COM_BINLOG_DUMP packet.
76 
77  This function parses the packet and then calls mysql_binlog_send.
78 
79  @param thd The dump thread.
80  @param packet The COM_BINLOG_DUMP packet.
81  @param packet_length The length of the packet in bytes.
82  @retval true Error
83  @retval false Success
84 */
85 bool com_binlog_dump(THD *thd, char *packet, size_t packet_length);
86 
87 /**
88  Low-level function where the dump thread iterates over the binary
89  log and sends events to the slave. This function is common for both
90  COM_BINLOG_DUMP and COM_BINLOG_DUMP_GTID.
91 
92  @param thd The dump thread.
93 
94  @param log_ident The filename of the binary log, as given in the
95  COM_BINLOG_DUMP[_GTID] packet. If this is is an empty string (first
96  character is '\0'), we start with the oldest binary log.
97 
98  @param pos The offset in the binary log, as given in the
99  COM_BINLOG_DUMP[_GTID] packet. This must be at least 4 and at most
100  the size of the binary log file.
101 
102  @param gtid_set The gtid_set that the slave sent, or NULL if the
103  protocol is COM_BINLOG_DUMP.
104 
105  @param flags flags in COM_BINLOG_DUMP[_GTID] packets.
106 
107  @note This function will start reading at the given (filename,
108  offset), or from the oldest log if filename[0]==0. It will send all
109  events from that position; but if gtid_set!=NULL, it will skip all
110  events in that set.
111 */
112 void mysql_binlog_send(THD *thd, char *log_ident, my_off_t pos,
113  Gtid_set *gtid_set, uint32 flags);
114 
115 bool reset_master(THD *thd, bool unlock_read_lock);
116 
117 class user_var_entry;
118 /**
119  Read a user variable that may exist under two different names.
120 
121  @param thd The session to read from.
122 
123  @param alt1 The first variable name alternative.
124 
125  @param alt2 The second variable name alternative.
126 
127  @retval If there exists a user variable in the current session with
128  the first name, return that. Otherwise, if the second one exists,
129  return that. Otherwise, return NULL.
130 */
132  const std::string alt1,
133  const std::string alt2);
134 
135 #endif /* RPL_SOURCE_H_INCLUDED */
Represents a set of GTIDs.
Definition: rpl_gtid.h:1435
Using this class is fraught with peril, and you need to be very careful when doing so.
Definition: sql_string.h:165
For each client connection we create a separate thread with THD serving as a thread/connection descri...
Definition: sql_class.h:821
Definition: item_func.h:3007
char * pos
Definition: do_ctype.cc:76
bool server_id_supplied
Definition: mysqld.cc:1166
static int flags[50]
Definition: hp_test1.cc:39
Common definition used by mysys, performance schema and server & client.
static constexpr int HOSTNAME_LENGTH
Definition: my_hostname.h:42
Some integer typedefs for easier portability.
ulonglong my_off_t
Definition: my_inttypes.h:71
unsigned char uchar
Definition: my_inttypes.h:51
uint16_t uint16
Definition: my_inttypes.h:64
uint32_t uint32
Definition: my_inttypes.h:66
Common definition between mysql server & client.
#define USERNAME_LENGTH
Definition: mysql_com.h:68
const string value("\"Value\"")
void unregister_slave(THD *thd, bool only_mine, bool need_lock_slave_list)
Definition: rpl_source.cc:162
String * get_replica_uuid(THD *thd, String *value)
An auxiliary function extracts slave UUID.
Definition: rpl_source.cc:1008
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.
Definition: rpl_source.cc:982
bool show_master_status(THD *thd)
Execute a SHOW MASTER STATUS statement.
Definition: rpl_source.cc:1195
bool com_binlog_dump(THD *thd, char *packet, size_t packet_length)
Process a COM_BINLOG_DUMP packet.
Definition: rpl_source.cc:885
bool show_slave_hosts(THD *thd)
Execute a SHOW SLAVE HOSTS statement.
Definition: rpl_source.cc:186
int max_binlog_dump_events
Definition: rpl_source.cc:80
bool show_binlogs(THD *thd)
Execute a SHOW BINARY LOGS statement.
Definition: rpl_source.cc:1256
int register_slave(THD *thd, uchar *packet, size_t packet_length)
Register slave in 'slave_list' hash table.
Definition: rpl_source.cc:112
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.
Definition: rpl_source.cc:989
void kill_zombie_dump_threads(THD *thd)
Definition: rpl_source.cc:1084
bool com_binlog_dump_gtid(THD *thd, char *packet, size_t packet_length)
Process a COM_BINLOG_DUMP_GTID packet.
Definition: rpl_source.cc:925
bool opt_show_replica_auth_info
Definition: mysqld.cc:1207
bool opt_sporadic_binlog_dump_fail
Definition: rpl_source.cc:81
bool reset_master(THD *thd, bool unlock_read_lock)
Execute a RESET MASTER statement.
Definition: rpl_source.cc:1124
File containing constants that can be used throughout the server.
Definition: rpl_source.h:43
uint16 port
Definition: rpl_source.h:49
uint32 server_id
Definition: rpl_source.h:44
char password[MAX_PASSWORD_LENGTH+1]
Definition: rpl_source.h:48
uint32 master_id
Definition: rpl_source.h:45
THD * thd
Definition: rpl_source.h:50
char user[USERNAME_LENGTH+1]
Definition: rpl_source.h:47
char host[HOSTNAME_LENGTH+1]
Definition: rpl_source.h:46
uint32 rpl_recovery_rank
Definition: rpl_source.h:45
const int MAX_PASSWORD_LENGTH
Definition: validate_password_imp.cc:43