mysql_com.h 20.7 KB
Newer Older
unknown's avatar
unknown committed
1 2 3 4
/* Copyright (C) 2000 MySQL AB

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
unknown's avatar
unknown committed
5
   the Free Software Foundation; version 2 of the License.
unknown's avatar
unknown committed
6 7

   This program is distributed in the hope that it will be useful,
unknown's avatar
unknown committed
8
   but WITHOUT ANY WARRANTY; without even the implied warranty of
unknown's avatar
unknown committed
9 10 11 12 13 14
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
unknown's avatar
unknown committed
15 16 17 18 19 20 21 22 23

/*
** Common definition between mysql server & client
*/

#ifndef _mysql_com_h
#define _mysql_com_h

#define HOSTNAME_LENGTH 60
24 25 26 27 28 29
#define SYSTEM_CHARSET_MBMAXLEN 3
#define NAME_CHAR_LEN	64              /* Field/table name length */
#define USERNAME_CHAR_LENGTH 16
#define NAME_LEN                (NAME_CHAR_LEN*SYSTEM_CHARSET_MBMAXLEN)
#define USERNAME_LENGTH         (USERNAME_CHAR_LENGTH*SYSTEM_CHARSET_MBMAXLEN)

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/*
  MDEV-4088

  MySQL (and MariaDB 5.x before the fix) was using the first character of the
  server version string (as sent in the first handshake protocol packet) to
  decide on the replication event formats. And for 10.x the first character
  is "1", which the slave thought comes from some ancient 1.x version
  (ignoring the fact that the first ever MySQL version was 3.x).

  To support replication to these old clients, we fake the version in the
  first handshake protocol packet to start from "5.5.5-" (for example,
  it might be "5.5.5-10.0.1-MariaDB-debug-log".

  On the client side we remove this fake version prefix to restore the
  correct server version. The version "5.5.5" did not support
  pluggable authentication, so any version starting from "5.5.5-" and
  claiming to support pluggable auth, must be using this fake prefix.
*/
#ifdef EMBEDDED_LIBRARY
#define RPL_VERSION_HACK ""
#else
/* this version must be the one that *does not* support pluggable auth */
#define RPL_VERSION_HACK "5.5.5-"
#endif

unknown's avatar
unknown committed
55
#define SERVER_VERSION_LENGTH 60
56
#define SQLSTATE_LENGTH 5
unknown's avatar
unknown committed
57

58 59 60 61 62 63
/*
  USER_HOST_BUFF_SIZE -- length of string buffer, that is enough to contain
  username and hostname parts of the user identifier with trailing zero in
  MySQL standard format:
  user_name_part@host_name_part\0
*/
unknown's avatar
unknown committed
64
#define USER_HOST_BUFF_SIZE HOSTNAME_LENGTH + USERNAME_LENGTH + 2
65

unknown's avatar
unknown committed
66 67 68
#define LOCAL_HOST	"localhost"
#define LOCAL_HOST_NAMEDPIPE "."

unknown's avatar
unknown committed
69

unknown's avatar
unknown committed
70 71
#if defined(__WIN__) && !defined( _CUSTOMCONFIG_)
#define MYSQL_NAMEDPIPE "MySQL"
unknown's avatar
unknown committed
72
#define MYSQL_SERVICENAME "MySQL"
unknown's avatar
unknown committed
73 74
#endif /* __WIN__ */

unknown's avatar
unknown committed
75 76 77 78 79
/*
  You should add new commands to the end of this list, otherwise old
  servers won't be able to handle them as 'unsupported'.
*/

80 81 82 83 84 85 86
enum enum_server_command
{
  COM_SLEEP, COM_QUIT, COM_INIT_DB, COM_QUERY, COM_FIELD_LIST,
  COM_CREATE_DB, COM_DROP_DB, COM_REFRESH, COM_SHUTDOWN, COM_STATISTICS,
  COM_PROCESS_INFO, COM_CONNECT, COM_PROCESS_KILL, COM_DEBUG, COM_PING,
  COM_TIME, COM_DELAYED_INSERT, COM_CHANGE_USER, COM_BINLOG_DUMP,
  COM_TABLE_DUMP, COM_CONNECT_OUT, COM_REGISTER_SLAVE,
87
  COM_STMT_PREPARE, COM_STMT_EXECUTE, COM_STMT_SEND_LONG_DATA, COM_STMT_CLOSE,
unknown's avatar
unknown committed
88
  COM_STMT_RESET, COM_SET_OPTION, COM_STMT_FETCH, COM_DAEMON,
89 90 91 92
  /* don't forget to update const char *command_name[] in sql_parse.cc */

  /* Must be last */
  COM_END
93
};
unknown's avatar
unknown committed
94

unknown's avatar
unknown committed
95

96 97
/*
  Length of random string sent by server on handshake; this is also length of
98
  obfuscated password, recieved from client
99 100 101 102 103 104
*/
#define SCRAMBLE_LENGTH 20
#define SCRAMBLE_LENGTH_323 8
/* length of password stored in the db: new passwords are preceeded with '*' */
#define SCRAMBLED_PASSWORD_CHAR_LENGTH (SCRAMBLE_LENGTH*2+1)
#define SCRAMBLED_PASSWORD_CHAR_LENGTH_323 (SCRAMBLE_LENGTH_323*2)
unknown's avatar
unknown committed
105 106


unknown's avatar
unknown committed
107 108 109 110 111 112 113
#define NOT_NULL_FLAG	1		/* Field can't be NULL */
#define PRI_KEY_FLAG	2		/* Field is part of a primary key */
#define UNIQUE_KEY_FLAG 4		/* Field is part of a unique key */
#define MULTIPLE_KEY_FLAG 8		/* Field is part of a key */
#define BLOB_FLAG	16		/* Field is a blob */
#define UNSIGNED_FLAG	32		/* Field is unsigned */
#define ZEROFILL_FLAG	64		/* Field is zerofill */
unknown's avatar
unknown committed
114
#define BINARY_FLAG	128		/* Field is binary   */
115

unknown's avatar
unknown committed
116 117 118 119 120
/* The following are only sent to new clients */
#define ENUM_FLAG	256		/* field is an enum */
#define AUTO_INCREMENT_FLAG 512		/* field is a autoincrement field */
#define TIMESTAMP_FLAG	1024		/* Field is a timestamp */
#define SET_FLAG	2048		/* field is a set */
unknown's avatar
unknown committed
121
#define NO_DEFAULT_VALUE_FLAG 4096	/* Field doesn't have default value */
122
#define ON_UPDATE_NOW_FLAG 8192         /* Field is set to NOW on UPDATE */
123
#define NUM_FLAG	32768		/* Field is num (for clients) */
unknown's avatar
unknown committed
124 125 126
#define PART_KEY_FLAG	16384		/* Intern; Part of some key */
#define GROUP_FLAG	32768		/* Intern: Group field */
#define UNIQUE_FLAG	65536		/* Intern: Used by sql_yacc */
127
#define BINCMP_FLAG	131072		/* Intern: Used by sql_yacc */
128 129
#define GET_FIXED_FIELDS_FLAG (1 << 18) /* Used to get fields in item tree */
#define FIELD_IN_PART_FUNC_FLAG (1 << 19)/* Field part of partition func */
130
#define FIELD_IN_ADD_INDEX (1<< 20)	/* Intern: Field used in ADD INDEX */
131
#define FIELD_IS_RENAMED (1<< 21)       /* Intern: Field is being renamed */
unknown's avatar
unknown committed
132 133 134 135 136 137

#define REFRESH_GRANT		1	/* Refresh grant tables */
#define REFRESH_LOG		2	/* Start on new log file */
#define REFRESH_TABLES		4	/* close all tables */
#define REFRESH_HOSTS		8	/* Flush host cache */
#define REFRESH_STATUS		16	/* Flush status variables */
unknown's avatar
unknown committed
138
#define REFRESH_THREADS		32	/* Flush thread cache */
unknown's avatar
unknown committed
139 140 141 142 143 144 145 146 147
#define REFRESH_SLAVE           64      /* Reset master info and restart slave
					   thread */
#define REFRESH_MASTER          128     /* Remove all bin logs in the index
					   and truncate the index */

/* The following can't be set with mysql_refresh() */
#define REFRESH_READ_LOCK	16384	/* Lock tables for read */
#define REFRESH_FAST		32768	/* Intern flag */

unknown's avatar
unknown committed
148 149 150
/* RESET (remove all queries) from query cache */
#define REFRESH_QUERY_CACHE	65536
#define REFRESH_QUERY_CACHE_FREE 0x20000L /* pack query cache */
unknown's avatar
unknown committed
151
#define REFRESH_DES_KEY_FILE	0x40000L
152
#define REFRESH_USER_RESOURCES	0x80000L
unknown's avatar
unknown committed
153

unknown's avatar
unknown committed
154 155 156 157 158 159 160 161 162
#define CLIENT_LONG_PASSWORD	1	/* new more secure passwords */
#define CLIENT_FOUND_ROWS	2	/* Found instead of affected rows */
#define CLIENT_LONG_FLAG	4	/* Get all column flags */
#define CLIENT_CONNECT_WITH_DB	8	/* One can specify db on connect */
#define CLIENT_NO_SCHEMA	16	/* Don't allow database.table.column */
#define CLIENT_COMPRESS		32	/* Can use compression protocol */
#define CLIENT_ODBC		64	/* Odbc client */
#define CLIENT_LOCAL_FILES	128	/* Can use LOAD DATA LOCAL */
#define CLIENT_IGNORE_SPACE	256	/* Ignore spaces before '(' */
163
#define CLIENT_PROTOCOL_41	512	/* New 4.1 protocol */
unknown's avatar
unknown committed
164
#define CLIENT_INTERACTIVE	1024	/* This is an interactive client */
165 166
#define CLIENT_SSL              2048	/* Switch to SSL after handshake */
#define CLIENT_IGNORE_SIGPIPE   4096    /* IGNORE sigpipes */
unknown's avatar
unknown committed
167
#define CLIENT_TRANSACTIONS	8192	/* Client knows about transactions */
168 169
#define CLIENT_RESERVED         16384   /* Old flag for 4.1 protocol  */
#define CLIENT_SECURE_CONNECTION 32768  /* New 4.1 authentication */
170 171
#define CLIENT_MULTI_STATEMENTS (1UL << 16) /* Enable/disable multi-stmt support */
#define CLIENT_MULTI_RESULTS    (1UL << 17) /* Enable/disable multi-results */
172

173 174
#define CLIENT_PLUGIN_AUTH  (1UL << 19) /* Client supports plugin authentication */

175 176
#define CLIENT_SSL_VERIFY_SERVER_CERT (1UL << 30)
#define CLIENT_REMEMBER_OPTIONS (1UL << 31)
unknown's avatar
unknown committed
177

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
/* Gather all possible capabilites (flags) supported by the server */
#define CLIENT_ALL_FLAGS  (CLIENT_LONG_PASSWORD | \
                           CLIENT_FOUND_ROWS | \
                           CLIENT_LONG_FLAG | \
                           CLIENT_CONNECT_WITH_DB | \
                           CLIENT_NO_SCHEMA | \
                           CLIENT_COMPRESS | \
                           CLIENT_ODBC | \
                           CLIENT_LOCAL_FILES | \
                           CLIENT_IGNORE_SPACE | \
                           CLIENT_PROTOCOL_41 | \
                           CLIENT_INTERACTIVE | \
                           CLIENT_SSL | \
                           CLIENT_IGNORE_SIGPIPE | \
                           CLIENT_TRANSACTIONS | \
                           CLIENT_RESERVED | \
                           CLIENT_SECURE_CONNECTION | \
                           CLIENT_MULTI_STATEMENTS | \
                           CLIENT_MULTI_RESULTS | \
                           CLIENT_SSL_VERIFY_SERVER_CERT | \
                           CLIENT_REMEMBER_OPTIONS)

/*
  Switch off the flags that are optional and depending on build flags
  If any of the optional flags is supported by the build it will be switched
  on before sending to the client during the connection handshake.
*/
#define CLIENT_BASIC_FLAGS (((CLIENT_ALL_FLAGS & ~CLIENT_SSL) \
                                               & ~CLIENT_COMPRESS) \
                                               & ~CLIENT_SSL_VERIFY_SERVER_CERT)

209 210
#define SERVER_STATUS_IN_TRANS     1	/* Transaction has started */
#define SERVER_STATUS_AUTOCOMMIT   2	/* Server in auto_commit mode */
211
#define SERVER_MORE_RESULTS_EXISTS 8    /* Multi query - next query exists */
212 213
#define SERVER_QUERY_NO_GOOD_INDEX_USED 16
#define SERVER_QUERY_NO_INDEX_USED      32
214
/**
215 216 217
  The server was able to fulfill the clients request and opened a
  read-only non-scrollable cursor for a query. This flag comes
  in reply to COM_STMT_EXECUTE and COM_STMT_FETCH commands.
218 219
*/
#define SERVER_STATUS_CURSOR_EXISTS 64
220
/**
221 222
  This flag is sent when a read-only cursor is exhausted, in reply to
  COM_STMT_FETCH command.
223 224
*/
#define SERVER_STATUS_LAST_ROW_SENT 128
225
#define SERVER_STATUS_DB_DROPPED        256 /* A database was dropped */
226
#define SERVER_STATUS_NO_BACKSLASH_ESCAPES 512
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
/**
  Sent to the client if after a prepared statement reprepare
  we discovered that the new statement returns a different 
  number of result set columns.
*/
#define SERVER_STATUS_METADATA_CHANGED 1024

/**
  Server status flags that must be cleared when starting
  execution of a new SQL statement.
  Flags from this set are only added to the
  current server status by the execution engine, but 
  never removed -- the execution engine expects them 
  to disappear automagically by the next command.
*/
#define SERVER_STATUS_CLEAR_SET (SERVER_QUERY_NO_GOOD_INDEX_USED| \
                                 SERVER_QUERY_NO_INDEX_USED|\
                                 SERVER_MORE_RESULTS_EXISTS|\
                                 SERVER_STATUS_METADATA_CHANGED)
unknown's avatar
unknown committed
246

247
#define MYSQL_ERRMSG_SIZE	512
unknown's avatar
unknown committed
248 249 250 251
#define NET_READ_TIMEOUT	30		/* Timeout on read */
#define NET_WRITE_TIMEOUT	60		/* Timeout on write */
#define NET_WAIT_TIMEOUT	8*60*60		/* Wait for new query */

unknown's avatar
SCRUM  
unknown committed
252 253
#define ONLY_KILL_QUERY         1

254

unknown's avatar
unknown committed
255 256 257
struct st_vio;					/* Only C */
typedef struct st_vio Vio;

258 259 260 261 262
#define MAX_TINYINT_WIDTH       3       /* Max width for a TINY w.o. sign */
#define MAX_SMALLINT_WIDTH      5       /* Max width for a SHORT w.o. sign */
#define MAX_MEDIUMINT_WIDTH     8       /* Max width for a INT24 w.o. sign */
#define MAX_INT_WIDTH           10      /* Max width for a LONG w.o. sign */
#define MAX_BIGINT_WIDTH        20      /* Max width for a LONGLONG */
unknown's avatar
unknown committed
263
#define MAX_CHAR_WIDTH		255	/* Max length for a CHAR colum */
264
#define MAX_BLOB_WIDTH		16777216	/* Default width for blob */
265

unknown's avatar
unknown committed
266
typedef struct st_net {
unknown's avatar
SCRUM  
unknown committed
267
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || !defined(EMBEDDED_LIBRARY)
268
  Vio *vio;
unknown's avatar
unknown committed
269
  unsigned char *buff,*buff_end,*write_pos,*read_pos;
unknown's avatar
unknown committed
270
  my_socket fd;					/* For Perl DBI/dbd */
271 272 273 274 275
  /*
    The following variable is set if we are doing several queries in one
    command ( as in LOAD TABLE ... FROM MASTER ),
    and do not want to confuse the client with OK at the wrong time
  */
unknown's avatar
unknown committed
276
  unsigned long remain_in_buf,length, buf_length, where_b;
277 278 279 280
  unsigned long max_packet,max_packet_size;
  unsigned int pkt_nr,compress_pkt_nr;
  unsigned int write_timeout, read_timeout, retry_count;
  int fcntl;
unknown's avatar
unknown committed
281 282 283
  unsigned int *return_status;
  unsigned char reading_or_writing;
  char save_char;
284
  char net_skip_rest_factor;
285
  my_bool unused; /* Please remove with the next incompatible ABI change */
286
  my_bool compress;
287
  my_bool unused1; /* Please remove with the next incompatible ABI change. */
288 289 290
  /*
    Pointer to query object in query cache, do not equal NULL (0) for
    queries in cache that have not stored its results yet
unknown's avatar
unknown committed
291
  */
292
#endif
293 294 295 296
  /*
    'query_cache_query' should be accessed only via query cache
    functions and methods to maintain proper locking.
  */
297
  unsigned char *query_cache_query;
unknown's avatar
unknown committed
298
  unsigned int last_errno;
299 300
  unsigned char error; 
  my_bool unused2; /* Please remove with the next incompatible ABI change. */
301
  my_bool return_errno;
302
  /** Client library error message buffer. Actually belongs to struct MYSQL. */
unknown's avatar
unknown committed
303
  char last_error[MYSQL_ERRMSG_SIZE];
304 305
  /** Client library sqlstate buffer. Set along with the error message. */
  char sqlstate[SQLSTATE_LENGTH+1];
306
  void *extension;
unknown's avatar
unknown committed
307 308
} NET;

309

unknown's avatar
unknown committed
310
#define packet_error (~(unsigned long) 0)
unknown's avatar
unknown committed
311

312 313 314 315 316 317 318
enum enum_field_types { MYSQL_TYPE_DECIMAL, MYSQL_TYPE_TINY,
			MYSQL_TYPE_SHORT,  MYSQL_TYPE_LONG,
			MYSQL_TYPE_FLOAT,  MYSQL_TYPE_DOUBLE,
			MYSQL_TYPE_NULL,   MYSQL_TYPE_TIMESTAMP,
			MYSQL_TYPE_LONGLONG,MYSQL_TYPE_INT24,
			MYSQL_TYPE_DATE,   MYSQL_TYPE_TIME,
			MYSQL_TYPE_DATETIME, MYSQL_TYPE_YEAR,
319
			MYSQL_TYPE_NEWDATE, MYSQL_TYPE_VARCHAR,
unknown's avatar
unknown committed
320
			MYSQL_TYPE_BIT,
unknown's avatar
unknown committed
321
                        MYSQL_TYPE_NEWDECIMAL=246,
322 323 324 325 326 327 328 329 330 331
			MYSQL_TYPE_ENUM=247,
			MYSQL_TYPE_SET=248,
			MYSQL_TYPE_TINY_BLOB=249,
			MYSQL_TYPE_MEDIUM_BLOB=250,
			MYSQL_TYPE_LONG_BLOB=251,
			MYSQL_TYPE_BLOB=252,
			MYSQL_TYPE_VAR_STRING=253,
			MYSQL_TYPE_STRING=254,
			MYSQL_TYPE_GEOMETRY=255

unknown's avatar
unknown committed
332 333
};

334
/* For backward compatibility */
335
#define CLIENT_MULTI_QUERIES    CLIENT_MULTI_STATEMENTS    
336
#define FIELD_TYPE_DECIMAL     MYSQL_TYPE_DECIMAL
unknown's avatar
unknown committed
337
#define FIELD_TYPE_NEWDECIMAL  MYSQL_TYPE_NEWDECIMAL
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
#define FIELD_TYPE_TINY        MYSQL_TYPE_TINY
#define FIELD_TYPE_SHORT       MYSQL_TYPE_SHORT
#define FIELD_TYPE_LONG        MYSQL_TYPE_LONG
#define FIELD_TYPE_FLOAT       MYSQL_TYPE_FLOAT
#define FIELD_TYPE_DOUBLE      MYSQL_TYPE_DOUBLE
#define FIELD_TYPE_NULL        MYSQL_TYPE_NULL
#define FIELD_TYPE_TIMESTAMP   MYSQL_TYPE_TIMESTAMP
#define FIELD_TYPE_LONGLONG    MYSQL_TYPE_LONGLONG
#define FIELD_TYPE_INT24       MYSQL_TYPE_INT24
#define FIELD_TYPE_DATE        MYSQL_TYPE_DATE
#define FIELD_TYPE_TIME        MYSQL_TYPE_TIME
#define FIELD_TYPE_DATETIME    MYSQL_TYPE_DATETIME
#define FIELD_TYPE_YEAR        MYSQL_TYPE_YEAR
#define FIELD_TYPE_NEWDATE     MYSQL_TYPE_NEWDATE
#define FIELD_TYPE_ENUM        MYSQL_TYPE_ENUM
#define FIELD_TYPE_SET         MYSQL_TYPE_SET
#define FIELD_TYPE_TINY_BLOB   MYSQL_TYPE_TINY_BLOB
#define FIELD_TYPE_MEDIUM_BLOB MYSQL_TYPE_MEDIUM_BLOB
356
#define FIELD_TYPE_LONG_BLOB   MYSQL_TYPE_LONG_BLOB
357 358 359 360
#define FIELD_TYPE_BLOB        MYSQL_TYPE_BLOB
#define FIELD_TYPE_VAR_STRING  MYSQL_TYPE_VAR_STRING
#define FIELD_TYPE_STRING      MYSQL_TYPE_STRING
#define FIELD_TYPE_CHAR        MYSQL_TYPE_TINY
361
#define FIELD_TYPE_INTERVAL    MYSQL_TYPE_ENUM
362
#define FIELD_TYPE_GEOMETRY    MYSQL_TYPE_GEOMETRY
unknown's avatar
unknown committed
363
#define FIELD_TYPE_BIT         MYSQL_TYPE_BIT
364

365 366 367 368

/* Shutdown/kill enums and constants */ 

/* Bits for THD::killable. */
unknown's avatar
unknown committed
369 370 371 372
#define MYSQL_SHUTDOWN_KILLABLE_CONNECT    (unsigned char)(1 << 0)
#define MYSQL_SHUTDOWN_KILLABLE_TRANS      (unsigned char)(1 << 1)
#define MYSQL_SHUTDOWN_KILLABLE_LOCK_TABLE (unsigned char)(1 << 2)
#define MYSQL_SHUTDOWN_KILLABLE_UPDATE     (unsigned char)(1 << 3)
373

unknown's avatar
unknown committed
374
enum mysql_enum_shutdown_level {
375
  /*
376 377 378
    We want levels to be in growing order of hardness (because we use number
    comparisons). Note that DEFAULT does not respect the growing property, but
    it's ok.
379
  */
380
  SHUTDOWN_DEFAULT = 0,
381
  /* wait for existing connections to finish */
382
  SHUTDOWN_WAIT_CONNECTIONS= MYSQL_SHUTDOWN_KILLABLE_CONNECT,
383
  /* wait for existing trans to finish */
384
  SHUTDOWN_WAIT_TRANSACTIONS= MYSQL_SHUTDOWN_KILLABLE_TRANS,
385
  /* wait for existing updates to finish (=> no partial MyISAM update) */
386
  SHUTDOWN_WAIT_UPDATES= MYSQL_SHUTDOWN_KILLABLE_UPDATE,
387
  /* flush InnoDB buffers and other storage engines' buffers*/
388
  SHUTDOWN_WAIT_ALL_BUFFERS= (MYSQL_SHUTDOWN_KILLABLE_UPDATE << 1),
389
  /* don't flush InnoDB buffers, flush other storage engines' buffers*/
390
  SHUTDOWN_WAIT_CRITICAL_BUFFERS= (MYSQL_SHUTDOWN_KILLABLE_UPDATE << 1) + 1,
391 392 393 394 395
  /* Now the 2 levels of the KILL command */
#if MYSQL_VERSION_ID >= 50000
  KILL_QUERY= 254,
#endif
  KILL_CONNECTION= 255
396 397
};

398 399 400 401 402 403 404 405 406 407

enum enum_cursor_type
{
  CURSOR_TYPE_NO_CURSOR= 0,
  CURSOR_TYPE_READ_ONLY= 1,
  CURSOR_TYPE_FOR_UPDATE= 2,
  CURSOR_TYPE_SCROLLABLE= 4
};


408 409 410 411 412 413 414
/* options for mysql_set_option */
enum enum_mysql_set_option
{
  MYSQL_OPTION_MULTI_STATEMENTS_ON,
  MYSQL_OPTION_MULTI_STATEMENTS_OFF
};

unknown's avatar
unknown committed
415 416
#define net_new_transaction(net) ((net)->pkt_nr=0)

unknown's avatar
unknown committed
417 418 419 420
#ifdef __cplusplus
extern "C" {
#endif

421
my_bool	my_net_init(NET *net, Vio* vio);
unknown's avatar
unknown committed
422
void	my_net_local_init(NET *net);
unknown's avatar
unknown committed
423
void	net_end(NET *net);
424
  void	net_clear(NET *net, my_bool clear_buffer);
425
my_bool net_realloc(NET *net, size_t length);
426
my_bool	net_flush(NET *net);
427
my_bool	my_net_write(NET *net,const unsigned char *packet, size_t len);
428
my_bool	net_write_command(NET *net,unsigned char command,
429 430 431
			  const unsigned char *header, size_t head_len,
			  const unsigned char *packet, size_t len);
int	net_real_write(NET *net,const unsigned char *packet, size_t len);
432
unsigned long my_net_read(NET *net);
unknown's avatar
unknown committed
433

434
#ifdef _global_h
435 436
void my_net_set_write_timeout(NET *net, uint timeout);
void my_net_set_read_timeout(NET *net, uint timeout);
437
#endif
438

439 440 441 442
/*
  The following function is not meant for normal usage
  Currently it's used internally by manager.c
*/
unknown's avatar
unknown committed
443
struct sockaddr;
unknown's avatar
unknown committed
444 445
int my_connect(my_socket s, const struct sockaddr *name, unsigned int namelen,
	       unsigned int timeout);
446
struct my_rnd_struct;
unknown's avatar
unknown committed
447

unknown's avatar
unknown committed
448 449 450 451
#ifdef __cplusplus
}
#endif

unknown's avatar
unknown committed
452 453
  /* The following is for user defined functions */

454 455 456 457 458 459 460
enum Item_result
{
  STRING_RESULT=0, REAL_RESULT, INT_RESULT, ROW_RESULT, DECIMAL_RESULT
#ifdef MYSQL_SERVER
  ,IMPOSSIBLE_RESULT  /* Yes, we know this is ugly, don't tell us */
#endif
};
unknown's avatar
unknown committed
461 462 463 464 465 466 467 468

typedef struct st_udf_args
{
  unsigned int arg_count;		/* Number of arguments */
  enum Item_result *arg_type;		/* Pointer to item_results */
  char **args;				/* Pointer to argument */
  unsigned long *lengths;		/* Length of string arguments */
  char *maybe_null;			/* Set to 1 for all maybe_null args */
469 470
  char **attributes;                    /* Pointer to attribute name */
  unsigned long *attribute_lengths;     /* Length of attribute arguments */
471
  void *extension;
unknown's avatar
unknown committed
472 473 474 475 476 477
} UDF_ARGS;

  /* This holds information about the result */

typedef struct st_udf_init
{
478 479 480 481 482
  my_bool maybe_null;          /* 1 if function can return NULL */
  unsigned int decimals;       /* for real functions */
  unsigned long max_length;    /* For string functions */
  char *ptr;                   /* free pointer for function data */
  my_bool const_item;          /* 1 if function always returns the same value */
483
  void *extension;
unknown's avatar
unknown committed
484
} UDF_INIT;
485 486 487 488
/* 
  TODO: add a notion for determinism of the UDF. 
  See Item_udf_func::update_used_tables ()
*/
unknown's avatar
unknown committed
489 490 491 492 493 494 495 496 497 498

  /* Constants when using compression */
#define NET_HEADER_SIZE 4		/* standard header size */
#define COMP_HEADER_SIZE 3		/* compression header extra size */

  /* Prototypes to password functions */

#ifdef __cplusplus
extern "C" {
#endif
unknown's avatar
unknown committed
499

500 501 502 503 504
/*
  These functions are used for authentication by client and server and
  implemented in sql/password.c
*/

505 506
void create_random_string(char *to, unsigned int length,
                          struct my_rnd_struct *rand_st);
507

508
void hash_password(unsigned long *to, const char *password, unsigned int password_len);
509
void make_scrambled_password_323(char *to, const char *password);
510
void scramble_323(char *to, const char *message, const char *password);
511
my_bool check_scramble_323(const char *, const char *message,
512
                           unsigned long *salt);
513 514 515 516
void get_salt_from_password_323(unsigned long *res, const char *password);
void make_password_from_salt_323(char *to, const unsigned long *salt);

void make_scrambled_password(char *to, const char *password);
unknown's avatar
unknown committed
517
void scramble(char *to, const char *message, const char *password);
518 519 520 521
my_bool check_scramble(const char *reply, const char *message,
                       const unsigned char *hash_stage2);
void get_salt_from_password(unsigned char *res, const char *password);
void make_password_from_salt(char *to, const unsigned char *hash_stage2);
unknown's avatar
unknown committed
522
char *octet2hex(char *to, const char *str, unsigned int len);
523 524 525

/* end of password.c */

526
char *get_tty_password(const char *opt_message);
527
const char *mysql_errno_to_sqlstate(unsigned int mysql_errno);
unknown's avatar
unknown committed
528 529 530

/* Some other useful functions */

unknown's avatar
unknown committed
531
my_bool my_thread_init(void);
532
void my_thread_end(void);
unknown's avatar
unknown committed
533

unknown's avatar
SCRUM  
unknown committed
534 535
#ifdef _global_h
ulong STDCALL net_field_length(uchar **packet);
unknown's avatar
SCRUM  
unknown committed
536
my_ulonglong net_field_length_ll(uchar **packet);
537
uchar *net_store_length(uchar *pkg, ulonglong length);
unknown's avatar
SCRUM  
unknown committed
538 539
#endif

unknown's avatar
unknown committed
540 541 542 543
#ifdef __cplusplus
}
#endif

unknown's avatar
unknown committed
544
#define NULL_LENGTH ((unsigned long) ~0) /* For net_store_length */
unknown's avatar
unknown committed
545
#define MYSQL_STMT_HEADER       4
546
#define MYSQL_LONG_DATA_HEADER  6
unknown's avatar
unknown committed
547 548

#endif