MySQL  8.0.27
Source Code Documentation
rpl_rli_pdb.h File Reference
#include <stdarg.h>
#include <sys/types.h>
#include <time.h>
#include <atomic>
#include <tuple>
#include "libbinlogevents/include/binlog_event.h"
#include "my_bitmap.h"
#include "my_compiler.h"
#include "my_dbug.h"
#include "my_inttypes.h"
#include "my_io.h"
#include "my_loglevel.h"
#include "my_psi_config.h"
#include "mysql/components/services/bits/psi_bits.h"
#include "mysql/components/services/mysql_cond_bits.h"
#include "mysql/components/services/mysql_mutex_bits.h"
#include "mysql/components/services/psi_mutex_bits.h"
#include "mysql/service_mysql_alloc.h"
#include "prealloced_array.h"
#include "sql/log_event.h"
#include "sql/rpl_gtid.h"
#include "sql/rpl_mta_submode.h"
#include "sql/rpl_replica.h"
#include "sql/rpl_rli.h"
#include "sql/sql_class.h"
#include "sql/system_variables.h"

Go to the source code of this file.

Classes

struct  db_worker_hash_entry
 Legends running throughout the module: More...
 
struct  Slave_job_group
 
class  circular_buffer_queue< Element_type >
 The class defines a type of queue with a predefined max size that is implemented using the circular memory buffer. More...
 
class  Slave_committed_queue
 Group Assigned Queue whose first element identifies first gap in committed sequence. More...
 
class  Slave_jobs_queue
 
class  Slave_worker
 

Macros

#define SLAVE_INIT_DBS_IN_GROUP   4
 

Functions

bool init_hash_workers (Relay_log_info *rli)
 
void destroy_hash_workers (Relay_log_info *)
 
Slave_workermap_db_to_worker (const char *dbname, Relay_log_info *rli, db_worker_hash_entry **ptr_entry, bool need_temp_tables, Slave_worker *w)
 The function produces a reference to the struct of a Worker that has been or will be engaged to process the dbname -keyed partition (D). More...
 
Slave_workerget_least_occupied_worker (Relay_log_info *rli, Slave_worker_array *workers, Log_event *ev)
 Get the least occupied worker. More...
 
void * head_queue (Slave_jobs_queue *jobs, Slave_job_item *ret)
 return the value of data member of the head of the queue. More...
 
bool handle_slave_worker_stop (Slave_worker *worker, Slave_job_item *job_item)
 This function is called by both coordinator and workers. More...
 
bool set_max_updated_index_on_stop (Slave_worker *worker, Slave_job_item *job_item)
 This function is called by both coordinator and workers. More...
 
TABLEmts_move_temp_table_to_entry (TABLE *, THD *, db_worker_hash_entry *)
 Relocating temporary table reference into entry's table list head. More...
 
TABLEmts_move_temp_tables_to_thd (THD *, TABLE *)
 Relocation of the list of temporary tables to thd->temporary_tables. More...
 
TABLEmts_move_temp_tables_to_thd (THD *, TABLE *, enum_mts_parallel_type)
 
bool append_item_to_jobs (slave_job_item *job_item, Slave_worker *w, Relay_log_info *rli)
 Coordinator enqueues a job item into a Worker private queue. More...
 
Slave_job_itemde_queue (Slave_jobs_queue *jobs, Slave_job_item *ret)
 return a job item through a struct which point is supplied via argument. More...
 
Slave_workerget_thd_worker (THD *thd)
 
int slave_worker_exec_job_group (Slave_worker *w, Relay_log_info *rli)
 apply one job group. More...
 

Variables

ulong w_rr
 

Macro Definition Documentation

◆ SLAVE_INIT_DBS_IN_GROUP

#define SLAVE_INIT_DBS_IN_GROUP   4

Function Documentation

◆ append_item_to_jobs()

bool append_item_to_jobs ( slave_job_item job_item,
Slave_worker worker,
Relay_log_info rli 
)

Coordinator enqueues a job item into a Worker private queue.

Parameters
job_itema pointer to struct carrying a reference to an event
workera pointer to the assigned Worker struct
rlia pointer to Relay_log_info of Coordinator
Returns
false Success. true Thread killed or worker stopped while waiting for successful enqueue.

◆ de_queue()

Slave_job_item* de_queue ( Slave_jobs_queue jobs,
Slave_job_item ret 
)

return a job item through a struct which point is supplied via argument.

◆ destroy_hash_workers()

void destroy_hash_workers ( Relay_log_info rli)

◆ get_least_occupied_worker()

Slave_worker* get_least_occupied_worker ( Relay_log_info rli,
Slave_worker_array ws,
Log_event ev 
)

Get the least occupied worker.

Parameters
rlipointer to Relay_log_info of Coordinator
wsdynarray of pointers to Slave_worker
evevent for which we are searching for a worker
Returns
a pointer to chosen Slave_worker instance

◆ get_thd_worker()

Slave_worker* get_thd_worker ( THD thd)
inline

◆ handle_slave_worker_stop()

bool handle_slave_worker_stop ( Slave_worker worker,
Slave_job_item job_item 
)

This function is called by both coordinator and workers.

Upon receiving the STOP command, the workers will identify a maximum group index already executed (or under execution).

All groups whose index are below or equal to the maximum group index will be applied by the workers before stopping.

The workers with groups above the maximum group index will exit without applying these groups by setting their running status to "STOP_ACCEPTED".

Parameters
workera pointer to the waiting Worker struct
job_itema pointer to struct carrying a reference to an event
Returns
true if STOP command gets accepted otherwise false is returned.

◆ head_queue()

void* head_queue ( Slave_jobs_queue jobs,
Slave_job_item ret 
)

return the value of data member of the head of the queue.

◆ init_hash_workers()

bool init_hash_workers ( Relay_log_info rli)

◆ map_db_to_worker()

Slave_worker* map_db_to_worker ( const char *  dbname,
Relay_log_info rli,
db_worker_hash_entry **  ptr_entry,
bool  need_temp_tables,
Slave_worker last_worker 
)

The function produces a reference to the struct of a Worker that has been or will be engaged to process the dbname -keyed partition (D).

It checks a local to Coordinator CGAP list first and returns last_assigned_worker when found (todo: assert).

Otherwise, the partition is appended to the current group list:

 CGAP .= D

here .= is concatenate operation, and a possible D's Worker id is searched in Assigned Partition Hash (APH) that collects tuples (P, W_id, U, mutex, cond). In case not found,

 W_d := W_c unless W_c is NULL.

When W_c is NULL it is assigned to a least occupied as defined by get_least_occupied_worker().

 W_d := W_c := W_{least_occupied}

 APH .=  a new (D, W_d, 1)

In a case APH contains W_d == W_c, (assert U >= 1)

 update APH set  U++ where  APH.P = D

The case APH contains a W_d != W_c != NULL assigned to D-partition represents the hashing conflict and is handled as the following:

a. marks the record of APH with a flag requesting to signal in the cond var when ‘U’ the usage counter drops to zero by the other Worker; b. waits for the other Worker to finish tasks on that partition and gets the signal; c. updates the APH record to point to the first Worker (naturally, U := 1), scheduled the event, and goes back into the parallel mode

Parameters
dbnamepointer to c-string containing database name It can be empty string to indicate specific locking to faciliate sequential applying.
rlipointer to Coordinators relay-log-info instance
ptr_entryreference to a pointer to the resulted entry in the Assigne Partition Hash where the entry's pointer is stored at return.
need_temp_tablesif false migration of temporary tables not needed
last_workercaller opts for this Worker, it must be rli->last_assigned_worker if one is determined.
Note
modifies CGAP, APH and unlinks dbname -keyd temporary tables from C's thd->temporary_tables to move them into the entry record.
Returns
the pointer to a Worker struct

◆ mts_move_temp_table_to_entry()

TABLE* mts_move_temp_table_to_entry ( TABLE table,
THD thd,
db_worker_hash_entry entry 
)

Relocating temporary table reference into entry's table list head.

Sources can be the coordinator's and the Worker's thd->temporary_tables.

Parameters
tableTABLE instance pointer
thdTHD instance pointer of the source of relocation
entrydb_worker_hash_entry instance pointer
Note
thd->temporary_tables can become NULL
Returns
the pointer to a table following the unlinked

◆ mts_move_temp_tables_to_thd() [1/2]

TABLE* mts_move_temp_tables_to_thd ( THD thd,
TABLE temporary_tables 
)

Relocation of the list of temporary tables to thd->temporary_tables.

Parameters
thdTHD instance pointer of the destination
temporary_tablesthe source temporary_tables list
Note
destroying references to the source list, if necessary, is left to the caller.
Returns
the post-merge value of thd->temporary_tables.

◆ mts_move_temp_tables_to_thd() [2/2]

TABLE* mts_move_temp_tables_to_thd ( THD ,
TABLE ,
enum_mts_parallel_type   
)

◆ set_max_updated_index_on_stop()

bool set_max_updated_index_on_stop ( Slave_worker worker,
Slave_job_item job_item 
)

This function is called by both coordinator and workers.

Both coordinator and workers contribute to max_updated_index.

Parameters
workera pointer to the waiting Worker struct
job_itema pointer to struct carrying a reference to an event
Returns
true if STOP command gets accepted otherwise false is returned.

◆ slave_worker_exec_job_group()

int slave_worker_exec_job_group ( Slave_worker worker,
Relay_log_info rli 
)

apply one job group.

Note
the function maintains worker's CGEP and modifies APH, updates the current group item in GAQ via slave_worker_ends_group().

param[in] worker the worker which calls it. param[in] rli slave's relay log info object.

return returns 0 if the group of jobs are applied successfully, otherwise returns an error code.

Variable Documentation

◆ w_rr

ulong w_rr
extern