mysql_com.h 20.5 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
#define MYSQL_AUTODETECT_CHARSET_NAME "auto"

unknown's avatar
unknown committed
32
#define SERVER_VERSION_LENGTH 60
33
#define SQLSTATE_LENGTH 5
unknown's avatar
unknown committed
34

35 36 37 38 39 40 41 42
/*
  Maximum length of comments
*/
#define TABLE_COMMENT_INLINE_MAXLEN 180 /* pre 6.0: 60 characters */
#define TABLE_COMMENT_MAXLEN 2048
#define COLUMN_COMMENT_MAXLEN 1024
#define INDEX_COMMENT_MAXLEN 1024

43 44 45 46 47 48
/*
  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
49
#define USER_HOST_BUFF_SIZE HOSTNAME_LENGTH + USERNAME_LENGTH + 2
50

unknown's avatar
unknown committed
51 52 53
#define LOCAL_HOST	"localhost"
#define LOCAL_HOST_NAMEDPIPE "."

unknown's avatar
unknown committed
54

unknown's avatar
unknown committed
55 56
#if defined(__WIN__) && !defined( _CUSTOMCONFIG_)
#define MYSQL_NAMEDPIPE "MySQL"
unknown's avatar
unknown committed
57
#define MYSQL_SERVICENAME "MySQL"
unknown's avatar
unknown committed
58 59
#endif /* __WIN__ */

unknown's avatar
unknown committed
60 61 62 63 64
/*
  You should add new commands to the end of this list, otherwise old
  servers won't be able to handle them as 'unsupported'.
*/

65 66 67 68 69 70 71
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,
72
  COM_STMT_PREPARE, COM_STMT_EXECUTE, COM_STMT_SEND_LONG_DATA, COM_STMT_CLOSE,
unknown's avatar
unknown committed
73
  COM_STMT_RESET, COM_SET_OPTION, COM_STMT_FETCH, COM_DAEMON,
74 75 76 77
  /* don't forget to update const char *command_name[] in sql_parse.cc */

  /* Must be last */
  COM_END
78
};
unknown's avatar
unknown committed
79

unknown's avatar
unknown committed
80

81 82
/*
  Length of random string sent by server on handshake; this is also length of
83
  obfuscated password, recieved from client
84 85 86 87 88 89
*/
#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
90 91


unknown's avatar
unknown committed
92 93 94 95 96 97 98
#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
99
#define BINARY_FLAG	128		/* Field is binary   */
100

unknown's avatar
unknown committed
101 102 103 104 105
/* 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
106
#define NO_DEFAULT_VALUE_FLAG 4096	/* Field doesn't have default value */
107
#define ON_UPDATE_NOW_FLAG 8192         /* Field is set to NOW on UPDATE */
108
#define NUM_FLAG	32768		/* Field is num (for clients) */
unknown's avatar
unknown committed
109 110 111
#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 */
112
#define BINCMP_FLAG	131072		/* Intern: Used by sql_yacc */
113 114
#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 */
115
#define FIELD_IN_ADD_INDEX (1<< 20)	/* Intern: Field used in ADD INDEX */
116
#define FIELD_IS_RENAMED (1<< 21)       /* Intern: Field is being renamed */
unknown's avatar
unknown committed
117 118 119 120 121 122

#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
123
#define REFRESH_THREADS		32	/* Flush thread cache */
unknown's avatar
unknown committed
124 125 126 127
#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 */
128 129 130 131 132 133
#define REFRESH_ERROR_LOG       256 /* Rotate only the erorr log */
#define REFRESH_ENGINE_LOG      512 /* Flush all storage engine logs */
#define REFRESH_BINARY_LOG     1024 /* Flush the binary log */
#define REFRESH_RELAY_LOG      2048 /* Flush the relay log */
#define REFRESH_GENERAL_LOG    4096 /* Flush the general log */
#define REFRESH_SLOW_LOG       8192 /* Flush the slow query log */
unknown's avatar
unknown committed
134 135 136 137 138

/* 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
139 140 141
/* 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
142
#define REFRESH_DES_KEY_FILE	0x40000L
143
#define REFRESH_USER_RESOURCES	0x80000L
unknown's avatar
unknown committed
144

unknown's avatar
unknown committed
145 146 147 148 149 150 151 152 153
#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 '(' */
154
#define CLIENT_PROTOCOL_41	512	/* New 4.1 protocol */
unknown's avatar
unknown committed
155
#define CLIENT_INTERACTIVE	1024	/* This is an interactive client */
156 157
#define CLIENT_SSL              2048	/* Switch to SSL after handshake */
#define CLIENT_IGNORE_SIGPIPE   4096    /* IGNORE sigpipes */
unknown's avatar
unknown committed
158
#define CLIENT_TRANSACTIONS	8192	/* Client knows about transactions */
159 160
#define CLIENT_RESERVED         16384   /* Old flag for 4.1 protocol  */
#define CLIENT_SECURE_CONNECTION 32768  /* New 4.1 authentication */
161 162
#define CLIENT_MULTI_STATEMENTS (1UL << 16) /* Enable/disable multi-stmt support */
#define CLIENT_MULTI_RESULTS    (1UL << 17) /* Enable/disable multi-results */
163
#define CLIENT_PS_MULTI_RESULTS (1UL << 18) /* Multi-results in PS-protocol */
164

165 166
#define CLIENT_SSL_VERIFY_SERVER_CERT (1UL << 30)
#define CLIENT_REMEMBER_OPTIONS (1UL << 31)
unknown's avatar
unknown committed
167

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/* 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 | \
187
                           CLIENT_PS_MULTI_RESULTS | \
188 189 190 191 192 193 194 195 196 197 198 199
                           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)

200 201
#define SERVER_STATUS_IN_TRANS     1	/* Transaction has started */
#define SERVER_STATUS_AUTOCOMMIT   2	/* Server in auto_commit mode */
202
#define SERVER_MORE_RESULTS_EXISTS 8    /* Multi query - next query exists */
203 204
#define SERVER_QUERY_NO_GOOD_INDEX_USED 16
#define SERVER_QUERY_NO_INDEX_USED      32
205
/**
206 207 208
  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.
209 210
*/
#define SERVER_STATUS_CURSOR_EXISTS 64
211
/**
212 213
  This flag is sent when a read-only cursor is exhausted, in reply to
  COM_STMT_FETCH command.
214 215
*/
#define SERVER_STATUS_LAST_ROW_SENT 128
216
#define SERVER_STATUS_DB_DROPPED        256 /* A database was dropped */
217
#define SERVER_STATUS_NO_BACKSLASH_ESCAPES 512
218 219 220 221 222 223
/**
  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
Alexander Nozdrin's avatar
Alexander Nozdrin committed
224
#define SERVER_QUERY_WAS_SLOW          2048
225

226 227 228 229 230
/**
  To mark ResultSet containing output parameter values.
*/
#define SERVER_PS_OUT_PARAMS            4096

231 232 233 234 235 236 237 238 239 240 241 242
/**
  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
243

244
#define MYSQL_ERRMSG_SIZE	512
unknown's avatar
unknown committed
245 246 247 248
#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
249 250
#define ONLY_KILL_QUERY         1

251

unknown's avatar
unknown committed
252 253 254
struct st_vio;					/* Only C */
typedef struct st_vio Vio;

255 256 257 258 259
#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
260
#define MAX_CHAR_WIDTH		255	/* Max length for a CHAR colum */
261
#define MAX_BLOB_WIDTH		16777216	/* Default width for blob */
262

unknown's avatar
unknown committed
263
typedef struct st_net {
unknown's avatar
SCRUM  
unknown committed
264
#if !defined(CHECK_EMBEDDED_DIFFERENCES) || !defined(EMBEDDED_LIBRARY)
265
  Vio *vio;
unknown's avatar
unknown committed
266
  unsigned char *buff,*buff_end,*write_pos,*read_pos;
unknown's avatar
unknown committed
267
  my_socket fd;					/* For Perl DBI/dbd */
268 269 270 271 272
  /*
    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
273
  unsigned long remain_in_buf,length, buf_length, where_b;
274 275 276 277
  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
278 279 280
  unsigned int *return_status;
  unsigned char reading_or_writing;
  char save_char;
281
  my_bool unused1; /* Please remove with the next incompatible ABI change. */
282 283 284
  my_bool unused2; /* Please remove with the next incompatible ABI change */
  my_bool compress;
  my_bool unused3; /* Please remove with the next incompatible ABI change. */
285 286 287
  /*
    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
288
  */
289
#endif
290
  /*
291
    Unused, please remove with the next incompatible ABI change.
292
  */
293
  unsigned char *unused;
unknown's avatar
unknown committed
294
  unsigned int last_errno;
295
  unsigned char error; 
296 297
  my_bool unused4; /* Please remove with the next incompatible ABI change. */
  my_bool unused5; /* Please remove with the next incompatible ABI change. */
298
  /** Client library error message buffer. Actually belongs to struct MYSQL. */
unknown's avatar
unknown committed
299
  char last_error[MYSQL_ERRMSG_SIZE];
300 301
  /** Client library sqlstate buffer. Set along with the error message. */
  char sqlstate[SQLSTATE_LENGTH+1];
302
  void *extension;
unknown's avatar
unknown committed
303 304
} NET;

305

unknown's avatar
unknown committed
306
#define packet_error (~(unsigned long) 0)
unknown's avatar
unknown committed
307

308 309 310 311 312 313 314
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,
315
			MYSQL_TYPE_NEWDATE, MYSQL_TYPE_VARCHAR,
unknown's avatar
unknown committed
316
			MYSQL_TYPE_BIT,
unknown's avatar
unknown committed
317
                        MYSQL_TYPE_NEWDECIMAL=246,
318 319 320 321 322 323 324 325 326 327
			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
328 329
};

330
/* For backward compatibility */
331
#define CLIENT_MULTI_QUERIES    CLIENT_MULTI_STATEMENTS    
332
#define FIELD_TYPE_DECIMAL     MYSQL_TYPE_DECIMAL
unknown's avatar
unknown committed
333
#define FIELD_TYPE_NEWDECIMAL  MYSQL_TYPE_NEWDECIMAL
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
#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
352
#define FIELD_TYPE_LONG_BLOB   MYSQL_TYPE_LONG_BLOB
353 354 355 356
#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
357
#define FIELD_TYPE_INTERVAL    MYSQL_TYPE_ENUM
358
#define FIELD_TYPE_GEOMETRY    MYSQL_TYPE_GEOMETRY
unknown's avatar
unknown committed
359
#define FIELD_TYPE_BIT         MYSQL_TYPE_BIT
360

361 362 363 364

/* Shutdown/kill enums and constants */ 

/* Bits for THD::killable. */
unknown's avatar
unknown committed
365 366 367 368
#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)
369

unknown's avatar
unknown committed
370
enum mysql_enum_shutdown_level {
371
  /*
372 373 374
    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.
375
  */
376
  SHUTDOWN_DEFAULT = 0,
377
  /* wait for existing connections to finish */
378
  SHUTDOWN_WAIT_CONNECTIONS= MYSQL_SHUTDOWN_KILLABLE_CONNECT,
379
  /* wait for existing trans to finish */
380
  SHUTDOWN_WAIT_TRANSACTIONS= MYSQL_SHUTDOWN_KILLABLE_TRANS,
381
  /* wait for existing updates to finish (=> no partial MyISAM update) */
382
  SHUTDOWN_WAIT_UPDATES= MYSQL_SHUTDOWN_KILLABLE_UPDATE,
383
  /* flush InnoDB buffers and other storage engines' buffers*/
384
  SHUTDOWN_WAIT_ALL_BUFFERS= (MYSQL_SHUTDOWN_KILLABLE_UPDATE << 1),
385
  /* don't flush InnoDB buffers, flush other storage engines' buffers*/
386
  SHUTDOWN_WAIT_CRITICAL_BUFFERS= (MYSQL_SHUTDOWN_KILLABLE_UPDATE << 1) + 1,
387 388 389 390 391
  /* Now the 2 levels of the KILL command */
#if MYSQL_VERSION_ID >= 50000
  KILL_QUERY= 254,
#endif
  KILL_CONNECTION= 255
392 393
};

394 395 396 397 398 399 400 401 402 403

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


404 405 406 407 408 409 410
/* 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
411 412
#define net_new_transaction(net) ((net)->pkt_nr=0)

unknown's avatar
unknown committed
413 414 415 416
#ifdef __cplusplus
extern "C" {
#endif

417
my_bool	my_net_init(NET *net, Vio* vio);
unknown's avatar
unknown committed
418
void	my_net_local_init(NET *net);
unknown's avatar
unknown committed
419
void	net_end(NET *net);
420
  void	net_clear(NET *net, my_bool clear_buffer);
421
my_bool net_realloc(NET *net, size_t length);
422
my_bool	net_flush(NET *net);
423
my_bool	my_net_write(NET *net,const unsigned char *packet, size_t len);
424
my_bool	net_write_command(NET *net,unsigned char command,
425 426 427
			  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);
428
unsigned long my_net_read(NET *net);
unknown's avatar
unknown committed
429

430
#ifdef _global_h
431 432
void my_net_set_write_timeout(NET *net, uint timeout);
void my_net_set_read_timeout(NET *net, uint timeout);
433
#endif
434

unknown's avatar
unknown committed
435
struct sockaddr;
unknown's avatar
unknown committed
436 437
int my_connect(my_socket s, const struct sockaddr *name, unsigned int namelen,
	       unsigned int timeout);
unknown's avatar
unknown committed
438 439 440 441 442 443

struct rand_struct {
  unsigned long seed1,seed2,max_value;
  double max_value_dbl;
};

unknown's avatar
unknown committed
444 445 446 447
#ifdef __cplusplus
}
#endif

unknown's avatar
unknown committed
448 449
  /* The following is for user defined functions */

unknown's avatar
Merge  
unknown committed
450
enum Item_result {STRING_RESULT=0, REAL_RESULT, INT_RESULT, ROW_RESULT,
unknown's avatar
unknown committed
451
                  DECIMAL_RESULT};
unknown's avatar
unknown committed
452 453 454 455 456 457 458 459

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 */
460 461
  char **attributes;                    /* Pointer to attribute name */
  unsigned long *attribute_lengths;     /* Length of attribute arguments */
462
  void *extension;
unknown's avatar
unknown committed
463 464 465 466 467 468
} UDF_ARGS;

  /* This holds information about the result */

typedef struct st_udf_init
{
469 470 471 472 473
  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 */
474
  void *extension;
unknown's avatar
unknown committed
475
} UDF_INIT;
476 477 478 479
/* 
  TODO: add a notion for determinism of the UDF. 
  See Item_udf_func::update_used_tables ()
*/
unknown's avatar
unknown committed
480 481 482 483 484 485 486 487 488 489

  /* 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
490

491 492 493 494 495 496 497
/*
  These functions are used for authentication by client and server and
  implemented in sql/password.c
*/

void randominit(struct rand_struct *, unsigned long seed1,
                unsigned long seed2);
498
double my_rnd(struct rand_struct *);
499
void create_random_string(char *to, unsigned int length, struct rand_struct *rand_st);
500

501
void hash_password(unsigned long *to, const char *password, unsigned int password_len);
502
void make_scrambled_password_323(char *to, const char *password);
503
void scramble_323(char *to, const char *message, const char *password);
504
my_bool check_scramble_323(const char *, const char *message,
505
                           unsigned long *salt);
506 507 508 509
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
510
void scramble(char *to, const char *message, const char *password);
511 512 513 514
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
515
char *octet2hex(char *to, const char *str, unsigned int len);
516 517 518

/* end of password.c */

519
char *get_tty_password(const char *opt_message);
520
const char *mysql_errno_to_sqlstate(unsigned int mysql_errno);
unknown's avatar
unknown committed
521 522 523

/* Some other useful functions */

unknown's avatar
unknown committed
524
my_bool my_thread_init(void);
525
void my_thread_end(void);
unknown's avatar
unknown committed
526

unknown's avatar
SCRUM  
unknown committed
527 528
#ifdef _global_h
ulong STDCALL net_field_length(uchar **packet);
unknown's avatar
SCRUM  
unknown committed
529
my_ulonglong net_field_length_ll(uchar **packet);
530
uchar *net_store_length(uchar *pkg, ulonglong length);
unknown's avatar
SCRUM  
unknown committed
531 532
#endif

unknown's avatar
unknown committed
533 534 535 536
#ifdef __cplusplus
}
#endif

unknown's avatar
unknown committed
537
#define NULL_LENGTH ((unsigned long) ~0) /* For net_store_length */
unknown's avatar
unknown committed
538
#define MYSQL_STMT_HEADER       4
539
#define MYSQL_LONG_DATA_HEADER  6
unknown's avatar
unknown committed
540

541
#define NOT_FIXED_DEC           31
unknown's avatar
unknown committed
542
#endif