MySQL  8.0.27
Source Code Documentation
mysql_com.h
Go to the documentation of this file.
1 /* Copyright (c) 2000, 2021, 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"
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 preceeded 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 erorr 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 0x80000L /** FLISH RESOUCES. @sa ::reset_mqh */
248 #define REFRESH_FOR_EXPORT 0x100000L /** FLUSH TABLES ... FOR EXPORT */
249 #define REFRESH_OPTIMIZER_COSTS 0x200000L /** FLUSH OPTIMIZER_COSTS */
250 #define REFRESH_PERSIST 0x400000L /** RESET PERSIST */
251 
252 /** @}*/
253 
254 /**
255  @defgroup group_cs_capabilities_flags Capabilities Flags
256  @ingroup group_cs
257 
258  @brief Values for the capabilities flag bitmask used by the MySQL protocol
259 
260  Currently need to fit into 32 bits.
261 
262  Each bit represents an optional feature of the protocol.
263 
264  Both the client and the server are sending these.
265 
266  The intersection of the two determines whast optional parts of the
267  protocol will be used.
268 */
269 
270 /**
271  @addtogroup group_cs_capabilities_flags
272  @{
273 */
274 
275 /**
276  Use the improved version of Old Password Authentication.
277 
278  Not used.
279 
280  @note Assumed to be set since 4.1.1.
281 */
282 #define CLIENT_LONG_PASSWORD 1
283 /**
284  Send found rows instead of affected rows in @ref
285  page_protocol_basic_eof_packet
286 */
287 #define CLIENT_FOUND_ROWS 2
288 /**
289  @brief Get all column flags
290 
291  Longer flags in Protocol::ColumnDefinition320.
292 
293  @todo Reference Protocol::ColumnDefinition320
294 
295  Server
296  ------
297 
298  Supports longer flags.
299 
300  Client
301  ------
302 
303  Expects longer flags.
304 */
305 #define CLIENT_LONG_FLAG 4
306 /**
307  Database (schema) name can be specified on connect in Handshake Response
308  Packet.
309 
310  @todo Reference Handshake Response Packet.
311 
312  Server
313  ------
314 
315  Supports schema-name in Handshake Response Packet.
316 
317  Client
318  ------
319 
320  Handshake Response Packet contains a schema-name.
321 
322  @sa send_client_reply_packet()
323 */
324 #define CLIENT_CONNECT_WITH_DB 8
325 #define CLIENT_NO_SCHEMA 16 /**< Don't allow database.table.column */
326 /**
327  Compression protocol supported.
328 
329  @todo Reference Compression
330 
331  Server
332  ------
333 
334  Supports compression.
335 
336  Client
337  ------
338 
339  Switches to Compression compressed protocol after successful authentication.
340 */
341 #define CLIENT_COMPRESS 32
342 /**
343  Special handling of ODBC behavior.
344 
345  @note No special behavior since 3.22.
346 */
347 #define CLIENT_ODBC 64
348 /**
349  Can use LOAD DATA LOCAL.
350 
351  Server
352  ------
353 
354  Enables the LOCAL INFILE request of LOAD DATA|XML.
355 
356  Client
357  ------
358 
359  Will handle LOCAL INFILE request.
360 */
361 #define CLIENT_LOCAL_FILES 128
362 /**
363  Ignore spaces before '('
364 
365  Server
366  ------
367 
368  Parser can ignore spaces before '('.
369 
370  Client
371  ------
372 
373  Let the parser ignore spaces before '('.
374 */
375 #define CLIENT_IGNORE_SPACE 256
376 /**
377  New 4.1 protocol
378 
379  @todo Reference the new 4.1 protocol
380 
381  Server
382  ------
383 
384  Supports the 4.1 protocol.
385 
386  Client
387  ------
388 
389  Uses the 4.1 protocol.
390 
391  @note this value was CLIENT_CHANGE_USER in 3.22, unused in 4.0
392 */
393 #define CLIENT_PROTOCOL_41 512
394 /**
395  This is an interactive client
396 
397  Use @ref System_variables::net_wait_timeout
398  versus @ref System_variables::net_interactive_timeout.
399 
400  Server
401  ------
402 
403  Supports interactive and noninteractive clients.
404 
405  Client
406  ------
407 
408  Client is interactive.
409 
410  @sa mysql_real_connect()
411 */
412 #define CLIENT_INTERACTIVE 1024
413 /**
414  Use SSL encryption for the session
415 
416  @todo Reference SSL
417 
418  Server
419  ------
420 
421  Supports SSL
422 
423  Client
424  ------
425 
426  Switch to SSL after sending the capability-flags.
427 */
428 #define CLIENT_SSL 2048
429 /**
430  Client only flag. Not used.
431 
432  Client
433  ------
434 
435  Do not issue SIGPIPE if network failures occur (libmysqlclient only).
436 
437  @sa mysql_real_connect()
438 */
439 #define CLIENT_IGNORE_SIGPIPE 4096
440 /**
441  Client knows about transactions
442 
443  Server
444  ------
445 
446  Can send status flags in @ref page_protocol_basic_ok_packet /
447  @ref page_protocol_basic_eof_packet.
448 
449  Client
450  ------
451 
452  Expects status flags in @ref page_protocol_basic_ok_packet /
453  @ref page_protocol_basic_eof_packet.
454 
455  @note This flag is optional in 3.23, but always set by the server since 4.0.
456  @sa send_server_handshake_packet(), parse_client_handshake_packet(),
457  net_send_ok(), net_send_eof()
458 */
459 #define CLIENT_TRANSACTIONS 8192
460 #define CLIENT_RESERVED 16384 /**< DEPRECATED: Old flag for 4.1 protocol */
461 #define CLIENT_RESERVED2 \
462  32768 /**< DEPRECATED: Old flag for 4.1 authentication \
463  CLIENT_SECURE_CONNECTION */
464 /**
465  Enable/disable multi-stmt support
466 
467  Also sets @ref CLIENT_MULTI_RESULTS. Currently not checked anywhere.
468 
469  Server
470  ------
471 
472  Can handle multiple statements per COM_QUERY and COM_STMT_PREPARE.
473 
474  Client
475  -------
476 
477  May send multiple statements per COM_QUERY and COM_STMT_PREPARE.
478 
479  @note Was named ::CLIENT_MULTI_QUERIES in 4.1.0, renamed later.
480 
481  Requires
482  --------
483 
484  ::CLIENT_PROTOCOL_41
485 
486  @todo Reference COM_QUERY and COM_STMT_PREPARE
487 */
488 #define CLIENT_MULTI_STATEMENTS (1UL << 16)
489 /**
490  Enable/disable multi-results
491 
492  Server
493  ------
494 
495  Can send multiple resultsets for COM_QUERY.
496  Error if the server needs to send them and client
497  does not support them.
498 
499  Client
500  -------
501 
502  Can handle multiple resultsets for COM_QUERY.
503 
504  Requires
505  --------
506 
507  ::CLIENT_PROTOCOL_41
508 
509  @sa mysql_execute_command(), sp_head::MULTI_RESULTS
510 */
511 #define CLIENT_MULTI_RESULTS (1UL << 17)
512 /**
513  Multi-results and OUT parameters in PS-protocol.
514 
515  Server
516  ------
517 
518  Can send multiple resultsets for COM_STMT_EXECUTE.
519 
520  Client
521  ------
522 
523  Can handle multiple resultsets for COM_STMT_EXECUTE.
524 
525  Requires
526  --------
527 
528  ::CLIENT_PROTOCOL_41
529 
530  @todo Reference COM_STMT_EXECUTE and PS-protocol
531 
532  @sa Protocol_binary::send_out_parameters
533 */
534 #define CLIENT_PS_MULTI_RESULTS (1UL << 18)
535 
536 /**
537  Client supports plugin authentication
538 
539  Server
540  ------
541 
542  Sends extra data in Initial Handshake Packet and supports the pluggable
543  authentication protocol.
544 
545  Client
546  ------
547 
548  Supports authentication plugins.
549 
550  Requires
551  --------
552 
553  ::CLIENT_PROTOCOL_41
554 
555  @todo Reference plugin authentication, Initial Handshake Packet,
556  Authentication plugins
557 
558  @sa send_change_user_packet(), send_client_reply_packet(), run_plugin_auth(),
559  parse_com_change_user_packet(), parse_client_handshake_packet()
560 */
561 #define CLIENT_PLUGIN_AUTH (1UL << 19)
562 /**
563  Client supports connection attributes
564 
565  Server
566  ------
567 
568  Permits connection attributes in Protocol::HandshakeResponse41.
569 
570  Client
571  ------
572 
573  Sends connection attributes in Protocol::HandshakeResponse41.
574 
575  @todo Reference Protocol::HandshakeResponse41
576 
577  @sa send_client_connect_attrs(), read_client_connect_attrs()
578 */
579 #define CLIENT_CONNECT_ATTRS (1UL << 20)
580 
581 /**
582  Enable authentication response packet to be larger than 255 bytes.
583 
584  When the ability to change default plugin require that the initial password
585  field in the Protocol::HandshakeResponse41 paclet can be of arbitrary size.
586  However, the 4.1 client-server protocol limits the length of the
587  auth-data-field sent from client to server to 255 bytes.
588  The solution is to change the type of the field to a true length encoded
589  string and indicate the protocol change
590  with this client capability flag.
591 
592  Server
593  ------
594 
595  Understands length-encoded integer for auth response data in
596  Protocol::HandshakeResponse41.
597 
598  Client
599  ------
600 
601  Length of auth response data in Protocol::HandshakeResponse41
602  is a length-encoded integer.
603 
604  @todo Reference Protocol::HandshakeResponse41
605 
606  @note The flag was introduced in 5.6.6, but had the wrong value.
607 
608  @sa send_client_reply_packet(), parse_client_handshake_packet(),
609  get_56_lenc_string(), get_41_lenc_string()
610 */
611 #define CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA (1UL << 21)
612 
613 /**
614  Don't close the connection for a user account with expired password.
615 
616  Server
617  ------
618 
619  Announces support for expired password extension.
620 
621  Client
622  ------
623 
624  Can handle expired passwords.
625 
626  @todo Reference expired password
627 
628  @sa MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS, disconnect_on_expired_password
629  ACL_USER::password_expired, check_password_lifetime(), acl_authenticate()
630 */
631 #define CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS (1UL << 22)
632 
633 /**
634  Capable of handling server state change information. Its a hint to the
635  server to include the state change information in
636  @ref page_protocol_basic_ok_packet.
637 
638  Server
639  ------
640  Can set ::SERVER_SESSION_STATE_CHANGED in the ::SERVER_STATUS_flags_enum
641  and send @ref sect_protocol_basic_ok_packet_sessinfo in a
642  @ref page_protocol_basic_ok_packet.
643 
644  Client
645  ------
646 
647  Expects the server to send @ref sect_protocol_basic_ok_packet_sessinfo in
648  a @ref page_protocol_basic_ok_packet.
649 
650  @sa enum_session_state_type, read_ok_ex(), net_send_ok(), Session_tracker,
651  State_tracker
652 */
653 #define CLIENT_SESSION_TRACK (1UL << 23)
654 /**
655  Client no longer needs @ref page_protocol_basic_eof_packet and will
656  use @ref page_protocol_basic_ok_packet instead.
657  @sa net_send_ok()
658 
659  Server
660  ------
661 
662  Can send OK after a Text Resultset.
663 
664  Client
665  ------
666 
667  Expects an @ref page_protocol_basic_ok_packet (instead of
668  @ref page_protocol_basic_eof_packet) after the resultset rows of a
669  Text Resultset.
670 
671  Background
672  ----------
673 
674  To support ::CLIENT_SESSION_TRACK, additional information must be sent after
675  all successful commands. Although the @ref page_protocol_basic_ok_packet is
676  extensible, the @ref page_protocol_basic_eof_packet is not due to the overlap
677  of its bytes with the content of the Text Resultset Row.
678 
679  Therefore, the @ref page_protocol_basic_eof_packet in the
680  Text Resultset is replaced with an @ref page_protocol_basic_ok_packet.
681  @ref page_protocol_basic_eof_packet is deprecated as of MySQL 5.7.5.
682 
683  @todo Reference Text Resultset
684 
685  @sa cli_safe_read_with_ok(), read_ok_ex(), net_send_ok(), net_send_eof()
686 */
687 #define CLIENT_DEPRECATE_EOF (1UL << 24)
688 
689 /**
690  The client can handle optional metadata information in the resultset.
691 */
692 #define CLIENT_OPTIONAL_RESULTSET_METADATA (1UL << 25)
693 
694 /**
695  Compression protocol extended to support zstd compression method
696 
697  This capability flag is used to send zstd compression level between
698  client and server provided both client and server are enabled with
699  this flag.
700 
701  Server
702  ------
703  Server sets this flag when global variable protocol-compression-algorithms
704  has zstd in its list of supported values.
705 
706  Client
707  ------
708  Client sets this flag when it is configured to use zstd compression method.
709 
710 */
711 #define CLIENT_ZSTD_COMPRESSION_ALGORITHM (1UL << 26)
712 
713 /**
714  Support optional extension for query parameters into the @ref
715  page_protocol_com_query and @ref page_protocol_com_stmt_execute packets.
716 
717  Server
718  ------
719 
720  Expects an optional part containing the query parameter set(s). Executes the
721  query for each set of parameters or returns an error if more than 1 set of
722  parameters is sent and the server can't execute it.
723 
724  Client
725  ------
726 
727  Can send the optional part containing the query parameter set(s).
728 */
729 #define CLIENT_QUERY_ATTRIBUTES (1UL << 27)
730 
731 /**
732  Support Multi factor authentication.
733 
734  Server
735  ------
736  Server sends AuthNextFactor packet after every nth factor authentication
737  method succeeds, except the last factor authentication.
738 
739  Client
740  ------
741  Client reads AuthNextFactor packet sent by server and initiates next factor
742  authentication method.
743 */
744 #define MULTI_FACTOR_AUTHENTICATION (1UL << 28)
745 
746 /**
747  This flag will be reserved to extend the 32bit capabilities structure to
748  64bits.
749 */
750 #define CLIENT_CAPABILITY_EXTENSION (1UL << 29)
751 
752 /**
753  Verify server certificate.
754 
755  Client only flag.
756 
757  @deprecated in favor of --ssl-mode.
758 */
759 #define CLIENT_SSL_VERIFY_SERVER_CERT (1UL << 30)
760 
761 /**
762  Don't reset the options after an unsuccessful connect
763 
764  Client only flag.
765 
766  Typically passed via ::mysql_real_connect() 's client_flag parameter.
767 
768  @sa mysql_real_connect()
769 */
770 #define CLIENT_REMEMBER_OPTIONS (1UL << 31)
771 /** @}*/
772 
773 /** a compatibility alias for CLIENT_COMPRESS */
774 #define CAN_CLIENT_COMPRESS CLIENT_COMPRESS
775 
776 /** Gather all possible capabilites (flags) supported by the server */
777 #define CLIENT_ALL_FLAGS \
778  (CLIENT_LONG_PASSWORD | CLIENT_FOUND_ROWS | CLIENT_LONG_FLAG | \
779  CLIENT_CONNECT_WITH_DB | CLIENT_NO_SCHEMA | CLIENT_COMPRESS | CLIENT_ODBC | \
780  CLIENT_LOCAL_FILES | CLIENT_IGNORE_SPACE | CLIENT_PROTOCOL_41 | \
781  CLIENT_INTERACTIVE | CLIENT_SSL | CLIENT_IGNORE_SIGPIPE | \
782  CLIENT_TRANSACTIONS | CLIENT_RESERVED | CLIENT_RESERVED2 | \
783  CLIENT_MULTI_STATEMENTS | CLIENT_MULTI_RESULTS | CLIENT_PS_MULTI_RESULTS | \
784  CLIENT_SSL_VERIFY_SERVER_CERT | CLIENT_REMEMBER_OPTIONS | \
785  CLIENT_PLUGIN_AUTH | CLIENT_CONNECT_ATTRS | \
786  CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA | \
787  CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS | CLIENT_SESSION_TRACK | \
788  CLIENT_DEPRECATE_EOF | CLIENT_OPTIONAL_RESULTSET_METADATA | \
789  CLIENT_ZSTD_COMPRESSION_ALGORITHM | CLIENT_QUERY_ATTRIBUTES | \
790  MULTI_FACTOR_AUTHENTICATION)
791 
792 /**
793  Switch off from ::CLIENT_ALL_FLAGS the flags that are optional and
794  depending on build flags.
795  If any of the optional flags is supported by the build it will be switched
796  on before sending to the client during the connection handshake.
797 */
798 #define CLIENT_BASIC_FLAGS \
799  (CLIENT_ALL_FLAGS & \
800  ~(CLIENT_SSL | CLIENT_COMPRESS | CLIENT_SSL_VERIFY_SERVER_CERT | \
801  CLIENT_ZSTD_COMPRESSION_ALGORITHM))
802 
803 /** The status flags are a bit-field */
805  /**
806  Is raised when a multi-statement transaction
807  has been started, either explicitly, by means
808  of BEGIN or COMMIT AND CHAIN, or
809  implicitly, by the first transactional
810  statement, when autocommit=off.
811  */
813  SERVER_STATUS_AUTOCOMMIT = 2, /**< Server in auto_commit mode */
814  SERVER_MORE_RESULTS_EXISTS = 8, /**< Multi query - next query exists */
817  /**
818  The server was able to fulfill the clients request and opened a
819  read-only non-scrollable cursor for a query. This flag comes
820  in reply to COM_STMT_EXECUTE and COM_STMT_FETCH commands.
821  Used by Binary Protocol Resultset to signal that COM_STMT_FETCH
822  must be used to fetch the row-data.
823  @todo Refify "Binary Protocol Resultset" and "COM_STMT_FETCH".
824  */
826  /**
827  This flag is sent when a read-only cursor is exhausted, in reply to
828  COM_STMT_FETCH command.
829  */
831  SERVER_STATUS_DB_DROPPED = 256, /**< A database was dropped */
833  /**
834  Sent to the client if after a prepared statement reprepare
835  we discovered that the new statement returns a different
836  number of result set columns.
837  */
840  /**
841  To mark ResultSet containing output parameter values.
842  */
844 
845  /**
846  Set at the same time as SERVER_STATUS_IN_TRANS if the started
847  multi-statement transaction is a read-only transaction. Cleared
848  when the transaction commits or aborts. Since this flag is sent
849  to clients in OK and EOF packets, the flag indicates the
850  transaction status at the end of command execution.
851  */
853 
854  /**
855  This status flag, when on, implies that one of the state information has
856  changed on the server because of the execution of the last statement.
857  */
858  SERVER_SESSION_STATE_CHANGED = (1UL << 14)
859 };
860 
861 /**
862  Server status flags that must be cleared when starting
863  execution of a new SQL statement.
864  Flags from this set are only added to the
865  current server status by the execution engine, but
866  never removed -- the execution engine expects them
867  to disappear automagically by the next command.
868 */
869 #define SERVER_STATUS_CLEAR_SET \
870  (SERVER_QUERY_NO_GOOD_INDEX_USED | SERVER_QUERY_NO_INDEX_USED | \
871  SERVER_MORE_RESULTS_EXISTS | SERVER_STATUS_METADATA_CHANGED | \
872  SERVER_QUERY_WAS_SLOW | SERVER_STATUS_DB_DROPPED | \
873  SERVER_STATUS_CURSOR_EXISTS | SERVER_STATUS_LAST_ROW_SENT | \
874  SERVER_SESSION_STATE_CHANGED)
875 
876 /** Max length of a error message. Should be kept in sync with ::ERRMSGSIZE. */
877 #define MYSQL_ERRMSG_SIZE 512
878 #define NET_READ_TIMEOUT 30 /**< Timeout on read */
879 #define NET_WRITE_TIMEOUT 60 /**< Timeout on write */
880 #define NET_WAIT_TIMEOUT 8 * 60 * 60 /**< Wait for new query */
881 
882 /**
883  Flag used by the parser. Kill only the query and not the connection.
884 
885  @sa SQLCOM_KILL, sql_kill(), LEX::type
886 */
887 #define ONLY_KILL_QUERY 1
888 
889 #ifndef MYSQL_VIO
890 struct Vio;
891 #define MYSQL_VIO struct Vio *
892 #endif
893 
894 #define MAX_TINYINT_WIDTH 3 /**< Max width for a TINY w.o. sign */
895 #define MAX_SMALLINT_WIDTH 5 /**< Max width for a SHORT w.o. sign */
896 #define MAX_MEDIUMINT_WIDTH 8 /**< Max width for a INT24 w.o. sign */
897 #define MAX_INT_WIDTH 10 /**< Max width for a LONG w.o. sign */
898 #define MAX_BIGINT_WIDTH 20 /**< Max width for a LONGLONG */
899 /// Max width for a CHAR column, in number of characters
900 #define MAX_CHAR_WIDTH 255
901 /// Default width for blob in bytes @todo - align this with sizes from field.h
902 #define MAX_BLOB_WIDTH 16777216
903 
904 #define NET_ERROR_UNSET 0 /**< No error has occurred yet */
905 #define NET_ERROR_SOCKET_RECOVERABLE 1 /**< Socket still usable */
906 #define NET_ERROR_SOCKET_UNUSABLE 2 /**< Do not use the socket */
907 #define NET_ERROR_SOCKET_NOT_READABLE 3 /**< Try write and close socket */
908 #define NET_ERROR_SOCKET_NOT_WRITABLE 4 /**< Try read and close socket */
909 
910 typedef struct NET {
912  unsigned char *buff, *buff_end, *write_pos, *read_pos;
913  my_socket fd; /* For Perl DBI/dbd */
914  /**
915  Set if we are doing several queries in one
916  command ( as in LOAD TABLE ... FROM MASTER ),
917  and do not want to confuse the client with OK at the wrong time
918  */
920  unsigned long max_packet, max_packet_size;
921  unsigned int pkt_nr, compress_pkt_nr;
923  int fcntl;
924  unsigned int *return_status;
925  unsigned char reading_or_writing;
926  unsigned char save_char;
927  bool compress;
928  unsigned int last_errno;
929  unsigned char error;
930  /** Client library error message buffer. Actually belongs to struct MYSQL. */
932  /** Client library sqlstate buffer. Set along with the error message. */
934  /**
935  Extension pointer, for the caller private use.
936  Any program linking with the networking library can use this pointer,
937  which is handy when private connection specific data needs to be
938  maintained.
939  The mysqld server process uses this pointer internally,
940  to maintain the server internal instrumentation for the connection.
941  */
942  void *extension;
943 } NET;
944 
945 #define packet_error (~(unsigned long)0)
946 
947 /**
948  @addtogroup group_cs_backward_compatibility Backward compatibility
949  @ingroup group_cs
950  @{
951 */
952 #define CLIENT_MULTI_QUERIES CLIENT_MULTI_STATEMENTS
953 #define FIELD_TYPE_DECIMAL MYSQL_TYPE_DECIMAL
954 #define FIELD_TYPE_NEWDECIMAL MYSQL_TYPE_NEWDECIMAL
955 #define FIELD_TYPE_TINY MYSQL_TYPE_TINY
956 #define FIELD_TYPE_SHORT MYSQL_TYPE_SHORT
957 #define FIELD_TYPE_LONG MYSQL_TYPE_LONG
958 #define FIELD_TYPE_FLOAT MYSQL_TYPE_FLOAT
959 #define FIELD_TYPE_DOUBLE MYSQL_TYPE_DOUBLE
960 #define FIELD_TYPE_NULL MYSQL_TYPE_NULL
961 #define FIELD_TYPE_TIMESTAMP MYSQL_TYPE_TIMESTAMP
962 #define FIELD_TYPE_LONGLONG MYSQL_TYPE_LONGLONG
963 #define FIELD_TYPE_INT24 MYSQL_TYPE_INT24
964 #define FIELD_TYPE_DATE MYSQL_TYPE_DATE
965 #define FIELD_TYPE_TIME MYSQL_TYPE_TIME
966 #define FIELD_TYPE_DATETIME MYSQL_TYPE_DATETIME
967 #define FIELD_TYPE_YEAR MYSQL_TYPE_YEAR
968 #define FIELD_TYPE_NEWDATE MYSQL_TYPE_NEWDATE
969 #define FIELD_TYPE_ENUM MYSQL_TYPE_ENUM
970 #define FIELD_TYPE_SET MYSQL_TYPE_SET
971 #define FIELD_TYPE_TINY_BLOB MYSQL_TYPE_TINY_BLOB
972 #define FIELD_TYPE_MEDIUM_BLOB MYSQL_TYPE_MEDIUM_BLOB
973 #define FIELD_TYPE_LONG_BLOB MYSQL_TYPE_LONG_BLOB
974 #define FIELD_TYPE_BLOB MYSQL_TYPE_BLOB
975 #define FIELD_TYPE_VAR_STRING MYSQL_TYPE_VAR_STRING
976 #define FIELD_TYPE_STRING MYSQL_TYPE_STRING
977 #define FIELD_TYPE_CHAR MYSQL_TYPE_TINY
978 #define FIELD_TYPE_INTERVAL MYSQL_TYPE_ENUM
979 #define FIELD_TYPE_GEOMETRY MYSQL_TYPE_GEOMETRY
980 #define FIELD_TYPE_BIT MYSQL_TYPE_BIT
981 /** @}*/
982 
983 /**
984  @addtogroup group_cs_shutdown_kill_constants Shutdown/kill enums and constants
985  @ingroup group_cs
986 
987  @sa THD::is_killable
988  @{
989 */
990 #define MYSQL_SHUTDOWN_KILLABLE_CONNECT (unsigned char)(1 << 0)
991 #define MYSQL_SHUTDOWN_KILLABLE_TRANS (unsigned char)(1 << 1)
992 #define MYSQL_SHUTDOWN_KILLABLE_LOCK_TABLE (unsigned char)(1 << 2)
993 #define MYSQL_SHUTDOWN_KILLABLE_UPDATE (unsigned char)(1 << 3)
994 
995 /**
996  We want levels to be in growing order of hardness (because we use number
997  comparisons).
998 
999  @note ::SHUTDOWN_DEFAULT does not respect the growing property, but it's ok.
1000 */
1003  /** Wait for existing connections to finish */
1005  /** Wait for existing transactons to finish */
1007  /** Wait for existing updates to finish (=> no partial MyISAM update) */
1009  /** Flush InnoDB buffers and other storage engines' buffers*/
1011  /** Don't flush InnoDB buffers, flush other storage engines' buffers*/
1013  /** Query level of the KILL command */
1014  KILL_QUERY = 254,
1015  /** Connection level of the KILL command */
1016  KILL_CONNECTION = 255
1017 };
1018 /** @}*/
1019 
1021  /** No metadata will be sent. */
1023  /** The server will send all metadata. */
1025 };
1026 
1027 #if defined(__clang__)
1028 // disable -Wdocumentation to workaround
1029 // https://bugs.llvm.org/show_bug.cgi?id=38905
1030 #pragma clang diagnostic push
1031 #pragma clang diagnostic ignored "-Wdocumentation"
1032 #endif
1033 /**
1034  The flags used in COM_STMT_EXECUTE.
1035  @sa @ref Protocol_classic::parse_packet, @ref mysql_int_serialize_param_data
1036 */
1037 #if defined(__clang__)
1038 #pragma clang diagnostic pop
1039 #endif
1045  /**
1046  On when the client will send the parameter count
1047  even for 0 parameters.
1048  */
1050 };
1051 
1052 /** options for ::mysql_options() */
1056 };
1057 
1058 /**
1059  Type of state change information that the server can include in the Ok
1060  packet.
1061 
1062  @note
1063  - session_state_type shouldn't go past 255 (i.e. 1-byte boundary).
1064  - Modify the definition of ::SESSION_TRACK_END when a new member is added.
1065 */
1067  SESSION_TRACK_SYSTEM_VARIABLES, /**< Session system variables */
1068  SESSION_TRACK_SCHEMA, /**< Current schema */
1069  SESSION_TRACK_STATE_CHANGE, /**< track session state changes */
1070  SESSION_TRACK_GTIDS, /**< See also: session_track_gtids */
1071  SESSION_TRACK_TRANSACTION_CHARACTERISTICS, /**< Transaction chistics */
1072  SESSION_TRACK_TRANSACTION_STATE /**< Transaction state */
1073 };
1074 
1075 /** start of ::enum_session_state_type */
1076 #define SESSION_TRACK_BEGIN SESSION_TRACK_SYSTEM_VARIABLES
1077 
1078 /** End of ::enum_session_state_type */
1079 #define SESSION_TRACK_END SESSION_TRACK_TRANSACTION_STATE
1080 
1081 /** is T a valid session state type */
1082 #define IS_SESSION_STATE_TYPE(T) \
1083  (((int)(T) >= SESSION_TRACK_BEGIN) && ((T) <= SESSION_TRACK_END))
1084 
1085 #define net_new_transaction(net) ((net)->pkt_nr = 0)
1086 
1087 bool my_net_init(struct NET *net, MYSQL_VIO vio);
1088 void my_net_local_init(struct NET *net);
1089 void net_end(struct NET *net);
1090 void net_clear(struct NET *net, bool check_buffer);
1091 void net_claim_memory_ownership(struct NET *net, bool claim);
1092 bool net_realloc(struct NET *net, size_t length);
1093 bool net_flush(struct NET *net);
1094 bool my_net_write(struct NET *net, const unsigned char *packet, size_t len);
1095 bool net_write_command(struct NET *net, unsigned char command,
1096  const unsigned char *header, size_t head_len,
1097  const unsigned char *packet, size_t len);
1098 bool net_write_packet(struct NET *net, const unsigned char *packet,
1099  size_t length);
1100 unsigned long my_net_read(struct NET *net);
1101 void my_net_set_write_timeout(struct NET *net, unsigned int timeout);
1102 void my_net_set_read_timeout(struct NET *net, unsigned int timeout);
1103 void my_net_set_retry_count(struct NET *net, unsigned int retry_count);
1104 
1105 struct rand_struct {
1106  unsigned long seed1, seed2, max_value;
1108 };
1109 
1110 /* Include the types here so existing UDFs can keep compiling */
1112 
1113 /**
1114  @addtogroup group_cs_compresson_constants Constants when using compression
1115  @ingroup group_cs
1116  @{
1117 */
1118 #define NET_HEADER_SIZE 4 /**< standard header size */
1119 #define COMP_HEADER_SIZE 3 /**< compression header extra size */
1120 /** @}*/
1121 
1122 /* Prototypes to password functions */
1123 
1124 /*
1125  These functions are used for authentication by client and server and
1126  implemented in sql/password.c
1127 */
1128 
1129 void randominit(struct rand_struct *, unsigned long seed1, unsigned long seed2);
1130 double my_rnd(struct rand_struct *);
1131 void create_random_string(char *to, unsigned int length,
1132  struct rand_struct *rand_st);
1133 
1134 void hash_password(unsigned long *to, const char *password,
1135  unsigned int password_len);
1136 void make_scrambled_password_323(char *to, const char *password);
1137 void scramble_323(char *to, const char *message, const char *password);
1138 bool check_scramble_323(const unsigned char *reply, const char *message,
1139  unsigned long *salt);
1140 void get_salt_from_password_323(unsigned long *res, const char *password);
1141 void make_password_from_salt_323(char *to, const unsigned long *salt);
1142 
1143 void make_scrambled_password(char *to, const char *password);
1144 void scramble(char *to, const char *message, const char *password);
1145 bool check_scramble(const unsigned char *reply, const char *message,
1146  const unsigned char *hash_stage2);
1147 void get_salt_from_password(unsigned char *res, const char *password);
1148 void make_password_from_salt(char *to, const unsigned char *hash_stage2);
1149 char *octet2hex(char *to, const char *str, unsigned int len);
1150 
1151 /* end of password.c */
1152 
1153 bool generate_sha256_scramble(unsigned char *dst, size_t dst_size,
1154  const char *src, size_t src_size, const char *rnd,
1155  size_t rnd_size);
1156 
1157 // extern "C" since it is an (undocumented) part of the libmysql ABI.
1158 #ifdef __cplusplus
1159 extern "C" {
1160 #endif
1161 char *get_tty_password(const char *opt_message);
1162 #ifdef __cplusplus
1163 }
1164 #endif
1165 
1166 const char *mysql_errno_to_sqlstate(unsigned int mysql_errno);
1167 
1168 /* Some other useful functions */
1169 
1170 // Need to be extern "C" for the time being, due to memcached.
1171 #ifdef __cplusplus
1172 extern "C" {
1173 #endif
1174 bool my_thread_init(void);
1175 void my_thread_end(void);
1176 #ifdef __cplusplus
1177 }
1178 #endif
1179 
1180 #ifdef STDCALL
1181 unsigned long STDCALL net_field_length(unsigned char **packet);
1182 unsigned long STDCALL net_field_length_checked(unsigned char **packet,
1183  unsigned long max_length);
1184 #endif
1185 uint64_t net_field_length_ll(unsigned char **packet);
1186 unsigned char *net_store_length(unsigned char *pkg, unsigned long long length);
1187 unsigned int net_length_size(unsigned long long num);
1188 unsigned int net_field_length_size(const unsigned char *pos);
1189 
1190 #define NULL_LENGTH ((unsigned long)~0) /**< For ::net_store_length() */
1191 #define MYSQL_STMT_HEADER 4
1192 #define MYSQL_LONG_DATA_HEADER 6
1193 #endif
char * pos
Definition: do_ctype.cc:76
mysql_enum_shutdown_level
We want levels to be in growing order of hardness (because we use number comparisons).
Definition: mysql_com.h:1001
#define MYSQL_SHUTDOWN_KILLABLE_CONNECT
Definition: mysql_com.h:990
#define MYSQL_SHUTDOWN_KILLABLE_UPDATE
Definition: mysql_com.h:993
#define MYSQL_SHUTDOWN_KILLABLE_TRANS
Definition: mysql_com.h:991
@ SHUTDOWN_WAIT_CRITICAL_BUFFERS
Don't flush InnoDB buffers, flush other storage engines' buffers.
Definition: mysql_com.h:1012
@ SHUTDOWN_WAIT_ALL_BUFFERS
Flush InnoDB buffers and other storage engines' buffers.
Definition: mysql_com.h:1010
@ SHUTDOWN_WAIT_CONNECTIONS
Wait for existing connections to finish.
Definition: mysql_com.h:1004
@ SHUTDOWN_WAIT_TRANSACTIONS
Wait for existing transactons to finish.
Definition: mysql_com.h:1006
@ KILL_QUERY
Query level of the KILL command.
Definition: mysql_com.h:1014
@ SHUTDOWN_WAIT_UPDATES
Wait for existing updates to finish (=> no partial MyISAM update)
Definition: mysql_com.h:1008
@ KILL_CONNECTION
Connection level of the KILL command.
Definition: mysql_com.h:1016
@ SHUTDOWN_DEFAULT
Definition: mysql_com.h:1002
#define rnd(X)
Definition: mi_test3.cc:39
#define STDCALL
Definition: my_compiler.h:155
Common #defines and includes for file and socket I/O.
Types to make file and socket I/O compatible.
int my_socket
Definition: my_io_bits.h:59
unsigned int STDCALL mysql_errno(MYSQL *mysql)
Definition: client.cc:8763
void make_scrambled_password_323(char *to, const char *password)
enum_session_state_type
Type of state change information that the server can include in the Ok packet.
Definition: mysql_com.h:1066
@ SESSION_TRACK_GTIDS
See also: session_track_gtids.
Definition: mysql_com.h:1070
@ SESSION_TRACK_SCHEMA
Current schema.
Definition: mysql_com.h:1068
@ SESSION_TRACK_TRANSACTION_CHARACTERISTICS
Transaction chistics.
Definition: mysql_com.h:1071
@ SESSION_TRACK_TRANSACTION_STATE
Transaction state.
Definition: mysql_com.h:1072
@ SESSION_TRACK_STATE_CHANGE
track session state changes
Definition: mysql_com.h:1069
@ SESSION_TRACK_SYSTEM_VARIABLES
Session system variables.
Definition: mysql_com.h:1067
SERVER_STATUS_flags_enum
The status flags are a bit-field.
Definition: mysql_com.h:804
@ 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:830
@ SERVER_QUERY_WAS_SLOW
Definition: mysql_com.h:839
@ 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:812
@ SERVER_STATUS_NO_BACKSLASH_ESCAPES
Definition: mysql_com.h:832
@ SERVER_STATUS_DB_DROPPED
A database was dropped.
Definition: mysql_com.h:831
@ 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:825
@ SERVER_STATUS_AUTOCOMMIT
Server in auto_commit mode.
Definition: mysql_com.h:813
@ 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:858
@ SERVER_QUERY_NO_GOOD_INDEX_USED
Definition: mysql_com.h:815
@ 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:852
@ SERVER_QUERY_NO_INDEX_USED
Definition: mysql_com.h:816
@ SERVER_MORE_RESULTS_EXISTS
Multi query - next query exists.
Definition: mysql_com.h:814
@ 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:838
@ SERVER_PS_OUT_PARAMS
To mark ResultSet containing output parameter values.
Definition: mysql_com.h:843
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
unsigned char * net_store_length(unsigned char *pkg, unsigned long long length)
void scramble_323(char *to, const char *message, const char *password)
void scramble(char *to, const char *message, const char *password)
Produce an obscure octet sequence from password and random string, received from the server.
Definition: password.cc:270
void my_net_set_read_timeout(struct NET *net, unsigned int timeout)
Definition: net_serv.cc:2232
void make_password_from_salt_323(char *to, const unsigned long *salt)
void my_net_set_write_timeout(struct NET *net, unsigned int timeout)
Definition: net_serv.cc:2239
bool my_thread_init(void)
Allocate thread specific memory for the thread, used by mysys and dbug.
Definition: my_thr_init.cc:268
double my_rnd(struct rand_struct *)
Generate random number.
Definition: my_rnd.cc:50
enum_cursor_type
The flags used in COM_STMT_EXECUTE.
Definition: mysql_com.h:1040
@ CURSOR_TYPE_NO_CURSOR
Definition: mysql_com.h:1041
@ CURSOR_TYPE_FOR_UPDATE
Definition: mysql_com.h:1043
@ CURSOR_TYPE_SCROLLABLE
Definition: mysql_com.h:1044
@ CURSOR_TYPE_READ_ONLY
Definition: mysql_com.h:1042
@ PARAMETER_COUNT_AVAILABLE
On when the client will send the parameter count even for 0 parameters.
Definition: mysql_com.h:1049
#define MYSQL_ERRMSG_SIZE
Max length of a error message.
Definition: mysql_com.h:877
void create_random_string(char *to, unsigned int length, struct rand_struct *rand_st)
bool check_scramble(const unsigned char *reply, const char *message, const unsigned char *hash_stage2)
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:2219
#define MYSQL_VIO
Definition: mysql_com.h:891
bool check_scramble_323(const unsigned char *reply, const char *message, unsigned long *salt)
enum_mysql_set_option
options for mysql_options()
Definition: mysql_com.h:1053
@ MYSQL_OPTION_MULTI_STATEMENTS_OFF
Definition: mysql_com.h:1055
@ MYSQL_OPTION_MULTI_STATEMENTS_ON
Definition: mysql_com.h:1054
void get_salt_from_password_323(unsigned long *res, const char *password)
void my_thread_end(void)
Deallocate memory used by the thread for book-keeping.
Definition: my_thr_init.cc:303
void my_net_set_retry_count(struct NET *net, unsigned int retry_count)
Definition: net_serv.cc:2246
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:177
void net_clear(struct NET *net, bool check_buffer)
char * get_tty_password(const char *opt_message)
Definition: get_password.cc:145
struct NET NET
#define SQLSTATE_LENGTH
Definition: mysql_com.h:74
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:386
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:1289
bool net_realloc(struct NET *net, size_t length)
Realloc the packet buffer.
Definition: net_serv.cc:210
void make_scrambled_password(char *to, const char *password)
Definition: password.cc:250
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:1020
@ RESULTSET_METADATA_NONE
No metadata will be sent.
Definition: mysql_com.h:1022
@ RESULTSET_METADATA_FULL
The server will send all metadata.
Definition: mysql_com.h:1024
void randominit(struct rand_struct *, unsigned long seed1, unsigned long seed2)
void my_net_local_init(struct NET *net)
Definition: sql_client.cc:38
bool net_flush(struct NET *net)
Flush write_buffer if not empty.
Definition: net_serv.cc:285
void get_salt_from_password(unsigned char *res, const char *password)
uint64_t net_field_length_ll(unsigned char **packet)
Definition: pack.cc:89
void hash_password(unsigned long *to, const char *password, unsigned int password_len)
void net_claim_memory_ownership(struct NET *net, bool claim)
Definition: net_serv.cc:204
char * octet2hex(char *to, const char *str, unsigned int len)
Definition: password.cc:138
void make_password_from_salt(char *to, const unsigned char *hash_stage2)
const char * mysql_errno_to_sqlstate(unsigned int mysql_errno)
Definition: sql_state.cc:42
static char * password
Definition: mysql_secure_installation.cc:55
std::string str(const mysqlrouter::ConfigGenerator::Options::Endpoint &ep)
Definition: config_generator.cc:1056
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:75
static bool timeout(bool(*wait_condition)())
Timeout function.
Definition: log0meb.cc:494
Definition: buffer.h:42
ulong STDCALL net_field_length(uchar **packet)
Definition: pack.cc:37
ulong STDCALL net_field_length_checked(uchar **packet, ulong max_length)
Definition: pack.cc:60
Definition: mysql_com.h:910
unsigned int pkt_nr
Definition: mysql_com.h:921
char sqlstate[SQLSTATE_LENGTH+1]
Client library sqlstate buffer.
Definition: mysql_com.h:933
MYSQL_VIO vio
Definition: mysql_com.h:911
unsigned char error
Definition: mysql_com.h:929
unsigned char * read_pos
Definition: mysql_com.h:912
unsigned char reading_or_writing
Definition: mysql_com.h:925
unsigned int retry_count
Definition: mysql_com.h:922
bool compress
Definition: mysql_com.h:927
unsigned int * return_status
Definition: mysql_com.h:924
unsigned long length
Definition: mysql_com.h:919
unsigned long max_packet_size
Definition: mysql_com.h:920
unsigned long where_b
Definition: mysql_com.h:919
unsigned long max_packet
Definition: mysql_com.h:920
void * extension
Extension pointer, for the caller private use.
Definition: mysql_com.h:942
unsigned char save_char
Definition: mysql_com.h:926
unsigned int last_errno
Definition: mysql_com.h:928
unsigned char * buff
Definition: mysql_com.h:912
int fcntl
Definition: mysql_com.h:923
my_socket fd
Definition: mysql_com.h:913
unsigned char * write_pos
Definition: mysql_com.h:912
unsigned long remain_in_buf
Set if we are doing several queries in one command ( as in LOAD TABLE ...
Definition: mysql_com.h:919
char last_error[MYSQL_ERRMSG_SIZE]
Client library error message buffer.
Definition: mysql_com.h:931
unsigned int compress_pkt_nr
Definition: mysql_com.h:921
unsigned int read_timeout
Definition: mysql_com.h:922
unsigned char * buff_end
Definition: mysql_com.h:912
unsigned int write_timeout
Definition: mysql_com.h:922
unsigned long buf_length
Definition: mysql_com.h:919
Definition: violite.h:323
Definition: mysql_com.h:1105
unsigned long seed2
Definition: mysql_com.h:1106
unsigned long max_value
Definition: mysql_com.h:1106
double max_value_dbl
Definition: mysql_com.h:1107
unsigned long seed1
Definition: mysql_com.h:1106
command
Definition: version_token.cc:279