#include "mysql/components/services/clone_protocol_service.h"
#include "mysql/components/service_implementation.h"
#include "mysql/components/services/log_builtins.h"
#include "my_byteorder.h"
#include "mysql.h"
#include "sql/mysqld.h"
#include "sql/protocol_classic.h"
#include "sql/set_var.h"
#include "sql/sql_class.h"
#include "sql/sql_show.h"
#include "sql/sql_thd_internal_api.h"
#include "sql/ssl_init_callback.h"
#include "sql/sys_vars_shared.h"
#include "sql_common.h"
#include "sql/dd/cache/dictionary_client.h"
#include "sql/dd/dictionary.h"

Typedefs
template<typename T >
using	DD_Objs = std::vector< const T * >

using	Releaser = dd::cache::Dictionary_client::Auto_releaser

Functions
static void	set_read_timeout (NET *net, uint32_t timeout)
	Set Network read timeout. More...

static void	set_write_timeout (NET *net, uint32_t timeout)
	Set Network write timeout. More...

static void	set_idle_timeout (NET *net, uint32_t timeout)
	Set Network idle timeout. More...

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. More...

void	mysql_clone_finish_statement (THD *thd) noexcept
	Finish statement and session. More...

int	mysql_clone_get_charsets (THD *thd, Mysql_Clone_Values &char_sets) noexcept
	Get all character set and collations. More...

int	mysql_clone_validate_charsets (THD *thd, Mysql_Clone_Values &char_sets) noexcept
	Check if all characters sets are supported by server. More...

static int	get_utf8_config (THD *thd, std::string config_name, String &utf8_val)
	Get configuration parameter value in utf8. More...

int	mysql_clone_get_configs (THD *thd, Mysql_Clone_Key_Values &configs) noexcept
	Get system configuration parameter values. More...

int	mysql_clone_validate_configs (THD *thd, Mysql_Clone_Key_Values &configs) noexcept
	Check if configuration parameter values match. More...

int	mysql_clone_validate_version (const std::string &recipient, const std::string &donor, const bool is_recipient_lts, const bool is_donor_lts) noexcept

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. More...

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. More...

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. More...

int	mysql_clone_kill (MYSQL connection, MYSQL kill_connection) noexcept
	Kill a remote connection. More...

void	mysql_clone_disconnect (THD thd, MYSQL mysql, bool is_fatal, bool clear_error) noexcept
	Disconnect from a remote server. More...

void	mysql_clone_get_error (THD thd, uint32_t err_num, const char **err_mesg) noexcept
	Get error number and message. More...

int	mysql_clone_get_command (THD thd, uchar command, uchar *com_buffer, size_t buffer_length) noexcept
	Get command from client. More...

int	mysql_clone_send_response (THD thd, bool secure, uchar packet, size_t length) noexcept
	Send response to client. More...

int	mysql_clone_send_error (THD *thd, uchar err_cmd, bool is_fatal) noexcept
	Send error to client. More...

Variables
static const uint32_t	MIN_IDLE_TIME_OUT_SEC = 8 * 60 * 60
	The minimum idle timeout in seconds. More...

static const uint32_t	MIN_READ_TIME_OUT_SEC = 30
	Minimum read timeout in seconds. More...

static const uint32_t	MIN_WRITE_TIME_OUT_SEC = 60
	Minimum write timeout in seconds. More...

Typedef Documentation

◆ DD_Objs

template<typename T >

using DD_Objs = std::vector<const T *>

◆ Releaser

using Releaser = dd::cache::Dictionary_client::Auto_releaser

Function Documentation

◆ get_utf8_config()

static int get_utf8_config	(	THD *	thd,
		std::string	config_name,
		String &	utf8_val
	)

static

Get configuration parameter value in utf8.

Parameters

[in]	thd	server session THD
[in]	config_name	parameter name
[out]	utf8_val	parameter value in utf8 string

Returns: error code.

◆ mysql_clone_connect()

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.

Parameters

[in,out]	thd	server session THD
[in]	host	host name to connect to
[in]	port	port number to connect to
[in]	user	user name on remote host
[in]	passwd	password for the user
[in]	ssl_ctx	client ssl context
[out]	socket	Network socket for the connection

Returns: Connection object if successful.

◆ mysql_clone_disconnect()

void mysql_clone_disconnect	(	THD *	thd,
		MYSQL *	mysql,
		bool	is_fatal,
		bool	clear_error
	)

noexcept

Disconnect from a remote server.

Parameters

[in,out]	thd	local session THD
[in,out]	mysql	connection object
[in]	is_fatal	if closing after fatal error
[in]	clear_error	clear any earlier error in session

◆ mysql_clone_finish_statement()

void mysql_clone_finish_statement ( THD * thd )

noexcept

Finish statement and session.

Parameters

[in,out] thd server session THD

◆ mysql_clone_get_charsets()

int mysql_clone_get_charsets	(	THD *	thd,
		Mysql_Clone_Values &	char_sets
	)

noexcept

Get all character set and collations.

Parameters

[in,out]	thd	server session THD
[out]	char_sets	all character set collations

Returns: error code.

◆ mysql_clone_get_command()

int mysql_clone_get_command	(	THD *	thd,
		uchar *	command,
		uchar **	com_buffer,
		size_t *	buffer_length
	)

noexcept

Get command from client.

Parameters

[in,out]	thd	server session THD
[out]	command	remote command
[out]	com_buffer	data following command
[out]	buffer_length	data length

Returns: error code.

◆ mysql_clone_get_configs()

int mysql_clone_get_configs	(	THD *	thd,
		Mysql_Clone_Key_Values &	configs
	)

noexcept

Get system configuration parameter values.

Parameters

[in,out]	thd	server session THD
[in,out]	configs	a list of configuration key value pair keys are input and values are output

Returns: error code.

◆ mysql_clone_get_error()

void mysql_clone_get_error	(	THD *	thd,
		uint32_t *	err_num,
		const char **	err_mesg
	)

noexcept

Get error number and message.

Parameters

[in,out]	thd	local session THD
[out]	err_num	error number
[out]	err_mesg	error message text

◆ mysql_clone_get_response()

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.

Parameters

[in,out]	thd	local session THD
[in,out]	connection	connection object
[in]	set_active	set socket active for current THD
[in]	timeout	timeout in seconds
[out]	packet	response packet
[out]	length	packet length
[out]	net_length	network data length for compressed data

Returns: error code.

◆ mysql_clone_kill()

int mysql_clone_kill	(	MYSQL *	connection,
		MYSQL *	kill_connection
	)

noexcept

Kill a remote connection.

Parameters

[in,out]	connection	connection object
[in]	kill_connection	connection to kill

Returns: error code.

◆ mysql_clone_send_command()

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.

Parameters

[in,out]	thd	local session THD
[in,out]	connection	connection object
[in]	set_active	set socket active for current THD
[in]	command	remote command
[in]	com_buffer	data following command
[in]	buffer_length	data length

Returns: error code.

◆ mysql_clone_send_error()

int mysql_clone_send_error	(	THD *	thd,
		uchar	err_cmd,
		bool	is_fatal
	)

noexcept

Send error to client.

Parameters

[in,out]	thd	server session THD
[in]	err_cmd	error response command
[in]	is_fatal	if fatal error

Returns: error code.

◆ mysql_clone_send_response()

int mysql_clone_send_response	(	THD *	thd,
		bool	secure,
		uchar *	packet,
		size_t	length
	)

noexcept

Send response to client.

Parameters

[in,out]	thd	server session THD
[in]	secure	needs to be sent over secure connection
[in]	packet	response packet
[in]	length	packet length

Returns: error code.

◆ mysql_clone_start_statement()

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.

Parameters

[in,out]	thd	server session THD
[in]	thread_key	PSI key for thread
[in]	statement_key	PSI Key for statement

◆ mysql_clone_validate_charsets()

int mysql_clone_validate_charsets	(	THD *	thd,
		Mysql_Clone_Values &	char_sets
	)

noexcept

Check if all characters sets are supported by server.

Parameters

[in,out]	thd	server session THD
[in]	char_sets	all character set collations to validate

Returns: error code.

◆ mysql_clone_validate_configs()

int mysql_clone_validate_configs	(	THD *	thd,
		Mysql_Clone_Key_Values &	configs
	)

noexcept

Check if configuration parameter values match.

Parameters

[in,out]	thd	server session THD
[in]	configs	a list of configuration key value pair

Returns: error code.

◆ mysql_clone_validate_version()

int mysql_clone_validate_version	(	const std::string &	recipient,
		const std::string &	donor,
		const bool	is_recipient_lts,
		const bool	is_donor_lts
	)

noexcept

◆ set_idle_timeout()

static void set_idle_timeout	(	NET *	net,
		uint32_t	timeout
	)

static

Set Network idle timeout.

Parameters

[in,out]	net	network object
[in]	timeout	time out in seconds

◆ set_read_timeout()

static void set_read_timeout	(	NET *	net,
		uint32_t	timeout
	)

static

Set Network read timeout.

Parameters

[in,out]	net	network object
[in]	timeout	time out in seconds

◆ set_write_timeout()

static void set_write_timeout	(	NET *	net,
		uint32_t	timeout
	)

static

Set Network write timeout.

Parameters

[in,out]	net	network object
[in]	timeout	time out in seconds

Variable Documentation

◆ MIN_IDLE_TIME_OUT_SEC

const uint32_t MIN_IDLE_TIME_OUT_SEC = 8 * 60 * 60

static

The minimum idle timeout in seconds.

It is kept at 8 hours which is also the Server default. Currently recipient sends ACK during state transition. In future we could have better time controlled ACK.

◆ MIN_READ_TIME_OUT_SEC

const uint32_t MIN_READ_TIME_OUT_SEC = 30

static

Minimum read timeout in seconds.

Maintain above the donor ACK frequency.

◆ MIN_WRITE_TIME_OUT_SEC

const uint32_t MIN_WRITE_TIME_OUT_SEC = 60

static

Minimum write timeout in seconds.

Disallow configuring it to too low. We might need a separate clone configuration in future or retry on failure.

Typedefs

Functions

Variables

Typedef Documentation

◆ DD_Objs

◆ Releaser

Function Documentation

◆ get_utf8_config()

◆ mysql_clone_connect()

◆ mysql_clone_disconnect()

◆ mysql_clone_finish_statement()

◆ mysql_clone_get_charsets()

◆ mysql_clone_get_command()

◆ mysql_clone_get_configs()

◆ mysql_clone_get_error()

◆ mysql_clone_get_response()

◆ mysql_clone_kill()

◆ mysql_clone_send_command()

◆ mysql_clone_send_error()

◆ mysql_clone_send_response()

◆ mysql_clone_start_statement()

◆ mysql_clone_validate_charsets()

◆ mysql_clone_validate_configs()

◆ mysql_clone_validate_version()

◆ set_idle_timeout()

◆ set_read_timeout()

◆ set_write_timeout()

Variable Documentation

◆ MIN_IDLE_TIME_OUT_SEC

◆ MIN_READ_TIME_OUT_SEC

◆ MIN_WRITE_TIME_OUT_SEC