MySQL 8.0.32
Source Code Documentation
plugin.h
Go to the documentation of this file.
1/* Copyright (c) 2014, 2022, 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 also distributed 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 included with MySQL.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License, version 2.0, for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23#ifndef PLUGIN_INCLUDE
24#define PLUGIN_INCLUDE
25
27#include <mysql/plugin.h>
29
54
55// Forward declarations
60class Mysql_thread;
61
62// Definition of system var structures
63
64// Definition of system vars structure for access their information in the
65// plugin
66struct SYS_VAR {
68};
69
70/**
71 Position of channel observation manager's in channel_observation_manager_list
72*/
77};
78
79/**
80 @enum enum_exit_state_action
81 @brief Action performed when the member leaves the group
82 unexpectedly.
83*/
88};
89
90/**
91 This struct provides a namespace for the GR layer components.
92*/
93struct gr_modules {
94 /**
95 @enum gr_modules_enum
96 @brief Represents the GR layer modules that can be initialized
97 and/or terminated at will while the plugin is running.
98 @see terminate_plugin_modules
99 */
121 };
122 using mask = std::bitset<NUM_MODULES>;
123 static constexpr mask all_modules = (1 << NUM_MODULES) - 1;
124};
125
126/**
127 @enum enum_tls_source_values
128 @brief Source of TLS configuration for the connection between Group
129 Replication members.
130*/
135
136/**
137 @enum enum_wait_on_start_process_result
138 @brief Reasons why asynchronous channels start wait for Group
139 Replication status can be aborted.
140*/
146
147/**
148 The plugin modules.
149
150 @note Whenever you want to create a new plugin module, be sure to add it to
151 the gr_modules enum (@sa gr_modules) and see if it's part of the rejoin
152 process.
153*/
164// Lock for the applier and recovery module to prevent the race between STOP
165// Group replication and ongoing transactions.
178
179// Auxiliary Functionality
187// Latch used as the control point of the event driven
188// management of the transactions.
190extern SERVICE_TYPE_NO_CONST(mysql_runtime_error) * mysql_runtime_error_service;
191
192// Plugin global methods
194void *get_plugin_pointer();
198 Delayed_initialization_thread *delayed_init_thd);
200int terminate_plugin_modules(gr_modules::mask modules_to_terminate,
201 char **error_message = nullptr,
202 bool rejoin = false);
209void set_single_primary_mode_var(bool option);
211void reset_auto_increment_handler_values(bool force_reset = false);
220/**
221 Encapsulates the logic necessary to attempt a rejoin, i.e. gracefully leave
222 the group, terminate GCS infrastructure, terminate auto-rejoin relevant plugin
223 modules, reinitialize auto-rejoin relevant plugin modules, reinitialize GCS
224 infrastructure and attempt to join the group again.
225
226 @returns a flag indicating success or failure.
227 @retval true the rejoin failed.
228 @retval false the rejoin succeeded.
229*/
230bool attempt_rejoin();
236void set_plugin_is_setting_read_mode(bool value);
238const char *get_group_name_var();
239const char *get_view_change_uuid_var();
253
254// Plugin public methods
257int plugin_group_replication_start(char **error_message = nullptr);
258int plugin_group_replication_stop(char **error_message = nullptr);
266void set_wait_on_start_process(bool cond);
272 uint index,
276
277/**
278 Method to set retrieved certification info from a recovery channel extracted
279 from a given View_change event
280
281 @note a copy of the certification info is made here.
282
283 @param info the given view_change_event.
284*/
286
287#endif /* PLUGIN_INCLUDE */
static const sasl_callback_t callbacks[]
Definition: auth_ldap_sasl_client.h:44
Definition: applier.h:282
Definition: asynchronous_channels_state_observer.h:29
Represents and encapsulates the logic responsible for handling the auto-rejoin process within Group R...
Definition: autorejoin.h:48
Definition: plugin_utils.h:99
A class to hold different channel observation manager.
Definition: channel_observation_manager.h:64
This has the functionality of mysql_rwlock_t, with two differences:
Definition: rpl_gtid.h:308
Definition: compatibility_module.h:39
Deals with the orchestration necessary to set the appropriate "consensus leaders" on GCS.
Definition: consensus_leaders_handler.h:38
Definition: delayed_plugin_initialization.h:28
Coordinates all operations to GCS interface.
Definition: gcs_operations.h:48
The coordinator class where group actions are submitted.
Definition: group_action_coordinator.h:65
Class alerts listeners of group events like view changes and elections.
Definition: group_event_observer.h:86
Definition: member_info.h:741
Definition: member_info.h:79
Definition: group_partition_handling.h:29
Definition: group_transaction_observation_manager.h:86
Handles member actions configuration and trigger.
Definition: member_actions_handler.h:95
Handles the deliver of recv service messages to subscribed modules.
Definition: message_service.h:44
A generic single thread executor.
Definition: mysql_thread.h:207
Definition: gcs_event_handlers.h:58
The base class to request and execute an election.
Definition: primary_election_invocation_handler.h:40
Definition: recovery.h:44
This is the interface for the registrty module.
Definition: registry.h:37
Class that hold the logic to decide if we should or not execute a clone operation and the logic to la...
Definition: remote_clone_handler.h:34
This class holds the references to server services that Group Replication acquires on plugin install.
Definition: server_services_references.h:40
Definition: plugin_utils.h:708
The consistency information of all ongoing transactions which have consistency GROUP_REPLICATION_CONS...
Definition: consistency_manager.h:270
Ticket register/wait auxiliary class.
Definition: plugin_utils.h:499
const char * p
Definition: ctype-mb.cc:1236
void * MYSQL_PLUGIN
Definition: plugin.h:81
unsigned long long int ulonglong
Definition: my_inttypes.h:55
Log info(cout, "NOTE")
bool is_running(const PluginFuncEnv *env) noexcept
Definition: loader.cc:201
ulong get_flow_control_mode_var()
Definition: plugin.cc:302
bool plugin_get_group_member_stats(uint index, const GROUP_REPLICATION_GROUP_MEMBER_STATS_CALLBACKS &callbacks)
Definition: plugin.cc:502
int get_flow_control_release_percent_var()
Definition: plugin.cc:330
Group_action_coordinator * group_action_coordinator
The coordinator for group actions.
Definition: plugin.cc:114
Blocked_transaction_handler * blocked_transaction_handler
The handler for transaction killing when an error or partition happens.
Definition: plugin.cc:112
ulong get_transaction_size_limit()
Definition: plugin.cc:2747
enum_channel_observation_manager_position
Position of channel observation manager's in channel_observation_manager_list.
Definition: plugin.h:73
@ ASYNC_CHANNEL_OBSERVATION_MANAGER_POS
Definition: plugin.h:75
@ END_CHANNEL_OBSERVATION_MANAGER_POS
Definition: plugin.h:76
@ GROUP_CHANNEL_OBSERVATION_MANAGER_POS
Definition: plugin.h:74
Applier_module * applier_module
The plugin applier.
Definition: plugin.cc:84
int initialize_plugin_and_join(enum_plugin_con_isolation sql_api_isolation, Delayed_initialization_thread *delayed_init_thd)
Definition: plugin.cc:676
Server_services_references * server_services_references_module
Module with the acquired server services on plugin install.
Definition: plugin.cc:136
rpl_sidno get_view_change_sidno()
Definition: plugin.cc:273
int plugin_group_replication_init(MYSQL_PLUGIN plugin_info)
Definition: plugin.cc:1918
bool plugin_is_group_replication_cloning()
Definition: plugin.cc:252
ulong get_exit_state_action_var()
Definition: plugin.cc:300
bool get_allow_single_leader()
Definition: plugin.cc:346
bool is_plugin_auto_starting_on_non_bootstrap_member()
Definition: plugin.cc:256
void reset_auto_increment_handler_values(bool force_reset=false)
Definition: plugin.cc:2391
void mysql_thread_handler_finalize()
Definition: plugin.cc:1858
ulong get_components_stop_timeout_var()
Definition: plugin.cc:334
void set_wait_on_start_process(bool cond)
Set condition to block or unblock the calling threads.
Definition: plugin.cc:380
Group_member_info * local_member_info
Definition: plugin.cc:143
long get_flow_control_min_quota_var()
Definition: plugin.cc:312
bool plugin_get_connection_status(const GROUP_REPLICATION_CONNECTION_STATUS_CALLBACKS &callbacks)
Definition: plugin.cc:471
void set_plugin_is_setting_read_mode(bool value)
Definition: plugin.cc:288
Transaction_consistency_manager * transaction_consistency_manager
The plugin transaction consistency manager.
Definition: plugin.cc:104
enum_wait_on_start_process_result
Reasons why asynchronous channels start wait for Group Replication status can be aborted.
Definition: plugin.h:141
@ WAIT_ON_START_PROCESS_ABORT_SECONDARY_MEMBER
Definition: plugin.h:144
@ WAIT_ON_START_PROCESS_ABORT_ON_CLONE
Definition: plugin.h:143
@ WAIT_ON_START_PROCESS_SUCCESS
Definition: plugin.h:142
Autorejoin_thread * autorejoin_module
The thread that handles the auto-rejoin process.
Definition: plugin.cc:118
Message_service_handler * message_service_handler
The thread that handles the message service process.
Definition: plugin.cc:122
bool is_autorejoin_enabled()
Definition: plugin.cc:340
const mysql_service_registry_t * get_plugin_registry()
Definition: plugin.cc:2765
bool get_server_shutdown_status()
Definition: plugin.cc:286
Checkable_rwlock * get_plugin_running_lock()
Definition: plugin.cc:242
bool plugin_is_group_replication_running()
Definition: plugin.cc:248
bool server_engine_initialized()
Definition: plugin.cc:2735
Mysql_thread * mysql_thread_handler
Handle tasks on mysql_thread.
Definition: plugin.cc:127
bool plugin_get_group_members(uint index, const GROUP_REPLICATION_GROUP_MEMBERS_CALLBACKS &callbacks)
Definition: plugin.cc:479
long get_flow_control_max_quota_var()
Definition: plugin.cc:318
void declare_plugin_cloning(bool is_running)
Definition: plugin.cc:2316
Group_partition_handling * group_partition_handler
The transaction handler for network partitions.
Definition: plugin.cc:110
Member_actions_handler * member_actions_handler
Definition: plugin.cc:125
bool check_async_channel_running_on_secondary()
Definition: plugin.cc:2654
mysql_mutex_t * get_plugin_applier_module_initialize_terminate_lock()
Definition: plugin.cc:244
Registry_module_interface * registry_module
The registry module.
Definition: plugin.cc:90
int initialize_plugin_modules(gr_modules::mask modules_to_init)
Definition: plugin.cc:1301
Group_transaction_observation_manager * group_transaction_observation_manager
The transaction observation module.
Definition: plugin.cc:99
mysql_service_mysql_runtime_error_t * mysql_runtime_error_service
Definition: plugin.cc:149
int plugin_group_replication_leave_group()
Definition: plugin.cc:1107
Channel_observation_manager_list * channel_observation_manager_list
The channel observation modules.
Definition: plugin.cc:94
Recovery_module * recovery_module
The plugin recovery module.
Definition: plugin.cc:86
Delayed_initialization_thread * delayed_initialization_thread
Initialization thread for server starts.
Definition: plugin.cc:108
Shared_writelock * shared_plugin_stop_lock
Class to coordinate access to the plugin stop lock.
Definition: plugin.cc:106
int get_flow_control_period_var()
Definition: plugin.cc:324
bool is_plugin_waiting_to_set_server_read_mode()
Definition: plugin.cc:2752
enum_tls_source_values
Source of TLS configuration for the connection between Group Replication members.
Definition: plugin.h:131
@ TLS_SOURCE_MYSQL_ADMIN
Definition: plugin.h:133
@ TLS_SOURCE_MYSQL_MAIN
Definition: plugin.h:132
const char * get_view_change_uuid_var()
Definition: plugin.cc:298
Asynchronous_channels_state_observer * asynchronous_channels_state_observer
The Single primary channel observation module.
Definition: plugin.cc:96
void * get_plugin_pointer()
Definition: plugin.cc:240
Remote_clone_handler * remote_clone_handler
The handler to invoke clone.
Definition: plugin.cc:120
uint plugin_get_group_members_number()
Definition: plugin.cc:491
int plugin_group_replication_stop(char **error_message=nullptr)
Definition: plugin.cc:1179
bool get_wait_on_engine_initialization()
Definition: plugin.cc:280
bool is_plugin_configured_and_starting()
Definition: plugin.cc:260
uint get_number_of_autorejoin_tries()
Definition: plugin.cc:342
long get_flow_control_applier_threshold_var()
Definition: plugin.cc:308
int plugin_group_replication_set_retrieved_certification_info(void *info)
Method to set retrieved certification info from a recovery channel extracted from a given View_change...
Definition: plugin.cc:264
Plugin_gcs_events_handler * events_handler
Definition: plugin.cc:138
Group_events_observation_manager * group_events_observation_manager
The observation module for group events.
Definition: plugin.cc:92
Gcs_operations * gcs_module
The plugin modules.
Definition: plugin.cc:88
ulonglong get_rejoin_timeout()
Definition: plugin.cc:344
void terminate_wait_on_start_process(enum_wait_on_start_process_result abort=WAIT_ON_START_PROCESS_SUCCESS)
Release all the blocked threads.
Definition: plugin.cc:404
bool get_plugin_is_stopping()
Definition: plugin.cc:278
void set_single_primary_mode_var(bool option)
Definition: plugin.cc:2761
int get_flow_control_hold_percent_var()
Definition: plugin.cc:326
enum_exit_state_action
Action performed when the member leaves the group unexpectedly.
Definition: plugin.h:84
@ EXIT_STATE_ACTION_ABORT_SERVER
Definition: plugin.h:86
@ EXIT_STATE_ACTION_OFFLINE_MODE
Definition: plugin.h:87
@ EXIT_STATE_ACTION_READ_ONLY
Definition: plugin.h:85
const char * get_group_name_var()
Definition: plugin.cc:296
bool get_plugin_is_setting_read_mode()
Definition: plugin.cc:292
void set_auto_increment_handler_values()
Definition: plugin.cc:2386
ulong get_communication_stack_var()
Definition: plugin.cc:338
Mysql_thread * mysql_thread_handler_read_only_mode
Dedicated mysql_thread to enable read_only and super_read_only since these are blocking operations.
Definition: plugin.cc:134
Consensus_leaders_handler * consensus_leaders_handler
Definition: plugin.cc:152
Primary_election_handler * primary_election_handler
The primary election handler.
Definition: plugin.cc:116
bool attempt_rejoin()
Encapsulates the logic necessary to attempt a rejoin, i.e.
Definition: plugin.cc:1668
long get_flow_control_certifier_threshold_var()
Definition: plugin.cc:304
int plugin_group_replication_deinit(void *p)
Definition: plugin.cc:2103
bool get_allow_local_lower_version_join()
Definition: plugin.cc:2742
void enable_server_shutdown_status()
Definition: plugin.cc:284
rpl_sidno get_group_sidno()
Definition: plugin.cc:268
Group_member_info_manager_interface * group_member_mgr
Definition: plugin.cc:142
Compatibility_module * compatibility_mgr
Definition: plugin.cc:146
enum_wait_on_start_process_result initiate_wait_on_start_process()
Blocks the calling thread.
Definition: plugin.cc:387
int get_flow_control_member_quota_percent_var()
Definition: plugin.cc:320
void set_enforce_update_everywhere_checks(bool option)
Definition: plugin.cc:2757
int terminate_plugin_modules(gr_modules::mask modules_to_terminate, char **error_message=nullptr, bool rejoin=false)
Definition: plugin.cc:1447
int plugin_group_replication_start(char **error_message=nullptr)
Definition: plugin.cc:510
long get_flow_control_min_recovery_quota_var()
Definition: plugin.cc:314
void register_server_reset_master()
Definition: plugin.cc:2740
Wait_ticket< my_thread_id > * transactions_latch
Transactions latch.
Definition: plugin.cc:102
API for Group Replication plugin.
static MYSQL_PLUGIN plugin_info
Definition: rewriter_plugin.cc:88
int rpl_sidno
Type of SIDNO (source ID number, first component of GTID)
Definition: rpl_gtid.h:95
#define SERVICE_TYPE(name)
Generates the standard Service type name.
Definition: service.h:75
#define SERVICE_TYPE_NO_CONST(name)
Generates the standard Service type name.
Definition: service.h:70
enum_plugin_con_isolation
What is the policy when creation a new server session for SQL execution.
Definition: sql_service_command.h:37
Definition: plugin_group_replication.h:53
Definition: plugin_group_replication.h:72
Definition: plugin_group_replication.h:100
Definition: plugin.h:66
MYSQL_PLUGIN_VAR_HEADER
Definition: plugin.h:67
This struct provides a namespace for the GR layer components.
Definition: plugin.h:93
static constexpr mask all_modules
Definition: plugin.h:123
std::bitset< NUM_MODULES > mask
Definition: plugin.h:122
gr_modules_enum
Represents the GR layer modules that can be initialized and/or terminated at will while the plugin is...
Definition: plugin.h:100
@ WAIT_ON_START
Definition: plugin.h:113
@ GROUP_ACTION_COORDINATOR
Definition: plugin.h:102
@ BLOCKED_TRANSACTION_HANDLER
Definition: plugin.h:109
@ AUTOREJOIN_THREAD
Definition: plugin.h:108
@ REMOTE_CLONE_HANDLER
Definition: plugin.h:116
@ MESSAGE_SERVICE_HANDLER
Definition: plugin.h:117
@ COMPATIBILITY_MANAGER
Definition: plugin.h:114
@ GROUP_PARTITION_HANDLER
Definition: plugin.h:107
@ NUM_MODULES
Definition: plugin.h:120
@ ASYNC_REPL_CHANNELS
Definition: plugin.h:106
@ AUTO_INCREMENT_HANDLER
Definition: plugin.h:104
@ RECOVERY_MODULE
Definition: plugin.h:101
@ GROUP_MEMBER_MANAGER
Definition: plugin.h:111
@ MEMBER_ACTIONS_HANDLER
Definition: plugin.h:119
@ BINLOG_DUMP_THREAD_KILL
Definition: plugin.h:118
@ PRIMARY_ELECTION_HANDLER
Definition: plugin.h:103
@ CERTIFICATION_LATCH
Definition: plugin.h:110
@ GCS_EVENTS_HANDLER
Definition: plugin.h:115
@ APPLIER_MODULE
Definition: plugin.h:105
@ REGISTRY_MODULE
Definition: plugin.h:112
An instrumented mutex structure.
Definition: mysql_mutex_bits.h:49
unsigned int uint
Definition: uca-dump.cc:29