MySQL 9.1.0
Source Code Documentation
clone_protocol_service.h
Go to the documentation of this file.
1/* Copyright (c) 2018, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef MYSQL_CLONE_PROTOCOL_SERVICE
25#define MYSQL_CLONE_PROTOCOL_SERVICE
26
27/**
28 @file
29 This service provides functions for clone plugin to
30 connect and interact with remote server's clone plugin
31 counterpart.
32
33*/
34
35#ifdef __cplusplus
36class THD;
37#else
38#define THD void
39#endif
40
41struct MYSQL;
42struct MYSQL_SOCKET;
43
45#include <stddef.h>
46#include <stdint.h>
47#include <string>
48#include <vector>
49
50#include "mysql_com_server.h"
51
52/** Connection parameters including SSL */
54 /** Clone ssl mode. Same as mysql client --ssl-mode */
56 /** Clone ssl private key. Same as mysql client --ssl-key */
57 const char *m_ssl_key;
58 /** Clone ssl certificate. Same as mysql client --ssl-cert */
59 const char *m_ssl_cert;
60 /** Clone ssl certificate authority. Same as mysql client --ssl-ca */
61 const char *m_ssl_ca;
62
63 /** Enable network compression. */
66};
67
68/** Vector of string values */
69using Mysql_Clone_Values = std::vector<std::string>;
70
71/** Vector of string Key-Value pairs. */
72using Mysql_Clone_Key_Values = std::vector<std::pair<std::string, std::string>>;
73
75
76/**
77 Start and set session and statement key form current thread
78 @param[in,out] thd server session THD
79 @param[in] thread_key PSI key for thread
80 @param[in] statement_key PSI Key for statement
81*/
83 (THD * &thd, unsigned int thread_key,
84 unsigned int statement_key));
85
86/**
87 Finish statement and session
88 @param[in,out] thd server session THD
89*/
91
92/**
93 Get all character set and collations
94 @param[in,out] thd server session THD
95 @param[out] char_sets all character set collations
96 @return error code.
97*/
99 (THD * thd, Mysql_Clone_Values &char_sets));
100
101/**
102 Check if all characters sets are supported by server
103 @param[in,out] thd server session THD
104 @param[in] char_sets all character set collations to validate
105 @return error code.
106*/
108 (THD * thd, Mysql_Clone_Values &char_sets));
109
110/**
111 Get system configuration parameter values.
112 @param[in,out] thd server session THD
113 @param[in,out] configs a list of configuration key value pair
114 keys are input and values are output
115 @return error code.
116*/
118 (THD * thd, Mysql_Clone_Key_Values &configs));
119
120/**
121 Check if configuration parameter values match
122 @param[in,out] thd server session THD
123 @param[in] configs a list of configuration key value pair
124 @return error code.
125*/
127 (THD * thd, Mysql_Clone_Key_Values &configs));
128
129/**
130 Connect to a remote server and switch to clone protocol
131 @param[in,out] thd server session THD
132 @param[in] host host name to connect to
133 @param[in] port port number to connect to
134 @param[in] user user name on remote host
135 @param[in] passwd password for the user
136 @param[in] ssl_ctx client ssl context
137 @param[out] socket Network socket for the connection
138
139 @return Connection object if successful.
140*/
142 (THD * thd, const char *host, uint32_t port, const char *user,
143 const char *passwd, mysql_clone_ssl_context *ssl_ctx,
145
146/**
147 Execute clone command on remote server
148 @param[in,out] thd local session THD
149 @param[in,out] connection connection object
150 @param[in] set_active set socket active for current THD
151 @param[in] command remote command
152 @param[in] com_buffer data following command
153 @param[in] buffer_length data length
154 @return error code.
155*/
157 (THD * thd, MYSQL *connection, bool set_active,
158 unsigned char command, unsigned char *com_buffer,
159 size_t buffer_length));
160
161/**
162 Get response from remote server
163 @param[in,out] thd local session THD
164 @param[in,out] connection connection object
165 @param[in] set_active set socket active for current THD
166 @param[in] timeout timeout in seconds
167 @param[out] packet response packet
168 @param[out] length packet length
169 @param[out] net_length network data length for compressed data
170 @return error code.
171*/
173 (THD * thd, MYSQL *connection, bool set_active, uint32_t timeout,
174 unsigned char **packet, size_t *length, size_t *net_length));
175
176/**
177 Kill a remote connection
178 @param[in,out] connection connection object
179 @param[in] kill_connection connection to kill
180 @return error code.
181*/
183 (MYSQL * connection, MYSQL *kill_connection));
184
185/**
186 Disconnect from a remote server
187 @param[in,out] thd local session THD
188 @param[in,out] connection connection object
189 @param[in] is_fatal if closing after fatal error
190 @param[in] clear_error clear any earlier error in session
191*/
193 (THD * thd, MYSQL *connection, bool is_fatal, bool clear_error));
194/**
195 Get error number and message.
196 @param[in,out] thd local session THD
197 @param[out] err_num error number
198 @param[out] err_mesg error message text
199*/
201 (THD * thd, uint32_t *err_num, const char **err_mesg));
202
203/**
204 Get command from client
205 @param[in,out] thd server session THD
206 @param[out] command remote command
207 @param[out] com_buffer data following command
208 @param[out] buffer_length data length
209 @return error code.
210*/
212 (THD * thd, unsigned char *command, unsigned char **com_buffer,
213 size_t *buffer_length));
214
215/**
216 Send response to client.
217 @param[in,out] thd server session THD
218 @param[in] secure needs to be sent over secure connection
219 @param[in] packet response packet
220 @param[in] length packet length
221 @return error code.
222*/
224 (THD * thd, bool secure, unsigned char *packet, size_t length));
225
226/**
227 Send error to client
228 @param[in,out] thd server session THD
229 @param[in] err_cmd error response command
230 @param[in] is_fatal if fatal error
231 @return error code.
232*/
234 (THD * thd, unsigned char err_cmd, bool is_fatal));
235
237
238#endif /* MYSQL_CLONE_PROTOCOL_SERVICE */
For each client connection we create a separate thread with THD serving as a thread/connection descri...
Definition: sql_lexer_thd.h:36
int mysql_clone_send_response(THD *thd, bool secure, uchar *packet, size_t length) noexcept
Send response to client.
Definition: clone_protocol_service.cc:711
int mysql_clone_send_command(THD *thd, MYSQL *connection, bool set_active, uchar command, uchar *com_buffer, size_t buffer_length) noexcept
Execute clone command on remote server.
Definition: clone_protocol_service.cc:475
int mysql_clone_kill(MYSQL *connection, MYSQL *kill_connection) noexcept
Kill a remote connection.
Definition: clone_protocol_service.cc:603
void mysql_clone_finish_statement(THD *thd) noexcept
Finish statement and session.
Definition: clone_protocol_service.cc:132
void mysql_clone_disconnect(THD *thd, MYSQL *mysql, bool is_fatal, bool clear_error) noexcept
Disconnect from a remote server.
Definition: clone_protocol_service.cc:618
int mysql_clone_get_response(THD *thd, MYSQL *connection, bool set_active, uint32_t timeout, uchar **packet, size_t *length, size_t *net_length) noexcept
Get response from remote server.
Definition: clone_protocol_service.cc:513
int mysql_clone_send_error(THD *thd, uchar err_cmd, bool is_fatal) noexcept
Send error to client.
Definition: clone_protocol_service.cc:739
int mysql_clone_get_charsets(THD *thd, Mysql_Clone_Values &char_sets) noexcept
Get all character set and collations.
Definition: clone_protocol_service.cc:146
void mysql_clone_get_error(THD *thd, uint32_t *err_num, const char **err_mesg) noexcept
Get error number and message.
Definition: clone_protocol_service.cc:646
void mysql_clone_start_statement(THD *&thd, PSI_thread_key thread_key, PSI_statement_key statement_key) noexcept
Start and set session and statement key form current thread.
Definition: clone_protocol_service.cc:91
int mysql_clone_get_configs(THD *thd, Mysql_Clone_Key_Values &configs) noexcept
Get system configuration parameter values.
Definition: clone_protocol_service.cc:230
int mysql_clone_validate_charsets(THD *thd, Mysql_Clone_Values &char_sets) noexcept
Check if all characters sets are supported by server.
Definition: clone_protocol_service.cc:168
MYSQL * mysql_clone_connect(THD *thd, const char *host, uint32_t port, const char *user, const char *passwd, mysql_clone_ssl_context *ssl_ctx, MYSQL_SOCKET *socket) noexcept
Connect to a remote server and switch to clone protocol.
Definition: clone_protocol_service.cc:354
int mysql_clone_get_command(THD *thd, uchar *command, uchar **com_buffer, size_t *buffer_length) noexcept
Get command from client.
Definition: clone_protocol_service.cc:666
int mysql_clone_validate_configs(THD *thd, Mysql_Clone_Key_Values &configs) noexcept
Check if configuration parameter values match.
Definition: clone_protocol_service.cc:294
std::vector< std::pair< std::string, std::string > > Mysql_Clone_Key_Values
Vector of string Key-Value pairs.
Definition: clone_protocol_service.h:72
std::vector< std::string > Mysql_Clone_Values
Vector of string values.
Definition: clone_protocol_service.h:69
Definitions private to the server, used in the networking layer to notify specific events.
char * user
Definition: mysqladmin.cc:66
const char * host
Definition: mysqladmin.cc:65
bool length(const dd::Spatial_reference_system *srs, const Geometry *g1, double *length, bool *null) noexcept
Computes the length of linestrings and multilinestrings.
Definition: length.cc:76
static bool timeout(bool(*wait_condition)())
Timeout function.
Definition: log0meb.cc:498
stdx::expected< native_handle_type, error_type > socket(int family, int sock_type, int protocol)
Definition: socket.h:63
void set_active(space_id_t space_id)
Set an undo tablespace active.
Definition: trx0purge.cc:1138
required uint64 port
Definition: replication_asynchronous_connection_failover.proto:33
#define DECLARE_METHOD(retval, name, args)
Declares a method as a part of the Service definition.
Definition: service.h:103
#define END_SERVICE_DEFINITION(name)
A macro to end the last Service definition started with the BEGIN_SERVICE_DEFINITION macro.
Definition: service.h:91
#define BEGIN_SERVICE_DEFINITION(name)
Declares a new Service.
Definition: service.h:86
An instrumented socket.
Definition: mysql_socket_bits.h:35
Definition: mysql.h:300
Definition: mysql_com_server.h:59
Connection parameters including SSL.
Definition: clone_protocol_service.h:53
int m_ssl_mode
Clone ssl mode.
Definition: clone_protocol_service.h:55
NET_SERVER * m_server_extn
Definition: clone_protocol_service.h:65
const char * m_ssl_key
Clone ssl private key.
Definition: clone_protocol_service.h:57
bool m_enable_compression
Enable network compression.
Definition: clone_protocol_service.h:64
const char * m_ssl_ca
Clone ssl certificate authority.
Definition: clone_protocol_service.h:61
const char * m_ssl_cert
Clone ssl certificate.
Definition: clone_protocol_service.h:59
command
Definition: version_token.cc:280