MySQL 8.4.3
Source Code Documentation
sql_common.h
Go to the documentation of this file.
1#ifndef SQL_COMMON_INCLUDED
2#define SQL_COMMON_INCLUDED
3
4/* Copyright (c) 2003, 2024, Oracle and/or its affiliates.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License, version 2.0,
8 as published by the Free Software Foundation.
9
10 This program is designed to work with certain software (including
11 but not limited to OpenSSL) that is licensed under separate terms,
12 as designated in a particular file or component or in included license
13 documentation. The authors of MySQL hereby grant you an additional
14 permission to link the program and your derivative works with the
15 separately licensed software that they have either included with
16 the program or referenced in the documentation.
17
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License, version 2.0, for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
26
27/**
28 @file include/sql_common.h
29*/
30
31#include <mysql.h>
32#include <stddef.h>
33#include <sys/types.h>
34
35#include "errmsg.h"
36#include "my_command.h"
37#include "my_compiler.h"
38#include "my_inttypes.h"
39#include "my_list.h"
40#include "mysql_com.h"
41#ifdef MYSQL_SERVER
42#include "mysql_com_server.h"
43#endif
44
45struct CHARSET_INFO;
46struct MEM_ROOT;
47
48#ifdef __cplusplus
49extern "C" {
50#endif
51
52#ifdef IMPORT_UNKNOWN_SQLSTATE
53__declspec(dllimport)
54#endif
55 extern const char *unknown_sqlstate;
56extern const char *cant_connect_sqlstate;
57extern const char *not_error_sqlstate;
58
59/*
60 Free all memory allocated in MYSQL handle except the
61 current options.
62*/
64
65/*
66 Clear connection options stored in MYSQL handle and
67 free memory used by them.
68*/
70
71/**
72 The structure is used to hold the state change information
73 received from the server. LIST functions are used for manipulation
74 of the members of the structure.
75*/
77 /** head_node->data is a LEX_STRING which contains the variable name. */
80};
81
82/**
83 Store the change info received from the server in an array of linked lists
84 with STATE_INFO_NODE elements (one per state type).
85*/
86struct STATE_INFO {
87 /** Array of STATE_NODE_INFO elements (one per state type). */
89};
90
91/*
92 Access to MYSQL::extension member.
93
94 Note: functions mysql_extension_{init,free}() are defined
95 in client.c.
96*/
97
98struct st_mysql_trace_info;
100
102 struct st_mysql_trace_info *trace_data;
104 /* Struct to track the state of asynchronous operations */
106#ifdef MYSQL_SERVER
107 // Used by replication to pass around compression context data.
109 /* used by mysql_init() api for mysql command service related information */
110 void *mcs_extn;
111#endif
112 struct {
114 char **names;
117};
118
119/* "Constructor/destructor" for MYSQL extension structure. */
122/* cleanup for the MYSQL extension bind structure */
124/*
125 Note: Allocated extension structure is freed in mysql_close_free()
126 called by mysql_close().
127*/
128#define MYSQL_EXTENSION_PTR(H) \
129 ((MYSQL_EXTENSION *)((H)->extension \
130 ? (H)->extension \
131 : ((H)->extension = mysql_extension_init(H))))
132
133#define ASYNC_DATA(M) \
134 (NULL != (M) ? (MYSQL_EXTENSION_PTR(M)->mysql_async_context) : NULL)
135/**
136 Sets the MYSQL_EXTENSION::server_extn attribute by the use of NET_SERVER which
137 contains information about compression context and compression attributes.
138 This attribute needs to be set each time mysql_real_connect() is called to
139 make a connection. When a connection attempt fails or when a connection is
140 closed, as part of the MYSQL handle cleanup, mysql_close_free() is called and
141 that will free MYSQL_EXTENSION::server_extn.
142
143 mysql_close_free() will free all the memory allocated in the MYSQL handle but
144 preserves MYSQL::options. These options are later free'd by
145 mysql_close_free_options() unless the client flag CLIENT_REMEMBER_OPTIONS is
146 set.
147
148 @param mysql The MYSQL handle
149 @param extn The NET_SERVER handle that contains compression context info.
150*/
151#ifdef MYSQL_SERVER
153 MYSQL_EXTENSION_PTR(mysql)->server_extn = extn;
154}
155#endif /* MYSQL_SERVER*/
156
157/*
158 Maximum allowed authentication plugins for a given user account.
159*/
160#define MAX_AUTHENTICATION_FACTOR 3
161/*
162 Placeholder to save plugin name and password of 1st, 2nd and 3rd
163 factor authentication methods.
164*/
167 char *password;
168};
169
173 char *ssl_crl; /* PEM CRL file */
174 char *ssl_crlpath; /* PEM directory of CRL-s? */
179 bool get_server_public_key; /* Former ssl_enforce */
180 char *tls_version; /* TLS version option */
181 long ssl_ctx_flags; /* SSL ctx options flag */
182 unsigned int ssl_mode;
183 unsigned int retry_count;
184 unsigned int ssl_fips_mode; /* SSL fips mode for enforced encryption.*/
192 void *ssl_session_data; /** the session serialization to use */
193 char *tls_sni_servername; /* TLS sni server name */
194};
195
196#define MYSQL_OPTIONS_EXTENSION_PTR(H, what) \
197 ((H)->options.extension ? (H)->options.extension->what : nullptr)
198
200 MYSQL *(*connect_method)(mysql_async_connect *connect_args);
203 const unsigned char *header, size_t header_length,
204 const unsigned char *arg, size_t arg_length,
205 bool skip_check, MYSQL_STMT *stmt);
206 MYSQL_DATA *(*read_rows)(MYSQL *mysql, MYSQL_FIELD *mysql_fields,
207 unsigned int fields);
208 MYSQL_RES *(*use_result)(MYSQL *mysql);
210 void (*fetch_lengths)(unsigned long *to, MYSQL_ROW column,
211 unsigned int field_count);
212 void (*flush_use_result)(MYSQL *mysql, bool flush_all_results);
214#if !defined(MYSQL_SERVER) && !defined(MYSQL_COMPONENT)
215 MYSQL_FIELD *(*list_fields)(MYSQL *mysql);
216 bool (*read_prepare_result)(MYSQL *mysql, MYSQL_STMT *stmt);
217 int (*stmt_execute)(MYSQL_STMT *stmt);
218 int (*read_binary_rows)(MYSQL_STMT *stmt);
219 int (*unbuffered_fetch)(MYSQL *mysql, char **row);
220 const char *(*read_statistics)(MYSQL *mysql);
221 bool (*next_result)(MYSQL *mysql);
222 int (*read_rows_from_cursor)(MYSQL_STMT *stmt);
223 void (*free_rows)(MYSQL_DATA *cur);
224#endif
228 const unsigned char *header, unsigned long header_length,
229 const unsigned char *arg, unsigned long arg_length, bool skip_check,
230 MYSQL_STMT *stmt, bool *error);
232 MYSQL_FIELD *mysql_fields,
233 unsigned int fields,
236 bool flush_all_results);
239 ulong *res);
240};
241
242#define simple_command(mysql, command, arg, length, skip_check) \
243 ((mysql)->methods \
244 ? (*(mysql)->methods->advanced_command)(mysql, command, nullptr, 0, \
245 arg, length, skip_check, NULL) \
246 : (set_mysql_error(mysql, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate), \
247 1))
248#define simple_command_nonblocking(mysql, command, arg, length, skip_check, \
249 error) \
250 (*(mysql)->methods->advanced_command_nonblocking)( \
251 mysql, command, nullptr, 0, arg, length, skip_check, nullptr, error)
252
253#define stmt_command(mysql, command, arg, length, stmt) \
254 ((mysql)->methods \
255 ? (*(mysql)->methods->advanced_command)(mysql, command, nullptr, 0, \
256 arg, length, 1, stmt) \
257 : (set_mysql_error(mysql, CR_COMMANDS_OUT_OF_SYNC, unknown_sqlstate), \
258 1))
259
262 uint fields, bool default_value,
263 uint server_capabilities);
265 unsigned long field_count,
266 unsigned int fields);
267MYSQL_FIELD *cli_read_metadata(MYSQL *mysql, unsigned long field_count,
268 unsigned int fields);
271void free_rows(MYSQL_DATA *cur);
273void end_server(MYSQL *mysql);
276 const char *filename, const char *group);
278 const unsigned char *header, size_t header_length,
279 const unsigned char *arg, size_t arg_length,
280 bool skip_check, MYSQL_STMT *stmt);
281unsigned long cli_safe_read(MYSQL *mysql, bool *is_data_packet);
283 bool *is_data_packet,
284 ulong *res);
285unsigned long cli_safe_read_with_ok(MYSQL *mysql, bool parse_ok,
286 bool *is_data_packet);
287void net_clear_error(NET *net);
288void set_stmt_errmsg(MYSQL_STMT *stmt, NET *net);
289void set_stmt_error(MYSQL_STMT *stmt, int errcode, const char *sqlstate);
290void set_stmt_extended_error(MYSQL_STMT *stmt, int errcode,
291 const char *sqlstate, const char *format, ...)
292 MY_ATTRIBUTE((format(printf, 4, 5)));
293void set_mysql_error(MYSQL *mysql, int errcode, const char *sqlstate);
294void set_mysql_extended_error(MYSQL *mysql, int errcode, const char *sqlstate,
295 const char *format, ...)
296 MY_ATTRIBUTE((format(printf, 4, 5)));
297
298/* client side of the pluggable authentication */
300
302int run_plugin_auth(MYSQL *mysql, char *data, uint data_len,
303 const char *data_plugin, const char *db);
306
308
313void read_ok_ex(MYSQL *mysql, unsigned long len);
314
315bool fix_param_bind(MYSQL_BIND *param, uint idx);
317 NET *net, unsigned int param_count, MYSQL_BIND *params, const char **names,
318 unsigned long n_param_sets, uchar **ret_data, ulong *ret_length,
319 uchar send_types_to_server, bool send_named_params,
320 bool send_parameter_set_count, bool send_parameter_count_when_zero);
321
322#ifdef __cplusplus
323}
324#endif
325
326#define protocol_41(A) ((A)->server_capabilities & CLIENT_PROTOCOL_41)
327
328/*
329 AuthNextFactor packet is defined to have value 2 in 1st byte.
330*/
331#define AUTH_NEXT_FACTOR_PACKETTYPE 2
332#endif /* SQL_COMMON_INCLUDED */
Error messages for MySQL clients.
enum_server_command
A list of all MySQL protocol commands.
Definition: my_command.h:48
Header for compiler-dependent features.
Some integer typedefs for easier portability.
unsigned char uchar
Definition: my_inttypes.h:52
static const char * filepath
Definition: myisamlog.cc:97
This file defines the client API to MySQL and also the ABI of the dynamically linked libmysqlclient.
char ** MYSQL_ROW
Definition: mysql.h:145
Common definition between mysql server & client.
#define MYSQL_VIO
Definition: mysql_com.h:895
#define SESSION_TRACK_END
End of enum_session_state_type.
Definition: mysql_com.h:1083
Definitions private to the server, used in the networking layer to notify specific events.
static MYSQL * mysql
Definition: mysqldump.cc:147
Definition: buf0block_hint.cc:30
Json_data_extension ext
Definition: backend.cc:52
Definition: instrumented_condition_variable.h:32
Definition: buffer.h:45
Definition: options.cc:57
const char * filename
Definition: pfs_example_component_population.cc:67
struct result result
Definition: result.h:34
net_async_status
Definition: plugin_auth_common.h:136
void mysql_extension_bind_free(MYSQL_EXTENSION *ext)
Definition: client.cc:3367
const char * unknown_sqlstate
Definition: client.cc:222
void set_stmt_extended_error(MYSQL_STMT *stmt, int errcode, const char *sqlstate, const char *format,...)
Set statement error code, sqlstate, and error message from given errcode and sqlstate.
Definition: libmysql.cc:1216
void mysql_close_free(MYSQL *mysql)
Definition: client.cc:7537
void set_stmt_errmsg(MYSQL_STMT *stmt, NET *net)
Set statement error code, sqlstate, and error message from NET.
Definition: libmysql.cc:1237
void end_server(MYSQL *mysql)
Definition: client.cc:1895
void set_mysql_extended_error(MYSQL *mysql, int errcode, const char *sqlstate, const char *format,...)
Set an error message on the client.
Definition: client.cc:393
bool libmysql_cleartext_plugin_enabled
Definition: client.cc:5552
bool fix_param_bind(MYSQL_BIND *param, uint idx)
Definition: bind_params.cc:465
bool mysql_reconnect(MYSQL *mysql)
Definition: client.cc:7206
int mysql_client_plugin_init()
Initializes the client plugin layer.
Definition: client_plugin.cc:336
#define MYSQL_EXTENSION_PTR(H)
Definition: sql_common.h:128
MYSQL_FIELD * cli_read_metadata(MYSQL *mysql, unsigned long field_count, unsigned int fields)
void mpvio_info(MYSQL_VIO vio, MYSQL_PLUGIN_VIO_INFO *info)
void net_clear_error(NET *net)
Clear possible error state of struct NET.
Definition: client.cc:376
const char * cant_connect_sqlstate
Definition: client.cc:224
unsigned long cli_safe_read(MYSQL *mysql, bool *is_data_packet)
Read a packet from server.
Definition: client.cc:1318
MYSQL_RES * use_result(MYSQL *mysql)
Definition: client.cc:8302
void read_ok_ex(MYSQL *mysql, unsigned long len)
enum net_async_status cli_safe_read_nonblocking(MYSQL *mysql, bool *is_data_packet, ulong *res)
Its a non blocking version of cli_safe_read.
Definition: client.cc:1163
bool cli_advanced_command(MYSQL *mysql, enum enum_server_command command, const unsigned char *header, size_t header_length, const unsigned char *arg, size_t arg_length, bool skip_check, MYSQL_STMT *stmt)
Definition: client.cc:1330
void free_rows(MYSQL_DATA *cur)
Definition: client.cc:1322
void mysql_client_plugin_deinit()
Deinitializes the client plugin layer.
Definition: client_plugin.cc:376
unsigned long cli_safe_read_with_ok(MYSQL *mysql, bool parse_ok, bool *is_data_packet)
Read a packet from server.
Definition: client.cc:1185
bool mysql_int_serialize_param_data(NET *net, unsigned int param_count, MYSQL_BIND *params, const char **names, unsigned long n_param_sets, uchar **ret_data, ulong *ret_length, uchar send_types_to_server, bool send_named_params, bool send_parameter_set_count, bool send_parameter_count_when_zero)
Serialize the query parameters.
Definition: bind_params.cc:362
int is_file_or_dir_world_writable(const char *filepath)
Check if a file/dir is world-writable (only on non-Windows platforms)
Definition: my_path_permissions.cc:43
MYSQL_FIELD * cli_read_metadata_ex(MYSQL *mysql, MEM_ROOT *alloc, unsigned long field_count, unsigned int fields)
MYSQL * connect_helper(mysql_async_connect *ctx)
Definition: client.cc:6205
MYSQL_FIELD * unpack_fields(MYSQL *mysql, MYSQL_ROWS *data, MEM_ROOT *alloc, uint fields, bool default_value, uint server_capabilities)
Definition: client.cc:2497
int run_plugin_auth(MYSQL *mysql, char *data, uint data_len, const char *data_plugin, const char *db)
Client side of the plugin driver authentication.
Definition: client.cc:5620
void set_mysql_error(MYSQL *mysql, int errcode, const char *sqlstate)
Set the internal error message to mysql handler.
Definition: client.cc:345
#define MAX_AUTHENTICATION_FACTOR
Definition: sql_common.h:160
CHARSET_INFO * default_client_charset_info
Definition: client.cc:234
void free_old_query(MYSQL *mysql)
Definition: client.cc:1620
uchar * send_client_connect_attrs(MYSQL *mysql, uchar *buf)
Definition: client.cc:4104
const char * not_error_sqlstate
Definition: client.cc:223
MYSQL_EXTENSION * mysql_extension_init(MYSQL *)
Definition: client.cc:3346
void set_stmt_error(MYSQL_STMT *stmt, int errcode, const char *sqlstate)
Set statement error code, sqlstate, and error message from given errcode and sqlstate.
Definition: libmysql.cc:1201
void mysql_close_free_options(MYSQL *mysql)
Definition: client.cc:7496
void mysql_extension_set_server_extn(MYSQL *mysql, NET_SERVER *extn)
Sets the MYSQL_EXTENSION::server_extn attribute by the use of NET_SERVER which contains information a...
Definition: sql_common.h:152
void mysql_extension_free(MYSQL_EXTENSION *)
Definition: client.cc:3378
struct st_mysql_client_plugin * mysql_client_builtins[]
Definition: client.cc:4072
void mysql_read_default_options(struct st_mysql_options *options, const char *filename, const char *group)
Definition: client.cc:2113
Definition: m_ctype.h:423
Definition: my_list.h:36
The MEM_ROOT is a simple arena, where allocations are carved out of larger blocks.
Definition: my_alloc.h:83
Definition: mysql_async.h:235
Definition: mysql.h:665
Definition: mysql.h:163
Definition: sql_common.h:101
char ** names
Definition: sql_common.h:114
uint n_params
Definition: sql_common.h:113
struct MYSQL_ASYNC * mysql_async_context
Definition: sql_common.h:105
NET_SERVER * server_extn
Definition: sql_common.h:108
struct MYSQL_EXTENSION::@9 bind_info
struct st_mysql_trace_info * trace_data
Definition: sql_common.h:102
STATE_INFO state_change
Definition: sql_common.h:103
void * mcs_extn
Definition: sql_common.h:110
MYSQL_BIND * bind
Definition: sql_common.h:115
Definition: mysql.h:121
Definition: sql_common.h:199
enum net_async_status(* advanced_command_nonblocking)(MYSQL *mysql, enum enum_server_command command, const unsigned char *header, unsigned long header_length, const unsigned char *arg, unsigned long arg_length, bool skip_check, MYSQL_STMT *stmt, bool *error)
Definition: sql_common.h:226
MYSQL_ROW(* fetch_row)(MYSQL_RES *)
Definition: sql_common.h:209
enum net_async_status(* read_change_user_result_nonblocking)(MYSQL *mysql, ulong *res)
Definition: sql_common.h:238
bool(* read_query_result)(MYSQL *mysql)
Definition: sql_common.h:201
void(* fetch_lengths)(unsigned long *to, MYSQL_ROW column, unsigned int field_count)
Definition: sql_common.h:210
bool(* advanced_command)(MYSQL *mysql, enum enum_server_command command, const unsigned char *header, size_t header_length, const unsigned char *arg, size_t arg_length, bool skip_check, MYSQL_STMT *stmt)
Definition: sql_common.h:202
enum net_async_status(* read_rows_nonblocking)(MYSQL *mysql, MYSQL_FIELD *mysql_fields, unsigned int fields, MYSQL_DATA **result)
Definition: sql_common.h:231
void(* flush_use_result)(MYSQL *mysql, bool flush_all_results)
Definition: sql_common.h:212
enum net_async_status(* read_query_result_nonblocking)(MYSQL *mysql)
Definition: sql_common.h:225
enum net_async_status(* next_result_nonblocking)(MYSQL *mysql)
Definition: sql_common.h:237
int(* read_change_user_result)(MYSQL *mysql)
Definition: sql_common.h:213
enum net_async_status(* flush_use_result_nonblocking)(MYSQL *mysql, bool flush_all_results)
Definition: sql_common.h:235
Definition: plugin_auth_common.h:121
Definition: mysql.h:340
Definition: mysql.h:153
Definition: mysql.h:692
Definition: mysql.h:300
Definition: client.cc:4100
Definition: mysql_com_server.h:59
Definition: mysql_com.h:914
The structure is used to hold the state change information received from the server.
Definition: sql_common.h:76
LIST * head_node
head_node->data is a LEX_STRING which contains the variable name.
Definition: sql_common.h:78
LIST * current_node
Definition: sql_common.h:79
Store the change info received from the server in an array of linked lists with STATE_INFO_NODE eleme...
Definition: sql_common.h:86
STATE_INFO_NODE info_list[SESSION_TRACK_END+1]
Array of STATE_NODE_INFO elements (one per state type).
Definition: sql_common.h:88
Definition: sql_common.h:165
char * plugin_name
Definition: sql_common.h:166
char * password
Definition: sql_common.h:167
Definition: client_async_authentication.h:164
Definition: client_plugin.h:114
Definition: sql_common.h:170
unsigned int ssl_fips_mode
Definition: sql_common.h:184
bool get_server_public_key
Definition: sql_common.h:179
char * default_auth
Definition: sql_common.h:172
char * compression_algorithm
Definition: sql_common.h:186
long ssl_ctx_flags
Definition: sql_common.h:181
char * ssl_crl
Definition: sql_common.h:173
char * tls_version
Definition: sql_common.h:180
void * ssl_session_data
Definition: sql_common.h:192
bool connection_compressed
Definition: sql_common.h:189
char * plugin_dir
Definition: sql_common.h:171
unsigned int retry_count
Definition: sql_common.h:183
bool enable_cleartext_plugin
Definition: sql_common.h:178
char * tls_ciphersuites
Definition: sql_common.h:185
struct client_authentication_info client_auth_info[MAX_AUTHENTICATION_FACTOR]
Definition: sql_common.h:191
unsigned int total_configured_compression_algorithms
Definition: sql_common.h:187
char * server_public_key_path
Definition: sql_common.h:176
size_t connection_attributes_length
Definition: sql_common.h:177
struct My_hash * connection_attributes
Definition: sql_common.h:175
unsigned int ssl_mode
Definition: sql_common.h:182
char * tls_sni_servername
the session serialization to use
Definition: sql_common.h:193
char * ssl_crlpath
Definition: sql_common.h:174
char * load_data_dir
Definition: sql_common.h:190
unsigned int zstd_compression_level
Definition: sql_common.h:188
Definition: mysql.h:226
command
Definition: version_token.cc:280