MySQL 8.4.3
Source Code Documentation
mysql_com.h
Go to the documentation of this file.
1/* Copyright (c) 2000, 2024, 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 designed to work 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 either included with
13 the program or referenced in the documentation.
14
15 Without limiting anything contained in the foregoing, this file,
16 which is part of C Driver for MySQL (Connector/C), is also subject to the
17 Universal FOSS Exception, version 1.0, a copy of which can be found at
18 http://oss.oracle.com/licenses/universal-foss-exception.
19
20 This program is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 GNU General Public License, version 2.0, for more details.
24
25 You should have received a copy of the GNU General Public License
26 along with this program; if not, write to the Free Software
27 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
28
29/**
30 @file include/mysql_com.h
31 Common definition between mysql server & client.
32*/
33
34#ifndef _mysql_com_h
35#define _mysql_com_h
36
37#ifndef MYSQL_ABI_CHECK
38#include <stdbool.h>
39#include <stdint.h>
40#endif
41
42#include "my_command.h"
43#include "my_compress.h"
44
45/*
46 We need a definition for my_socket. On the client, <mysql.h> already provides
47 it, but on the server side, we need to get it from a header.
48*/
49#ifndef my_socket_defined
50#include "my_io.h"
52#endif
53
54#ifndef MYSQL_ABI_CHECK
55#include <stdbool.h>
56#endif
57
58#define SYSTEM_CHARSET_MBMAXLEN 3
59#define FILENAME_CHARSET_MBMAXLEN 5
60#define NAME_CHAR_LEN 64 /**< Field/table name length */
61#define PARTITION_EXPR_CHAR_LEN \
62 2048 /**< Maximum expression length in chars \
63 */
64#define USERNAME_CHAR_LENGTH 32
65#define USERNAME_CHAR_LENGTH_STR "32"
66#ifndef NAME_LEN
67#define NAME_LEN (NAME_CHAR_LEN * SYSTEM_CHARSET_MBMAXLEN)
68#endif
69#define USERNAME_LENGTH (USERNAME_CHAR_LENGTH * SYSTEM_CHARSET_MBMAXLEN)
70#define CONNECT_STRING_MAXLEN 1024
71
72#define MYSQL_AUTODETECT_CHARSET_NAME "auto"
73
74#define SERVER_VERSION_LENGTH 60
75#define SQLSTATE_LENGTH 5
76
77/*
78 In FIDO terminology, relying party is the server where required services are
79 running. Relying party ID is unique name given to server.
80*/
81#define RELYING_PARTY_ID_LENGTH 255
82
83/* Length of random salt sent during fido registration */
84#define CHALLENGE_LENGTH 32
85
86/* Maximum authentication factors server supports */
87#define MAX_AUTH_FACTORS 3
88/**
89 Maximum length of comments
90
91 pre 5.6: 60 characters
92*/
93#define TABLE_COMMENT_INLINE_MAXLEN 180
94#define TABLE_COMMENT_MAXLEN 2048
95#define COLUMN_COMMENT_MAXLEN 1024
96#define INDEX_COMMENT_MAXLEN 1024
97#define TABLE_PARTITION_COMMENT_MAXLEN 1024
98#define TABLESPACE_COMMENT_MAXLEN 2048
99
100/**
101 Maximum length of protocol packet.
102 @ref page_protocol_basic_ok_packet length limit also restricted to this value
103 as any length greater than this value will have first byte of
104 @ref page_protocol_basic_ok_packet to be 254 thus does not
105 provide a means to identify if this is @ref page_protocol_basic_ok_packet or
106 @ref page_protocol_basic_eof_packet.
107*/
108#define MAX_PACKET_LENGTH (256L * 256L * 256L - 1)
109
110#define LOCAL_HOST "localhost"
111#define LOCAL_HOST_NAMEDPIPE "."
112
113#if defined(_WIN32)
114#define MYSQL_NAMEDPIPE "MySQL"
115#define MYSQL_SERVICENAME "MySQL"
116#endif /* _WIN32 */
117
118/** The length of the header part for each generated column in the .frm file.*/
119#define FRM_GCOL_HEADER_SIZE 4
120/**
121 Maximum length of the expression statement defined for generated columns.
122*/
123#define GENERATED_COLUMN_EXPRESSION_MAXLEN 65535 - FRM_GCOL_HEADER_SIZE
124/**
125 Length of random string sent by server on handshake; this is also length of
126 obfuscated password, received from client
127*/
128#define SCRAMBLE_LENGTH 20
129#define AUTH_PLUGIN_DATA_PART_1_LENGTH 8
130/** length of password stored in the db: new passwords are preceded with '*'*/
131#define SCRAMBLED_PASSWORD_CHAR_LENGTH (SCRAMBLE_LENGTH * 2 + 1)
132
133/**
134 @defgroup group_cs_column_definition_flags Column Definition Flags
135 @ingroup group_cs
136
137 @brief Values for the flags bitmask used by ::Send_field:flags
138
139 Currently need to fit into 32 bits.
140
141 Each bit represents an optional feature of the protocol.
142
143 Both the client and the server are sending these.
144
145 The intersection of the two determines what optional parts of the
146 protocol will be used.
147*/
148
149/**
150 @addtogroup group_cs_column_definition_flags
151 @{
152*/
153
154#define NOT_NULL_FLAG 1 /**< Field can't be NULL */
155#define PRI_KEY_FLAG 2 /**< Field is part of a primary key */
156#define UNIQUE_KEY_FLAG 4 /**< Field is part of a unique key */
157#define MULTIPLE_KEY_FLAG 8 /**< Field is part of a key */
158#define BLOB_FLAG 16 /**< Field is a blob */
159#define UNSIGNED_FLAG 32 /**< Field is unsigned */
160#define ZEROFILL_FLAG 64 /**< Field is zerofill */
161#define BINARY_FLAG 128 /**< Field is binary */
162
163/* The following are only sent to new clients */
164#define ENUM_FLAG 256 /**< field is an enum */
165#define AUTO_INCREMENT_FLAG 512 /**< field is a autoincrement field */
166#define TIMESTAMP_FLAG 1024 /**< Field is a timestamp */
167#define SET_FLAG 2048 /**< field is a set */
168#define NO_DEFAULT_VALUE_FLAG 4096 /**< Field doesn't have default value */
169#define ON_UPDATE_NOW_FLAG 8192 /**< Field is set to NOW on UPDATE */
170#define NUM_FLAG 32768 /**< Field is num (for clients) */
171#define PART_KEY_FLAG 16384 /**< Intern; Part of some key */
172#define GROUP_FLAG 32768 /**< Intern: Group field */
173#define UNIQUE_FLAG 65536 /**< Intern: Used by sql_yacc */
174#define BINCMP_FLAG 131072 /**< Intern: Used by sql_yacc */
175#define GET_FIXED_FIELDS_FLAG \
176 (1 << 18) /**< Used to get fields in item tree \
177 */
178#define FIELD_IN_PART_FUNC_FLAG (1 << 19) /**< Field part of partition func */
179/**
180 Intern: Field in TABLE object for new version of altered table,
181 which participates in a newly added index.
182*/
183#define FIELD_IN_ADD_INDEX (1 << 20)
184#define FIELD_IS_RENAMED (1 << 21) /**< Intern: Field is being renamed */
185#define FIELD_FLAGS_STORAGE_MEDIA 22 /**< Field storage media, bit 22-23 */
186#define FIELD_FLAGS_STORAGE_MEDIA_MASK (3 << FIELD_FLAGS_STORAGE_MEDIA)
187#define FIELD_FLAGS_COLUMN_FORMAT 24 /**< Field column format, bit 24-25 */
188#define FIELD_FLAGS_COLUMN_FORMAT_MASK (3 << FIELD_FLAGS_COLUMN_FORMAT)
189#define FIELD_IS_DROPPED (1 << 26) /**< Intern: Field is being dropped */
190#define EXPLICIT_NULL_FLAG \
191 (1 << 27) /**< Field is explicitly specified as \
192 NULL by the user */
193/* 1 << 28 is unused. */
194
195/** Field will not be loaded in secondary engine. */
196#define NOT_SECONDARY_FLAG (1 << 29)
197/** Field is explicitly marked as invisible by the user. */
198#define FIELD_IS_INVISIBLE (1 << 30)
199
200/** @}*/
201
202/**
203 @defgroup group_cs_com_refresh_flags COM_REFRESH Flags
204 @ingroup group_cs
205
206 @brief Values for the `sub_command` in ::COM_REFRESH
207
208 Currently the protocol carries only 8 bits of these flags.
209
210 The rest (8-end) are used only internally in the server.
211*/
212
213/**
214 @addtogroup group_cs_com_refresh_flags
215 @{
216*/
217
218#define REFRESH_GRANT 1 /**< Refresh grant tables, FLUSH PRIVILEGES */
219#define REFRESH_LOG 2 /**< Start on new log file, FLUSH LOGS */
220#define REFRESH_TABLES 4 /**< close all tables, FLUSH TABLES */
221#define UNUSED_8 \
222 8 /**< Previously REFRESH_HOSTS but not used anymore. Use TRUNCATE TABLE \
223 performance_schema.host_cache instead */
224#define REFRESH_STATUS 16 /**< Flush status variables, FLUSH STATUS */
225#define UNUSED_32 32 /**< Removed. Used to be flush thread cache */
226#define REFRESH_REPLICA \
227 64 /**< Reset source info and restart replica \
228 thread, RESET REPLICA */
229
230#define REFRESH_SOURCE \
231 128 /**< Remove all bin logs in the index \
232 and truncate the index. Also resets \
233 GTID information. Command: \
234 RESET BINARY LOGS AND GTIDS */
235
236#define REFRESH_ERROR_LOG 256 /**< Rotate only the error log */
237#define REFRESH_ENGINE_LOG 512 /**< Flush all storage engine logs */
238#define REFRESH_BINARY_LOG 1024 /**< Flush the binary log */
239#define REFRESH_RELAY_LOG 2048 /**< Flush the relay log */
240#define REFRESH_GENERAL_LOG 4096 /**< Flush the general log */
241#define REFRESH_SLOW_LOG 8192 /**< Flush the slow query log */
242#define REFRESH_READ_LOCK 16384 /**< Lock tables for read. */
243/**
244 Wait for an impending flush before closing the tables.
245
246 @sa REFRESH_READ_LOCK, handle_reload_request, close_cached_tables
247*/
248#define REFRESH_FAST 32768
249#define REFRESH_USER_RESOURCES \
250 0x80000L /** FLUSH RESOURCES. @sa ::reset_mqh \
251 */
252#define REFRESH_FOR_EXPORT 0x100000L /** FLUSH TABLES ... FOR EXPORT */
253#define REFRESH_OPTIMIZER_COSTS 0x200000L /** FLUSH OPTIMIZER_COSTS */
254#define REFRESH_PERSIST 0x400000L /** RESET PERSIST */
255
256/** @}*/
257
258/**
259 @defgroup group_cs_capabilities_flags Capabilities Flags
260 @ingroup group_cs
261
262 @brief Values for the capabilities flag bitmask used by the MySQL protocol
263
264 Currently need to fit into 32 bits.
265
266 Each bit represents an optional feature of the protocol.
267
268 Both the client and the server are sending these.
269
270 The intersection of the two determines whast optional parts of the
271 protocol will be used.
272*/
273
274/**
275 @addtogroup group_cs_capabilities_flags
276 @{
277*/
278
279/**
280 Use the improved version of Old Password Authentication.
281
282 Not used.
283
284 @note Assumed to be set since 4.1.1.
286#define CLIENT_LONG_PASSWORD 1
287/**
288 Send found rows instead of affected rows in @ref
289 page_protocol_basic_eof_packet
291#define CLIENT_FOUND_ROWS 2
292/**
293 @brief Get all column flags
294
295 Longer flags in Protocol::ColumnDefinition320.
296
297 @todo Reference Protocol::ColumnDefinition320
298
299 Server
300 ------
301
302 Supports longer flags.
303
304 Client
305 ------
306
307 Expects longer flags.
309#define CLIENT_LONG_FLAG 4
310/**
311 Database (schema) name can be specified on connect in Handshake Response
312 Packet.
313
314 @todo Reference Handshake Response Packet.
315
316 Server
317 ------
318
319 Supports schema-name in Handshake Response Packet.
320
321 Client
322 ------
323
324 Handshake Response Packet contains a schema-name.
325
326 @sa send_client_reply_packet()
328#define CLIENT_CONNECT_WITH_DB 8
329#define CLIENT_NO_SCHEMA \
330 16 /**< DEPRECATED: Don't allow database.table.column */
331/**
332 Compression protocol supported.
333
334 @todo Reference Compression
335
336 Server
337 ------
338
339 Supports compression.
340
341 Client
342 ------
343
344 Switches to Compression compressed protocol after successful authentication.
346#define CLIENT_COMPRESS 32
347/**
348 Special handling of ODBC behavior.
349
350 @note No special behavior since 3.22.
352#define CLIENT_ODBC 64
353/**
354 Can use LOAD DATA LOCAL.
355
356 Server
357 ------
358
359 Enables the LOCAL INFILE request of LOAD DATA|XML.
360
361 Client
362 ------
363
364 Will handle LOCAL INFILE request.
366#define CLIENT_LOCAL_FILES 128
367/**
368 Ignore spaces before '('
369
370 Server
371 ------
372
373 Parser can ignore spaces before '('.
374
375 Client
376 ------
377
378 Let the parser ignore spaces before '('.
380#define CLIENT_IGNORE_SPACE 256
381/**
382 New 4.1 protocol
383
384 @todo Reference the new 4.1 protocol
385
386 Server
387 ------
388
389 Supports the 4.1 protocol.
390
391 Client
392 ------
393
394 Uses the 4.1 protocol.
395
396 @note this value was CLIENT_CHANGE_USER in 3.22, unused in 4.0
398#define CLIENT_PROTOCOL_41 512
399/**
400 This is an interactive client
401
402 Use @ref System_variables::net_wait_timeout
403 versus @ref System_variables::net_interactive_timeout.
404
405 Server
406 ------
407
408 Supports interactive and noninteractive clients.
409
410 Client
411 ------
412
413 Client is interactive.
414
415 @sa mysql_real_connect()
417#define CLIENT_INTERACTIVE 1024
418/**
419 Use SSL encryption for the session
420
421 @todo Reference SSL
422
423 Server
424 ------
425
426 Supports SSL
427
428 Client
429 ------
430
431 Switch to SSL after sending the capability-flags.
433#define CLIENT_SSL 2048
434/**
435 Client only flag. Not used.
436
437 Client
438 ------
439
440 Do not issue SIGPIPE if network failures occur (libmysqlclient only).
441
442 @sa mysql_real_connect()
444#define CLIENT_IGNORE_SIGPIPE 4096
445/**
446 Client knows about transactions
447
448 Server
449 ------
450
451 Can send status flags in @ref page_protocol_basic_ok_packet /
452 @ref page_protocol_basic_eof_packet.
453
454 Client
455 ------
456
457 Expects status flags in @ref page_protocol_basic_ok_packet /
458 @ref page_protocol_basic_eof_packet.
459
460 @note This flag is optional in 3.23, but always set by the server since 4.0.
461 @sa send_server_handshake_packet(), parse_client_handshake_packet(),
462 net_send_ok(), net_send_eof()
464#define CLIENT_TRANSACTIONS 8192
465#define CLIENT_RESERVED 16384 /**< DEPRECATED: Old flag for 4.1 protocol */
466#define CLIENT_RESERVED2 \
467 32768 /**< DEPRECATED: Old flag for 4.1 authentication \
468 CLIENT_SECURE_CONNECTION */
469/**
470 Enable/disable multi-stmt support
471
472 Also sets @ref CLIENT_MULTI_RESULTS. Currently not checked anywhere.
473
474 Server
475 ------
476
477 Can handle multiple statements per COM_QUERY and COM_STMT_PREPARE.
478
479 Client
480 -------
481
482 May send multiple statements per COM_QUERY and COM_STMT_PREPARE.
483
484 @note Was named ::CLIENT_MULTI_QUERIES in 4.1.0, renamed later.
485
486 Requires
487 --------
488
489 ::CLIENT_PROTOCOL_41
490
491 @todo Reference COM_QUERY and COM_STMT_PREPARE
493#define CLIENT_MULTI_STATEMENTS (1UL << 16)
494/**
495 Enable/disable multi-results
496
497 Server
498 ------
499
500 Can send multiple resultsets for COM_QUERY.
501 Error if the server needs to send them and client
502 does not support them.
503
504 Client
505 -------
506
507 Can handle multiple resultsets for COM_QUERY.
508
509 Requires
510 --------
511
512 ::CLIENT_PROTOCOL_41
513
514 @sa mysql_execute_command(), sp_head::MULTI_RESULTS
516#define CLIENT_MULTI_RESULTS (1UL << 17)
517/**
518 Multi-results and OUT parameters in PS-protocol.
519
520 Server
521 ------
522
523 Can send multiple resultsets for COM_STMT_EXECUTE.
524
525 Client
526 ------
527
528 Can handle multiple resultsets for COM_STMT_EXECUTE.
529
530 Requires
531 --------
532
533 ::CLIENT_PROTOCOL_41
534
535 @todo Reference COM_STMT_EXECUTE and PS-protocol
536
537 @sa Protocol_binary::send_out_parameters
539#define CLIENT_PS_MULTI_RESULTS (1UL << 18)
540
541/**
542 Client supports plugin authentication
543
544 Server
545 ------
546
547 Sends extra data in Initial Handshake Packet and supports the pluggable
548 authentication protocol.
549
550 Client
551 ------
552
553 Supports authentication plugins.
554
555 Requires
556 --------
557
558 ::CLIENT_PROTOCOL_41
559
560 @todo Reference plugin authentication, Initial Handshake Packet,
561 Authentication plugins
562
563 @sa send_change_user_packet(), send_client_reply_packet(), run_plugin_auth(),
564 parse_com_change_user_packet(), parse_client_handshake_packet()
566#define CLIENT_PLUGIN_AUTH (1UL << 19)
567/**
568 Client supports connection attributes
569
570 Server
571 ------
572
573 Permits connection attributes in Protocol::HandshakeResponse41.
574
575 Client
576 ------
577
578 Sends connection attributes in Protocol::HandshakeResponse41.
579
580 @todo Reference Protocol::HandshakeResponse41
581
582 @sa send_client_connect_attrs(), read_client_connect_attrs()
584#define CLIENT_CONNECT_ATTRS (1UL << 20)
585
586/**
587 Enable authentication response packet to be larger than 255 bytes.
588
589 When the ability to change default plugin require that the initial password
590 field in the Protocol::HandshakeResponse41 paclet can be of arbitrary size.
591 However, the 4.1 client-server protocol limits the length of the
592 auth-data-field sent from client to server to 255 bytes.
593 The solution is to change the type of the field to a true length encoded
594 string and indicate the protocol change
595 with this client capability flag.
596
597 Server
598 ------
599
600 Understands length-encoded integer for auth response data in
601 Protocol::HandshakeResponse41.
602
603 Client
604 ------
605
606 Length of auth response data in Protocol::HandshakeResponse41
607 is a length-encoded integer.
608
609 @todo Reference Protocol::HandshakeResponse41
610
611 @note The flag was introduced in 5.6.6, but had the wrong value.
612
613 @sa send_client_reply_packet(), parse_client_handshake_packet(),
614 get_56_lenc_string(), get_41_lenc_string()
616#define CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA (1UL << 21)
617
618/**
619 Don't close the connection for a user account with expired password.
620
621 Server
622 ------
623
624 Announces support for expired password extension.
625
626 Client
627 ------
628
629 Can handle expired passwords.
630
631 @todo Reference expired password
632
633 @sa MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS, disconnect_on_expired_password
634 ACL_USER::password_expired, check_password_lifetime(), acl_authenticate()
636#define CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS (1UL << 22)
637
638/**
639 Capable of handling server state change information. Its a hint to the
640 server to include the state change information in
641 @ref page_protocol_basic_ok_packet.
642
643 Server
644 ------
645 Can set ::SERVER_SESSION_STATE_CHANGED in the ::SERVER_STATUS_flags_enum
646 and send @ref sect_protocol_basic_ok_packet_sessinfo in a
647 @ref page_protocol_basic_ok_packet.
648
649 Client
650 ------
651
652 Expects the server to send @ref sect_protocol_basic_ok_packet_sessinfo in
653 a @ref page_protocol_basic_ok_packet.
654
655 @sa enum_session_state_type, read_ok_ex(), net_send_ok(), Session_tracker,
656 State_tracker
658#define CLIENT_SESSION_TRACK (1UL << 23)
659/**
660 Client no longer needs @ref page_protocol_basic_eof_packet and will
661 use @ref page_protocol_basic_ok_packet instead.
662 @sa net_send_ok()
663
664 Server
665 ------
666
667 Can send OK after a Text Resultset.
668
669 Client
670 ------
671
672 Expects an @ref page_protocol_basic_ok_packet (instead of
673 @ref page_protocol_basic_eof_packet) after the resultset rows of a
674 Text Resultset.
675
676 Background
677 ----------
678
679 To support ::CLIENT_SESSION_TRACK, additional information must be sent after
680 all successful commands. Although the @ref page_protocol_basic_ok_packet is
681 extensible, the @ref page_protocol_basic_eof_packet is not due to the overlap
682 of its bytes with the content of the Text Resultset Row.
683
684 Therefore, the @ref page_protocol_basic_eof_packet in the
685 Text Resultset is replaced with an @ref page_protocol_basic_ok_packet.
686 @ref page_protocol_basic_eof_packet is deprecated as of MySQL 5.7.5.
687
688 @todo Reference Text Resultset
689
690 @sa cli_safe_read_with_ok(), read_ok_ex(), net_send_ok(), net_send_eof()
692#define CLIENT_DEPRECATE_EOF (1UL << 24)
693
694/**
695 The client can handle optional metadata information in the resultset.
697#define CLIENT_OPTIONAL_RESULTSET_METADATA (1UL << 25)
698
699/**
700 Compression protocol extended to support zstd compression method
701
702 This capability flag is used to send zstd compression level between
703 client and server provided both client and server are enabled with
704 this flag.
705
706 Server
707 ------
708 Server sets this flag when global variable protocol-compression-algorithms
709 has zstd in its list of supported values.
710
711 Client
712 ------
713 Client sets this flag when it is configured to use zstd compression method.
714
716#define CLIENT_ZSTD_COMPRESSION_ALGORITHM (1UL << 26)
717
718/**
719 Support optional extension for query parameters into the @ref
720 page_protocol_com_query and @ref page_protocol_com_stmt_execute packets.
721
722 Server
723 ------
724
725 Expects an optional part containing the query parameter set(s). Executes the
726 query for each set of parameters or returns an error if more than 1 set of
727 parameters is sent and the server can't execute it.
728
729 Client
730 ------
731
732 Can send the optional part containing the query parameter set(s).
734#define CLIENT_QUERY_ATTRIBUTES (1UL << 27)
735
736/**
737 Support Multi factor authentication.
738
739 Server
740 ------
741 Server sends AuthNextFactor packet after every nth factor authentication
742 method succeeds, except the last factor authentication.
743
744 Client
745 ------
746 Client reads AuthNextFactor packet sent by server and initiates next factor
747 authentication method.
749#define MULTI_FACTOR_AUTHENTICATION (1UL << 28)
750
751/**
752 This flag will be reserved to extend the 32bit capabilities structure to
753 64bits.
755#define CLIENT_CAPABILITY_EXTENSION (1UL << 29)
756
757/**
758 Verify server certificate.
759
760 Client only flag.
761
762 @deprecated in favor of --ssl-mode.
764#define CLIENT_SSL_VERIFY_SERVER_CERT (1UL << 30)
765
766/**
767 Don't reset the options after an unsuccessful connect
768
769 Client only flag.
770
771 Typically passed via ::mysql_real_connect() 's client_flag parameter.
772
773 @sa mysql_real_connect()
775#define CLIENT_REMEMBER_OPTIONS (1UL << 31)
776/** @}*/
777
778/** a compatibility alias for CLIENT_COMPRESS */
779#define CAN_CLIENT_COMPRESS CLIENT_COMPRESS
780
781/** Gather all possible capabilities (flags) supported by the server */
782#define CLIENT_ALL_FLAGS \
783 (CLIENT_LONG_PASSWORD | CLIENT_FOUND_ROWS | CLIENT_LONG_FLAG | \
784 CLIENT_CONNECT_WITH_DB | CLIENT_NO_SCHEMA | CLIENT_COMPRESS | CLIENT_ODBC | \
785 CLIENT_LOCAL_FILES | CLIENT_IGNORE_SPACE | CLIENT_PROTOCOL_41 | \
786 CLIENT_INTERACTIVE | CLIENT_SSL | CLIENT_IGNORE_SIGPIPE | \
787 CLIENT_TRANSACTIONS | CLIENT_RESERVED | CLIENT_RESERVED2 | \
788 CLIENT_MULTI_STATEMENTS | CLIENT_MULTI_RESULTS | CLIENT_PS_MULTI_RESULTS | \
789 CLIENT_SSL_VERIFY_SERVER_CERT | CLIENT_REMEMBER_OPTIONS | \
790 CLIENT_PLUGIN_AUTH | CLIENT_CONNECT_ATTRS | \
791 CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA | \
792 CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS | CLIENT_SESSION_TRACK | \
793 CLIENT_DEPRECATE_EOF | CLIENT_OPTIONAL_RESULTSET_METADATA | \
794 CLIENT_ZSTD_COMPRESSION_ALGORITHM | CLIENT_QUERY_ATTRIBUTES | \
795 MULTI_FACTOR_AUTHENTICATION)
796
797/**
798 Switch off from ::CLIENT_ALL_FLAGS the flags that are optional and
799 depending on build flags.
800 If any of the optional flags is supported by the build it will be switched
801 on before sending to the client during the connection handshake.
803#define CLIENT_BASIC_FLAGS \
804 (CLIENT_ALL_FLAGS & \
805 ~(CLIENT_SSL | CLIENT_COMPRESS | CLIENT_SSL_VERIFY_SERVER_CERT | \
806 CLIENT_ZSTD_COMPRESSION_ALGORITHM))
807
808/** The status flags are a bit-field */
810 /**
811 Is raised when a multi-statement transaction
812 has been started, either explicitly, by means
813 of BEGIN or COMMIT AND CHAIN, or
814 implicitly, by the first transactional
815 statement, when autocommit=off.
816 */
818 SERVER_STATUS_AUTOCOMMIT = 2, /**< Server in auto_commit mode */
819 SERVER_MORE_RESULTS_EXISTS = 8, /**< Multi query - next query exists */
822 /**
823 The server was able to fulfill the clients request and opened a
824 read-only non-scrollable cursor for a query. This flag comes
825 in reply to COM_STMT_EXECUTE and COM_STMT_FETCH commands.
826 Used by Binary Protocol Resultset to signal that COM_STMT_FETCH
827 must be used to fetch the row-data.
828 @todo Refify "Binary Protocol Resultset" and "COM_STMT_FETCH".
829 */
831 /**
832 This flag is sent when a read-only cursor is exhausted, in reply to
833 COM_STMT_FETCH command.
834 */
836 SERVER_STATUS_DB_DROPPED = 256, /**< A database was dropped */
838 /**
839 Sent to the client if after a prepared statement reprepare
840 we discovered that the new statement returns a different
841 number of result set columns.
842 */
845 /**
846 To mark ResultSet containing output parameter values.
847 */
849
850 /**
851 Set at the same time as SERVER_STATUS_IN_TRANS if the started
852 multi-statement transaction is a read-only transaction. Cleared
853 when the transaction commits or aborts. Since this flag is sent
854 to clients in OK and EOF packets, the flag indicates the
855 transaction status at the end of command execution.
856 */
858
859 /**
860 This status flag, when on, implies that one of the state information has
861 changed on the server because of the execution of the last statement.
862 */
864};
865
866/**
867 Server status flags that must be cleared when starting
868 execution of a new SQL statement.
869 Flags from this set are only added to the
870 current server status by the execution engine, but
871 never removed -- the execution engine expects them
872 to disappear automagically by the next command.
874#define SERVER_STATUS_CLEAR_SET \
875 (SERVER_QUERY_NO_GOOD_INDEX_USED | SERVER_QUERY_NO_INDEX_USED | \
876 SERVER_MORE_RESULTS_EXISTS | SERVER_STATUS_METADATA_CHANGED | \
877 SERVER_QUERY_WAS_SLOW | SERVER_STATUS_DB_DROPPED | \
878 SERVER_STATUS_CURSOR_EXISTS | SERVER_STATUS_LAST_ROW_SENT | \
879 SERVER_SESSION_STATE_CHANGED)
880
881/** Max length of a error message. Should be kept in sync with ::ERRMSGSIZE. */
882#define MYSQL_ERRMSG_SIZE 512
883#define NET_READ_TIMEOUT 30 /**< Timeout on read */
884#define NET_WRITE_TIMEOUT 60 /**< Timeout on write */
885#define NET_WAIT_TIMEOUT 8 * 60 * 60 /**< Wait for new query */
886
887/**
888 Flag used by the parser. Kill only the query and not the connection.
889
890 @sa SQLCOM_KILL, sql_kill(), LEX::type
892#define ONLY_KILL_QUERY 1
893
894#ifndef MYSQL_VIO
895struct Vio;
896#define MYSQL_VIO struct Vio *
897#endif
899#define MAX_TINYINT_WIDTH 3 /**< Max width for a TINY w.o. sign */
900#define MAX_SMALLINT_WIDTH 5 /**< Max width for a SHORT w.o. sign */
901#define MAX_MEDIUMINT_WIDTH 8 /**< Max width for a INT24 w.o. sign */
902#define MAX_INT_WIDTH 10 /**< Max width for a LONG w.o. sign */
903#define MAX_BIGINT_WIDTH 20 /**< Max width for a LONGLONG */
904/// Max width for a CHAR column, in number of characters
905#define MAX_CHAR_WIDTH 255
906/// Default width for blob in bytes @todo - align this with sizes from field.h
907#define MAX_BLOB_WIDTH 16777216
909#define NET_ERROR_UNSET 0 /**< No error has occurred yet */
910#define NET_ERROR_SOCKET_RECOVERABLE 1 /**< Socket still usable */
911#define NET_ERROR_SOCKET_UNUSABLE 2 /**< Do not use the socket */
912#define NET_ERROR_SOCKET_NOT_READABLE 3 /**< Try write and close socket */
913#define NET_ERROR_SOCKET_NOT_WRITABLE 4 /**< Try read and close socket */
915typedef struct NET {
917 unsigned char *buff, *buff_end, *write_pos, *read_pos;
918 my_socket fd; /* For Perl DBI/dbd */
919 /**
920 Set if we are doing several queries in one
921 command ( as in LOAD TABLE ... FROM MASTER ),
922 and do not want to confuse the client with OK at the wrong time
923 */
926 unsigned int pkt_nr, compress_pkt_nr;
928 int fcntl;
929 unsigned int *return_status;
930 unsigned char reading_or_writing;
931 unsigned char save_char;
933 unsigned int last_errno;
934 unsigned char error;
935 /** Client library error message buffer. Actually belongs to struct MYSQL. */
937 /** Client library sqlstate buffer. Set along with the error message. */
938 char sqlstate[SQLSTATE_LENGTH + 1];
939 /**
940 Extension pointer, for the caller private use.
941 Any program linking with the networking library can use this pointer,
942 which is handy when private connection specific data needs to be
943 maintained.
944 The mysqld server process uses this pointer internally,
945 to maintain the server internal instrumentation for the connection.
946 */
948} NET;
950#define packet_error (~(unsigned long)0)
951
952/**
953 @addtogroup group_cs_backward_compatibility Backward compatibility
954 @ingroup group_cs
955 @{
957#define CLIENT_MULTI_QUERIES CLIENT_MULTI_STATEMENTS
958#define FIELD_TYPE_DECIMAL MYSQL_TYPE_DECIMAL
959#define FIELD_TYPE_NEWDECIMAL MYSQL_TYPE_NEWDECIMAL
960#define FIELD_TYPE_TINY MYSQL_TYPE_TINY
961#define FIELD_TYPE_SHORT MYSQL_TYPE_SHORT
962#define FIELD_TYPE_LONG MYSQL_TYPE_LONG
963#define FIELD_TYPE_FLOAT MYSQL_TYPE_FLOAT
964#define FIELD_TYPE_DOUBLE MYSQL_TYPE_DOUBLE
965#define FIELD_TYPE_NULL MYSQL_TYPE_NULL
966#define FIELD_TYPE_TIMESTAMP MYSQL_TYPE_TIMESTAMP
967#define FIELD_TYPE_LONGLONG MYSQL_TYPE_LONGLONG
968#define FIELD_TYPE_INT24 MYSQL_TYPE_INT24
969#define FIELD_TYPE_DATE MYSQL_TYPE_DATE
970#define FIELD_TYPE_TIME MYSQL_TYPE_TIME
971#define FIELD_TYPE_DATETIME MYSQL_TYPE_DATETIME
972#define FIELD_TYPE_YEAR MYSQL_TYPE_YEAR
973#define FIELD_TYPE_NEWDATE MYSQL_TYPE_NEWDATE
974#define FIELD_TYPE_ENUM MYSQL_TYPE_ENUM
975#define FIELD_TYPE_SET MYSQL_TYPE_SET
976#define FIELD_TYPE_TINY_BLOB MYSQL_TYPE_TINY_BLOB
977#define FIELD_TYPE_MEDIUM_BLOB MYSQL_TYPE_MEDIUM_BLOB
978#define FIELD_TYPE_LONG_BLOB MYSQL_TYPE_LONG_BLOB
979#define FIELD_TYPE_BLOB MYSQL_TYPE_BLOB
980#define FIELD_TYPE_VAR_STRING MYSQL_TYPE_VAR_STRING
981#define FIELD_TYPE_STRING MYSQL_TYPE_STRING
982#define FIELD_TYPE_CHAR MYSQL_TYPE_TINY
983#define FIELD_TYPE_INTERVAL MYSQL_TYPE_ENUM
984#define FIELD_TYPE_GEOMETRY MYSQL_TYPE_GEOMETRY
985#define FIELD_TYPE_BIT MYSQL_TYPE_BIT
986/** @}*/
987
988/**
989 @addtogroup group_cs_shutdown_kill_constants Shutdown/kill enums and constants
990 @ingroup group_cs
991
992 @sa THD::is_killable
993 @{
995#define MYSQL_SHUTDOWN_KILLABLE_CONNECT (unsigned char)(1 << 0)
996#define MYSQL_SHUTDOWN_KILLABLE_TRANS (unsigned char)(1 << 1)
997#define MYSQL_SHUTDOWN_KILLABLE_LOCK_TABLE (unsigned char)(1 << 2)
998#define MYSQL_SHUTDOWN_KILLABLE_UPDATE (unsigned char)(1 << 3)
999
1000/**
1001 We want levels to be in growing order of hardness (because we use number
1002 comparisons).
1003
1004 @note ::SHUTDOWN_DEFAULT does not respect the growing property, but it's ok.
1007 SHUTDOWN_DEFAULT = 0,
1008 /** Wait for existing connections to finish */
1010 /** Wait for existing transactons to finish */
1012 /** Wait for existing updates to finish (=> no partial MyISAM update) */
1014 /** Flush InnoDB buffers and other storage engines' buffers*/
1016 /** Don't flush InnoDB buffers, flush other storage engines' buffers*/
1018 /** Query level of the KILL command */
1019 KILL_QUERY = 254,
1020 /** Connection level of the KILL command */
1022};
1023/** @}*/
1026 /** No metadata will be sent. */
1028 /** The server will send all metadata. */
1030};
1031
1032#if defined(__clang__)
1033// disable -Wdocumentation to workaround
1034// https://bugs.llvm.org/show_bug.cgi?id=38905
1035#pragma clang diagnostic push
1036#pragma clang diagnostic ignored "-Wdocumentation"
1037#endif
1038/**
1039 The flags used in COM_STMT_EXECUTE.
1040 @sa @ref Protocol_classic::parse_packet, @ref mysql_int_serialize_param_data
1041*/
1042#if defined(__clang__)
1043#pragma clang diagnostic pop
1044#endif
1050 /**
1051 On when the client will send the parameter count
1052 even for 0 parameters.
1053 */
1055};
1056
1057/** options for ::mysql_options() */
1061};
1062
1063/**
1064 Type of state change information that the server can include in the Ok
1065 packet.
1066
1067 @note
1068 - session_state_type shouldn't go past 255 (i.e. 1-byte boundary).
1069 - Modify the definition of ::SESSION_TRACK_END when a new member is added.
1072 SESSION_TRACK_SYSTEM_VARIABLES, /**< Session system variables */
1073 SESSION_TRACK_SCHEMA, /**< Current schema */
1074 SESSION_TRACK_STATE_CHANGE, /**< track session state changes */
1075 SESSION_TRACK_GTIDS, /**< See also: session_track_gtids */
1076 SESSION_TRACK_TRANSACTION_CHARACTERISTICS, /**< Transaction chistics */
1077 SESSION_TRACK_TRANSACTION_STATE /**< Transaction state */
1078};
1079
1080/** start of ::enum_session_state_type */
1081#define SESSION_TRACK_BEGIN SESSION_TRACK_SYSTEM_VARIABLES
1082
1083/** End of ::enum_session_state_type */
1084#define SESSION_TRACK_END SESSION_TRACK_TRANSACTION_STATE
1085
1086/** is T a valid session state type */
1087#define IS_SESSION_STATE_TYPE(T) \
1088 (((int)(T) >= SESSION_TRACK_BEGIN) && ((T) <= SESSION_TRACK_END))
1090#define net_new_transaction(net) ((net)->pkt_nr = 0)
1092bool my_net_init(struct NET *net, MYSQL_VIO vio);
1093void my_net_local_init(struct NET *net);
1094void net_end(struct NET *net);
1095void net_clear(struct NET *net, bool check_buffer);
1096void net_claim_memory_ownership(struct NET *net, bool claim);
1097bool net_realloc(struct NET *net, size_t length);
1098bool net_flush(struct NET *net);
1099bool my_net_write(struct NET *net, const unsigned char *packet, size_t len);
1100bool net_write_command(struct NET *net, unsigned char command,
1101 const unsigned char *header, size_t head_len,
1102 const unsigned char *packet, size_t len);
1103bool net_write_packet(struct NET *net, const unsigned char *packet,
1104 size_t length);
1105unsigned long my_net_read(struct NET *net);
1106void my_net_set_write_timeout(struct NET *net, unsigned int timeout);
1107void my_net_set_read_timeout(struct NET *net, unsigned int timeout);
1108void my_net_set_retry_count(struct NET *net, unsigned int retry_count);
1111 unsigned long seed1, seed2, max_value;
1112 double max_value_dbl;
1113};
1114
1115/* Include the types here so existing UDFs can keep compiling */
1117
1118/**
1119 @addtogroup group_cs_compresson_constants Constants when using compression
1120 @ingroup group_cs
1121 @{
1123#define NET_HEADER_SIZE 4 /**< standard header size */
1124#define COMP_HEADER_SIZE 3 /**< compression header extra size */
1125/** @}*/
1126
1127/* Prototypes to password functions */
1128
1129/* used in both client and server */
1130char *octet2hex(char *to, const char *str, unsigned int len);
1131
1132/* end of password.c */
1133
1134bool generate_sha256_scramble(unsigned char *dst, size_t dst_size,
1135 const char *src, size_t src_size, const char *rnd,
1136 size_t rnd_size);
1137
1138// extern "C" since it is an (undocumented) part of the libmysql ABI.
1139#ifdef __cplusplus
1140extern "C" {
1141#endif
1142char *get_tty_password(const char *opt_message);
1143#ifdef __cplusplus
1144}
1145#endif
1147const char *mysql_errno_to_sqlstate(unsigned int mysql_errno);
1148
1149/* Some other useful functions */
1150
1151bool my_thread_init(void);
1152void my_thread_end(void);
1153
1154#ifdef STDCALL
1155unsigned long STDCALL net_field_length(unsigned char **packet);
1156unsigned long STDCALL net_field_length_checked(unsigned char **packet,
1157 unsigned long max_length);
1158#endif
1159uint64_t net_field_length_ll(unsigned char **packet);
1160unsigned char *net_store_length(unsigned char *pkg, unsigned long long length);
1161unsigned int net_length_size(unsigned long long num);
1162unsigned int net_field_length_size(const unsigned char *pos);
1163uint64_t net_length_size_including_self(uint64_t length_without_self);
1165#define NULL_LENGTH ((unsigned long)~0) /**< For ::net_store_length() */
1166#define MYSQL_STMT_HEADER 4
1167#define MYSQL_LONG_DATA_HEADER 6
1168
1169/* clang-format off */
1170/**
1171 Describes the current state of Asynchronous connection phase state machine
1172
1173 @startuml
1174 [*] --> CONNECT_STAGE_INVALID
1175 [*] --> CONNECT_STAGE_NOT_STARTED
1176
1177 CONNECT_STAGE_NOT_STARTED --> CONNECT_STAGE_NET_BEGIN_CONNECT
1178 CONNECT_STAGE_NOT_STARTED --> CONNECT_STAGE_COMPLETE
1179
1180 CONNECT_STAGE_NET_BEGIN_CONNECT --> CONNECT_STAGE_NET_WAIT_CONNECT
1181 CONNECT_STAGE_NET_BEGIN_CONNECT --> CONNECT_STAGE_NET_COMPLETE_CONNECT
1182 CONNECT_STAGE_NET_BEGIN_CONNECT --> STATE_MACHINE_FAILED
1183
1184 CONNECT_STAGE_NET_WAIT_CONNECT --> CONNECT_STAGE_NET_COMPLETE_CONNECT
1185 CONNECT_STAGE_NET_WAIT_CONNECT --> STATE_MACHINE_FAILED
1186
1187 CONNECT_STAGE_NET_COMPLETE_CONNECT --> STATE_MACHINE_FAILED
1188 CONNECT_STAGE_NET_COMPLETE_CONNECT --> CONNECT_STAGE_READ_GREETING
1189
1190 CONNECT_STAGE_READ_GREETING --> STATE_MACHINE_FAILED
1191 CONNECT_STAGE_READ_GREETING --> CONNECT_STAGE_PARSE_HANDSHAKE
1192
1193 CONNECT_STAGE_PARSE_HANDSHAKE --> STATE_MACHINE_FAILED
1194 CONNECT_STAGE_PARSE_HANDSHAKE --> CONNECT_STAGE_ESTABLISH_SSL
1195
1196 CONNECT_STAGE_ESTABLISH_SSL --> STATE_MACHINE_FAILED
1197 CONNECT_STAGE_ESTABLISH_SSL --> CONNECT_STAGE_AUTHENTICATE
1198
1199 CONNECT_STAGE_AUTHENTICATE --> STATE_MACHINE_FAILED
1200 CONNECT_STAGE_AUTHENTICATE --> CONNECT_STAGE_AUTH_BEGIN
1201
1202 CONNECT_STAGE_AUTH_BEGIN --> STATE_MACHINE_FAILED
1203 CONNECT_STAGE_AUTH_BEGIN --> CONNECT_STAGE_AUTH_RUN_FIRST_AUTHENTICATE_USER
1204
1205 CONNECT_STAGE_AUTH_RUN_FIRST_AUTHENTICATE_USER --> CONNECT_STAGE_AUTH_HANDLE_FIRST_AUTHENTICATE_USER
1206
1207 CONNECT_STAGE_AUTH_HANDLE_FIRST_AUTHENTICATE_USER --> STATE_MACHINE_FAILED
1208 CONNECT_STAGE_AUTH_HANDLE_FIRST_AUTHENTICATE_USER --> CONNECT_STAGE_AUTH_READ_CHANGE_USER_RESULT
1209
1210 CONNECT_STAGE_AUTH_READ_CHANGE_USER_RESULT --> CONNECT_STAGE_AUTH_HANDLE_CHANGE_USER_REQUEST
1211
1212 CONNECT_STAGE_AUTH_HANDLE_CHANGE_USER_REQUEST --> STATE_MACHINE_FAILED
1213 CONNECT_STAGE_AUTH_HANDLE_CHANGE_USER_REQUEST --> CONNECT_STAGE_AUTH_RUN_SECOND_AUTHENTICATE_USER
1214 CONNECT_STAGE_AUTH_HANDLE_CHANGE_USER_REQUEST --> CONNECT_STAGE_AUTH_INIT_MULTI_AUTH
1215 CONNECT_STAGE_AUTH_HANDLE_CHANGE_USER_REQUEST --> CONNECT_STAGE_AUTH_FINISH_AUTH
1216
1217 CONNECT_STAGE_AUTH_RUN_SECOND_AUTHENTICATE_USER --> STATE_MACHINE_FAILED
1218 CONNECT_STAGE_AUTH_RUN_SECOND_AUTHENTICATE_USER --> CONNECT_STAGE_AUTH_HANDLE_SECOND_AUTHENTICATE_USER
1219
1220 CONNECT_STAGE_AUTH_HANDLE_SECOND_AUTHENTICATE_USER --> STATE_MACHINE_FAILED
1221 CONNECT_STAGE_AUTH_HANDLE_SECOND_AUTHENTICATE_USER --> CONNECT_STAGE_AUTH_INIT_MULTI_AUTH
1222 CONNECT_STAGE_AUTH_HANDLE_SECOND_AUTHENTICATE_USER --> CONNECT_STAGE_AUTH_FINISH_AUTH
1223
1224 CONNECT_STAGE_AUTH_INIT_MULTI_AUTH --> STATE_MACHINE_FAILED
1225 CONNECT_STAGE_AUTH_INIT_MULTI_AUTH --> CONNECT_STAGE_AUTH_DO_MULTI_PLUGIN_AUTH
1226
1227 CONNECT_STAGE_AUTH_DO_MULTI_PLUGIN_AUTH --> STATE_MACHINE_FAILED
1228 CONNECT_STAGE_AUTH_DO_MULTI_PLUGIN_AUTH --> CONNECT_STAGE_AUTH_HANDLE_MULTI_AUTH_RESPONSE
1229
1230 CONNECT_STAGE_AUTH_HANDLE_MULTI_AUTH_RESPONSE --> STATE_MACHINE_FAILED
1231 CONNECT_STAGE_AUTH_HANDLE_MULTI_AUTH_RESPONSE --> CONNECT_STAGE_AUTH_INIT_MULTI_AUTH
1232 CONNECT_STAGE_AUTH_HANDLE_MULTI_AUTH_RESPONSE --> CONNECT_STAGE_AUTH_FINISH_AUTH
1233
1234 CONNECT_STAGE_AUTH_FINISH_AUTH --> STATE_MACHINE_FAILED
1235 CONNECT_STAGE_AUTH_FINISH_AUTH --> CONNECT_STAGE_PREP_SELECT_DATABASE
1236
1237 CONNECT_STAGE_PREP_SELECT_DATABASE --> CONNECT_STAGE_COMPLETE
1238 CONNECT_STAGE_PREP_SELECT_DATABASE --> CONNECT_STAGE_PREP_INIT_COMMANDS
1239
1240 CONNECT_STAGE_PREP_INIT_COMMANDS --> CONNECT_STAGE_COMPLETE
1241 CONNECT_STAGE_PREP_INIT_COMMANDS --> CONNECT_STAGE_SEND_ONE_INIT_COMMAND
1242
1243 CONNECT_STAGE_SEND_ONE_INIT_COMMAND --> CONNECT_STAGE_SEND_ONE_INIT_COMMAND
1244 CONNECT_STAGE_SEND_ONE_INIT_COMMAND --> STATE_MACHINE_FAILED
1245 CONNECT_STAGE_SEND_ONE_INIT_COMMAND --> CONNECT_STAGE_COMPLETE
1246
1247 STATE_MACHINE_FAILED --> [*]
1248 CONNECT_STAGE_COMPLETE --> [*]
1249 CONNECT_STAGE_INVALID --> [*]
1250 @enduml
1251*/
1252/* clang-format on */
1253enum connect_stage {
1254 /** MYSQL not valid or an unknown state */
1256 /** not connected */
1258 /** begin connection to the server */
1260 /** wait for connection to be established */
1262 /** init the local data structures post connect */
1264 /** read the first packet */
1266 /** parse the first packet */
1268 /** tls establishment */
1270 /** authentication phase */
1272 /** determine the plugin to use */
1274 /** run first auth plugin */
1276 /** handle the result of the first auth plugin run */
1278 /** read the implied changed user auth, if any */
1280 /** Check if server asked to use a different authentication plugin */
1282 /** Start the authentication process again with the plugin which
1283 server asked for */
1285 /** Start multi factor authentication */
1287 /** Final cleanup */
1289 /** Now read the results of the second plugin run */
1291 /** Invoke client plugins multi-auth authentication method */
1293 /** Handle response from client plugins authentication method */
1295 /** Authenticated, set initial database if specified */
1297 /** Prepare to send a sequence of init commands. */
1299 /** Send an init command. This is called once per init command until
1300 they've all been run (or a failure occurs) */
1302 /** Connected or no async connect in progress */
1304};
1305#endif
mysql_enum_shutdown_level
We want levels to be in growing order of hardness (because we use number comparisons).
Definition: mysql_com.h:1005
#define MYSQL_SHUTDOWN_KILLABLE_CONNECT
Definition: mysql_com.h:994
#define MYSQL_SHUTDOWN_KILLABLE_UPDATE
Definition: mysql_com.h:997
#define MYSQL_SHUTDOWN_KILLABLE_TRANS
Definition: mysql_com.h:995
@ SHUTDOWN_WAIT_CRITICAL_BUFFERS
Don't flush InnoDB buffers, flush other storage engines' buffers.
Definition: mysql_com.h:1016
@ SHUTDOWN_WAIT_ALL_BUFFERS
Flush InnoDB buffers and other storage engines' buffers.
Definition: mysql_com.h:1014
@ SHUTDOWN_WAIT_CONNECTIONS
Wait for existing connections to finish.
Definition: mysql_com.h:1008
@ SHUTDOWN_WAIT_TRANSACTIONS
Wait for existing transactons to finish.
Definition: mysql_com.h:1010
@ KILL_QUERY
Query level of the KILL command.
Definition: mysql_com.h:1018
@ SHUTDOWN_WAIT_UPDATES
Wait for existing updates to finish (=> no partial MyISAM update)
Definition: mysql_com.h:1012
@ KILL_CONNECTION
Connection level of the KILL command.
Definition: mysql_com.h:1020
@ SHUTDOWN_DEFAULT
Definition: mysql_com.h:1006
static int rnd(int max_value)
Definition: hp_test2.cc:551
#define STDCALL
Definition: my_compiler.h:145
Common #defines and includes for file and socket I/O.
Types to make file and socket I/O compatible.
unsigned int STDCALL mysql_errno(MYSQL *mysql)
Definition: client.cc:9174
int my_socket
Definition: mysql.h:65
unsigned char * net_store_length(unsigned char *pkg, unsigned long long length)
enum_session_state_type
Type of state change information that the server can include in the Ok packet.
Definition: mysql_com.h:1070
@ SESSION_TRACK_GTIDS
See also: session_track_gtids.
Definition: mysql_com.h:1074
@ SESSION_TRACK_SCHEMA
Current schema.
Definition: mysql_com.h:1072
@ SESSION_TRACK_TRANSACTION_CHARACTERISTICS
Transaction chistics.
Definition: mysql_com.h:1075
@ SESSION_TRACK_TRANSACTION_STATE
Transaction state.
Definition: mysql_com.h:1076
@ SESSION_TRACK_STATE_CHANGE
track session state changes
Definition: mysql_com.h:1073
@ SESSION_TRACK_SYSTEM_VARIABLES
Session system variables.
Definition: mysql_com.h:1071
SERVER_STATUS_flags_enum
The status flags are a bit-field.
Definition: mysql_com.h:808
@ SERVER_STATUS_LAST_ROW_SENT
This flag is sent when a read-only cursor is exhausted, in reply to COM_STMT_FETCH command.
Definition: mysql_com.h:834
@ SERVER_QUERY_WAS_SLOW
Definition: mysql_com.h:843
@ SERVER_STATUS_IN_TRANS
Is raised when a multi-statement transaction has been started, either explicitly, by means of BEGIN o...
Definition: mysql_com.h:816
@ SERVER_STATUS_NO_BACKSLASH_ESCAPES
Definition: mysql_com.h:836
@ SERVER_STATUS_DB_DROPPED
A database was dropped.
Definition: mysql_com.h:835
@ SERVER_STATUS_CURSOR_EXISTS
The server was able to fulfill the clients request and opened a read-only non-scrollable cursor for a...
Definition: mysql_com.h:829
@ SERVER_STATUS_AUTOCOMMIT
Server in auto_commit mode.
Definition: mysql_com.h:817
@ SERVER_SESSION_STATE_CHANGED
This status flag, when on, implies that one of the state information has changed on the server becaus...
Definition: mysql_com.h:862
@ SERVER_QUERY_NO_GOOD_INDEX_USED
Definition: mysql_com.h:819
@ SERVER_STATUS_IN_TRANS_READONLY
Set at the same time as SERVER_STATUS_IN_TRANS if the started multi-statement transaction is a read-o...
Definition: mysql_com.h:856
@ SERVER_QUERY_NO_INDEX_USED
Definition: mysql_com.h:820
@ SERVER_MORE_RESULTS_EXISTS
Multi query - next query exists.
Definition: mysql_com.h:818
@ SERVER_STATUS_METADATA_CHANGED
Sent to the client if after a prepared statement reprepare we discovered that the new statement retur...
Definition: mysql_com.h:842
@ SERVER_PS_OUT_PARAMS
To mark ResultSet containing output parameter values.
Definition: mysql_com.h:847
connect_stage
Describes the current state of Asynchronous connection phase state machine.
Definition: mysql_com.h:1252
@ CONNECT_STAGE_COMPLETE
Connected or no async connect in progress.
Definition: mysql_com.h:1302
@ CONNECT_STAGE_AUTH_INIT_MULTI_AUTH
Start multi factor authentication.
Definition: mysql_com.h:1285
@ CONNECT_STAGE_AUTH_HANDLE_FIRST_AUTHENTICATE_USER
handle the result of the first auth plugin run
Definition: mysql_com.h:1276
@ CONNECT_STAGE_NET_COMPLETE_CONNECT
init the local data structures post connect
Definition: mysql_com.h:1262
@ CONNECT_STAGE_AUTHENTICATE
authentication phase
Definition: mysql_com.h:1270
@ CONNECT_STAGE_SEND_ONE_INIT_COMMAND
Send an init command.
Definition: mysql_com.h:1300
@ CONNECT_STAGE_NET_WAIT_CONNECT
wait for connection to be established
Definition: mysql_com.h:1260
@ CONNECT_STAGE_PREP_SELECT_DATABASE
Authenticated, set initial database if specified.
Definition: mysql_com.h:1295
@ CONNECT_STAGE_AUTH_RUN_SECOND_AUTHENTICATE_USER
Start the authentication process again with the plugin which server asked for.
Definition: mysql_com.h:1283
@ CONNECT_STAGE_PARSE_HANDSHAKE
parse the first packet
Definition: mysql_com.h:1266
@ CONNECT_STAGE_AUTH_HANDLE_SECOND_AUTHENTICATE_USER
Now read the results of the second plugin run.
Definition: mysql_com.h:1289
@ CONNECT_STAGE_PREP_INIT_COMMANDS
Prepare to send a sequence of init commands.
Definition: mysql_com.h:1297
@ CONNECT_STAGE_AUTH_RUN_FIRST_AUTHENTICATE_USER
run first auth plugin
Definition: mysql_com.h:1274
@ CONNECT_STAGE_AUTH_DO_MULTI_PLUGIN_AUTH
Invoke client plugins multi-auth authentication method.
Definition: mysql_com.h:1291
@ CONNECT_STAGE_AUTH_HANDLE_CHANGE_USER_REQUEST
Check if server asked to use a different authentication plugin.
Definition: mysql_com.h:1280
@ CONNECT_STAGE_AUTH_HANDLE_MULTI_AUTH_RESPONSE
Handle response from client plugins authentication method.
Definition: mysql_com.h:1293
@ CONNECT_STAGE_AUTH_FINISH_AUTH
Final cleanup.
Definition: mysql_com.h:1287
@ CONNECT_STAGE_NOT_STARTED
not connected
Definition: mysql_com.h:1256
@ CONNECT_STAGE_ESTABLISH_SSL
tls establishment
Definition: mysql_com.h:1268
@ CONNECT_STAGE_NET_BEGIN_CONNECT
begin connection to the server
Definition: mysql_com.h:1258
@ CONNECT_STAGE_AUTH_BEGIN
determine the plugin to use
Definition: mysql_com.h:1272
@ CONNECT_STAGE_READ_GREETING
read the first packet
Definition: mysql_com.h:1264
@ CONNECT_STAGE_INVALID
MYSQL not valid or an unknown state.
Definition: mysql_com.h:1254
@ CONNECT_STAGE_AUTH_READ_CHANGE_USER_RESULT
read the implied changed user auth, if any
Definition: mysql_com.h:1278
bool my_net_init(struct NET *net, MYSQL_VIO vio)
bool net_write_command(struct NET *net, unsigned char command, const unsigned char *header, size_t head_len, const unsigned char *packet, size_t len)
Send a command to the server.
Definition: net_serv.cc:872
void my_net_set_read_timeout(struct NET *net, unsigned int timeout)
void my_net_set_write_timeout(struct NET *net, unsigned int timeout)
bool my_thread_init(void)
Allocate thread specific memory for the thread, used by mysys and dbug.
Definition: my_thr_init.cc:263
enum_cursor_type
The flags used in COM_STMT_EXECUTE.
Definition: mysql_com.h:1044
@ CURSOR_TYPE_NO_CURSOR
Definition: mysql_com.h:1045
@ CURSOR_TYPE_FOR_UPDATE
Definition: mysql_com.h:1047
@ CURSOR_TYPE_SCROLLABLE
Definition: mysql_com.h:1048
@ CURSOR_TYPE_READ_ONLY
Definition: mysql_com.h:1046
@ PARAMETER_COUNT_AVAILABLE
On when the client will send the parameter count even for 0 parameters.
Definition: mysql_com.h:1053
#define MYSQL_ERRMSG_SIZE
Max length of a error message.
Definition: mysql_com.h:881
char * get_tty_password(const char *opt_message)
Definition: get_password.cc:146
unsigned long my_net_read(struct NET *net)
Read a packet from the client/server and return it without the internal package header.
Definition: net_serv.cc:2251
#define MYSQL_VIO
Definition: mysql_com.h:895
enum_mysql_set_option
options for mysql_options()
Definition: mysql_com.h:1057
@ MYSQL_OPTION_MULTI_STATEMENTS_OFF
Definition: mysql_com.h:1059
@ MYSQL_OPTION_MULTI_STATEMENTS_ON
Definition: mysql_com.h:1058
void my_thread_end(void)
Deallocate memory used by the thread for book-keeping.
Definition: my_thr_init.cc:312
void my_net_set_retry_count(struct NET *net, unsigned int retry_count)
unsigned int net_field_length_size(const unsigned char *pos)
length of buffer required to represent a length-encoded string give the length part of length encoded...
Definition: pack.cc:178
void net_clear(struct NET *net, bool check_buffer)
Clear (reinitialize) the NET structure for a new command.
Definition: net_serv.cc:264
struct NET NET
#define SQLSTATE_LENGTH
Definition: mysql_com.h:75
uint64_t net_length_size_including_self(uint64_t length_without_self)
Calculates length of the field in case value of this field includes length of this field (self)
Definition: pack.cc:193
unsigned int net_length_size(unsigned long long num)
bool generate_sha256_scramble(unsigned char *dst, size_t dst_size, const char *src, size_t src_size, const char *rnd, size_t rnd_size)
Definition: sha2_password_common.cc:387
bool net_write_packet(struct NET *net, const unsigned char *packet, size_t length)
Write a MySQL protocol packet to the network handler.
Definition: net_serv.cc:1296
const char * mysql_errno_to_sqlstate(unsigned int mysql_errno)
bool net_realloc(struct NET *net, size_t length)
Realloc the packet buffer.
Definition: net_serv.cc:210
bool my_net_write(struct NET *net, const unsigned char *packet, size_t len)
Write a logical packet with packet header.
Definition: net_serv.cc:436
void net_end(struct NET *net)
Definition: net_serv.cc:191
enum_resultset_metadata
Definition: mysql_com.h:1024
@ RESULTSET_METADATA_NONE
No metadata will be sent.
Definition: mysql_com.h:1026
@ RESULTSET_METADATA_FULL
The server will send all metadata.
Definition: mysql_com.h:1028
char * octet2hex(char *to, const char *str, unsigned int len)
void my_net_local_init(struct NET *net)
Definition: libmysql.cc:967
bool net_flush(struct NET *net)
Flush write_buffer if not empty.
Definition: net_serv.cc:285
uint64_t net_field_length_ll(unsigned char **packet)
Definition: pack.cc:90
void net_claim_memory_ownership(struct NET *net, bool claim)
Definition: net_serv.cc:204
std::string str(const mysqlrouter::ConfigGenerator::Options::Endpoint &ep)
Definition: config_generator.cc:1081
bool length(const dd::Spatial_reference_system *srs, const Geometry *g1, double *length, bool *null) noexcept
Computes the length of linestrings and multilinestrings.
Definition: length.cc:76
static bool timeout(bool(*wait_condition)())
Timeout function.
Definition: log0meb.cc:498
Definition: buffer.h:45
ulong STDCALL net_field_length(uchar **packet)
Definition: pack.cc:38
ulong STDCALL net_field_length_checked(uchar **packet, ulong max_length)
Definition: pack.cc:61
Definition: mysql_com.h:914
unsigned int pkt_nr
Definition: mysql_com.h:925
char sqlstate[SQLSTATE_LENGTH+1]
Client library sqlstate buffer.
Definition: mysql_com.h:937
MYSQL_VIO vio
Definition: mysql_com.h:915
unsigned char error
Definition: mysql_com.h:933
unsigned char * read_pos
Definition: mysql_com.h:916
unsigned char reading_or_writing
Definition: mysql_com.h:929
unsigned int retry_count
Definition: mysql_com.h:926
bool compress
Definition: mysql_com.h:931
unsigned int * return_status
Definition: mysql_com.h:928
unsigned long length
Definition: mysql_com.h:923
unsigned long max_packet_size
Definition: mysql_com.h:924
unsigned long where_b
Definition: mysql_com.h:923
unsigned long max_packet
Definition: mysql_com.h:924
void * extension
Extension pointer, for the caller private use.
Definition: mysql_com.h:946
unsigned char save_char
Definition: mysql_com.h:930
unsigned int last_errno
Definition: mysql_com.h:932
unsigned char * buff
Definition: mysql_com.h:916
int fcntl
Definition: mysql_com.h:927
my_socket fd
Definition: mysql_com.h:917
unsigned char * write_pos
Definition: mysql_com.h:916
unsigned long remain_in_buf
Set if we are doing several queries in one command ( as in LOAD TABLE ... FROM MASTER ),...
Definition: mysql_com.h:923
char last_error[MYSQL_ERRMSG_SIZE]
Client library error message buffer.
Definition: mysql_com.h:935
unsigned int compress_pkt_nr
Definition: mysql_com.h:925
unsigned int read_timeout
Definition: mysql_com.h:926
unsigned char * buff_end
Definition: mysql_com.h:916
unsigned int write_timeout
Definition: mysql_com.h:926
unsigned long buf_length
Definition: mysql_com.h:923
Definition: violite.h:320
Definition: mysql_com.h:1109
unsigned long seed2
Definition: mysql_com.h:1110
unsigned long max_value
Definition: mysql_com.h:1110
double max_value_dbl
Definition: mysql_com.h:1111
unsigned long seed1
Definition: mysql_com.h:1110
command
Definition: version_token.cc:280