MySQL  8.0.19
Source Code Documentation
que0que.h File Reference
#include "data0data.h"
#include "dict0types.h"
#include "pars0types.h"
#include "que0types.h"
#include "row0types.h"
#include "srv0srv.h"
#include "trx0roll.h"
#include "trx0trx.h"
#include "univ.i"
#include "usr0types.h"
#include "que0que.ic"

Go to the source code of this file.

Classes

struct  que_thr_t
 
struct  que_fork_t
 

Macros

#define QUE_THR_MAGIC_N   8476583
 
#define QUE_THR_MAGIC_FREED   123461526
 
#define QUE_FORK_SELECT_NON_SCROLL   1 /* forward-only cursor */
 
#define QUE_FORK_SELECT_SCROLL   2 /* scrollable cursor */
 
#define QUE_FORK_INSERT   3
 
#define QUE_FORK_UPDATE   4
 
#define QUE_FORK_ROLLBACK   5
 
#define QUE_FORK_PURGE   6
 
#define QUE_FORK_EXECUTE   7
 
#define QUE_FORK_PROCEDURE   8
 
#define QUE_FORK_PROCEDURE_CALL   9
 
#define QUE_FORK_MYSQL_INTERFACE   10
 
#define QUE_FORK_RECOVERY   11
 
#define QUE_FORK_ACTIVE   1
 
#define QUE_FORK_COMMAND_WAIT   2
 
#define QUE_FORK_INVALID   3
 
#define QUE_FORK_BEING_FREED   4
 
#define QUE_NODE_CONTROL_STAT   1024
 
#define QUE_NODE_LOCK   1
 
#define QUE_NODE_INSERT   2
 
#define QUE_NODE_UPDATE   4
 
#define QUE_NODE_CURSOR   5
 
#define QUE_NODE_SELECT   6
 
#define QUE_NODE_AGGREGATE   7
 
#define QUE_NODE_FORK   8
 
#define QUE_NODE_THR   9
 
#define QUE_NODE_UNDO   10
 
#define QUE_NODE_COMMIT   11
 
#define QUE_NODE_ROLLBACK   12
 
#define QUE_NODE_PURGE   13
 
#define QUE_NODE_SYMBOL   14
 
#define QUE_NODE_RES_WORD   15
 
#define QUE_NODE_FUNC   16
 
#define QUE_NODE_ORDER   17
 
#define QUE_NODE_PROC   (18 + QUE_NODE_CONTROL_STAT)
 
#define QUE_NODE_IF   (19 + QUE_NODE_CONTROL_STAT)
 
#define QUE_NODE_WHILE   (20 + QUE_NODE_CONTROL_STAT)
 
#define QUE_NODE_ASSIGNMENT   21
 
#define QUE_NODE_FETCH   22
 
#define QUE_NODE_OPEN   23
 
#define QUE_NODE_COL_ASSIGNMENT   24
 
#define QUE_NODE_FOR   (25 + QUE_NODE_CONTROL_STAT)
 
#define QUE_NODE_RETURN   26
 
#define QUE_NODE_ELSIF   27
 
#define QUE_NODE_CALL   28
 
#define QUE_NODE_EXIT   29
 

Enumerations

enum  que_thr_state_t {
  QUE_THR_RUNNING, QUE_THR_PROCEDURE_WAIT, QUE_THR_COMPLETED, QUE_THR_COMMAND_WAIT,
  QUE_THR_LOCK_WAIT, QUE_THR_SUSPENDED
}
 Query thread states. More...
 
enum  que_thr_lock_t { QUE_THR_LOCK_NOLOCK, QUE_THR_LOCK_ROW, QUE_THR_LOCK_TABLE }
 Query thread lock states. More...
 
enum  que_cur_t { QUE_CUR_NOT_DEFINED, QUE_CUR_START, QUE_CUR_END }
 From where the cursor position is counted. More...
 

Functions

que_fork_tque_fork_create (que_t *graph, que_node_t *parent, ulint fork_type, mem_heap_t *heap)
 Creates a query graph fork node. More...
 
UNIV_INLINE que_thr_tque_fork_get_first_thr (que_fork_t *fork)
 Gets the first thr in a fork. More...
 
UNIV_INLINE que_node_tque_fork_get_child (que_fork_t *fork)
 Gets the child node of the first thr in a fork. More...
 
UNIV_INLINE void que_node_set_parent (que_node_t *node, que_node_t *parent)
 Sets the parent of a graph node. More...
 
que_thr_tque_thr_create (que_fork_t *parent, mem_heap_t *heap, row_prebuilt_t *prebuilt)
 Creates a query graph thread node. More...
 
void que_graph_free_recursive (que_node_t *node)
 Frees a query graph, but not the heap where it was created. More...
 
void que_graph_free (que_t *graph)
 Frees a query graph. More...
 
ibool que_thr_stop (que_thr_t *thr)
 Stops a query thread if graph or trx is in a state requiring it. More...
 
void que_thr_move_to_run_state_for_mysql (que_thr_t *thr, trx_t *trx)
 Moves a thread from another state to the QUE_THR_RUNNING state. More...
 
void que_thr_stop_for_mysql_no_error (que_thr_t *thr, trx_t *trx)
 A patch for MySQL used to 'stop' a dummy query thread used in MySQL select, when there is no error or lock wait. More...
 
void que_thr_stop_for_mysql (que_thr_t *thr)
 A patch for MySQL used to 'stop' a dummy query thread used in MySQL. More...
 
void que_run_threads (que_thr_t *thr)
 Run a query thread. More...
 
que_thr_tque_thr_end_lock_wait (trx_t *trx)
 Moves a suspended query thread to the QUE_THR_RUNNING state and release a worker thread to execute it. More...
 
que_thr_tque_fork_start_command (que_fork_t *fork)
 Starts execution of a command in a query fork. More...
 
UNIV_INLINE trx_tthr_get_trx (que_thr_t *thr)
 Gets the trx of a query thread. More...
 
UNIV_INLINE ibool thr_is_recv (const que_thr_t *thr)
 Determines if this thread is rolling back an incomplete transaction in crash recovery. More...
 
UNIV_INLINE ulint que_node_get_type (const que_node_t *node)
 Gets the type of a graph node. More...
 
UNIV_INLINE dtype_tque_node_get_data_type (que_node_t *node)
 Gets pointer to the value data type field of a graph node. More...
 
UNIV_INLINE dfield_tque_node_get_val (que_node_t *node)
 Gets pointer to the value dfield of a graph node. More...
 
UNIV_INLINE ulint que_node_get_val_buf_size (que_node_t *node)
 Gets the value buffer size of a graph node. More...
 
UNIV_INLINE void que_node_set_val_buf_size (que_node_t *node, ulint size)
 Sets the value buffer size of a graph node. More...
 
UNIV_INLINE que_node_tque_node_get_next (que_node_t *node)
 Gets the next list node in a list of query graph nodes. More...
 
UNIV_INLINE que_node_tque_node_get_parent (que_node_t *node)
 Gets the parent node of a query graph node. More...
 
que_node_tque_node_get_containing_loop_node (que_node_t *node)
 Get the first containing loop node (e.g. More...
 
UNIV_INLINE que_node_tque_node_list_add_last (que_node_t *node_list, que_node_t *node)
 Catenates a query graph node to a list of them, possible empty list. More...
 
UNIV_INLINE que_node_tque_node_list_get_last (que_node_t *node_list)
 
UNIV_INLINE ulint que_node_list_get_len (que_node_t *node_list)
 Gets a query graph node list length. More...
 
UNIV_INLINE ibool que_thr_peek_stop (que_thr_t *thr)
 Checks if graph, trx, or session is in a state where the query thread should be stopped. More...
 
UNIV_INLINE ibool que_graph_is_select (que_t *graph)
 Returns TRUE if the query graph is for a SELECT statement. More...
 
void que_node_print_info (que_node_t *node)
 Prints info of an SQL query graph node. More...
 
dberr_t que_eval_sql (pars_info_t *info, const char *sql, ibool reserve_dict_mutex, trx_t *trx)
 Evaluate the given SQL. More...
 
que_thr_tque_fork_scheduler_round_robin (que_fork_t *fork, que_thr_t *thr)
 Round robin scheduler. More...
 
void que_init (void)
 Initialise the query sub-system. More...
 
void que_close (void)
 Close the query sub-system. More...
 

Variables

ib_mutex_t que_thr_mutex
 Mutex protecting the query threads. More...
 

Detailed Description

Query graph

Created 5/27/1996 Heikki Tuuri

Macro Definition Documentation

◆ QUE_FORK_ACTIVE

#define QUE_FORK_ACTIVE   1

◆ QUE_FORK_BEING_FREED

#define QUE_FORK_BEING_FREED   4

◆ QUE_FORK_COMMAND_WAIT

#define QUE_FORK_COMMAND_WAIT   2

◆ QUE_FORK_EXECUTE

#define QUE_FORK_EXECUTE   7

◆ QUE_FORK_INSERT

#define QUE_FORK_INSERT   3

◆ QUE_FORK_INVALID

#define QUE_FORK_INVALID   3

◆ QUE_FORK_MYSQL_INTERFACE

#define QUE_FORK_MYSQL_INTERFACE   10

◆ QUE_FORK_PROCEDURE

#define QUE_FORK_PROCEDURE   8

◆ QUE_FORK_PROCEDURE_CALL

#define QUE_FORK_PROCEDURE_CALL   9

◆ QUE_FORK_PURGE

#define QUE_FORK_PURGE   6

◆ QUE_FORK_RECOVERY

#define QUE_FORK_RECOVERY   11

◆ QUE_FORK_ROLLBACK

#define QUE_FORK_ROLLBACK   5

◆ QUE_FORK_SELECT_NON_SCROLL

#define QUE_FORK_SELECT_NON_SCROLL   1 /* forward-only cursor */

◆ QUE_FORK_SELECT_SCROLL

#define QUE_FORK_SELECT_SCROLL   2 /* scrollable cursor */

◆ QUE_FORK_UPDATE

#define QUE_FORK_UPDATE   4

◆ QUE_NODE_AGGREGATE

#define QUE_NODE_AGGREGATE   7

◆ QUE_NODE_ASSIGNMENT

#define QUE_NODE_ASSIGNMENT   21

◆ QUE_NODE_CALL

#define QUE_NODE_CALL   28

◆ QUE_NODE_COL_ASSIGNMENT

#define QUE_NODE_COL_ASSIGNMENT   24

◆ QUE_NODE_COMMIT

#define QUE_NODE_COMMIT   11

◆ QUE_NODE_CONTROL_STAT

#define QUE_NODE_CONTROL_STAT   1024

◆ QUE_NODE_CURSOR

#define QUE_NODE_CURSOR   5

◆ QUE_NODE_ELSIF

#define QUE_NODE_ELSIF   27

◆ QUE_NODE_EXIT

#define QUE_NODE_EXIT   29

◆ QUE_NODE_FETCH

#define QUE_NODE_FETCH   22

◆ QUE_NODE_FOR

#define QUE_NODE_FOR   (25 + QUE_NODE_CONTROL_STAT)

◆ QUE_NODE_FORK

#define QUE_NODE_FORK   8

◆ QUE_NODE_FUNC

#define QUE_NODE_FUNC   16

◆ QUE_NODE_IF

#define QUE_NODE_IF   (19 + QUE_NODE_CONTROL_STAT)

◆ QUE_NODE_INSERT

#define QUE_NODE_INSERT   2

◆ QUE_NODE_LOCK

#define QUE_NODE_LOCK   1

◆ QUE_NODE_OPEN

#define QUE_NODE_OPEN   23

◆ QUE_NODE_ORDER

#define QUE_NODE_ORDER   17

◆ QUE_NODE_PROC

#define QUE_NODE_PROC   (18 + QUE_NODE_CONTROL_STAT)

◆ QUE_NODE_PURGE

#define QUE_NODE_PURGE   13

◆ QUE_NODE_RES_WORD

#define QUE_NODE_RES_WORD   15

◆ QUE_NODE_RETURN

#define QUE_NODE_RETURN   26

◆ QUE_NODE_ROLLBACK

#define QUE_NODE_ROLLBACK   12

◆ QUE_NODE_SELECT

#define QUE_NODE_SELECT   6

◆ QUE_NODE_SYMBOL

#define QUE_NODE_SYMBOL   14

◆ QUE_NODE_THR

#define QUE_NODE_THR   9

◆ QUE_NODE_UNDO

#define QUE_NODE_UNDO   10

◆ QUE_NODE_UPDATE

#define QUE_NODE_UPDATE   4

◆ QUE_NODE_WHILE

#define QUE_NODE_WHILE   (20 + QUE_NODE_CONTROL_STAT)

◆ QUE_THR_MAGIC_FREED

#define QUE_THR_MAGIC_FREED   123461526

◆ QUE_THR_MAGIC_N

#define QUE_THR_MAGIC_N   8476583

Enumeration Type Documentation

◆ que_cur_t

enum que_cur_t

From where the cursor position is counted.

Enumerator
QUE_CUR_NOT_DEFINED 
QUE_CUR_START 
QUE_CUR_END 

◆ que_thr_lock_t

Query thread lock states.

Enumerator
QUE_THR_LOCK_NOLOCK 
QUE_THR_LOCK_ROW 
QUE_THR_LOCK_TABLE 

◆ que_thr_state_t

Query thread states.

Enumerator
QUE_THR_RUNNING 
QUE_THR_PROCEDURE_WAIT 
QUE_THR_COMPLETED 

in selects this means that the thread is at the end of its result set (or start, in case of a scroll cursor); in other statements, this means the thread has done its task

QUE_THR_COMMAND_WAIT 
QUE_THR_LOCK_WAIT 
QUE_THR_SUSPENDED 

Function Documentation

◆ que_close()

void que_close ( void  )

Close the query sub-system.

◆ que_eval_sql()

dberr_t que_eval_sql ( pars_info_t info,
const char *  sql,
ibool  reserve_dict_mutex,
trx_t trx 
)

Evaluate the given SQL.

Returns
error code or DB_SUCCESS in: trx
error code or DB_SUCCESS

◆ que_fork_create()

que_fork_t* que_fork_create ( que_t graph,
que_node_t parent,
ulint  fork_type,
mem_heap_t heap 
)

Creates a query graph fork node.

Returns
own: fork node in: memory heap where created
own: fork node

◆ que_fork_get_child()

UNIV_INLINE que_node_t* que_fork_get_child ( que_fork_t fork)

Gets the child node of the first thr in a fork.

in: query fork

◆ que_fork_get_first_thr()

UNIV_INLINE que_thr_t* que_fork_get_first_thr ( que_fork_t fork)

Gets the first thr in a fork.

in: query fork

◆ que_fork_scheduler_round_robin()

que_thr_t* que_fork_scheduler_round_robin ( que_fork_t fork,
que_thr_t thr 
)

Round robin scheduler.

Returns
a query thread of the graph moved to QUE_THR_RUNNING state, or NULL; the query thread should be executed by que_run_threads by the caller in: current pos
a query thread of the graph moved to QUE_THR_RUNNING state, or NULL; the query thread should be executed by que_run_threads by the caller

◆ que_fork_start_command()

que_thr_t* que_fork_start_command ( que_fork_t fork)

Starts execution of a command in a query fork.

Picks a query thread which is not in the QUE_THR_RUNNING state and moves it to that state. If none can be chosen, a situation which may arise in parallelized fetches, NULL is returned.

Returns
a query thread of the graph moved to QUE_THR_RUNNING state, or NULL; the query thread should be executed by que_run_threads by the caller in: a query fork

Picks a query thread which is not in the QUE_THR_RUNNING state and moves it to that state. If none can be chosen, a situation which may arise in parallelized fetches, NULL is returned.

Returns
a query thread of the graph moved to QUE_THR_RUNNING state, or NULL; the query thread should be executed by que_run_threads by the caller

◆ que_graph_free()

void que_graph_free ( que_t graph)

Frees a query graph.

in: query graph; we assume that the memory heap where this graph was created is private to this graph: if not, then use que_graph_free_recursive and free the heap afterwards!

◆ que_graph_free_recursive()

void que_graph_free_recursive ( que_node_t node)

Frees a query graph, but not the heap where it was created.

Does not free explicit cursor declarations, they are freed in que_graph_free. in: query graph node

Does not free explicit cursor declarations, they are freed in que_graph_free.

◆ que_graph_is_select()

UNIV_INLINE ibool que_graph_is_select ( que_t graph)

Returns TRUE if the query graph is for a SELECT statement.

Returns
true if a select in: graph

◆ que_init()

void que_init ( void  )

Initialise the query sub-system.

◆ que_node_get_containing_loop_node()

que_node_t* que_node_get_containing_loop_node ( que_node_t node)

Get the first containing loop node (e.g.

while_node_t or for_node_t) for the given node, or NULL if the node is not within a loop.

Returns
containing loop node, or NULL. in: node

while_node_t or for_node_t) for the given node, or NULL if the node is not within a loop.

Returns
containing loop node, or NULL.

◆ que_node_get_data_type()

UNIV_INLINE dtype_t* que_node_get_data_type ( que_node_t node)

Gets pointer to the value data type field of a graph node.

in: graph node

◆ que_node_get_next()

UNIV_INLINE que_node_t* que_node_get_next ( que_node_t node)

Gets the next list node in a list of query graph nodes.

in: node in a list

◆ que_node_get_parent()

UNIV_INLINE que_node_t* que_node_get_parent ( que_node_t node)

Gets the parent node of a query graph node.

Returns
parent node or NULL in: node

◆ que_node_get_type()

UNIV_INLINE ulint que_node_get_type ( const que_node_t node)

Gets the type of a graph node.

in: graph node

◆ que_node_get_val()

UNIV_INLINE dfield_t* que_node_get_val ( que_node_t node)

Gets pointer to the value dfield of a graph node.

in: graph node

◆ que_node_get_val_buf_size()

UNIV_INLINE ulint que_node_get_val_buf_size ( que_node_t node)

Gets the value buffer size of a graph node.

Returns
val buffer size, not defined if val.data == NULL in node in: graph node

◆ que_node_list_add_last()

UNIV_INLINE que_node_t* que_node_list_add_last ( que_node_t node_list,
que_node_t node 
)

Catenates a query graph node to a list of them, possible empty list.

Parameters
[in]node_listnode list, or NULL
[in]nodenode
Returns
one-way list of nodes

◆ que_node_list_get_last()

UNIV_INLINE que_node_t* que_node_list_get_last ( que_node_t node_list)

◆ que_node_list_get_len()

UNIV_INLINE ulint que_node_list_get_len ( que_node_t node_list)

Gets a query graph node list length.

Returns
length, for NULL list 0 in: node list, or NULL

◆ que_node_print_info()

void que_node_print_info ( que_node_t node)

Prints info of an SQL query graph node.

in: query graph node

◆ que_node_set_parent()

UNIV_INLINE void que_node_set_parent ( que_node_t node,
que_node_t parent 
)

Sets the parent of a graph node.

Parameters
[in]nodegraph node
[in]parentparent

◆ que_node_set_val_buf_size()

UNIV_INLINE void que_node_set_val_buf_size ( que_node_t node,
ulint  size 
)

Sets the value buffer size of a graph node.

Parameters
[in]nodegraph node
[in]sizesize

◆ que_run_threads()

void que_run_threads ( que_thr_t thr)

Run a query thread.

Handles lock waits. in: query thread

Handles lock waits.

◆ que_thr_create()

que_thr_t* que_thr_create ( que_fork_t parent,
mem_heap_t heap,
row_prebuilt_t prebuilt 
)

Creates a query graph thread node.

Parameters
[in]parentparent node, i.e., a fork node
[in]heapmemory heap where created
[in]prebuiltrow prebuilt structure
Returns
own: query thread node

◆ que_thr_end_lock_wait()

que_thr_t* que_thr_end_lock_wait ( trx_t trx)

Moves a suspended query thread to the QUE_THR_RUNNING state and release a worker thread to execute it.

This function should be used to end the wait state of a query thread waiting for a lock or a stored procedure completion.

Returns
query thread instance of thread to wakeup or NULL in: transaction in the QUE_THR_LOCK_WAIT state

Moves a suspended query thread to the QUE_THR_RUNNING state and release a worker thread to execute it.

This function should be used to end the wait state of a query thread waiting for a lock or a stored procedure completion.

Returns
the query thread that needs to be released.

◆ que_thr_move_to_run_state_for_mysql()

void que_thr_move_to_run_state_for_mysql ( que_thr_t thr,
trx_t trx 
)

Moves a thread from another state to the QUE_THR_RUNNING state.

Increments the n_active_thrs counters of the query graph and transaction. in: transaction

Increments the n_active_thrs counters of the query graph and transaction if thr was not active.

◆ que_thr_peek_stop()

UNIV_INLINE ibool que_thr_peek_stop ( que_thr_t thr)

Checks if graph, trx, or session is in a state where the query thread should be stopped.

Returns
true if should be stopped; NOTE that if the peek is made without reserving the trx_t::mutex, then another peek with the mutex reserved is necessary before deciding the actual stopping in: query thread

◆ que_thr_stop()

ibool que_thr_stop ( que_thr_t thr)

Stops a query thread if graph or trx is in a state requiring it.

The conditions are tested in the order (1) graph, (2) trx. The lock_sys_t::mutex has to be reserved.

Returns
true if stopped in: query thread

The conditions are tested in the order (1) graph, (2) trx.

Returns
true if stopped

◆ que_thr_stop_for_mysql()

void que_thr_stop_for_mysql ( que_thr_t thr)

A patch for MySQL used to 'stop' a dummy query thread used in MySQL.

The query thread is stopped and made inactive, except in the case where it was put to the lock wait state in lock0lock.cc, but the lock has already been granted or the transaction chosen as a victim in deadlock resolution. in: query thread

The query thread is stopped and made inactive, except in the case where it was put to the lock wait state in lock0lock.cc, but the lock has already been granted or the transaction chosen as a victim in deadlock resolution.

◆ que_thr_stop_for_mysql_no_error()

void que_thr_stop_for_mysql_no_error ( que_thr_t thr,
trx_t trx 
)

A patch for MySQL used to 'stop' a dummy query thread used in MySQL select, when there is no error or lock wait.

in: transaction

Parameters
thrin: query thread

◆ thr_get_trx()

UNIV_INLINE trx_t* thr_get_trx ( que_thr_t thr)

Gets the trx of a query thread.

in: query thread

◆ thr_is_recv()

UNIV_INLINE ibool thr_is_recv ( const que_thr_t thr)

Determines if this thread is rolling back an incomplete transaction in crash recovery.

Returns
true if thr is rolling back an incomplete transaction in crash recovery in: query thread

Variable Documentation

◆ que_thr_mutex

ib_mutex_t que_thr_mutex

Mutex protecting the query threads.