~drizzle-trunk/drizzle/development

/* -*- mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-

 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:

 *

 *  Copyright (C) 2008 Sun Microsystems, Inc.

 *

 *  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

 *  the Free Software Foundation; version 2 of the License.

 *

 *  This program is distributed in the hope that it will be useful,

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

 *  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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

 */

/*

** Common definition between mysql server & client

*/

#ifndef DRIZZLED_DRIZZLE_COMMON_H

#define DRIZZLED_DRIZZLE_COMMON_H

#include <unistd.h>

#include <stdint.h>

#include <drizzled/korr.h>

#if !defined(__cplusplus)

# include <stdbool.h>

#endif

/*

   This is included in the server and in the client.

   Options for select set by the yacc parser (stored in lex->options).

   XXX:

   log_event.h defines OPTIONS_WRITTEN_TO_BIN_LOG to specify what THD

   options list are written into binlog. These options can NOT change their

   values, or it will break replication between version.

   context is encoded as following:

   SELECT - SELECT_LEX_NODE::options

   THD    - THD::options

   intern - neither. used only as

            func(..., select_node->options | thd->options | OPTION_XXX, ...)

   TODO: separate three contexts above, move them to separate bitfields.

*/

#define SELECT_DISTINCT         (UINT64_C(1) << 0)     // SELECT, user

#define SELECT_STRAIGHT_JOIN    (UINT64_C(1) << 1)     // SELECT, user

#define SELECT_DESCRIBE         (UINT64_C(1) << 2)     // SELECT, user

#define SELECT_SMALL_RESULT     (UINT64_C(1) << 3)     // SELECT, user

#define SELECT_BIG_RESULT       (UINT64_C(1) << 4)     // SELECT, user

#define OPTION_FOUND_ROWS       (UINT64_C(1) << 5)     // SELECT, user

#define SELECT_NO_JOIN_CACHE    (UINT64_C(1) << 7)     // intern

#define OPTION_BIG_TABLES       (UINT64_C(1) << 8)     // THD, user

#define OPTION_BIG_SELECTS      (UINT64_C(1) << 9)     // THD, user

#define OPTION_LOG_OFF          (UINT64_C(1) << 10)    // THD, user

#define OPTION_QUOTE_SHOW_CREATE (UINT64_C(1) << 11)   // THD, user, unused

#define TMP_TABLE_ALL_COLUMNS   (UINT64_C(1) << 12)    // SELECT, intern

#define OPTION_WARNINGS         (UINT64_C(1) << 13)    // THD, user

#define OPTION_AUTO_IS_NULL     (UINT64_C(1) << 14)    // THD, user, binlog

#define OPTION_FOUND_COMMENT    (UINT64_C(1) << 15)    // SELECT, intern, parser

#define OPTION_SAFE_UPDATES     (UINT64_C(1) << 16)    // THD, user

#define OPTION_BUFFER_RESULT    (UINT64_C(1) << 17)    // SELECT, user

#define OPTION_BIN_LOG          (UINT64_C(1) << 18)    // THD, user

#define OPTION_NOT_AUTOCOMMIT   (UINT64_C(1) << 19)    // THD, user

#define OPTION_BEGIN            (UINT64_C(1) << 20)    // THD, intern

#define OPTION_TABLE_LOCK       (UINT64_C(1) << 21)    // THD, intern

#define OPTION_QUICK            (UINT64_C(1) << 22)    // SELECT (for DELETE)

#define OPTION_KEEP_LOG         (UINT64_C(1) << 23)    // THD, user

/* The following is used to detect a conflict with DISTINCT */

#define SELECT_ALL              (UINT64_C(1) << 24)    // SELECT, user, parser

/** The following can be set when importing tables in a 'wrong order'

   to suppress foreign key checks */

#define OPTION_NO_FOREIGN_KEY_CHECKS    (UINT64_C(1) << 26) // THD, user, binlog

/** The following speeds up inserts to InnoDB tables by suppressing unique

   key checks in some cases */

#define OPTION_RELAXED_UNIQUE_CHECKS    (UINT64_C(1) << 27) // THD, user, binlog

#define SELECT_NO_UNLOCK                (UINT64_C(1) << 28) // SELECT, intern

#define OPTION_SCHEMA_TABLE             (UINT64_C(1) << 29) // SELECT, intern

/** Flag set if setup_tables already done */

#define OPTION_SETUP_TABLES_DONE        (UINT64_C(1) << 30) // intern

/** If not set then the thread will ignore all warnings with level notes. */

#define OPTION_SQL_NOTES                (UINT64_C(1) << 31) // THD, user

/**

  Force the used temporary table to be a MyISAM table (because we will use

  fulltext functions when reading from it.

*/

#define TMP_TABLE_FORCE_MYISAM          (UINT64_C(1) << 32)

#define OPTION_PROFILING                (UINT64_C(1) << 33)

/*

  Dont report errors for individual rows,

  But just report error on commit (or read ofcourse)

*/

#define OPTION_ALLOW_BATCH              (UINT64_C(1) << 33) // THD, intern (slave)

/**

  Maximum length of time zone name that we support

  (Time zone name is char(64) in db). mysqlbinlog needs it.

*/

#define MAX_TIME_ZONE_NAME_LENGTH       (NAME_LEN + 1)

#define HOSTNAME_LENGTH 60

#define SYSTEM_CHARSET_MBMAXLEN 4

#define USERNAME_CHAR_LENGTH 16

#define NAME_CHAR_LEN	64              /* Field/table name length */

#define NAME_LEN                (NAME_CHAR_LEN*SYSTEM_CHARSET_MBMAXLEN)

#define USERNAME_LENGTH         (USERNAME_CHAR_LENGTH*SYSTEM_CHARSET_MBMAXLEN)

#define SERVER_VERSION_LENGTH 60

#define SQLSTATE_LENGTH 5

/*

  Maximum length of comments

*/

#define TABLE_COMMENT_MAXLEN 2048

#define COLUMN_COMMENT_MAXLEN 1024

#define INDEX_COMMENT_MAXLEN 1024

/* The length of the header part for each virtual column in the .frm file. */

#define FRM_VCOL_HEADER_SIZE 3

/*

  Maximum length of the expression statement defined for virtual columns.

*/

#define VIRTUAL_COLUMN_EXPRESSION_MAXLEN 255 - FRM_VCOL_HEADER_SIZE

/*

  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

*/

#define USER_HOST_BUFF_SIZE HOSTNAME_LENGTH + USERNAME_LENGTH + 2

#define LOCAL_HOST	"localhost"

#define LOCAL_HOST_NAMEDPIPE "."

/*

  You should add new commands to the end of this list, otherwise old

  servers won't be able to handle them as 'unsupported'.

*/

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_PROCESS_INFO, COM_CONNECT, COM_PROCESS_KILL, COM_PING,

  COM_TIME, COM_CHANGE_USER, COM_BINLOG_DUMP,

  COM_CONNECT_OUT, COM_REGISTER_SLAVE,

  COM_SET_OPTION, COM_DAEMON,

  /* don't forget to update const char *command_name[] in sql_parse.cc */

  /* Must be last */

  COM_END

};

/*

  Length of random string sent by server on handshake; this is also length of

  obfuscated password, recieved from client

*/

#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)

#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 DECIMAL_FLAG	64		/* Field is zerofill */

#define BINARY_FLAG	128		/* Field is binary   */

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

#define NO_DEFAULT_VALUE_FLAG 4096	/* Field doesn't have default value */

#define ON_UPDATE_NOW_FLAG 8192         /* Field is set to NOW on UPDATE */

#define NUM_FLAG	32768		/* Field is num (for clients) */

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

#define BINCMP_FLAG	131072		/* Intern: Used by sql_yacc */

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

#define FIELD_IN_ADD_INDEX (1<< 20)	/* Intern: Field used in ADD INDEX */

#define FIELD_IS_RENAMED (1<< 21)       /* Intern: Field is being renamed */

#define FIELD_STORAGE_FLAGS 22          /* Storage type: bit 22, 23 and 24 */

#define COLUMN_FORMAT_FLAGS 25          /* Column format: bit 25, 26 and 27 */

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

#define REFRESH_THREADS		32	/* Flush thread cache */

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

/* RESET (remove all queries) from query cache */

#define REFRESH_QUERY_CACHE	65536

#define REFRESH_QUERY_CACHE_FREE 0x20000L /* pack query cache */

#define REFRESH_DES_KEY_FILE	0x40000L

#define REFRESH_USER_RESOURCES	0x80000L

#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 '(' */

#define UNUSED_CLIENT_PROTOCOL_41	512	/* New 4.1 protocol */

#define CLIENT_INTERACTIVE	1024	/* This is an interactive client */

#define CLIENT_SSL              2048	/* Switch to SSL after handshake */

#define CLIENT_IGNORE_SIGPIPE   4096    /* IGNORE sigpipes */

#define CLIENT_TRANSACTIONS	8192	/* Client knows about transactions */

#define CLIENT_RESERVED         16384   /* Old flag for 4.1 protocol  */

#define CLIENT_SECURE_CONNECTION 32768  /* New 4.1 authentication */

#define CLIENT_MULTI_STATEMENTS (1UL << 16) /* Enable/disable multi-stmt support */

#define CLIENT_MULTI_RESULTS    (1UL << 17) /* Enable/disable multi-results */

#define CLIENT_SSL_VERIFY_SERVER_CERT (1UL << 30)

#define CLIENT_REMEMBER_OPTIONS (1UL << 31)

/* 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_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)

#define SERVER_STATUS_IN_TRANS     1	/* Transaction has started */

#define SERVER_STATUS_AUTOCOMMIT   2	/* Server in auto_commit mode */

#define SERVER_MORE_RESULTS_EXISTS 8    /* Multi query - next query exists */

#define SERVER_QUERY_NO_GOOD_INDEX_USED 16

#define SERVER_QUERY_NO_INDEX_USED      32

/*

  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.

*/

#define SERVER_STATUS_CURSOR_EXISTS 64

/*

  This flag is sent when a read-only cursor is exhausted, in reply to

  COM_STMT_FETCH command.

*/

#define SERVER_STATUS_LAST_ROW_SENT 128

#define SERVER_STATUS_DB_DROPPED        256 /* A database was dropped */

#define SERVER_STATUS_NO_BACKSLASH_ESCAPES 512

/*

  Tell clients that this query was logged to the slow query log.

  Not yet set in the server, but interface is defined for applications

  to use.  See WorkLog 4098.

*/

#define SERVER_QUERY_WAS_SLOW           1024

#define DRIZZLE_ERRMSG_SIZE	512

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

#define ONLY_KILL_QUERY         1

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

#define MAX_CHAR_WIDTH		255	/* Max length for a CHAR colum */

#define MAX_BLOB_WIDTH		16777216	/* Default width for blob */

#define DRIZZLE_PROTOCOL_NO_MORE_DATA 0xFE

#define packet_error (~(uint32_t) 0)

/* Shutdown/kill enums and constants */

/* Bits for THD::killable. */

#define DRIZZLE_SHUTDOWN_KILLABLE_CONNECT    (unsigned char)(1 << 0)

#define DRIZZLE_SHUTDOWN_KILLABLE_TRANS      (unsigned char)(1 << 1)

#define DRIZZLE_SHUTDOWN_KILLABLE_LOCK_TABLE (unsigned char)(1 << 2)

#define DRIZZLE_SHUTDOWN_KILLABLE_UPDATE     (unsigned char)(1 << 3)

/* Start TINY at 1 because we removed DECIMAL from off the front of the enum */

enum enum_field_types { DRIZZLE_TYPE_TINY,

                        DRIZZLE_TYPE_LONG,

                        DRIZZLE_TYPE_DOUBLE,

                        DRIZZLE_TYPE_NULL,

                        DRIZZLE_TYPE_TIMESTAMP,

                        DRIZZLE_TYPE_LONGLONG,

                        DRIZZLE_TYPE_TIME,

                        DRIZZLE_TYPE_DATETIME,

                        DRIZZLE_TYPE_DATE,

                        DRIZZLE_TYPE_VARCHAR,

                        DRIZZLE_TYPE_VIRTUAL,

                        DRIZZLE_TYPE_NEWDECIMAL,

                        DRIZZLE_TYPE_ENUM,

                        DRIZZLE_TYPE_BLOB,

                        DRIZZLE_TYPE_MAX=DRIZZLE_TYPE_BLOB

};

enum enum_cursor_type

{

  CURSOR_TYPE_NO_CURSOR= 0,

  CURSOR_TYPE_READ_ONLY= 1,

  CURSOR_TYPE_FOR_UPDATE= 2,

  CURSOR_TYPE_SCROLLABLE= 4

};

/* options for mysql_set_option */

enum enum_drizzle_set_option

{

  DRIZZLE_OPTION_MULTI_STATEMENTS_ON,

  DRIZZLE_OPTION_MULTI_STATEMENTS_OFF

};

#define net_new_transaction(net) ((net)->pkt_nr=0)

  /* The following is for user defined functions */

enum Item_result {STRING_RESULT=0, REAL_RESULT, INT_RESULT, ROW_RESULT,

                  DECIMAL_RESULT};

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

  char **attributes;                    /* Pointer to attribute name */

  unsigned long *attribute_lengths;     /* Length of attribute arguments */

  void *extension;

} UDF_ARGS;

  /* This holds information about the result */

typedef struct st_udf_init

{

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

  bool const_item;          /* 1 if function always returns the same value */

  void *extension;

} UDF_INIT;

/*

  TODO: add a notion for determinism of the UDF.

  See Item_udf_func::update_used_tables ()

*/

  /* Constants when using compression */

#define NET_HEADER_SIZE 4		/* standard header size */

#define COMP_HEADER_SIZE 3		/* compression header extra size */

#define NULL_LENGTH UINT32_MAX /* For net_store_length */

#endif