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

source code of include/mysql/mysql_com.h