sql_class.h 115 KB
Newer Older
Marc Alff's avatar
Marc Alff committed
1
/* Copyright (C) 2000-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
unknown's avatar
unknown committed
2

unknown's avatar
unknown committed
3 4
   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

unknown's avatar
unknown committed
7 8 9 10
   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.
unknown's avatar
unknown committed
11

unknown's avatar
unknown committed
12 13 14 15 16
   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 */


17 18 19
#ifndef SQL_CLASS_INCLUDED
#define SQL_CLASS_INCLUDED

unknown's avatar
unknown committed
20 21
/* Classes in mysql */

22
#ifdef USE_PRAGMA_INTERFACE
unknown's avatar
unknown committed
23 24 25
#pragma interface			/* gcc class implementation */
#endif

26
#include "my_global.h"                          /* NO_EMBEDDED_ACCESS_CHECKS */
27 28 29 30
#ifdef MYSQL_SERVER
#include "unireg.h"                    // REQUIRED: for other includes
#endif
#include "sql_const.h"
31
#include <mysql/plugin_audit.h>
32 33
#include "log.h"
#include "rpl_tblmap.h"
34
#include "mdl.h"
35 36 37 38 39 40 41
#include "sql_locale.h"                         /* my_locale_st */
#include "sql_profile.h"                   /* PROFILING */
#include "scheduler.h"                     /* thd_scheduler */
#include "protocol.h"             /* Protocol_text, Protocol_binary */
#include "violite.h"              /* vio_is_connected */
#include "thr_lock.h"             /* thr_lock_type, THR_LOCK_DATA,
                                     THR_LOCK_INFO, THR_LOCK_OWNER */
42

unknown's avatar
unknown committed
43

44
class Reprepare_observer;
45
class Relay_log_info;
46

unknown's avatar
unknown committed
47 48
class Query_log_event;
class Load_log_event;
49
class Slave_log_event;
50
class sp_rcontext;
51
class sp_cache;
52
class Parser_state;
53
class Rows_log_event;
Konstantin Osipov's avatar
Konstantin Osipov committed
54
class Sroutine_hash_entry;
55 56
class User_level_lock;
class user_var_entry;
unknown's avatar
unknown committed
57

58
enum enum_enable_or_disable { LEAVE_AS_IS, ENABLE, DISABLE };
59
enum enum_ha_read_modes { RFIRST, RNEXT, RPREV, RLAST, RKEY, RNEXT_SAME };
60
enum enum_duplicates { DUP_ERROR, DUP_REPLACE, DUP_UPDATE };
61 62
enum enum_delay_key_write { DELAY_KEY_WRITE_NONE, DELAY_KEY_WRITE_ON,
			    DELAY_KEY_WRITE_ALL };
63 64 65
enum enum_slave_exec_mode { SLAVE_EXEC_MODE_STRICT,
                            SLAVE_EXEC_MODE_IDEMPOTENT,
                            SLAVE_EXEC_MODE_LAST_BIT};
unknown's avatar
unknown committed
66 67
enum enum_slave_type_conversions { SLAVE_TYPE_CONVERSIONS_ALL_LOSSY,
                                   SLAVE_TYPE_CONVERSIONS_ALL_NON_LOSSY};
68 69
enum enum_mark_columns
{ MARK_COLUMNS_NONE, MARK_COLUMNS_READ, MARK_COLUMNS_WRITE};
70
enum enum_filetype { FILETYPE_CSV, FILETYPE_XML };
71

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
/* Bits for different SQL modes modes (including ANSI mode) */
#define MODE_REAL_AS_FLOAT              1
#define MODE_PIPES_AS_CONCAT            2
#define MODE_ANSI_QUOTES                4
#define MODE_IGNORE_SPACE               8
#define MODE_NOT_USED                   16
#define MODE_ONLY_FULL_GROUP_BY         32
#define MODE_NO_UNSIGNED_SUBTRACTION    64
#define MODE_NO_DIR_IN_CREATE           128
#define MODE_POSTGRESQL                 256
#define MODE_ORACLE                     512
#define MODE_MSSQL                      1024
#define MODE_DB2                        2048
#define MODE_MAXDB                      4096
#define MODE_NO_KEY_OPTIONS             8192
#define MODE_NO_TABLE_OPTIONS           16384
#define MODE_NO_FIELD_OPTIONS           32768
#define MODE_MYSQL323                   65536L
#define MODE_MYSQL40                    (MODE_MYSQL323*2)
#define MODE_ANSI                       (MODE_MYSQL40*2)
#define MODE_NO_AUTO_VALUE_ON_ZERO      (MODE_ANSI*2)
#define MODE_NO_BACKSLASH_ESCAPES       (MODE_NO_AUTO_VALUE_ON_ZERO*2)
#define MODE_STRICT_TRANS_TABLES        (MODE_NO_BACKSLASH_ESCAPES*2)
#define MODE_STRICT_ALL_TABLES          (MODE_STRICT_TRANS_TABLES*2)
#define MODE_NO_ZERO_IN_DATE            (MODE_STRICT_ALL_TABLES*2)
#define MODE_NO_ZERO_DATE               (MODE_NO_ZERO_IN_DATE*2)
#define MODE_INVALID_DATES              (MODE_NO_ZERO_DATE*2)
#define MODE_ERROR_FOR_DIVISION_BY_ZERO (MODE_INVALID_DATES*2)
#define MODE_TRADITIONAL                (MODE_ERROR_FOR_DIVISION_BY_ZERO*2)
#define MODE_NO_AUTO_CREATE_USER        (MODE_TRADITIONAL*2)
#define MODE_HIGH_NOT_PRECEDENCE        (MODE_NO_AUTO_CREATE_USER*2)
#define MODE_NO_ENGINE_SUBSTITUTION     (MODE_HIGH_NOT_PRECEDENCE*2)
#define MODE_PAD_CHAR_TO_FULL_LENGTH    (ULL(1) << 31)

unknown's avatar
unknown committed
106
extern char internal_table_name[2];
107
extern char empty_c_string[1];
108
extern MYSQL_PLUGIN_IMPORT const char **errmesg;
unknown's avatar
unknown committed
109

110 111
extern bool volatile shutdown_in_progress;

112 113 114 115 116 117 118
#define TC_LOG_PAGE_SIZE   8192
#define TC_LOG_MIN_SIZE    (3*TC_LOG_PAGE_SIZE)

#define TC_HEURISTIC_RECOVER_COMMIT   1
#define TC_HEURISTIC_RECOVER_ROLLBACK 2
extern uint tc_heuristic_recover;

unknown's avatar
unknown committed
119 120 121 122 123 124 125
typedef struct st_user_var_events
{
  user_var_entry *user_var_event;
  char *value;
  ulong length;
  Item_result type;
  uint charset_number;
126
  bool unsigned_flag;
unknown's avatar
unknown committed
127 128
} BINLOG_USER_VAR_EVENT;

129 130 131
#define RP_LOCK_LOG_IS_ALREADY_LOCKED 1
#define RP_FORCE_ROTATE               2

132 133 134 135 136 137 138 139 140 141 142 143
/*
  The COPY_INFO structure is used by INSERT/REPLACE code.
  The schema of the row counting by the INSERT/INSERT ... ON DUPLICATE KEY
  UPDATE code:
    If a row is inserted then the copied variable is incremented.
    If a row is updated by the INSERT ... ON DUPLICATE KEY UPDATE and the
      new data differs from the old one then the copied and the updated
      variables are incremented.
    The touched variable is incremented if a row was touched by the update part
      of the INSERT ... ON DUPLICATE KEY UPDATE no matter whether the row
      was actually changed or not.
*/
unknown's avatar
unknown committed
144
typedef struct st_copy_info {
unknown's avatar
unknown committed
145 146 147 148
  ha_rows records; /**< Number of processed records */
  ha_rows deleted; /**< Number of deleted records */
  ha_rows updated; /**< Number of updated records */
  ha_rows copied;  /**< Number of copied records */
149
  ha_rows error_count;
150
  ha_rows touched; /* Number of touched records */
unknown's avatar
unknown committed
151
  enum enum_duplicates handle_duplicates;
152
  int escape_char, last_errno;
153 154
  bool ignore;
  /* for INSERT ... UPDATE */
155 156
  List<Item> *update_fields;
  List<Item> *update_values;
unknown's avatar
unknown committed
157
  /* for VIEW ... WITH CHECK OPTION */
unknown's avatar
unknown committed
158
  TABLE_LIST *view;
unknown's avatar
unknown committed
159 160 161
} COPY_INFO;


unknown's avatar
unknown committed
162
class Key_part_spec :public Sql_alloc {
unknown's avatar
unknown committed
163
public:
164
  LEX_STRING field_name;
unknown's avatar
unknown committed
165
  uint length;
166 167 168 169 170 171
  Key_part_spec(const LEX_STRING &name, uint len)
    : field_name(name), length(len)
  {}
  Key_part_spec(const char *name, const size_t name_len, uint len)
    : length(len)
  { field_name.str= (char *)name; field_name.length= name_len; }
unknown's avatar
unknown committed
172
  bool operator==(const Key_part_spec& other) const;
173
  /**
unknown's avatar
unknown committed
174
    Construct a copy of this Key_part_spec. field_name is copied
175 176 177 178 179 180 181
    by-pointer as it is known to never change. At the same time
    'length' may be reset in mysql_prepare_create_table, and this
    is why we supply it with a copy.

    @return If out of memory, 0 is returned and an error is set in
    THD.
  */
unknown's avatar
unknown committed
182 183
  Key_part_spec *clone(MEM_ROOT *mem_root) const
  { return new (mem_root) Key_part_spec(*this); }
unknown's avatar
unknown committed
184 185 186 187 188 189 190 191 192 193
};


class Alter_drop :public Sql_alloc {
public:
  enum drop_type {KEY, COLUMN };
  const char *name;
  enum drop_type type;
  Alter_drop(enum drop_type par_type,const char *par_name)
    :name(par_name), type(par_type) {}
194 195
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
196
    @sa comment for Key_part_spec::clone
197 198 199
  */
  Alter_drop *clone(MEM_ROOT *mem_root) const
    { return new (mem_root) Alter_drop(*this); }
unknown's avatar
unknown committed
200 201 202 203 204 205 206 207 208
};


class Alter_column :public Sql_alloc {
public:
  const char *name;
  Item *def;
  Alter_column(const char *par_name,Item *literal)
    :name(par_name), def(literal) {}
209 210
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
211
    @sa comment for Key_part_spec::clone
212 213 214
  */
  Alter_column *clone(MEM_ROOT *mem_root) const
    { return new (mem_root) Alter_column(*this); }
unknown's avatar
unknown committed
215 216 217 218 219
};


class Key :public Sql_alloc {
public:
220
  enum Keytype { PRIMARY, UNIQUE, MULTIPLE, FULLTEXT, SPATIAL, FOREIGN_KEY};
unknown's avatar
unknown committed
221
  enum Keytype type;
unknown's avatar
unknown committed
222
  KEY_CREATE_INFO key_create_info;
unknown's avatar
unknown committed
223
  List<Key_part_spec> columns;
224
  LEX_STRING name;
225
  bool generated;
unknown's avatar
unknown committed
226

227
  Key(enum Keytype type_par, const LEX_STRING &name_arg,
228
      KEY_CREATE_INFO *key_info_arg,
unknown's avatar
unknown committed
229
      bool generated_arg, List<Key_part_spec> &cols)
unknown's avatar
unknown committed
230 231
    :type(type_par), key_create_info(*key_info_arg), columns(cols),
    name(name_arg), generated(generated_arg)
232
  {}
233 234 235 236 237 238 239 240 241
  Key(enum Keytype type_par, const char *name_arg, size_t name_len_arg,
      KEY_CREATE_INFO *key_info_arg, bool generated_arg,
      List<Key_part_spec> &cols)
    :type(type_par), key_create_info(*key_info_arg), columns(cols),
    generated(generated_arg)
  {
    name.str= (char *)name_arg;
    name.length= name_len_arg;
  }
242 243
  Key(const Key &rhs, MEM_ROOT *mem_root);
  virtual ~Key() {}
244
  /* Equality comparison of keys (ignoring name) */
245
  friend bool foreign_key_prefix(Key *a, Key *b);
246 247
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
248
    @sa comment for Key_part_spec::clone
249 250 251
  */
  virtual Key *clone(MEM_ROOT *mem_root) const
    { return new (mem_root) Key(*this, mem_root); }
unknown's avatar
unknown committed
252 253
};

254 255
class Table_ident;

unknown's avatar
unknown committed
256
class Foreign_key: public Key {
257 258 259 260 261 262 263
public:
  enum fk_match_opt { FK_MATCH_UNDEF, FK_MATCH_FULL,
		      FK_MATCH_PARTIAL, FK_MATCH_SIMPLE};
  enum fk_option { FK_OPTION_UNDEF, FK_OPTION_RESTRICT, FK_OPTION_CASCADE,
		   FK_OPTION_SET_NULL, FK_OPTION_NO_ACTION, FK_OPTION_DEFAULT};

  Table_ident *ref_table;
unknown's avatar
unknown committed
264
  List<Key_part_spec> ref_columns;
265
  uint delete_opt, update_opt, match_opt;
266
  Foreign_key(const LEX_STRING &name_arg, List<Key_part_spec> &cols,
unknown's avatar
unknown committed
267
	      Table_ident *table,   List<Key_part_spec> &ref_cols,
268
	      uint delete_opt_arg, uint update_opt_arg, uint match_opt_arg)
269
    :Key(FOREIGN_KEY, name_arg, &default_key_create_info, 0, cols),
270
    ref_table(table), ref_columns(ref_cols),
271 272 273
    delete_opt(delete_opt_arg), update_opt(update_opt_arg),
    match_opt(match_opt_arg)
  {}
unknown's avatar
unknown committed
274
  Foreign_key(const Foreign_key &rhs, MEM_ROOT *mem_root);
275 276
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
277
    @sa comment for Key_part_spec::clone
278 279
  */
  virtual Key *clone(MEM_ROOT *mem_root) const
unknown's avatar
unknown committed
280
  { return new (mem_root) Foreign_key(*this, mem_root); }
281
};
unknown's avatar
unknown committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298

typedef struct st_mysql_lock
{
  TABLE **table;
  uint table_count,lock_count;
  THR_LOCK_DATA **locks;
} MYSQL_LOCK;


class LEX_COLUMN : public Sql_alloc
{
public:
  String column;
  uint rights;
  LEX_COLUMN (const String& x,const  uint& y ): column (x),rights (y) {}
};

299 300
class MY_LOCALE;

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
/**
  Query_cache_tls -- query cache thread local data.
*/

struct Query_cache_block;

struct Query_cache_tls
{
  /*
    'first_query_block' should be accessed only via query cache
    functions and methods to maintain proper locking.
  */
  Query_cache_block *first_query_block;
  void set_first_query_block(Query_cache_block *first_query_block_arg)
  {
    first_query_block= first_query_block_arg;
  }

  Query_cache_tls() :first_query_block(NULL) {}
};

Marc Alff's avatar
Marc Alff committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
/* SIGNAL / RESIGNAL / GET DIAGNOSTICS */

/**
  This enumeration list all the condition item names of a condition in the
  SQL condition area.
*/
typedef enum enum_diag_condition_item_name
{
  /*
    Conditions that can be set by the user (SIGNAL/RESIGNAL),
    and by the server implementation.
  */

  DIAG_CLASS_ORIGIN= 0,
  FIRST_DIAG_SET_PROPERTY= DIAG_CLASS_ORIGIN,
  DIAG_SUBCLASS_ORIGIN= 1,
  DIAG_CONSTRAINT_CATALOG= 2,
  DIAG_CONSTRAINT_SCHEMA= 3,
  DIAG_CONSTRAINT_NAME= 4,
  DIAG_CATALOG_NAME= 5,
  DIAG_SCHEMA_NAME= 6,
  DIAG_TABLE_NAME= 7,
  DIAG_COLUMN_NAME= 8,
  DIAG_CURSOR_NAME= 9,
  DIAG_MESSAGE_TEXT= 10,
  DIAG_MYSQL_ERRNO= 11,
  LAST_DIAG_SET_PROPERTY= DIAG_MYSQL_ERRNO
} Diag_condition_item_name;

/**
  Name of each diagnostic condition item.
  This array is indexed by Diag_condition_item_name.
*/
extern const LEX_STRING Diag_condition_item_names[];

unknown's avatar
unknown committed
357 358
#include "sql_lex.h"				/* Must be here */

359
class Delayed_insert;
unknown's avatar
unknown committed
360
class select_result;
361
class Time_zone;
unknown's avatar
unknown committed
362

363 364 365 366 367
#define THD_SENTRY_MAGIC 0xfeedd1ff
#define THD_SENTRY_GONE  0xdeadbeef

#define THD_CHECK_SENTRY(thd) DBUG_ASSERT(thd->dbug_sentry == THD_SENTRY_MAGIC)

368
typedef struct system_variables
369
{
unknown's avatar
unknown committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383
  /*
    How dynamically allocated system variables are handled:
    
    The global_system_variables and max_system_variables are "authoritative"
    They both should have the same 'version' and 'size'.
    When attempting to access a dynamic variable, if the session version
    is out of date, then the session version is updated and realloced if
    neccessary and bytes copied from global to make up for missing data.
  */ 
  ulong dynamic_variables_version;
  char* dynamic_variables_ptr;
  uint dynamic_variables_head;  /* largest valid variable offset */
  uint dynamic_variables_size;  /* how many bytes are in use */
  
384 385
  ulonglong max_heap_table_size;
  ulonglong tmp_table_size;
386
  ulonglong long_query_time;
387 388 389
  ulonglong optimizer_switch;
  ulonglong sql_mode; ///< which non-standard SQL behaviour should be enabled
  ulonglong option_bits; ///< OPTION_xxx constants, e.g. OPTION_PROFILING
390 391
  ha_rows select_limit;
  ha_rows max_join_size;
392
  ulong auto_increment_increment, auto_increment_offset;
unknown's avatar
unknown committed
393
  ulong bulk_insert_buff_size;
394
  ulong join_buff_size;
395
  ulong lock_wait_timeout;
unknown's avatar
unknown committed
396
  ulong max_allowed_packet;
397
  ulong max_error_count;
unknown's avatar
unknown committed
398
  ulong max_length_for_sort_data;
399
  ulong max_sort_length;
400
  ulong max_tmp_tables;
401
  ulong max_insert_delayed_threads;
402
  ulong min_examined_row_limit;
unknown's avatar
unknown committed
403
  ulong multi_range_count;
unknown's avatar
unknown committed
404
  ulong net_buffer_length;
405
  ulong net_interactive_timeout;
unknown's avatar
unknown committed
406
  ulong net_read_timeout;
407
  ulong net_retry_count;
408
  ulong net_wait_timeout;
unknown's avatar
unknown committed
409
  ulong net_write_timeout;
410 411
  ulong optimizer_prune_level;
  ulong optimizer_search_depth;
unknown's avatar
unknown committed
412
  ulong preload_buff_size;
413
  ulong profiling_history_size;
unknown's avatar
unknown committed
414 415
  ulong read_buff_size;
  ulong read_rnd_buff_size;
unknown's avatar
unknown committed
416
  ulong div_precincrement;
417
  ulong sortbuff_size;
418
  ulong max_sp_recursion_depth;
unknown's avatar
unknown committed
419
  ulong default_week_format;
420
  ulong max_seeks_for_key;
421 422 423 424 425
  ulong range_alloc_block_size;
  ulong query_alloc_block_size;
  ulong query_prealloc_size;
  ulong trans_alloc_block_size;
  ulong trans_prealloc_size;
426
  ulong log_warnings;
427
  ulong group_concat_max_len;
428 429

  uint binlog_format; ///< binlog format for this thd (see enum_binlog_format)
430
  my_bool binlog_direct_non_trans_update;
431
  my_bool sql_log_bin;
432 433 434 435 436 437
  uint completion_type;
  uint query_cache_type;
  uint tx_isolation;
  uint updatable_views_with_limit;
  uint max_user_connections;
  /**
unknown's avatar
unknown committed
438 439 440
    In slave thread we need to know in behalf of which
    thread the query is being run to replicate temp tables properly
  */
unknown's avatar
unknown committed
441
  my_thread_id pseudo_thread_id;
unknown's avatar
unknown committed
442

unknown's avatar
unknown committed
443 444
  my_bool low_priority_updates;
  my_bool new_mode;
445
  my_bool query_cache_wlock_invalidate;
unknown's avatar
unknown committed
446
  my_bool engine_condition_pushdown;
unknown's avatar
unknown committed
447
  my_bool keep_files_on_create;
448

unknown's avatar
unknown committed
449
  my_bool old_alter_table;
450
  my_bool old_passwords;
451
  my_bool big_tables;
452

unknown's avatar
unknown committed
453
  plugin_ref table_plugin;
unknown's avatar
unknown committed
454

455
  /* Only charset part of these variables is sensible */
unknown's avatar
unknown committed
456
  CHARSET_INFO  *character_set_filesystem;
457
  CHARSET_INFO  *character_set_client;
458
  CHARSET_INFO  *character_set_results;
459

460 461 462
  /* Both charset and collation parts of these variables are important */
  CHARSET_INFO	*collation_server;
  CHARSET_INFO	*collation_database;
unknown's avatar
unknown committed
463
  CHARSET_INFO  *collation_connection;
464

465 466
  /* Error messages */
  MY_LOCALE *lc_messages;
unknown's avatar
unknown committed
467 468 469
  /* Locale Support */
  MY_LOCALE *lc_time_names;

470 471
  Time_zone *time_zone;

472
  my_bool sysdate_is_now;
473 474 475

  double long_query_time_double;
} SV;
unknown's avatar
unknown committed
476

477 478 479 480 481

/* per thread status variables */

typedef struct system_status_var
{
482 483
  ulonglong bytes_received;
  ulonglong bytes_sent;
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
  ulong com_other;
  ulong com_stat[(uint) SQLCOM_END];
  ulong created_tmp_disk_tables;
  ulong created_tmp_tables;
  ulong ha_commit_count;
  ulong ha_delete_count;
  ulong ha_read_first_count;
  ulong ha_read_last_count;
  ulong ha_read_key_count;
  ulong ha_read_next_count;
  ulong ha_read_prev_count;
  ulong ha_read_rnd_count;
  ulong ha_read_rnd_next_count;
  ulong ha_rollback_count;
  ulong ha_update_count;
  ulong ha_write_count;
500 501 502 503
  ulong ha_prepare_count;
  ulong ha_discover_count;
  ulong ha_savepoint_count;
  ulong ha_savepoint_rollback_count;
504 505 506 507 508 509 510 511 512 513 514 515

  /* KEY_CACHE parts. These are copies of the original */
  ulong key_blocks_changed;
  ulong key_blocks_used;
  ulong key_cache_r_requests;
  ulong key_cache_read;
  ulong key_cache_w_requests;
  ulong key_cache_write;
  /* END OF KEY_CACHE parts */

  ulong net_big_packet_count;
  ulong opened_tables;
unknown's avatar
unknown committed
516
  ulong opened_shares;
517 518 519 520 521 522 523 524 525 526
  ulong select_full_join_count;
  ulong select_full_range_join_count;
  ulong select_range_count;
  ulong select_range_check_count;
  ulong select_scan_count;
  ulong long_query_count;
  ulong filesort_merge_passes;
  ulong filesort_range_count;
  ulong filesort_rows;
  ulong filesort_scan_count;
527
  /* Prepared statements and binary protocol */
unknown's avatar
unknown committed
528
  ulong com_stmt_prepare;
unknown's avatar
unknown committed
529
  ulong com_stmt_reprepare;
unknown's avatar
unknown committed
530 531 532 533 534
  ulong com_stmt_execute;
  ulong com_stmt_send_long_data;
  ulong com_stmt_fetch;
  ulong com_stmt_reset;
  ulong com_stmt_close;
535
  /*
536 537 538 539 540 541 542 543
    Number of statements sent from the client
  */
  ulong questions;
  /*
    IMPORTANT!
    SEE last_system_status_var DEFINITION BELOW.
    Below 'last_system_status_var' are all variables which doesn't make any
    sense to add to the /global/ status variable counter.
544 545 546
    Status variables which it does not make sense to add to
    global status variable counter
  */
547
  double last_query_cost;
548 549 550
} STATUS_VAR;

/*
551 552 553
  This is used for 'SHOW STATUS'. It must be updated to the last ulong
  variable in system_status_var which is makes sens to add to the global
  counter
554 555
*/

556
#define last_system_status_var questions
557

unknown's avatar
unknown committed
558 559
void mark_transaction_to_rollback(THD *thd, bool all);

560 561
#ifdef MYSQL_SERVER

562
void free_tmp_table(THD *thd, TABLE *entry);
563 564


unknown's avatar
unknown committed
565 566
/* The following macro is to make init of Query_arena simpler */
#ifndef DBUG_OFF
unknown's avatar
unknown committed
567
#define INIT_ARENA_DBUG_INFO is_backup_arena= 0; is_reprepared= FALSE;
568 569
#else
#define INIT_ARENA_DBUG_INFO
unknown's avatar
unknown committed
570 571
#endif

unknown's avatar
unknown committed
572
class Query_arena
573 574 575 576 577 578 579
{
public:
  /*
    List of items created in the parser for this query. Every item puts
    itself to the list on creation (see Item::Item() for details))
  */
  Item *free_list;
unknown's avatar
unknown committed
580
  MEM_ROOT *mem_root;                   // Pointer to current memroot
unknown's avatar
unknown committed
581
#ifndef DBUG_OFF
582
  bool is_backup_arena; /* True if this arena is used for backup. */
unknown's avatar
unknown committed
583
  bool is_reprepared;
unknown's avatar
unknown committed
584
#endif
585 586 587 588 589 590 591
  /*
    The states relfects three diffrent life cycles for three
    different types of statements:
    Prepared statement: INITIALIZED -> PREPARED -> EXECUTED.
    Stored procedure:   INITIALIZED_FOR_SP -> EXECUTED.
    Other statements:   CONVENTIONAL_EXECUTION never changes.
  */
unknown's avatar
unknown committed
592
  enum enum_state
593
  {
594 595
    INITIALIZED= 0, INITIALIZED_FOR_SP= 1, PREPARED= 2,
    CONVENTIONAL_EXECUTION= 3, EXECUTED= 4, ERROR= -1
596
  };
unknown's avatar
unknown committed
597

unknown's avatar
unknown committed
598
  enum_state state;
599 600 601 602 603 604 605

  /* We build without RTTI, so dynamic_cast can't be used. */
  enum Type
  {
    STATEMENT, PREPARED_STATEMENT, STORED_PROCEDURE
  };

606 607
  Query_arena(MEM_ROOT *mem_root_arg, enum enum_state state_arg) :
    free_list(0), mem_root(mem_root_arg), state(state_arg)
608
  { INIT_ARENA_DBUG_INFO; }
609
  /*
unknown's avatar
unknown committed
610 611
    This constructor is used only when Query_arena is created as
    backup storage for another instance of Query_arena.
612
  */
613 614
  Query_arena() { INIT_ARENA_DBUG_INFO; }

615
  virtual Type type() const;
unknown's avatar
unknown committed
616
  virtual ~Query_arena() {};
617

618
  inline bool is_stmt_prepare() const { return state == INITIALIZED; }
619 620
  inline bool is_first_sp_execute() const
  { return state == INITIALIZED_FOR_SP; }
621 622
  inline bool is_stmt_prepare_or_first_sp_execute() const
  { return (int)state < (int)PREPARED; }
623 624
  inline bool is_stmt_prepare_or_first_stmt_execute() const
  { return (int)state <= (int)PREPARED; }
unknown's avatar
unknown committed
625
  inline bool is_first_stmt_execute() const { return state == PREPARED; }
626 627
  inline bool is_stmt_execute() const
  { return state == PREPARED || state == EXECUTED; }
unknown's avatar
unknown committed
628
  inline bool is_conventional() const
unknown's avatar
unknown committed
629
  { return state == CONVENTIONAL_EXECUTION; }
630

631 632
  inline void* alloc(size_t size) { return alloc_root(mem_root,size); }
  inline void* calloc(size_t size)
633
  {
634
    void *ptr;
unknown's avatar
unknown committed
635
    if ((ptr=alloc_root(mem_root,size)))
636
      bzero(ptr, size);
637 638 639
    return ptr;
  }
  inline char *strdup(const char *str)
unknown's avatar
unknown committed
640
  { return strdup_root(mem_root,str); }
641
  inline char *strmake(const char *str, size_t size)
unknown's avatar
unknown committed
642
  { return strmake_root(mem_root,str,size); }
643
  inline void *memdup(const void *str, size_t size)
unknown's avatar
unknown committed
644
  { return memdup_root(mem_root,str,size); }
645
  inline void *memdup_w_gap(const void *str, size_t size, uint gap)
646
  {
647 648
    void *ptr;
    if ((ptr= alloc_root(mem_root,size+gap)))
649 650 651 652
      memcpy(ptr,str,size);
    return ptr;
  }

unknown's avatar
unknown committed
653
  void set_query_arena(Query_arena *set);
654 655

  void free_items();
656 657
  /* Close the active state associated with execution of this statement */
  virtual void cleanup_stmt();
658 659
};

660

661
class Server_side_cursor;
662

663 664 665 666
/**
  @class Statement
  @brief State of a single command executed against this connection.

667 668 669 670 671 672 673 674 675 676 677 678
  One connection can contain a lot of simultaneously running statements,
  some of which could be:
   - prepared, that is, contain placeholders,
   - opened as cursors. We maintain 1 to 1 relationship between
     statement and cursor - if user wants to create another cursor for his
     query, we create another statement for it. 
  To perform some action with statement we reset THD part to the state  of
  that statement, do the action, and then save back modified state from THD
  to the statement. It will be changed in near future, and Statement will
  be used explicitly.
*/

679
class Statement: public ilink, public Query_arena
680
{
681 682
  Statement(const Statement &rhs);              /* not implemented: */
  Statement &operator=(const Statement &rhs);   /* non-copyable */
683 684
public:
  /*
unknown's avatar
unknown committed
685
    Uniquely identifies each statement object in thread scope; change during
686
    statement lifetime. FIXME: must be const
687
  */
unknown's avatar
unknown committed
688
   ulong id;
689 690

  /*
691 692 693 694 695 696 697 698 699
    MARK_COLUMNS_NONE:  Means mark_used_colums is not set and no indicator to
                        handler of fields used is set
    MARK_COLUMNS_READ:  Means a bit in read set is set to inform handler
	                that the field is to be read. If field list contains
                        duplicates, then thd->dup_field is set to point
                        to the last found duplicate.
    MARK_COLUMNS_WRITE: Means a bit is set in write set to inform handler
			that it needs to update this field in write_row
                        and update_row.
700
  */
701
  enum enum_mark_columns mark_used_columns;
702

703
  LEX_STRING name; /* name for named prepared statements */
704 705 706 707 708
  LEX *lex;                                     // parse tree descriptor
  /*
    Points to the query associated with this statement. It's const, but
    we need to declare it char * because all table handlers are written
    in C and need to point to it.
709

710 711 712 713
    Note that if we set query = NULL, we must at the same time set
    query_length = 0, and protect the whole operation with
    LOCK_thd_data mutex. To avoid crashes in races, if we do not
    know that thd->query cannot change at the moment, we should print
714
    thd->query like this:
715 716 717 718 719
      (1) reserve the LOCK_thd_data mutex;
      (2) print or copy the value of query and query_length
      (3) release LOCK_thd_data mutex.
    This printing is needed at least in SHOW PROCESSLIST and SHOW
    ENGINE INNODB STATUS.
720
  */
721
  LEX_STRING query_string;
722
  Server_side_cursor *cursor;
723

724 725 726 727
  inline char *query() { return query_string.str; }
  inline uint32 query_length() { return query_string.length; }
  void set_query_inner(char *query_arg, uint32 query_length_arg);

728 729 730 731 732 733 734 735 736 737 738 739 740 741
  /**
    Name of the current (default) database.

    If there is the current (default) database, "db" contains its name. If
    there is no current (default) database, "db" is NULL and "db_length" is
    0. In other words, "db", "db_length" must either be NULL, or contain a
    valid database name.

    @note this attribute is set and alloced by the slave SQL thread (for
    the THD of that thread); that thread is (and must remain, for now) the
    only responsible for freeing this member.
  */

  char *db;
742
  size_t db_length;
743

744 745
public:

unknown's avatar
unknown committed
746
  /* This constructor is called for backup statements */
747
  Statement() {}
748

749 750
  Statement(LEX *lex_arg, MEM_ROOT *mem_root_arg,
            enum enum_state state_arg, ulong id_arg);
751
  virtual ~Statement();
752 753

  /* Assign execution context (note: not all members) of given stmt to self */
754
  virtual void set_statement(Statement *stmt);
755 756
  void set_n_backup_statement(Statement *stmt, Statement *backup);
  void restore_backup_statement(Statement *stmt, Statement *backup);
757 758
  /* return class type */
  virtual Type type() const;
759 760 761
};


762
/**
763 764 765 766 767
  Container for all statements created/used in a connection.
  Statements in Statement_map have unique Statement::id (guaranteed by id
  assignment in Statement::Statement)
  Non-empty statement names are unique too: attempt to insert a new statement
  with duplicate name causes older statement to be deleted
768

769 770
  Statements are auto-deleted when they are removed from the map and when the
  map is deleted.
771 772 773 774 775 776
*/

class Statement_map
{
public:
  Statement_map();
777

778
  int insert(THD *thd, Statement *statement);
779 780

  Statement *find_by_name(LEX_STRING *name)
781
  {
782
    Statement *stmt;
Konstantin Osipov's avatar
Konstantin Osipov committed
783 784
    stmt= (Statement*)my_hash_search(&names_hash, (uchar*)name->str,
                                     name->length);
785
    return stmt;
786
  }
787 788

  Statement *find(ulong id)
789
  {
790
    if (last_found_statement == 0 || id != last_found_statement->id)
791 792
    {
      Statement *stmt;
Konstantin Osipov's avatar
Konstantin Osipov committed
793
      stmt= (Statement *) my_hash_search(&st_hash, (uchar *) &id, sizeof(id));
794
      if (stmt && stmt->name.str)
795 796 797
        return NULL;
      last_found_statement= stmt;
    }
798
    return last_found_statement;
799
  }
800 801 802 803 804 805
  /*
    Close all cursors of this connection that use tables of a storage
    engine that has transaction-specific state and therefore can not
    survive COMMIT or ROLLBACK. Currently all but MyISAM cursors are closed.
  */
  void close_transient_cursors();
806
  void erase(Statement *statement);
807
  /* Erase all statements (calls Statement destructor) */
808 809
  void reset();
  ~Statement_map();
810 811
private:
  HASH st_hash;
812
  HASH names_hash;
813
  I_List<Statement> transient_cursor_list;
814
  Statement *last_found_statement;
815 816
};

817 818 819
struct st_savepoint {
  struct st_savepoint *prev;
  char                *name;
820 821
  uint                 length;
  Ha_trx_info         *ha_list;
Konstantin Osipov's avatar
Konstantin Osipov committed
822
  /** Last acquired lock before this savepoint was set. */
Konstantin Osipov's avatar
Konstantin Osipov committed
823
  MDL_ticket     *mdl_savepoint;
824 825
};

826
enum xa_states {XA_NOTR=0, XA_ACTIVE, XA_IDLE, XA_PREPARED, XA_ROLLBACK_ONLY};
unknown's avatar
unknown committed
827
extern const char *xa_state_names[];
828

829 830 831 832 833
typedef struct st_xid_state {
  /* For now, this is only used to catch duplicated external xids */
  XID  xid;                           // transaction identifier
  enum xa_states xa_state;            // used by external XA only
  bool in_thd;
834 835
  /* Error reported by the Resource Manager (RM) to the Transaction Manager. */
  uint rm_error;
836 837
} XID_STATE;

Marc Alff's avatar
Marc Alff committed
838
extern mysql_mutex_t LOCK_xid_cache;
839 840 841 842 843 844 845 846
extern HASH xid_cache;
bool xid_cache_init(void);
void xid_cache_free(void);
XID_STATE *xid_cache_search(XID *xid);
bool xid_cache_insert(XID *xid, enum xa_states xa_state);
bool xid_cache_insert(XID_STATE *xid_state);
void xid_cache_delete(XID_STATE *xid_state);

847 848 849 850
/**
  @class Security_context
  @brief A set of THD members describing the current authenticated user.
*/
851

852 853
class Security_context {
public:
854
  Security_context() {}                       /* Remove gcc warning */
855 856 857 858
  /*
    host - host of the client
    user - user of the client, set to NULL until the user has been read from
    the connection
859
    priv_user - The user privilege we are using. May be "" for anonymous user.
860 861 862
    ip - client IP
  */
  char   *host, *user, *priv_user, *ip;
863
  /* The host privilege we are using */
864 865 866 867 868 869 870 871 872
  char   priv_host[MAX_HOSTNAME];
  /* points to host if host is available, otherwise points to ip */
  const char *host_or_ip;
  ulong master_access;                 /* Global privileges from mysql.user */
  ulong db_access;                     /* Privileges for current db */

  void init();
  void destroy();
  void skip_grants();
873
  inline char *priv_host_name()
874 875 876
  {
    return (*priv_host ? priv_host : (char *)"%");
  }
877 878
  
  bool set_user(char *user_arg);
879 880 881 882 883 884 885 886 887 888 889 890

#ifndef NO_EMBEDDED_ACCESS_CHECKS
  bool
  change_security_context(THD *thd,
                          LEX_STRING *definer_user,
                          LEX_STRING *definer_host,
                          LEX_STRING *db,
                          Security_context **backup);

  void
  restore_security_context(THD *thd, Security_context *backup);
#endif
891
  bool user_matches(Security_context *);
892 893 894
};


895
/**
896 897 898 899 900 901 902 903 904 905
  A registry for item tree transformations performed during
  query optimization. We register only those changes which require
  a rollback to re-execute a prepared statement or stored procedure
  yet another time.
*/

struct Item_change_record;
typedef I_List<Item_change_record> Item_change_list;


906
/**
Konstantin Osipov's avatar
Konstantin Osipov committed
907 908
  Type of locked tables mode.
  See comment for THD::locked_tables_mode for complete description.
909 910
*/

Konstantin Osipov's avatar
Konstantin Osipov committed
911 912 913 914 915 916 917
enum enum_locked_tables_mode
{
  LTM_NONE= 0,
  LTM_LOCK_TABLES,
  LTM_PRELOCKED,
  LTM_PRELOCKED_UNDER_LOCK_TABLES
};
918 919


920
/**
921
  Class that holds information about tables which were opened and locked
922 923 924 925 926 927 928
  by the thread. It is also used to save/restore this information in
  push_open_tables_state()/pop_open_tables_state().
*/

class Open_tables_state
{
public:
unknown's avatar
unknown committed
929 930 931 932 933 934 935 936 937 938
  /**
    As part of class THD, this member is set during execution
    of a prepared statement. When it is set, it is used
    by the locking subsystem to report a change in table metadata.

    When Open_tables_state part of THD is reset to open
    a system or INFORMATION_SCHEMA table, the member is cleared
    to avoid spurious ER_NEED_REPREPARE errors -- system and
    INFORMATION_SCHEMA tables are not subject to metadata version
    tracking.
939
    @sa check_and_update_table_version()
unknown's avatar
unknown committed
940
  */
941
  Reprepare_observer *m_reprepare_observer;
unknown's avatar
unknown committed
942

943 944 945 946 947 948 949 950 951 952 953
  /**
    List of regular tables in use by this thread. Contains temporary and
    base tables that were opened with @see open_tables().
  */
  TABLE *open_tables;
  /**
    List of temporary tables used by this thread. Contains user-level
    temporary tables, created with CREATE TEMPORARY TABLE, and
    internal temporary tables, created, e.g., to resolve a SELECT,
    or for an intermediate table used in ALTER.
    XXX Why are internal temporary tables added to this list?
954
  */
955 956
  TABLE *temporary_tables;
  TABLE *derived_tables;
957 958 959 960 961 962 963 964
  /*
    During a MySQL session, one can lock tables in two modes: automatic
    or manual. In automatic mode all necessary tables are locked just before
    statement execution, and all acquired locks are stored in 'lock'
    member. Unlocking takes place automatically as well, when the
    statement ends.
    Manual mode comes into play when a user issues a 'LOCK TABLES'
    statement. In this mode the user can only use the locked tables.
Konstantin Osipov's avatar
Konstantin Osipov committed
965 966 967
    Trying to use any other tables will give an error.
    The locked tables are also stored in this member, however,
    thd->locked_tables_mode is turned on.  Manual locking is described in
968 969 970 971
    the 'LOCK_TABLES' chapter of the MySQL manual.
    See also lock_tables() for details.
  */
  MYSQL_LOCK *lock;
972 973 974 975 976 977 978 979

  /*
    CREATE-SELECT keeps an extra lock for the table being
    created. This field is used to keep the extra lock available for
    lower level routines, which would otherwise miss that lock.
   */
  MYSQL_LOCK *extra_lock;

980
  /*
Konstantin Osipov's avatar
Konstantin Osipov committed
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
    Enum enum_locked_tables_mode and locked_tables_mode member are
    used to indicate whether the so-called "locked tables mode" is on,
    and what kind of mode is active.

    Locked tables mode is used when it's necessary to open and
    lock many tables at once, for usage across multiple
    (sub-)statements.
    This may be necessary either for queries that use stored functions
    and triggers, in which case the statements inside functions and
    triggers may be executed many times, or for implementation of
    LOCK TABLES, in which case the opened tables are reused by all
    subsequent statements until a call to UNLOCK TABLES.

    The kind of locked tables mode employed for stored functions and
    triggers is also called "prelocked mode".
    In this mode, first open_tables() call to open the tables used
    in a statement analyses all functions used by the statement
    and adds all indirectly used tables to the list of tables to
    open and lock.
    It also marks the parse tree of the statement as requiring
    prelocking. After that, lock_tables() locks the entire list
    of tables and changes THD::locked_tables_modeto LTM_PRELOCKED.
    All statements executed inside functions or triggers
    use the prelocked tables, instead of opening their own ones.
    Prelocked mode is turned off automatically once close_thread_tables()
    of the main statement is called.
1007
  */
Konstantin Osipov's avatar
Konstantin Osipov committed
1008
  enum enum_locked_tables_mode locked_tables_mode;
1009 1010
  uint current_tablenr;

1011 1012 1013 1014 1015 1016 1017 1018
  enum enum_flags {
    BACKUPS_AVAIL = (1U << 0)     /* There are backups available */
  };

  /*
    Flags with information about the open tables state.
  */
  uint state_flags;
Konstantin Osipov's avatar
Konstantin Osipov committed
1019 1020 1021 1022 1023
  /**
     This constructor initializes Open_tables_state instance which can only
     be used as backup storage. To prepare Open_tables_state instance for
     operations which open/lock/close tables (e.g. open_table()) one has to
     call init_open_tables_state().
1024
  */
1025
  Open_tables_state() : state_flags(0U) { }
1026

1027 1028 1029 1030 1031
  void set_open_tables_state(Open_tables_state *state)
  {
    *this= *state;
  }

1032
  void reset_open_tables_state(THD *thd)
1033
  {
1034
    open_tables= temporary_tables= derived_tables= 0;
Konstantin Osipov's avatar
Konstantin Osipov committed
1035 1036
    extra_lock= lock= 0;
    locked_tables_mode= LTM_NONE;
1037
    state_flags= 0U;
1038
    m_reprepare_observer= NULL;
1039 1040 1041
  }
};

1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

/**
  Storage for backup of Open_tables_state. Must
  be used only to open system tables (TABLE_CATEGORY_SYSTEM
  and TABLE_CATEGORY_LOG).
*/

class Open_tables_backup: public Open_tables_state
{
public:
  /**
    When we backup the open tables state to open a system
    table or tables, points at the last metadata lock
    acquired before the backup. Is used to release
    metadata locks on system tables after they are
    no longer used.
  */
  MDL_ticket *mdl_system_tables_svp;
};

1062 1063 1064 1065
/**
  @class Sub_statement_state
  @brief Used to save context when executing a function or trigger
*/
1066 1067 1068 1069 1070 1071

/* Defines used for Sub_statement_state::in_sub_stmt */

#define SUB_STMT_TRIGGER 1
#define SUB_STMT_FUNCTION 2

1072

1073 1074 1075
class Sub_statement_state
{
public:
1076
  ulonglong option_bits;
1077 1078 1079
  ulonglong first_successful_insert_id_in_prev_stmt;
  ulonglong first_successful_insert_id_in_cur_stmt, insert_id_for_cur_row;
  Discrete_interval auto_inc_interval_for_cur_row;
1080
  Discrete_intervals_list auto_inc_intervals_forced;
1081 1082 1083 1084
  ulonglong limit_found_rows;
  ha_rows    cuted_fields, sent_row_count, examined_row_count;
  ulong client_capabilities;
  uint in_sub_stmt;
1085
  bool enable_slow_log;
unknown's avatar
unknown committed
1086
  bool last_insert_id_used;
1087
  SAVEPOINT *savepoints;
1088
  enum enum_check_fields count_cuted_fields;
1089 1090 1091
};


1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
/* Flags for the THD::system_thread variable */
enum enum_thread_type
{
  NON_SYSTEM_THREAD= 0,
  SYSTEM_THREAD_DELAYED_INSERT= 1,
  SYSTEM_THREAD_SLAVE_IO= 2,
  SYSTEM_THREAD_SLAVE_SQL= 4,
  SYSTEM_THREAD_NDBCLUSTER_BINLOG= 8,
  SYSTEM_THREAD_EVENT_SCHEDULER= 16,
  SYSTEM_THREAD_EVENT_WORKER= 32
};

1104 1105 1106 1107 1108
inline char const *
show_system_thread(enum_thread_type thread)
{
#define RETURN_NAME_AS_STRING(NAME) case (NAME): return #NAME
  switch (thread) {
1109
    static char buf[64];
1110 1111 1112 1113 1114 1115 1116
    RETURN_NAME_AS_STRING(NON_SYSTEM_THREAD);
    RETURN_NAME_AS_STRING(SYSTEM_THREAD_DELAYED_INSERT);
    RETURN_NAME_AS_STRING(SYSTEM_THREAD_SLAVE_IO);
    RETURN_NAME_AS_STRING(SYSTEM_THREAD_SLAVE_SQL);
    RETURN_NAME_AS_STRING(SYSTEM_THREAD_NDBCLUSTER_BINLOG);
    RETURN_NAME_AS_STRING(SYSTEM_THREAD_EVENT_SCHEDULER);
    RETURN_NAME_AS_STRING(SYSTEM_THREAD_EVENT_WORKER);
1117 1118 1119
  default:
    sprintf(buf, "<UNKNOWN SYSTEM THREAD: %d>", thread);
    return buf;
1120 1121 1122
  }
#undef RETURN_NAME_AS_STRING
}
1123

unknown's avatar
unknown committed
1124 1125 1126 1127 1128 1129 1130 1131
/**
  This class represents the interface for internal error handlers.
  Internal error handlers are exception handlers used by the server
  implementation.
*/
class Internal_error_handler
{
protected:
1132 1133 1134 1135
  Internal_error_handler() :
    m_prev_internal_handler(NULL)
  {}

unknown's avatar
unknown committed
1136 1137 1138 1139
  virtual ~Internal_error_handler() {}

public:
  /**
Marc Alff's avatar
Marc Alff committed
1140
    Handle a sql condition.
unknown's avatar
unknown committed
1141 1142
    This method can be implemented by a subclass to achieve any of the
    following:
Marc Alff's avatar
Marc Alff committed
1143 1144 1145
    - mask a warning/error internally, prevent exposing it to the user,
    - mask a warning/error and throw another one instead.
    When this method returns true, the sql condition is considered
unknown's avatar
unknown committed
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
    'handled', and will not be propagated to upper layers.
    It is the responsability of the code installing an internal handler
    to then check for trapped conditions, and implement logic to recover
    from the anticipated conditions trapped during runtime.

    This mechanism is similar to C++ try/throw/catch:
    - 'try' correspond to <code>THD::push_internal_handler()</code>,
    - 'throw' correspond to <code>my_error()</code>,
    which invokes <code>my_message_sql()</code>,
    - 'catch' correspond to checking how/if an internal handler was invoked,
    before removing it from the exception stack with
    <code>THD::pop_internal_handler()</code>.

    @param thd the calling thread
Marc Alff's avatar
Marc Alff committed
1160 1161
    @param cond the condition raised.
    @return true if the condition is handled
unknown's avatar
unknown committed
1162
  */
Marc Alff's avatar
Marc Alff committed
1163 1164 1165 1166 1167 1168 1169
  virtual bool handle_condition(THD *thd,
                                uint sql_errno,
                                const char* sqlstate,
                                MYSQL_ERROR::enum_warning_level level,
                                const char* msg,
                                MYSQL_ERROR ** cond_hdl) = 0;

1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
private:
  Internal_error_handler *m_prev_internal_handler;
  friend class THD;
};


/**
  Implements the trivial error handler which cancels all error states
  and prevents an SQLSTATE to be set.
*/

class Dummy_error_handler : public Internal_error_handler
{
public:
Marc Alff's avatar
Marc Alff committed
1184
  bool handle_condition(THD *thd,
1185
                        uint sql_errno,
Marc Alff's avatar
Marc Alff committed
1186 1187 1188 1189
                        const char* sqlstate,
                        MYSQL_ERROR::enum_warning_level level,
                        const char* msg,
                        MYSQL_ERROR ** cond_hdl)
1190 1191 1192 1193
  {
    /* Ignore error */
    return TRUE;
  }
unknown's avatar
unknown committed
1194 1195 1196
};


1197
/**
1198
  This class is an internal error handler implementation for
1199 1200 1201 1202 1203 1204 1205 1206
  DROP TABLE statements. The thing is that there may be warnings during
  execution of these statements, which should not be exposed to the user.
  This class is intended to silence such warnings.
*/

class Drop_table_error_handler : public Internal_error_handler
{
public:
1207
  Drop_table_error_handler() {}
1208 1209

public:
1210 1211 1212 1213 1214 1215
  bool handle_condition(THD *thd,
                        uint sql_errno,
                        const char* sqlstate,
                        MYSQL_ERROR::enum_warning_level level,
                        const char* msg,
                        MYSQL_ERROR ** cond_hdl);
1216 1217 1218 1219 1220

private:
};


Konstantin Osipov's avatar
Konstantin Osipov committed
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
/**
  Tables that were locked with LOCK TABLES statement.

  Encapsulates a list of TABLE_LIST instances for tables
  locked by LOCK TABLES statement, memory root for metadata locks,
  and, generally, the context of LOCK TABLES statement.

  In LOCK TABLES mode, the locked tables are kept open between
  statements.
  Therefore, we can't allocate metadata locks on execution memory
  root -- as well as tables, the locks need to stay around till
  UNLOCK TABLES is called.
Konstantin Osipov's avatar
Konstantin Osipov committed
1233
  The locks are allocated in the memory root encapsulated in this
Konstantin Osipov's avatar
Konstantin Osipov committed
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
  class.

  Some SQL commands, like FLUSH TABLE or ALTER TABLE, demand that
  the tables they operate on are closed, at least temporarily.
  This class encapsulates a list of TABLE_LIST instances, one
  for each base table from LOCK TABLES list,
  which helps conveniently close the TABLEs when it's necessary
  and later reopen them.

  Implemented in sql_base.cc
*/

class Locked_tables_list
{
private:
  MEM_ROOT m_locked_tables_root;
  TABLE_LIST *m_locked_tables;
  TABLE_LIST **m_locked_tables_last;
Konstantin Osipov's avatar
Konstantin Osipov committed
1252 1253 1254 1255 1256 1257 1258 1259 1260
  /** An auxiliary array used only in reopen_tables(). */
  TABLE **m_reopen_array;
  /**
    Count the number of tables in m_locked_tables list. We can't
    rely on thd->lock->table_count because it excludes
    non-transactional temporary tables. We need to know
    an exact number of TABLE objects.
  */
  size_t m_locked_tables_count;
Konstantin Osipov's avatar
Konstantin Osipov committed
1261 1262 1263
public:
  Locked_tables_list()
    :m_locked_tables(NULL),
Konstantin Osipov's avatar
Konstantin Osipov committed
1264 1265 1266
    m_locked_tables_last(&m_locked_tables),
    m_reopen_array(NULL),
    m_locked_tables_count(0)
Konstantin Osipov's avatar
Konstantin Osipov committed
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
  {
    init_sql_alloc(&m_locked_tables_root, MEM_ROOT_BLOCK_SIZE, 0);
  }
  void unlock_locked_tables(THD *thd);
  ~Locked_tables_list()
  {
    unlock_locked_tables(0);
  }
  bool init_locked_tables(THD *thd);
  TABLE_LIST *locked_tables() { return m_locked_tables; }
  void unlink_from_list(THD *thd, TABLE_LIST *table_list,
                        bool remove_from_locked_tables);
Konstantin Osipov's avatar
Konstantin Osipov committed
1279 1280 1281
  void unlink_all_closed_tables(THD *thd,
                                MYSQL_LOCK *lock,
                                size_t reopen_count);
Konstantin Osipov's avatar
Konstantin Osipov committed
1282 1283 1284
  bool reopen_tables(THD *thd);
};

1285

1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
/**
  Storage engine specific thread local data.
*/

struct Ha_data
{
  /**
    Storage engine specific thread local data.
    Lifetime: one user connection.
  */
  void *ha_ptr;
  /**
    0: Life time: one statement within a transaction. If @@autocommit is
    on, also represents the entire transaction.
    @sa trans_register_ha()

    1: Life time: one transaction within a connection.
    If the storage engine does not participate in a transaction,
    this should not be used.
    @sa trans_register_ha()
  */
  Ha_trx_info ha_info[2];
1308 1309 1310 1311 1312
  /**
    NULL: engine is not bound to this thread
    non-NULL: engine is bound to this thread, engine shutdown forbidden
  */
  plugin_ref lock;
1313 1314 1315
  Ha_data() :ha_ptr(NULL) {}
};

1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
/**
  An instance of the global read lock in a connection.
  Implemented in lock.cc.
*/

class Global_read_lock
{
public:
  enum enum_grl_state
  {
    GRL_NONE,
    GRL_ACQUIRED,
    GRL_ACQUIRED_AND_BLOCKS_COMMIT
  };

  Global_read_lock()
    :m_protection_count(0), m_state(GRL_NONE), m_mdl_global_shared_lock(NULL)
  {}

  bool lock_global_read_lock(THD *thd);
  void unlock_global_read_lock(THD *thd);
  bool wait_if_global_read_lock(THD *thd, bool abort_on_refresh,
                                bool is_not_commit);
  void start_waiting_global_read_lock(THD *thd);
  bool make_global_read_lock_block_commit(THD *thd);
  bool is_acquired() const { return m_state != GRL_NONE; }
  bool has_protection() const { return m_protection_count > 0; }
  MDL_ticket *global_shared_lock() const { return m_mdl_global_shared_lock; }
private:
  uint           m_protection_count;            // GRL protection count
  /**
    In order to acquire the global read lock, the connection must
    acquire a global shared metadata lock, to prohibit all DDL.
  */
  enum_grl_state m_state;
  MDL_ticket *m_mdl_global_shared_lock;
};


Marc Alff's avatar
Marc Alff committed
1355
extern "C" void my_message_sql(uint error, const char *str, myf MyFlags);
1356

1357 1358
/**
  @class THD
unknown's avatar
unknown committed
1359 1360 1361
  For each client connection we create a separate thread with THD serving as
  a thread/connection descriptor
*/
1362

1363
class THD :public Statement,
1364
           public Open_tables_state
unknown's avatar
unknown committed
1365
{
unknown's avatar
unknown committed
1366
public:
1367 1368
  MDL_context mdl_context;

1369
  /* Used to execute base64 coded binlog events in MySQL server */
1370
  Relay_log_info* rli_fake;
1371

1372
  void reset_for_next_command();
1373 1374 1375 1376 1377 1378 1379 1380
  /*
    Constant for THD::where initialization in the beginning of every query.

    It's needed because we do not save/restore THD::where normally during
    primary (non subselect) query execution.
  */
  static const char * const DEFAULT_WHERE;

1381 1382
#ifdef EMBEDDED_LIBRARY
  struct st_mysql  *mysql;
unknown's avatar
SCRUM  
unknown committed
1383 1384
  unsigned long	 client_stmt_id;
  unsigned long  client_param_count;
unknown's avatar
unknown committed
1385
  struct st_mysql_bind *client_params;
unknown's avatar
unknown committed
1386 1387
  char *extra_data;
  ulong extra_length;
1388 1389 1390 1391 1392
  struct st_mysql_data *cur_data;
  struct st_mysql_data *first_data;
  struct st_mysql_data **data_tail;
  void clear_data_list();
  struct st_mysql_data *alloc_new_dataset();
1393 1394 1395 1396 1397 1398
  /*
    In embedded server it points to the statement that is processed
    in the current query. We store some results directly in statement
    fields then.
  */
  struct st_mysql_stmt *current_stmt;
1399 1400 1401
#endif
#ifdef HAVE_QUERY_CACHE
  Query_cache_tls query_cache_tls;
1402
#endif
unknown's avatar
unknown committed
1403
  NET	  net;				// client connection descriptor
1404
  Protocol *protocol;			// Current protocol
unknown's avatar
unknown committed
1405 1406
  Protocol_text   protocol_text;	// Normal protocol
  Protocol_binary protocol_binary;	// Binary protocol
unknown's avatar
unknown committed
1407 1408
  HASH    user_vars;			// hash for user variables
  String  packet;			// dynamic buffer for network I/O
1409
  String  convert_buffer;               // buffer for charset conversions
unknown's avatar
unknown committed
1410 1411
  struct  rand_struct rand;		// used for authentication
  struct  system_variables variables;	// Changeable local variables
1412
  struct  system_status_var status_var; // Per thread statistic vars
1413
  struct  system_status_var *initial_status_var; /* used by show status */
1414 1415 1416 1417
  THR_LOCK_INFO lock_info;              // Locking info of this thread
  THR_LOCK_OWNER main_lock_id;          // To use for conventional queries
  THR_LOCK_OWNER *lock_id;              // If not main_lock_id, points to
                                        // the lock_id of a cursor.
1418 1419 1420 1421 1422 1423 1424
  /**
    Protects THD data accessed from other threads:
    - thd->query and thd->query_length (used by SHOW ENGINE
      INNODB STATUS and SHOW PROCESSLIST
    - thd->mysys_var (used by KILL statement and shutdown).
    Is locked when THD is deleted.
  */
Marc Alff's avatar
Marc Alff committed
1425
  mysql_mutex_t LOCK_thd_data;
1426

1427
  /* all prepared statements and cursors of this connection */
1428
  Statement_map stmt_map;
unknown's avatar
unknown committed
1429 1430 1431 1432 1433 1434
  /*
    A pointer to the stack frame of handle_one_connection(),
    which is called first in the thread for handling a client
  */
  char	  *thread_stack;

1435 1436 1437 1438 1439
  /**
    Currently selected catalog.
  */
  char *catalog;

unknown's avatar
unknown committed
1440 1441 1442
  /**
    @note
    Some members of THD (currently 'Statement::db',
1443 1444 1445 1446 1447 1448
    'catalog' and 'query')  are set and alloced by the slave SQL thread
    (for the THD of that thread); that thread is (and must remain, for now)
    the only responsible for freeing these 3 members. If you add members
    here, and you add code to set them in replication, don't forget to
    free_them_and_set_them_to_0 in replication properly. For details see
    the 'err:' label of the handle_slave_sql() in sql/slave.cc.
unknown's avatar
unknown committed
1449 1450

    @see handle_slave_sql
1451 1452
  */

1453 1454
  Security_context main_security_ctx;
  Security_context *security_ctx;
1455

1456 1457 1458 1459
  /*
    Points to info-string that we show in SHOW PROCESSLIST
    You are supposed to update thd->proc_info only if you have coded
    a time-consuming piece that MySQL can get stuck in for a long time.
1460 1461 1462

    Set it using the  thd_proc_info(THD *thread, const char *message)
    macro/function.
1463 1464 1465 1466

    This member is accessed and assigned without any synchronization.
    Therefore, it may point only to constant (statically
    allocated) strings, which memory won't go away over time.
1467
  */
unknown's avatar
unknown committed
1468
  const char *proc_info;
1469

1470 1471 1472 1473 1474 1475 1476
  /*
    Used in error messages to tell user in what part of MySQL we found an
    error. E. g. when where= "having clause", if fix_fields() fails, user
    will know that the error was in having clause.
  */
  const char *where;

1477
  ulong client_capabilities;		/* What the client supports */
1478
  ulong max_client_packet_length;
1479

unknown's avatar
unknown committed
1480
  HASH		handler_tables_hash;
unknown's avatar
unknown committed
1481 1482 1483 1484 1485
  /*
    One thread can hold up to one named user-level lock. This variable
    points to a lock object if the lock is present. See item_func.cc and
    chapter 'Miscellaneous functions', for functions GET_LOCK, RELEASE_LOCK. 
  */
1486
  User_level_lock *ull;
1487 1488
#ifndef DBUG_OFF
  uint dbug_sentry; // watch out for memory corruption
1489
#endif
unknown's avatar
unknown committed
1490
  struct st_my_thread_var *mysys_var;
1491
  /*
1492
    Type of current query: COM_STMT_PREPARE, COM_QUERY, etc. Set from
1493 1494 1495
    first byte of the packet in do_command()
  */
  enum enum_server_command command;
unknown's avatar
unknown committed
1496
  uint32     server_id;
unknown's avatar
unknown committed
1497
  uint32     file_id;			// for LOAD DATA INFILE
1498 1499 1500
  /* remote (peer) port */
  uint16 peer_port;
  time_t     start_time, user_time;
1501 1502
  // track down slow pthread_create
  ulonglong  prior_thr_create_utime, thr_create_utime;
1503 1504
  ulonglong  start_utime, utime_after_lock;
  
unknown's avatar
unknown committed
1505
  thr_lock_type update_lock_default;
1506
  Delayed_insert *di;
1507

1508 1509
  /* <> 0 if we are inside of trigger or stored function. */
  uint in_sub_stmt;
1510

1511
  /* container for handler's private per-connection data */
1512
  Ha_data ha_data[MAX_HA];
1513 1514

#ifndef MYSQL_CLIENT
1515 1516
  int binlog_setup_trx_data();

1517
  /*
1518
    Public interface to write RBR events to the binlog
1519
  */
1520
  void binlog_start_trans_and_stmt();
1521
  void binlog_set_stmt_begin();
1522
  int binlog_write_table_map(TABLE *table, bool is_transactional);
1523
  int binlog_write_row(TABLE* table, bool is_transactional,
1524 1525
                       MY_BITMAP const* cols, size_t colcnt,
                       const uchar *buf);
1526
  int binlog_delete_row(TABLE* table, bool is_transactional,
1527 1528
                        MY_BITMAP const* cols, size_t colcnt,
                        const uchar *buf);
1529
  int binlog_update_row(TABLE* table, bool is_transactional,
1530 1531
                        MY_BITMAP const* cols, size_t colcnt,
                        const uchar *old_data, const uchar *new_data);
1532 1533 1534 1535 1536 1537 1538 1539 1540

  void set_server_id(uint32 sid) { server_id = sid; }

  /*
    Member functions to handle pending event for row-level logging.
  */
  template <class RowsEventT> Rows_log_event*
    binlog_prepare_pending_rows_event(TABLE* table, uint32 serv_id,
                                      MY_BITMAP const* cols,
1541 1542
                                      size_t colcnt,
                                      size_t needed,
unknown's avatar
unknown committed
1543 1544
                                      bool is_transactional,
				      RowsEventT* hint);
1545 1546 1547 1548 1549 1550 1551 1552 1553
  Rows_log_event* binlog_get_pending_rows_event(bool is_transactional) const;
  void binlog_set_pending_rows_event(Rows_log_event* ev, bool is_transactional);
  inline int binlog_flush_pending_rows_event(bool stmt_end)
  {
    return (binlog_flush_pending_rows_event(stmt_end, FALSE) || 
            binlog_flush_pending_rows_event(stmt_end, TRUE));
  }
  int binlog_flush_pending_rows_event(bool stmt_end, bool is_transactional);
  int binlog_remove_pending_rows_event(bool clear_maps, bool is_transactional);
1554

1555 1556 1557 1558 1559 1560 1561 1562 1563
  /**
    Determine the binlog format of the current statement.

    @retval 0 if the current statement will be logged in statement
    format.
    @retval nonzero if the current statement will be logged in row
    format.
   */
  int is_current_stmt_binlog_format_row() const {
1564 1565 1566 1567
    DBUG_ASSERT(current_stmt_binlog_format == BINLOG_FORMAT_STMT ||
                current_stmt_binlog_format == BINLOG_FORMAT_ROW);
    return current_stmt_binlog_format == BINLOG_FORMAT_ROW;
  }
1568

1569
private:
1570 1571 1572
  /**
    Indicates the format in which the current statement will be
    logged.  This can only be set from @c decide_logging_format().
1573
  */
1574 1575
  enum_binlog_format current_stmt_binlog_format;

1576
  /**
1577
    Bit field for the state of binlog warnings.
1578

1579
    There are two groups of bits:
1580

1581 1582
    - The first Lex::BINLOG_STMT_UNSAFE_COUNT bits list all types of
      unsafeness that the current statement has.
1583 1584 1585 1586 1587 1588

    - The following Lex::BINLOG_STMT_UNSAFE_COUNT bits list all types
      of unsafeness that the current statement has issued warnings
      for.

    Hence, this variable must be big enough to hold
1589 1590
    2*Lex::BINLOG_STMT_UNSAFE_COUNT bits.  This is asserted in @c
    issue_unsafe_warnings().
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602

    The first and second groups of bits are set by @c
    decide_logging_format() when it detects that a warning should be
    issued.  The third group of bits is set from @c binlog_query()
    when a warning is issued.  All bits are cleared at the end of the
    top-level statement.

    This must be a member of THD and not of LEX, because warnings are
    detected and issued in different places (@c
    decide_logging_format() and @c binlog_query(), respectively).
    Between these calls, the THD->lex object may change; e.g., if a
    stored routine is invoked.  Only THD persists between the calls.
1603
  */
1604 1605 1606
  uint32 binlog_unsafe_warning_flags;

  void issue_unsafe_warnings();
1607

1608 1609 1610 1611 1612
  /*
    Number of outstanding table maps, i.e., table maps in the
    transaction cache.
  */
  uint binlog_table_maps;
1613
public:
1614 1615 1616
  uint get_binlog_table_maps() const {
    return binlog_table_maps;
  }
1617 1618 1619
  void clear_binlog_table_maps() {
    binlog_table_maps= 0;
  }
1620 1621
#endif /* MYSQL_CLIENT */

1622 1623
public:

unknown's avatar
unknown committed
1624
  struct st_transactions {
1625
    SAVEPOINT *savepoints;
unknown's avatar
unknown committed
1626 1627
    THD_TRANS all;			// Trans since BEGIN WORK
    THD_TRANS stmt;			// Trans for current statement
1628
    bool on;                            // see ha_enable_transaction()
1629
    XID_STATE xid_state;
1630 1631
    Rows_log_event *m_pending_rows_event;

1632
    /*
1633
       Tables changed in transaction (that must be invalidated in query cache).
1634
       List contain only transactional tables, that not invalidated in query
1635 1636 1637 1638 1639 1640
       cache (instead of full list of changed in transaction tables).
    */
    CHANGED_TABLE_LIST* changed_tables;
    MEM_ROOT mem_root; // Transaction-life memory allocation pool
    void cleanup()
    {
1641 1642
      changed_tables= 0;
      savepoints= 0;
1643 1644 1645 1646 1647 1648 1649 1650
      /*
        If rm_error is raised, it means that this piece of a distributed
        transaction has failed and must be rolled back. But the user must
        rollback it explicitly, so don't start a new distributed XA until
        then.
      */
      if (!xid_state.rm_error)
        xid_state.xid.null();
1651 1652
      free_root(&mem_root,MYF(MY_KEEP_PREALLOC));
    }
1653 1654 1655
    st_transactions()
    {
      bzero((char*)this, sizeof(*this));
1656
      xid_state.xid.null();
1657
      init_sql_alloc(&mem_root, ALLOC_ROOT_MIN_BLOCK_SIZE, 0);
1658
    }
unknown's avatar
unknown committed
1659
  } transaction;
1660
  Global_read_lock global_read_lock;
1661
  Field      *dup_field;
unknown's avatar
unknown committed
1662
#ifndef __WIN__
unknown's avatar
unknown committed
1663
  sigset_t signals;
unknown's avatar
unknown committed
1664
#endif
1665 1666
#ifdef SIGNAL_WITH_VIO_CLOSE
  Vio* active_vio;
1667
#endif
1668 1669 1670 1671
  /*
    This is to track items changed during execution of a prepared
    statement/stored procedure. It's created by
    register_item_tree_change() in memory root of THD, and freed in
unknown's avatar
unknown committed
1672 1673
    rollback_item_tree_changes(). For conventional execution it's always
    empty.
1674 1675 1676
  */
  Item_change_list change_list;

unknown's avatar
unknown committed
1677
  /*
unknown's avatar
unknown committed
1678 1679
    A permanent memory area of the statement. For conventional
    execution, the parsed tree and execution runtime reside in the same
unknown's avatar
unknown committed
1680
    memory root. In this case stmt_arena points to THD. In case of
unknown's avatar
unknown committed
1681
    a prepared statement or a stored procedure statement, thd->mem_root
unknown's avatar
unknown committed
1682
    conventionally points to runtime memory, and thd->stmt_arena
unknown's avatar
unknown committed
1683 1684 1685
    points to the memory of the PS/SP, where the parsed tree of the
    statement resides. Whenever you need to perform a permanent
    transformation of a parsed tree, you should allocate new memory in
unknown's avatar
unknown committed
1686 1687
    stmt_arena, to allow correct re-execution of PS/SP.
    Note: in the parser, stmt_arena == thd, even for PS/SP.
unknown's avatar
unknown committed
1688
  */
unknown's avatar
unknown committed
1689
  Query_arena *stmt_arena;
1690 1691 1692 1693 1694 1695 1696

  /*
    map for tables that will be updated for a multi-table update query
    statement, for other query statements, this will be zero.
  */
  table_map table_map_for_update;

1697 1698
  /* Tells if LAST_INSERT_ID(#) was called for the current statement */
  bool arg_of_last_insert_id_function;
1699
  /*
1700 1701
    ALL OVER THIS FILE, "insert_id" means "*automatically generated* value for
    insertion into an auto_increment column".
1702 1703
  */
  /*
1704 1705 1706 1707 1708 1709
    This is the first autogenerated insert id which was *successfully*
    inserted by the previous statement (exactly, if the previous statement
    didn't successfully insert an autogenerated insert id, then it's the one
    of the statement before, etc).
    It can also be set by SET LAST_INSERT_ID=# or SELECT LAST_INSERT_ID(#).
    It is returned by LAST_INSERT_ID().
1710
  */
1711
  ulonglong  first_successful_insert_id_in_prev_stmt;
1712
  /*
1713 1714 1715 1716
    Variant of the above, used for storing in statement-based binlog. The
    difference is that the one above can change as the execution of a stored
    function progresses, while the one below is set once and then does not
    change (which is the value which statement-based binlog needs).
1717
  */
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
  ulonglong  first_successful_insert_id_in_prev_stmt_for_binlog;
  /*
    This is the first autogenerated insert id which was *successfully*
    inserted by the current statement. It is maintained only to set
    first_successful_insert_id_in_prev_stmt when statement ends.
  */
  ulonglong  first_successful_insert_id_in_cur_stmt;
  /*
    We follow this logic:
    - when stmt starts, first_successful_insert_id_in_prev_stmt contains the
    first insert id successfully inserted by the previous stmt.
1729 1730 1731 1732
    - as stmt makes progress, handler::insert_id_for_cur_row changes;
    every time get_auto_increment() is called,
    auto_inc_intervals_in_cur_stmt_for_binlog is augmented with the
    reserved interval (if statement-based binlogging).
1733 1734 1735
    - at first successful insertion of an autogenerated value,
    first_successful_insert_id_in_cur_stmt is set to
    handler::insert_id_for_cur_row.
1736 1737 1738
    - when stmt goes to binlog,
    auto_inc_intervals_in_cur_stmt_for_binlog is binlogged if
    non-empty.
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
    - when stmt ends, first_successful_insert_id_in_prev_stmt is set to
    first_successful_insert_id_in_cur_stmt.
  */
  /*
    stmt_depends_on_first_successful_insert_id_in_prev_stmt is set when
    LAST_INSERT_ID() is used by a statement.
    If it is set, first_successful_insert_id_in_prev_stmt_for_binlog will be
    stored in the statement-based binlog.
    This variable is CUMULATIVE along the execution of a stored function or
    trigger: if one substatement sets it to 1 it will stay 1 until the
    function/trigger ends, thus making sure that
    first_successful_insert_id_in_prev_stmt_for_binlog does not change anymore
    and is propagated to the caller for binlogging.
  */
  bool       stmt_depends_on_first_successful_insert_id_in_prev_stmt;
  /*
    List of auto_increment intervals reserved by the thread so far, for
    storage in the statement-based binlog.
    Note that its minimum is not first_successful_insert_id_in_cur_stmt:
    assuming a table with an autoinc column, and this happens:
    INSERT INTO ... VALUES(3);
    SET INSERT_ID=3; INSERT IGNORE ... VALUES (NULL);
    then the latter INSERT will insert no rows
    (first_successful_insert_id_in_cur_stmt == 0), but storing "INSERT_ID=3"
    in the binlog is still needed; the list's minimum will contain 3.
Guilhem Bichot's avatar
Guilhem Bichot committed
1764 1765 1766
    This variable is cumulative: if several statements are written to binlog
    as one (stored functions or triggers are used) this list is the
    concatenation of all intervals reserved by all statements.
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777
  */
  Discrete_intervals_list auto_inc_intervals_in_cur_stmt_for_binlog;
  /* Used by replication and SET INSERT_ID */
  Discrete_intervals_list auto_inc_intervals_forced;
  /*
    There is BUG#19630 where statement-based replication of stored
    functions/triggers with two auto_increment columns breaks.
    We however ensure that it works when there is 0 or 1 auto_increment
    column; our rules are
    a) on master, while executing a top statement involving substatements,
    first top- or sub- statement to generate auto_increment values wins the
1778 1779 1780
    exclusive right to see its values be written to binlog (the write
    will be done by the statement or its caller), and the losers won't see
    their values be written to binlog.
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
    b) on slave, while replicating a top statement involving substatements,
    first top- or sub- statement to need to read auto_increment values from
    the master's binlog wins the exclusive right to read them (so the losers
    won't read their values from binlog but instead generate on their own).
    a) implies that we mustn't backup/restore
    auto_inc_intervals_in_cur_stmt_for_binlog.
    b) implies that we mustn't backup/restore auto_inc_intervals_forced.

    If there are more than 1 auto_increment columns, then intervals for
    different columns may mix into the
    auto_inc_intervals_in_cur_stmt_for_binlog list, which is logically wrong,
    but there is no point in preventing this mixing by preventing intervals
    from the secondly inserted column to come into the list, as such
    prevention would be wrong too.
    What will happen in the case of
    INSERT INTO t1 (auto_inc) VALUES(NULL);
    where t1 has a trigger which inserts into an auto_inc column of t2, is
    that in binlog we'll store the interval of t1 and the interval of t2 (when
    we store intervals, soon), then in slave, t1 will use both intervals, t2
    will use none; if t1 inserts the same number of rows as on master,
    normally the 2nd interval will not be used by t1, which is fine. t2's
    values will be wrong if t2's internal auto_increment counter is different
    from what it was on master (which is likely). In 5.1, in mixed binlogging
    mode, row-based binlogging is used for such cases where two
    auto_increment columns are inserted.
  */
1807
  inline void record_first_successful_insert_id_in_cur_stmt(ulonglong id_arg)
1808 1809
  {
    if (first_successful_insert_id_in_cur_stmt == 0)
1810
      first_successful_insert_id_in_cur_stmt= id_arg;
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
  }
  inline ulonglong read_first_successful_insert_id_in_prev_stmt(void)
  {
    if (!stmt_depends_on_first_successful_insert_id_in_prev_stmt)
    {
      /* It's the first time we read it */
      first_successful_insert_id_in_prev_stmt_for_binlog=
        first_successful_insert_id_in_prev_stmt;
      stmt_depends_on_first_successful_insert_id_in_prev_stmt= 1;
    }
    return first_successful_insert_id_in_prev_stmt;
  }
  /*
1824
    Used by Intvar_log_event::do_apply_event() and by "SET INSERT_ID=#"
1825 1826 1827 1828 1829
    (mysqlbinlog). We'll soon add a variant which can take many intervals in
    argument.
  */
  inline void force_one_auto_inc_interval(ulonglong next_id)
  {
1830
    auto_inc_intervals_forced.empty(); // in case of multiple SET INSERT_ID
1831 1832 1833
    auto_inc_intervals_forced.append(next_id, ULONGLONG_MAX, 0);
  }

1834
  ulonglong  limit_found_rows;
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878

private:
  /**
    Stores the result of ROW_COUNT() function.

    ROW_COUNT() function is a MySQL extention, but we try to keep it
    similar to ROW_COUNT member of the GET DIAGNOSTICS stack of the SQL
    standard (see SQL99, part 2, search for ROW_COUNT). It's value is
    implementation defined for anything except INSERT, DELETE, UPDATE.

    ROW_COUNT is assigned according to the following rules:

      - In my_ok():
        - for DML statements: to the number of affected rows;
        - for DDL statements: to 0.

      - In my_eof(): to -1 to indicate that there was a result set.

        We derive this semantics from the JDBC specification, where int
        java.sql.Statement.getUpdateCount() is defined to (sic) "return the
        current result as an update count; if the result is a ResultSet
        object or there are no more results, -1 is returned".

      - In my_error(): to -1 to be compatible with the MySQL C API and
        MySQL ODBC driver.

      - For SIGNAL statements: to 0 per WL#2110 specification (see also
        sql_signal.cc comment). Zero is used since that's the "default"
        value of ROW_COUNT in the diagnostics area.
  */

  longlong m_row_count_func;    /* For the ROW_COUNT() function */

public:
  inline longlong get_row_count_func() const
  {
    return m_row_count_func;
  }

  inline void set_row_count_func(longlong row_count_func)
  {
    m_row_count_func= row_count_func;
  }

1879 1880 1881 1882 1883 1884 1885 1886
  ha_rows    cuted_fields;

  /*
    number of rows we actually sent to the client, including "synthetic"
    rows in ROLLUP etc.
  */
  ha_rows    sent_row_count;

1887 1888 1889 1890 1891 1892 1893 1894 1895
  /**
    Number of rows read and/or evaluated for a statement. Used for
    slow log reporting.

    An examined row is defined as a row that is read and/or evaluated
    according to a statement condition, including in
    create_sort_index(). Rows may be counted more than once, e.g., a
    statement including ORDER BY could possibly evaluate the row in
    filesort() before reading it for e.g. update.
1896 1897 1898
  */
  ha_rows    examined_row_count;

unknown's avatar
unknown committed
1899 1900 1901 1902 1903 1904
  /*
    The set of those tables whose fields are referenced in all subqueries
    of the query.
    TODO: possibly this it is incorrect to have used tables in THD because
    with more than one subquery, it is not clear what does the field mean.
  */
unknown's avatar
unknown committed
1905
  table_map  used_tables;
1906
  USER_CONN *user_connect;
1907
  CHARSET_INFO *db_charset;
Marc Alff's avatar
Marc Alff committed
1908 1909
  Warning_info *warning_info;
  Diagnostics_area *stmt_da;
1910
#if defined(ENABLED_PROFILING)
unknown's avatar
unknown committed
1911
  PROFILING  profiling;
1912
#endif
unknown's avatar
unknown committed
1913

1914 1915 1916 1917 1918 1919 1920 1921
  /*
    Id of current query. Statement can be reused to execute several queries
    query_id is global in context of the whole MySQL server.
    ID is automatically generated from mutex-protected counter.
    It's used in handler code for various purposes: to check which columns
    from table are necessary for this select, to check if it's necessary to
    update auto-updatable fields (like auto_increment and timestamp).
  */
Marc Alff's avatar
Marc Alff committed
1922
  query_id_t query_id;
unknown's avatar
unknown committed
1923
  ulong      col_access;
1924 1925 1926

  /* Statement id is thread-wide. This counter is used to generate ids */
  ulong      statement_id_counter;
1927
  ulong	     rand_saved_seed1, rand_saved_seed2;
unknown's avatar
unknown committed
1928 1929
  pthread_t  real_id;                           /* For debugging */
  my_thread_id  thread_id;
1930
  uint	     tmp_table;
1931 1932
  uint	     server_status,open_options;
  enum enum_thread_type system_thread;
unknown's avatar
unknown committed
1933
  uint       select_number;             //number of select (used for EXPLAIN)
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958
  /*
    Current or next transaction isolation level.
    When a connection is established, the value is taken from
    @@session.tx_isolation (default transaction isolation for
    the session), which is in turn taken from @@global.tx_isolation
    (the global value).
    If there is no transaction started, this variable
    holds the value of the next transaction's isolation level.
    When a transaction starts, the value stored in this variable
    becomes "actual".
    At transaction commit or rollback, we assign this variable
    again from @@session.tx_isolation.
    The only statement that can otherwise change the value
    of this variable is SET TRANSACTION ISOLATION LEVEL.
    Its purpose is to effect the isolation level of the next
    transaction in this session. When this statement is executed,
    the value in this variable is changed. However, since
    this statement is only allowed when there is no active
    transaction, this assignment (naturally) only affects the
    upcoming transaction.
    At the end of the current active transaction the value is
    be reset again from @@session.tx_isolation, as described
    above.
  */
  enum_tx_isolation tx_isolation;
1959
  enum_check_fields count_cuted_fields;
1960 1961 1962

  DYNAMIC_ARRAY user_var_events;        /* For user variables replication */
  MEM_ROOT      *user_var_events_alloc; /* Allocate above array elements here */
1963

1964 1965 1966 1967 1968 1969 1970 1971
  enum killed_state
  {
    NOT_KILLED=0,
    KILL_BAD_DATA=1,
    KILL_CONNECTION=ER_SERVER_SHUTDOWN,
    KILL_QUERY=ER_QUERY_INTERRUPTED,
    KILLED_NO_VALUE      /* means neither of the states */
  };
1972 1973
  killed_state volatile killed;

1974
  /* scramble - random string sent to client on handshake */
unknown's avatar
unknown committed
1975
  char	     scramble[SCRAMBLE_LENGTH+1];
1976

1977
  bool       slave_thread, one_shot_set;
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
  bool	     no_errors, password;
  /**
    Set to TRUE if execution of the current compound statement
    can not continue. In particular, disables activation of
    CONTINUE or EXIT handlers of stored routines.
    Reset in the end of processing of the current user request, in
    @see mysql_reset_thd_for_next_command().
  */
  bool is_fatal_error;
  /**
    Set by a storage engine to request the entire
    transaction (that possibly spans multiple engines) to
    rollback. Reset in ha_rollback.
  */
  bool       transaction_rollback_request;
  /**
    TRUE if we are in a sub-statement and the current error can
    not be safely recovered until we left the sub-statement mode.
    In particular, disables activation of CONTINUE and EXIT
    handlers inside sub-statements. E.g. if it is a deadlock
    error and requires a transaction-wide rollback, this flag is
    raised (traditionally, MySQL first has to close all the reads
    via @see handler::ha_index_or_rnd_end() and only then perform
    the rollback).
    Reset to FALSE when we leave the sub-statement mode.
  */
  bool       is_fatal_sub_stmt_error;
2005
  bool	     query_start_used, rand_used, time_zone_used;
2006 2007
  /* for IS NULL => = last_insert_id() fix in remove_eq_conds() */
  bool       substitute_null_with_insert_id;
2008
  bool	     in_lock_tables;
2009 2010
  /**
    True if a slave error. Causes the slave to stop. Not the same
2011
    as the statement execution error (is_error()), since
2012 2013 2014 2015 2016
    a statement may be expected to return an error, e.g. because
    it returned an error on master, and this is OK on the slave.
  */
  bool       is_slave_error;
  bool       bootstrap, cleanup_done;
2017 2018 2019
  
  /**  is set if some thread specific value(s) used in a statement. */
  bool       thread_specific_used;
2020 2021 2022 2023 2024
  /**  
    is set if a statement accesses a temporary table created through
    CREATE TEMPORARY TABLE. 
  */
  bool       thread_temporary_used;
unknown's avatar
unknown committed
2025
  bool	     charset_is_system_charset, charset_is_collation_connection;
unknown's avatar
unknown committed
2026
  bool       charset_is_character_set_filesystem;
2027
  bool       enable_slow_log;   /* enable slow log for current statement */
2028
  bool	     abort_on_warning;
unknown's avatar
Merge  
unknown committed
2029
  bool 	     got_warning;       /* Set on call to push_warning() */
2030
  bool	     no_warnings_for_error; /* no warnings on call to my_error() */
2031 2032
  /* set during loop of derived table processing */
  bool       derived_tables_processing;
2033 2034
  my_bool    tablespace_op;	/* This is TRUE in DISCARD/IMPORT TABLESPACE */

2035
  sp_rcontext *spcont;		// SP runtime context
2036 2037
  sp_cache   *sp_proc_cache;
  sp_cache   *sp_func_cache;
unknown's avatar
unknown committed
2038

2039 2040 2041
  /** number of name_const() substitutions, see sp_head.cc:subst_spvars() */
  uint       query_name_consts;

unknown's avatar
unknown committed
2042 2043 2044 2045 2046
  /*
    If we do a purge of binary logs, log index info of the threads
    that are currently reading it needs to be adjusted. To do that
    each thread that is using LOG_INFO needs to adjust the pointer to it
  */
unknown's avatar
unknown committed
2047
  LOG_INFO*  current_linfo;
unknown's avatar
unknown committed
2048
  NET*       slave_net;			// network connection from slave -> m.
unknown's avatar
unknown committed
2049 2050 2051
  /* Used by the sys_var class to store temporary values */
  union
  {
2052 2053 2054 2055
    my_bool   my_bool_value;
    long      long_value;
    ulong     ulong_value;
    ulonglong ulonglong_value;
unknown's avatar
unknown committed
2056
  } sys_var_tmp;
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
  
  struct {
    /* 
      If true, mysql_bin_log::write(Log_event) call will not write events to 
      binlog, and maintain 2 below variables instead (use
      mysql_bin_log.start_union_events to turn this on)
    */
    bool do_union;
    /*
      If TRUE, at least one mysql_bin_log::write(Log_event) call has been
      made after last mysql_bin_log.start_union_events() call.
    */
    bool unioned_events;
    /*
      If TRUE, at least one mysql_bin_log::write(Log_event e), where 
      e.cache_stmt == TRUE call has been made after last 
      mysql_bin_log.start_union_events() call.
    */
    bool unioned_events_trans;
2076 2077 2078 2079 2080 2081
    
    /* 
      'queries' (actually SP statements) that run under inside this binlog
      union have thd->query_id >= first_query_id.
    */
    query_id_t first_query_id;
2082
  } binlog_evt_union;
2083 2084

  /**
2085 2086 2087
    Internal parser state.
    Note that since the parser is not re-entrant, we keep only one parser
    state here. This member is valid only when executing code during parsing.
2088
  */
2089
  Parser_state *m_parser_state;
2090

Konstantin Osipov's avatar
Konstantin Osipov committed
2091 2092
  Locked_tables_list locked_tables_list;

unknown's avatar
unknown committed
2093
#ifdef WITH_PARTITION_STORAGE_ENGINE
unknown's avatar
unknown committed
2094
  partition_info *work_part_info;
unknown's avatar
unknown committed
2095
#endif
unknown's avatar
foo1  
unknown committed
2096

2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110
#ifndef EMBEDDED_LIBRARY
  /**
    Array of active audit plugins which have been used by this THD.
    This list is later iterated to invoke release_thd() on those
    plugins.
  */
  DYNAMIC_ARRAY audit_class_plugins;
  /**
    Array of bits indicating which audit classes have already been
    added to the list of audit plugins which are currently in use.
  */
  unsigned long audit_class_mask[MYSQL_AUDIT_CLASS_MASK_SIZE];
#endif

2111 2112 2113 2114
#if defined(ENABLED_DEBUG_SYNC)
  /* Debug Sync facility. See debug_sync.cc. */
  struct st_debug_sync_control *debug_sync_control;
#endif /* defined(ENABLED_DEBUG_SYNC) */
unknown's avatar
unknown committed
2115 2116
  THD();
  ~THD();
2117

unknown's avatar
unknown committed
2118
  void init(void);
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128
  /*
    Initialize memory roots necessary for query processing and (!)
    pre-allocate memory for it. We can't do that in THD constructor because
    there are use cases (acl_init, delayed inserts, watcher threads,
    killing mysqld) where it's vital to not allocate excessive and not used
    memory. Note, that we still don't return error from init_for_queries():
    if preallocation fails, we should notice that at the first call to
    alloc_root. 
  */
  void init_for_queries();
unknown's avatar
unknown committed
2129
  void change_user(void);
unknown's avatar
unknown committed
2130
  void cleanup(void);
2131
  void cleanup_after_query();
unknown's avatar
unknown committed
2132
  bool store_globals();
2133 2134
#ifdef SIGNAL_WITH_VIO_CLOSE
  inline void set_active_vio(Vio* vio)
2135
  {
Marc Alff's avatar
Marc Alff committed
2136
    mysql_mutex_lock(&LOCK_thd_data);
2137
    active_vio = vio;
Marc Alff's avatar
Marc Alff committed
2138
    mysql_mutex_unlock(&LOCK_thd_data);
2139
  }
2140
  inline void clear_active_vio()
2141
  {
Marc Alff's avatar
Marc Alff committed
2142
    mysql_mutex_lock(&LOCK_thd_data);
2143
    active_vio = 0;
Marc Alff's avatar
Marc Alff committed
2144
    mysql_mutex_unlock(&LOCK_thd_data);
2145
  }
unknown's avatar
unknown committed
2146
  void close_active_vio();
2147
#endif
unknown's avatar
SCRUM  
unknown committed
2148
  void awake(THD::killed_state state_to_set);
unknown's avatar
unknown committed
2149 2150 2151

#ifndef MYSQL_CLIENT
  enum enum_binlog_query_type {
2152
    /* The query can be logged in row format or in statement format. */
unknown's avatar
unknown committed
2153 2154
    ROW_QUERY_TYPE,
    
2155
    /* The query has to be logged in statement format. */
unknown's avatar
unknown committed
2156 2157 2158 2159 2160 2161
    STMT_QUERY_TYPE,
    
    QUERY_TYPE_COUNT
  };
  
  int binlog_query(enum_binlog_query_type qtype,
2162 2163
                   char const *query, ulong query_len, bool is_trans,
                   bool direct, bool suppress_use,
2164
                   int errcode);
unknown's avatar
unknown committed
2165 2166
#endif

2167 2168
  /*
    For enter_cond() / exit_cond() to work the mutex must be got before
2169 2170
    enter_cond(); this mutex is then released by exit_cond().
    Usage must be: lock mutex; enter_cond(); your code; exit_cond().
2171
  */
Marc Alff's avatar
Marc Alff committed
2172 2173
  inline const char* enter_cond(mysql_cond_t *cond, mysql_mutex_t* mutex,
                                const char* msg)
unknown's avatar
unknown committed
2174
  {
2175
    const char* old_msg = proc_info;
Marc Alff's avatar
Marc Alff committed
2176
    mysql_mutex_assert_owner(mutex);
2177 2178 2179 2180
    mysys_var->current_mutex = mutex;
    mysys_var->current_cond = cond;
    proc_info = msg;
    return old_msg;
unknown's avatar
unknown committed
2181 2182 2183
  }
  inline void exit_cond(const char* old_msg)
  {
2184 2185 2186 2187 2188 2189
    /*
      Putting the mutex unlock in thd->exit_cond() ensures that
      mysys_var->current_mutex is always unlocked _before_ mysys_var->mutex is
      locked (if that would not be the case, you'll get a deadlock if someone
      does a THD::awake() on you).
    */
Marc Alff's avatar
Marc Alff committed
2190 2191
    mysql_mutex_unlock(mysys_var->current_mutex);
    mysql_mutex_lock(&mysys_var->mutex);
2192 2193 2194
    mysys_var->current_mutex = 0;
    mysys_var->current_cond = 0;
    proc_info = old_msg;
Marc Alff's avatar
Marc Alff committed
2195
    mysql_mutex_unlock(&mysys_var->mutex);
2196
    return;
unknown's avatar
unknown committed
2197
  }
unknown's avatar
unknown committed
2198
  inline time_t query_start() { query_start_used=1; return start_time; }
2199
  inline void set_time()
2200
  {
2201 2202 2203 2204 2205 2206 2207
    if (user_time)
    {
      start_time= user_time;
      start_utime= utime_after_lock= my_micro_time();
    }
    else
      start_utime= utime_after_lock= my_micro_time_and_time(&start_time);
2208
  }
2209 2210 2211 2212 2213 2214
  inline void	set_current_time()    { start_time= my_time(MY_WME); }
  inline void	set_time(time_t t)
  {
    start_time= user_time= t;
    start_utime= utime_after_lock= my_micro_time();
  }
2215 2216 2217 2218 2219
  /*TODO: this will be obsolete when we have support for 64 bit my_time_t */
  inline bool	is_valid_time() 
  { 
    return (start_time < (time_t) MY_TIME_T_MAX); 
  }
2220 2221
  void set_time_after_lock()  { utime_after_lock= my_micro_time(); }
  ulonglong current_utime()  { return my_micro_time(); }
2222 2223 2224
  inline ulonglong found_rows(void)
  {
    return limit_found_rows;
2225
  }
2226 2227
  /**
    Returns TRUE if session is in a multi-statement transaction mode.
2228

2229 2230 2231
    OPTION_NOT_AUTOCOMMIT: When autocommit is off, a multi-statement
    transaction is implicitly started on the first statement after a
    previous transaction has been ended.
2232

2233 2234 2235
    OPTION_BEGIN: Regardless of the autocommit status, a multi-statement
    transaction can be explicitly started with the statements "START
    TRANSACTION", "BEGIN [WORK]", "[COMMIT | ROLLBACK] AND CHAIN", etc.
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247

    Note: this doesn't tell you whether a transaction is active.
    A session can be in multi-statement transaction mode, and yet
    have no active transaction, e.g., in case of:
    set @@autocommit=0;
    set @a= 3;                                     <-- these statements don't
    set transaction isolation level serializable;  <-- start an active
    flush tables;                                  <-- transaction

    I.e. for the above scenario this function returns TRUE, even
    though no active transaction has begun.
    @sa in_active_multi_stmt_transaction()
2248
  */
2249
  inline bool in_multi_stmt_transaction_mode()
2250
  {
unknown's avatar
unknown committed
2251
    return variables.option_bits & (OPTION_NOT_AUTOCOMMIT | OPTION_BEGIN);
2252
  }
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
  /**
    TRUE if the session is in a multi-statement transaction mode
    (@sa in_multi_stmt_transaction_mode()) *and* there is an
    active transaction, i.e. there is an explicit start of a
    transaction with BEGIN statement, or implicit with a
    statement that uses a transactional engine.

    For example, these scenarios don't start an active transaction
    (even though the server is in multi-statement transaction mode):

    set @@autocommit=0;
    select * from nontrans_table;
    set @var=TRUE;
    flush tables;

    Note, that even for a statement that starts a multi-statement
    transaction (i.e. select * from trans_table), this
    flag won't be set until we open the statement's tables
    and the engines register themselves for the transaction
    (see trans_register_ha()),
    hence this method is reliable to use only after
    open_tables() has completed.

    Why do we need a flag?
    ----------------------
    We need to maintain a (at first glance redundant)
    session flag, rather than looking at thd->transaction.all.ha_list
    because of explicit start of a transaction with BEGIN. 

    I.e. in case of
    BEGIN;
    select * from nontrans_t1; <-- in_active_multi_stmt_transaction() is true
  */
  inline bool in_active_multi_stmt_transaction()
  {
    return server_status & SERVER_STATUS_IN_TRANS;
  }
unknown's avatar
unknown committed
2290 2291
  inline bool fill_derived_tables()
  {
unknown's avatar
unknown committed
2292
    return !stmt_arena->is_stmt_prepare() && !lex->only_view_structure();
unknown's avatar
unknown committed
2293
  }
2294 2295 2296 2297
  inline bool fill_information_schema_tables()
  {
    return !stmt_arena->is_stmt_prepare();
  }
2298
  inline void* trans_alloc(unsigned int size)
unknown's avatar
unknown committed
2299
  {
2300 2301
    return alloc_root(&transaction.mem_root,size);
  }
2302

2303 2304 2305 2306
  LEX_STRING *make_lex_string(LEX_STRING *lex_str,
                              const char* str, uint length,
                              bool allocate_lex_string);

2307 2308 2309
  bool convert_string(LEX_STRING *to, CHARSET_INFO *to_cs,
		      const char *from, uint from_length,
		      CHARSET_INFO *from_cs);
2310 2311 2312

  bool convert_string(String *s, CHARSET_INFO *from_cs, CHARSET_INFO *to_cs);

2313
  void add_changed_table(TABLE *table);
unknown's avatar
unknown committed
2314 2315
  void add_changed_table(const char *key, long key_length);
  CHANGED_TABLE_LIST * changed_table_dup(const char *key, long key_length);
unknown's avatar
unknown committed
2316
  int send_explain_fields(select_result *result);
2317

2318 2319 2320 2321 2322 2323 2324
  /**
    Clear the current error, if any.
    We do not clear is_fatal_error or is_fatal_sub_stmt_error since we
    assume this is never called if the fatal error is set.
    @todo: To silence an error, one should use Internal_error_handler
    mechanism. In future this function will be removed.
  */
unknown's avatar
unknown committed
2325 2326
  inline void clear_error()
  {
2327
    DBUG_ENTER("clear_error");
Marc Alff's avatar
Marc Alff committed
2328 2329
    if (stmt_da->is_error())
      stmt_da->reset_diagnostics_area();
2330
    is_slave_error= 0;
2331
    DBUG_VOID_RETURN;
unknown's avatar
unknown committed
2332
  }
2333
#ifndef EMBEDDED_LIBRARY
2334
  inline bool vio_ok() const { return net.vio != 0; }
2335
  /** Return FALSE if connection to client is broken. */
2336 2337 2338 2339
  bool is_connected()
  {
    return vio_ok() ? vio_is_connected(net.vio) : FALSE;
  }
2340
#else
2341
  inline bool vio_ok() const { return TRUE; }
2342
  inline bool is_connected() { return TRUE; }
2343
#endif
2344 2345 2346 2347 2348
  /**
    Mark the current error as fatal. Warning: this does not
    set any error, it sets a property of the error, so must be
    followed or prefixed with my_error().
  */
2349 2350
  inline void fatal_error()
  {
2351
    DBUG_ASSERT(stmt_da->is_error() || killed);
2352
    is_fatal_error= 1;
unknown's avatar
unknown committed
2353
    DBUG_PRINT("error",("Fatal error set"));
2354
  }
2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367
  /**
    TRUE if there is an error in the error stack.

    Please use this method instead of direct access to
    net.report_error.

    If TRUE, the current (sub)-statement should be aborted.
    The main difference between this member and is_fatal_error
    is that a fatal error can not be handled by a stored
    procedure continue handler, whereas a normal error can.

    To raise this flag, use my_error().
  */
Marc Alff's avatar
Marc Alff committed
2368
  inline bool is_error() const { return stmt_da->is_error(); }
2369
  inline CHARSET_INFO *charset() { return variables.character_set_client; }
unknown's avatar
unknown committed
2370
  void update_charset();
2371

unknown's avatar
unknown committed
2372
  inline Query_arena *activate_stmt_arena_if_needed(Query_arena *backup)
unknown's avatar
unknown committed
2373 2374
  {
    /*
unknown's avatar
unknown committed
2375 2376
      Use the persistent arena if we are in a prepared statement or a stored
      procedure statement and we have not already changed to use this arena.
unknown's avatar
unknown committed
2377
    */
unknown's avatar
unknown committed
2378
    if (!stmt_arena->is_conventional() && mem_root != stmt_arena->mem_root)
unknown's avatar
unknown committed
2379
    {
unknown's avatar
unknown committed
2380 2381
      set_n_backup_active_arena(stmt_arena, backup);
      return stmt_arena;
unknown's avatar
unknown committed
2382 2383 2384 2385
    }
    return 0;
  }

2386
  void change_item_tree(Item **place, Item *new_value)
2387
  {
2388
    /* TODO: check for OOM condition here */
unknown's avatar
unknown committed
2389
    if (!stmt_arena->is_conventional())
unknown's avatar
unknown committed
2390
      nocheck_register_item_tree_change(place, *place, mem_root);
2391
    *place= new_value;
2392 2393
  }
  void nocheck_register_item_tree_change(Item **place, Item *old_value,
2394
                                         MEM_ROOT *runtime_memroot);
2395
  void rollback_item_tree_changes();
2396 2397 2398 2399 2400 2401

  /*
    Cleanup statement parse state (parse tree, lex) and execution
    state after execution of a non-prepared SQL statement.
  */
  void end_statement();
2402 2403
  inline int killed_errno() const
  {
2404 2405
    killed_state killed_val; /* to cache the volatile 'killed' */
    return (killed_val= killed) != KILL_BAD_DATA ? killed_val : 0;
2406 2407 2408
  }
  inline void send_kill_message() const
  {
unknown's avatar
unknown committed
2409
    int err= killed_errno();
2410
    if (err)
2411 2412 2413
    {
      if ((err == KILL_CONNECTION) && !shutdown_in_progress)
        err = KILL_QUERY;
2414
      my_message(err, ER(err), MYF(0));
2415
    }
2416
  }
unknown's avatar
unknown committed
2417 2418 2419 2420
  /* return TRUE if we will abort query if we make a warning now */
  inline bool really_abort_on_warning()
  {
    return (abort_on_warning &&
unknown's avatar
unknown committed
2421
            (!transaction.stmt.modified_non_trans_table ||
unknown's avatar
unknown committed
2422 2423
             (variables.sql_mode & MODE_STRICT_ALL_TABLES)));
  }
2424
  void set_status_var_init();
2425
  bool is_context_analysis_only()
unknown's avatar
unknown committed
2426
    { return stmt_arena->is_stmt_prepare() || lex->view_prepare_mode; }
2427 2428
  void reset_n_backup_open_tables_state(Open_tables_backup *backup);
  void restore_backup_open_tables_state(Open_tables_backup *backup);
2429 2430
  void reset_sub_statement_state(Sub_statement_state *backup, uint new_state);
  void restore_sub_statement_state(Sub_statement_state *backup);
unknown's avatar
unknown committed
2431 2432
  void set_n_backup_active_arena(Query_arena *set, Query_arena *backup);
  void restore_active_arena(Query_arena *set, Query_arena *backup);
2433

2434 2435 2436 2437
  /*
    @todo Make these methods private or remove them completely.  Only
    decide_logging_format should call them. /Sven
  */
2438
  inline void set_current_stmt_binlog_format_row_if_mixed()
2439
  {
2440
    DBUG_ENTER("set_current_stmt_binlog_format_row_if_mixed");
2441 2442 2443 2444 2445 2446 2447 2448
    /*
      This should only be called from decide_logging_format.

      @todo Once we have ensured this, uncomment the following
      statement, remove the big comment below that, and remove the
      in_sub_stmt==0 condition from the following 'if'.
    */
    /* DBUG_ASSERT(in_sub_stmt == 0); */
unknown's avatar
unknown committed
2449 2450 2451 2452 2453
    /*
      If in a stored/function trigger, the caller should already have done the
      change. We test in_sub_stmt to prevent introducing bugs where people
      wouldn't ensure that, and would switch to row-based mode in the middle
      of executing a stored function/trigger (which is too late, see also
2454
      reset_current_stmt_binlog_format_row()); this condition will make their
unknown's avatar
unknown committed
2455 2456 2457 2458 2459
      tests fail and so force them to propagate the
      lex->binlog_row_based_if_mixed upwards to the caller.
    */
    if ((variables.binlog_format == BINLOG_FORMAT_MIXED) &&
        (in_sub_stmt == 0))
2460
      set_current_stmt_binlog_format_row();
2461 2462

    DBUG_VOID_RETURN;
unknown's avatar
unknown committed
2463
  }
2464
  inline void set_current_stmt_binlog_format_row()
unknown's avatar
unknown committed
2465
  {
2466
    DBUG_ENTER("set_current_stmt_binlog_format_row");
2467 2468
    current_stmt_binlog_format= BINLOG_FORMAT_ROW;
    DBUG_VOID_RETURN;
2469
  }
2470
  inline void clear_current_stmt_binlog_format_row()
2471
  {
2472
    DBUG_ENTER("clear_current_stmt_binlog_format_row");
2473 2474
    current_stmt_binlog_format= BINLOG_FORMAT_STMT;
    DBUG_VOID_RETURN;
2475
  }
2476
  inline void reset_current_stmt_binlog_format_row()
2477
  {
2478
    DBUG_ENTER("reset_current_stmt_binlog_format_row");
unknown's avatar
unknown committed
2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493
    /*
      If there are temporary tables, don't reset back to
      statement-based. Indeed it could be that:
      CREATE TEMPORARY TABLE t SELECT UUID(); # row-based
      # and row-based does not store updates to temp tables
      # in the binlog.
      INSERT INTO u SELECT * FROM t; # stmt-based
      and then the INSERT will fail as data inserted into t was not logged.
      So we continue with row-based until the temp table is dropped.
      If we are in a stored function or trigger, we mustn't reset in the
      middle of its execution (as the binary logging way of a stored function
      or trigger is decided when it starts executing, depending for example on
      the caller (for a stored function: if caller is SELECT or
      INSERT/UPDATE/DELETE...).
    */
2494
    DBUG_PRINT("debug",
2495 2496
               ("temporary_tables: %s, in_sub_stmt: %s, system_thread: %s",
                YESNO(temporary_tables), YESNO(in_sub_stmt),
2497
                show_system_thread(system_thread)));
2498
    if (in_sub_stmt == 0)
unknown's avatar
unknown committed
2499
    {
2500
      if (variables.binlog_format == BINLOG_FORMAT_ROW)
2501
        set_current_stmt_binlog_format_row();
2502
      else if (temporary_tables == NULL)
2503
        clear_current_stmt_binlog_format_row();
unknown's avatar
unknown committed
2504
    }
2505
    DBUG_VOID_RETURN;
2506
  }
unknown's avatar
unknown committed
2507

2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519
  /**
    Set the current database; use deep copy of C-string.

    @param new_db     a pointer to the new database name.
    @param new_db_len length of the new database name.

    Initialize the current database from a NULL-terminated string with
    length. If we run out of memory, we free the current database and
    return TRUE.  This way the user will notice the error as there will be
    no current database selected (in addition to the error message set by
    malloc).

2520 2521 2522 2523
    @note This operation just sets {db, db_length}. Switching the current
    database usually involves other actions, like switching other database
    attributes including security context. In the future, this operation
    will be made private and more convenient interface will be provided.
2524 2525 2526 2527

    @return Operation status
      @retval FALSE Success
      @retval TRUE  Out-of-memory error
unknown's avatar
unknown committed
2528
  */
2529
  bool set_db(const char *new_db, size_t new_db_len)
unknown's avatar
unknown committed
2530
  {
2531 2532 2533 2534
    /* Do not reallocate memory if current chunk is big enough. */
    if (db && new_db && db_length >= new_db_len)
      memcpy(db, new_db, new_db_len+1);
    else
unknown's avatar
unknown committed
2535
    {
unknown's avatar
unknown committed
2536
      x_free(db);
2537 2538 2539 2540
      if (new_db)
        db= my_strndup(new_db, new_db_len, MYF(MY_WME | ME_FATALERROR));
      else
        db= NULL;
unknown's avatar
unknown committed
2541
    }
2542 2543
    db_length= db ? new_db_len : 0;
    return new_db && !db;
unknown's avatar
unknown committed
2544
  }
2545 2546 2547 2548 2549 2550 2551

  /**
    Set the current database; use shallow copy of C-string.

    @param new_db     a pointer to the new database name.
    @param new_db_len length of the new database name.

2552 2553 2554 2555
    @note This operation just sets {db, db_length}. Switching the current
    database usually involves other actions, like switching other database
    attributes including security context. In the future, this operation
    will be made private and more convenient interface will be provided.
2556
  */
2557
  void reset_db(char *new_db, size_t new_db_len)
unknown's avatar
unknown committed
2558 2559 2560 2561 2562 2563 2564 2565 2566
  {
    db= new_db;
    db_length= new_db_len;
  }
  /*
    Copy the current database to the argument. Use the current arena to
    allocate memory for a deep copy: current database may be freed after
    a statement is parsed but before it's executed.
  */
2567
  bool copy_db_to(char **p_db, size_t *p_db_length)
unknown's avatar
unknown committed
2568 2569 2570 2571 2572 2573 2574
  {
    if (db == NULL)
    {
      my_message(ER_NO_DB_ERROR, ER(ER_NO_DB_ERROR), MYF(0));
      return TRUE;
    }
    *p_db= strmake(db, db_length);
2575
    *p_db_length= db_length;
unknown's avatar
unknown committed
2576 2577
    return FALSE;
  }
unknown's avatar
unknown committed
2578
  thd_scheduler scheduler;
unknown's avatar
unknown committed
2579 2580

public:
2581 2582 2583
  inline Internal_error_handler *get_internal_handler()
  { return m_internal_handler; }

unknown's avatar
unknown committed
2584 2585 2586 2587 2588 2589 2590
  /**
    Add an internal error handler to the thread execution context.
    @param handler the exception handler to add
  */
  void push_internal_handler(Internal_error_handler *handler);

  /**
Marc Alff's avatar
Marc Alff committed
2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603
    Handle a sql condition.
    @param sql_errno the condition error number
    @param sqlstate the condition sqlstate
    @param level the condition level
    @param msg the condition message text
    @param[out] cond_hdl the sql condition raised, if any
    @return true if the condition is handled
  */
  virtual bool handle_condition(uint sql_errno,
                                const char* sqlstate,
                                MYSQL_ERROR::enum_warning_level level,
                                const char* msg,
                                MYSQL_ERROR ** cond_hdl);
unknown's avatar
unknown committed
2604 2605 2606 2607

  /**
    Remove the error handler last pushed.
  */
2608
  Internal_error_handler *pop_internal_handler();
unknown's avatar
unknown committed
2609

Marc Alff's avatar
Marc Alff committed
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691
  /**
    Raise an exception condition.
    @param code the MYSQL_ERRNO error code of the error
  */
  void raise_error(uint code);

  /**
    Raise an exception condition, with a formatted message.
    @param code the MYSQL_ERRNO error code of the error
  */
  void raise_error_printf(uint code, ...);

  /**
    Raise a completion condition (warning).
    @param code the MYSQL_ERRNO error code of the warning
  */
  void raise_warning(uint code);

  /**
    Raise a completion condition (warning), with a formatted message.
    @param code the MYSQL_ERRNO error code of the warning
  */
  void raise_warning_printf(uint code, ...);

  /**
    Raise a completion condition (note), with a fixed message.
    @param code the MYSQL_ERRNO error code of the note
  */
  void raise_note(uint code);

  /**
    Raise an completion condition (note), with a formatted message.
    @param code the MYSQL_ERRNO error code of the note
  */
  void raise_note_printf(uint code, ...);

private:
  /*
    Only the implementation of the SIGNAL and RESIGNAL statements
    is permitted to raise SQL conditions in a generic way,
    or to raise them by bypassing handlers (RESIGNAL).
    To raise a SQL condition, the code should use the public
    raise_error() or raise_warning() methods provided by class THD.
  */
  friend class Signal_common;
  friend class Signal_statement;
  friend class Resignal_statement;
  friend void push_warning(THD*, MYSQL_ERROR::enum_warning_level, uint, const char*);
  friend void my_message_sql(uint, const char *, myf);

  /**
    Raise a generic SQL condition.
    @param sql_errno the condition error number
    @param sqlstate the condition SQLSTATE
    @param level the condition level
    @param msg the condition message text
    @return The condition raised, or NULL
  */
  MYSQL_ERROR*
  raise_condition(uint sql_errno,
                  const char* sqlstate,
                  MYSQL_ERROR::enum_warning_level level,
                  const char* msg);

  /**
    Raise a generic SQL condition, without activation any SQL condition
    handlers.
    This method is necessary to support the RESIGNAL statement,
    which is allowed to bypass SQL exception handlers.
    @param sql_errno the condition error number
    @param sqlstate the condition SQLSTATE
    @param level the condition level
    @param msg the condition message text
    @return The condition raised, or NULL
  */
  MYSQL_ERROR*
  raise_condition_no_handler(uint sql_errno,
                             const char* sqlstate,
                             MYSQL_ERROR::enum_warning_level level,
                             const char* msg);

public:
2692 2693 2694 2695
  /** Overloaded to guard query/query_length fields */
  virtual void set_statement(Statement *stmt);

  /**
2696
    Assign a new value to thd->query and thd->query_id.
2697 2698 2699
    Protected with LOCK_thd_data mutex.
  */
  void set_query(char *query_arg, uint32 query_length_arg);
2700 2701 2702
  void set_query_and_id(char *query_arg, uint32 query_length_arg,
                        query_id_t new_query_id);
  void set_query_id(query_id_t new_query_id);
2703 2704 2705 2706 2707 2708
  void set_open_tables(TABLE *open_tables_arg)
  {
    mysql_mutex_lock(&LOCK_thd_data);
    open_tables= open_tables_arg;
    mysql_mutex_unlock(&LOCK_thd_data);
  }
2709 2710 2711
  void enter_locked_tables_mode(enum_locked_tables_mode mode_arg)
  {
    DBUG_ASSERT(locked_tables_mode == LTM_NONE);
2712 2713

    mdl_context.set_trans_sentinel();
2714 2715
    locked_tables_mode= mode_arg;
  }
2716
  void leave_locked_tables_mode();
2717
  int decide_logging_format(TABLE_LIST *tables);
unknown's avatar
unknown committed
2718
private:
2719

unknown's avatar
unknown committed
2720 2721
  /** The current internal error handler for this thread, or NULL. */
  Internal_error_handler *m_internal_handler;
2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737
  /**
    The lex to hold the parsed tree of conventional (non-prepared) queries.
    Whereas for prepared and stored procedure statements we use an own lex
    instance for each new query, for conventional statements we reuse
    the same lex. (@see mysql_parse for details).
  */
  LEX main_lex;
  /**
    This memory root is used for two purposes:
    - for conventional queries, to allocate structures stored in main_lex
    during parsing, and allocate runtime data (execution plan, etc.)
    during execution.
    - for prepared queries, only to allocate runtime data. The parsed
    tree itself is reused between executions and thus is stored elsewhere.
  */
  MEM_ROOT main_mem_root;
Marc Alff's avatar
Marc Alff committed
2738 2739
  Warning_info main_warning_info;
  Diagnostics_area main_da;
unknown's avatar
unknown committed
2740 2741
};

2742

Marc Alff's avatar
Marc Alff committed
2743
/** A short cut for thd->stmt_da->set_ok_status(). */
2744 2745

inline void
Marc Alff's avatar
Marc Alff committed
2746
my_ok(THD *thd, ulonglong affected_rows= 0, ulonglong id= 0,
2747 2748
        const char *message= NULL)
{
2749
  thd->set_row_count_func(affected_rows);
Marc Alff's avatar
Marc Alff committed
2750
  thd->stmt_da->set_ok_status(thd, affected_rows, id, message);
2751 2752 2753
}


Marc Alff's avatar
Marc Alff committed
2754
/** A short cut for thd->stmt_da->set_eof_status(). */
2755 2756

inline void
2757
my_eof(THD *thd)
2758
{
2759
  thd->set_row_count_func(-1);
Marc Alff's avatar
Marc Alff committed
2760
  thd->stmt_da->set_eof_status(thd);
2761 2762
}

2763
#define tmp_disable_binlog(A)       \
2764 2765
  {ulonglong tmp_disable_binlog__save_options= (A)->variables.option_bits; \
  (A)->variables.option_bits&= ~OPTION_BIN_LOG
2766

2767
#define reenable_binlog(A)   (A)->variables.option_bits= tmp_disable_binlog__save_options;}
2768

2769

unknown's avatar
unknown committed
2770
/*
2771
  Used to hold information about file and file structure in exchange
unknown's avatar
unknown committed
2772
  via non-DB file (...INTO OUTFILE..., ...LOAD DATA...)
2773
  XXX: We never call destructor for objects of this class.
unknown's avatar
unknown committed
2774
*/
2775

unknown's avatar
unknown committed
2776 2777 2778
class sql_exchange :public Sql_alloc
{
public:
2779
  enum enum_filetype filetype; /* load XML, Added by Arnold & Erik */
unknown's avatar
unknown committed
2780 2781 2782 2783
  char *file_name;
  String *field_term,*enclosed,*line_term,*line_start,*escaped;
  bool opt_enclosed;
  bool dumpfile;
2784
  ulong skip_lines;
2785
  CHARSET_INFO *cs;
2786 2787
  sql_exchange(char *name, bool dumpfile_flag,
               enum_filetype filetype_arg= FILETYPE_CSV);
2788
  bool escaped_given(void);
unknown's avatar
unknown committed
2789 2790 2791
};

/*
2792
  This is used to get result from a select
unknown's avatar
unknown committed
2793 2794
*/

unknown's avatar
unknown committed
2795 2796
class JOIN;

unknown's avatar
unknown committed
2797 2798 2799
class select_result :public Sql_alloc {
protected:
  THD *thd;
2800
  SELECT_LEX_UNIT *unit;
unknown's avatar
unknown committed
2801 2802 2803
public:
  select_result();
  virtual ~select_result() {};
2804 2805 2806 2807 2808
  virtual int prepare(List<Item> &list, SELECT_LEX_UNIT *u)
  {
    unit= u;
    return 0;
  }
2809
  virtual int prepare2(void) { return 0; }
2810 2811 2812 2813 2814 2815 2816
  /*
    Because of peculiarities of prepared statements protocol
    we need to know number of columns in the result set (if
    there is a result set) apart from sending columns metadata.
  */
  virtual uint field_count(List<Item> &fields) const
  { return fields.elements; }
2817
  virtual bool send_result_set_metadata(List<Item> &list, uint flags)=0;
unknown's avatar
unknown committed
2818
  virtual bool send_data(List<Item> &items)=0;
unknown's avatar
unknown committed
2819
  virtual bool initialize_tables (JOIN *join=0) { return 0; }
2820
  virtual void send_error(uint errcode,const char *err);
unknown's avatar
unknown committed
2821
  virtual bool send_eof()=0;
2822 2823 2824 2825 2826 2827 2828 2829
  /**
    Check if this query returns a result set and therefore is allowed in
    cursors and set an error message if it is not the case.

    @retval FALSE     success
    @retval TRUE      error, an error message is set
  */
  virtual bool check_simple_select() const;
unknown's avatar
unknown committed
2830
  virtual void abort() {}
2831 2832 2833 2834 2835
  /*
    Cleanup instance of this class for next execution of a prepared
    statement/stored procedure.
  */
  virtual void cleanup();
2836
  void set_thd(THD *thd_arg) { thd= thd_arg; }
2837 2838 2839 2840 2841
#ifdef EMBEDDED_LIBRARY
  virtual void begin_dataset() {}
#else
  void begin_dataset() {}
#endif
unknown's avatar
unknown committed
2842 2843 2844
};


2845 2846 2847 2848 2849 2850 2851 2852 2853
/*
  Base class for select_result descendands which intercept and
  transform result set rows. As the rows are not sent to the client,
  sending of result set metadata should be suppressed as well.
*/

class select_result_interceptor: public select_result
{
public:
2854
  select_result_interceptor() {}              /* Remove gcc warning */
2855
  uint field_count(List<Item> &fields) const { return 0; }
2856
  bool send_result_set_metadata(List<Item> &fields, uint flag) { return FALSE; }
2857 2858 2859
};


unknown's avatar
unknown committed
2860
class select_send :public select_result {
2861 2862 2863 2864 2865 2866
  /**
    True if we have sent result set metadata to the client.
    In this case the client always expects us to end the result
    set with an eof or error packet
  */
  bool is_result_set_started;
unknown's avatar
unknown committed
2867
public:
2868
  select_send() :is_result_set_started(FALSE) {}
2869
  bool send_result_set_metadata(List<Item> &list, uint flags);
unknown's avatar
unknown committed
2870 2871
  bool send_data(List<Item> &items);
  bool send_eof();
2872
  virtual bool check_simple_select() const { return FALSE; }
2873
  void abort();
2874
  virtual void cleanup();
unknown's avatar
unknown committed
2875 2876 2877
};


2878
class select_to_file :public select_result_interceptor {
2879
protected:
unknown's avatar
unknown committed
2880 2881 2882 2883
  sql_exchange *exchange;
  File file;
  IO_CACHE cache;
  ha_rows row_count;
2884 2885 2886 2887 2888 2889 2890
  char path[FN_REFLEN];

public:
  select_to_file(sql_exchange *ex) :exchange(ex), file(-1),row_count(0L)
  { path[0]=0; }
  ~select_to_file();
  void send_error(uint errcode,const char *err);
2891 2892
  bool send_eof();
  void cleanup();
2893 2894 2895
};


unknown's avatar
unknown committed
2896 2897 2898
#define ESCAPE_CHARS "ntrb0ZN" // keep synchronous with READ_INFO::unescape


unknown's avatar
unknown committed
2899 2900 2901 2902 2903 2904
/*
 List of all possible characters of a numeric value text representation.
*/
#define NUMERIC_CHARS ".0123456789e+-"


2905
class select_export :public select_to_file {
unknown's avatar
unknown committed
2906 2907
  uint field_term_length;
  int field_sep_char,escape_char,line_sep_char;
2908
  int field_term_char; // first char of FIELDS TERMINATED BY or MAX_INT
unknown's avatar
unknown committed
2909 2910 2911 2912 2913 2914
  /*
    The is_ambiguous_field_sep field is true if a value of the field_sep_char
    field is one of the 'n', 't', 'r' etc characters
    (see the READ_INFO::unescape method and the ESCAPE_CHARS constant value).
  */
  bool is_ambiguous_field_sep;
2915 2916 2917 2918 2919 2920
  /*
     The is_ambiguous_field_term is true if field_sep_char contains the first
     char of the FIELDS TERMINATED BY (ENCLOSED BY is empty), and items can
     contain this character.
  */
  bool is_ambiguous_field_term;
unknown's avatar
unknown committed
2921 2922 2923 2924 2925 2926
  /*
    The is_unsafe_field_sep field is true if a value of the field_sep_char
    field is one of the '0'..'9', '+', '-', '.' and 'e' characters
    (see the NUMERIC_CHARS constant value).
  */
  bool is_unsafe_field_sep;
unknown's avatar
unknown committed
2927
  bool fixed_row_size;
2928
  CHARSET_INFO *write_cs; // output charset
unknown's avatar
unknown committed
2929
public:
2930
  select_export(sql_exchange *ex) :select_to_file(ex) {}
unknown's avatar
unknown committed
2931
  ~select_export();
2932
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
unknown's avatar
unknown committed
2933 2934 2935
  bool send_data(List<Item> &items);
};

unknown's avatar
unknown committed
2936

2937
class select_dump :public select_to_file {
unknown's avatar
unknown committed
2938
public:
2939
  select_dump(sql_exchange *ex) :select_to_file(ex) {}
2940
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
unknown's avatar
unknown committed
2941 2942
  bool send_data(List<Item> &items);
};
unknown's avatar
unknown committed
2943 2944


2945
class select_insert :public select_result_interceptor {
unknown's avatar
unknown committed
2946
 public:
unknown's avatar
VIEW  
unknown committed
2947
  TABLE_LIST *table_list;
unknown's avatar
unknown committed
2948 2949
  TABLE *table;
  List<Item> *fields;
2950
  ulonglong autoinc_value_of_last_inserted_row; // autogenerated or not
unknown's avatar
unknown committed
2951
  COPY_INFO info;
unknown's avatar
VIEW  
unknown committed
2952
  bool insert_into_view;
unknown's avatar
unknown committed
2953 2954
  select_insert(TABLE_LIST *table_list_par,
		TABLE *table_par, List<Item> *fields_par,
unknown's avatar
unknown committed
2955
		List<Item> *update_fields, List<Item> *update_values,
2956
		enum_duplicates duplic, bool ignore);
unknown's avatar
unknown committed
2957
  ~select_insert();
2958
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
2959
  virtual int prepare2(void);
unknown's avatar
unknown committed
2960
  bool send_data(List<Item> &items);
unknown's avatar
unknown committed
2961
  virtual void store_values(List<Item> &values);
2962
  virtual bool can_rollback_data() { return 0; }
unknown's avatar
unknown committed
2963 2964
  void send_error(uint errcode,const char *err);
  bool send_eof();
2965
  void abort();
2966 2967
  /* not implemented: select_insert is never re-used in prepared statements */
  void cleanup();
unknown's avatar
unknown committed
2968 2969
};

unknown's avatar
unknown committed
2970

unknown's avatar
unknown committed
2971 2972
class select_create: public select_insert {
  ORDER *group;
unknown's avatar
VIEW  
unknown committed
2973
  TABLE_LIST *create_table;
unknown's avatar
unknown committed
2974
  HA_CREATE_INFO *create_info;
2975
  TABLE_LIST *select_tables;
2976
  Alter_info *alter_info;
unknown's avatar
unknown committed
2977
  Field **field;
2978 2979 2980 2981
  /* lock data for tmp table */
  MYSQL_LOCK *m_lock;
  /* m_lock or thd->extra_lock */
  MYSQL_LOCK **m_plock;
unknown's avatar
unknown committed
2982
public:
unknown's avatar
unknown committed
2983
  select_create (TABLE_LIST *table_arg,
unknown's avatar
VIEW  
unknown committed
2984
		 HA_CREATE_INFO *create_info_par,
2985
                 Alter_info *alter_info_arg,
2986 2987
		 List<Item> &select_fields,enum_duplicates duplic, bool ignore,
                 TABLE_LIST *select_tables_arg)
2988
    :select_insert (NULL, NULL, &select_fields, 0, 0, duplic, ignore),
2989
    create_table(table_arg),
2990 2991
    create_info(create_info_par),
    select_tables(select_tables_arg),
2992 2993
    alter_info(alter_info_arg),
    m_plock(NULL)
unknown's avatar
unknown committed
2994
    {}
2995
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
2996

2997
  int binlog_show_create_table(TABLE **tables, uint count);
unknown's avatar
unknown committed
2998
  void store_values(List<Item> &values);
2999
  void send_error(uint errcode,const char *err);
unknown's avatar
unknown committed
3000 3001
  bool send_eof();
  void abort();
3002 3003
  virtual bool can_rollback_data() { return 1; }

3004
  // Needed for access from local class MY_HOOKS in prepare(), since thd is proteted.
3005 3006
  const THD *get_thd(void) { return thd; }
  const HA_CREATE_INFO *get_create_info() { return create_info; };
3007
  int prepare2(void) { return 0; }
unknown's avatar
unknown committed
3008 3009
};

3010 3011
#include <myisam.h>

unknown's avatar
unknown committed
3012 3013 3014 3015 3016
/* 
  Param to create temporary tables when doing SELECT:s 
  NOTE
    This structure is copied using memcpy as a part of JOIN.
*/
3017 3018 3019

class TMP_TABLE_PARAM :public Sql_alloc
{
3020 3021 3022 3023 3024 3025
private:
  /* Prevent use of these (not safe because of lists and copy_field) */
  TMP_TABLE_PARAM(const TMP_TABLE_PARAM &);
  void operator=(TMP_TABLE_PARAM &);

public:
3026 3027 3028 3029
  List<Item> copy_funcs;
  List<Item> save_copy_funcs;
  Copy_field *copy_field, *copy_field_end;
  Copy_field *save_copy_field, *save_copy_field_end;
3030
  uchar	    *group_buff;
3031 3032 3033 3034
  Item	    **items_to_copy;			/* Fields in tmp table */
  MI_COLUMNDEF *recinfo,*start_recinfo;
  KEY *keyinfo;
  ha_rows end_write_records;
3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060
  /**
    Number of normal fields in the query, including those referred to
    from aggregate functions. Hence, "SELECT `field1`,
    SUM(`field2`) from t1" sets this counter to 2.

    @see count_field_types
  */
  uint	field_count; 
  /**
    Number of fields in the query that have functions. Includes both
    aggregate functions (e.g., SUM) and non-aggregates (e.g., RAND).
    Also counts functions referred to from aggregate functions, i.e.,
    "SELECT SUM(RAND())" sets this counter to 2.

    @see count_field_types
  */
  uint  func_count;  
  /**
    Number of fields in the query that have aggregate functions. Note
    that the optimizer may choose to optimize away these fields by
    replacing them with constants, in which case sum_func_count will
    need to be updated.

    @see opt_sum_query, count_field_types
  */
  uint  sum_func_count;   
3061 3062 3063 3064
  uint  hidden_field_count;
  uint	group_parts,group_length,group_null_parts;
  uint	quick_group;
  bool  using_indirect_summary_function;
3065 3066
  /* If >0 convert all blob fields to varchar(convert_blob_length) */
  uint  convert_blob_length; 
unknown's avatar
unknown committed
3067
  CHARSET_INFO *table_charset; 
3068
  bool schema_table;
3069 3070 3071 3072 3073 3074 3075
  /*
    True if GROUP BY and its aggregate functions are already computed
    by a table access method (e.g. by loose index scan). In this case
    query execution should not perform aggregation and should treat
    aggregate functions as normal functions.
  */
  bool precomputed_group_by;
3076
  bool force_copy_fields;
3077 3078

  TMP_TABLE_PARAM()
unknown's avatar
unknown committed
3079
    :copy_field(0), group_parts(0),
unknown's avatar
unknown committed
3080
     group_length(0), group_null_parts(0), convert_blob_length(0),
unknown's avatar
unknown committed
3081
     schema_table(0), precomputed_group_by(0), force_copy_fields(0)
3082 3083 3084 3085 3086
  {}
  ~TMP_TABLE_PARAM()
  {
    cleanup();
  }
3087
  void init(void);
3088 3089 3090 3091 3092
  inline void cleanup(void)
  {
    if (copy_field)				/* Fix for Intel compiler */
    {
      delete [] copy_field;
3093
      save_copy_field= copy_field= 0;
3094 3095 3096 3097
    }
  }
};

3098 3099
class select_union :public select_result_interceptor
{
3100
  TMP_TABLE_PARAM tmp_table_param;
3101 3102
public:
  TABLE *table;
unknown's avatar
unknown committed
3103

3104
  select_union() :table(0) {}
3105
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
unknown's avatar
unknown committed
3106 3107 3108
  bool send_data(List<Item> &items);
  bool send_eof();
  bool flush();
3109 3110 3111 3112

  bool create_result_table(THD *thd, List<Item> *column_types,
                           bool is_distinct, ulonglong options,
                           const char *alias);
unknown's avatar
unknown committed
3113 3114
};

unknown's avatar
unknown committed
3115
/* Base subselect interface class */
3116
class select_subselect :public select_result_interceptor
3117
{
unknown's avatar
unknown committed
3118
protected:
3119 3120 3121
  Item_subselect *item;
public:
  select_subselect(Item_subselect *item);
unknown's avatar
unknown committed
3122
  bool send_data(List<Item> &items)=0;
3123 3124 3125
  bool send_eof() { return 0; };
};

unknown's avatar
unknown committed
3126
/* Single value subselect interface class */
unknown's avatar
unknown committed
3127
class select_singlerow_subselect :public select_subselect
unknown's avatar
unknown committed
3128 3129
{
public:
3130 3131 3132
  select_singlerow_subselect(Item_subselect *item_arg)
    :select_subselect(item_arg)
  {}
unknown's avatar
unknown committed
3133 3134 3135
  bool send_data(List<Item> &items);
};

3136 3137 3138 3139 3140 3141 3142
/* used in independent ALL/ANY optimisation */
class select_max_min_finder_subselect :public select_subselect
{
  Item_cache *cache;
  bool (select_max_min_finder_subselect::*op)();
  bool fmax;
public:
3143 3144
  select_max_min_finder_subselect(Item_subselect *item_arg, bool mx)
    :select_subselect(item_arg), cache(0), fmax(mx)
3145
  {}
unknown's avatar
Merge  
unknown committed
3146
  void cleanup();
3147 3148 3149
  bool send_data(List<Item> &items);
  bool cmp_real();
  bool cmp_int();
unknown's avatar
Merge  
unknown committed
3150
  bool cmp_decimal();
3151 3152 3153
  bool cmp_str();
};

unknown's avatar
unknown committed
3154 3155 3156 3157
/* EXISTS subselect interface class */
class select_exists_subselect :public select_subselect
{
public:
3158 3159
  select_exists_subselect(Item_subselect *item_arg)
    :select_subselect(item_arg){}
unknown's avatar
unknown committed
3160 3161 3162
  bool send_data(List<Item> &items);
};

unknown's avatar
unknown committed
3163 3164 3165 3166 3167 3168
/* Structs used when sorting */

typedef struct st_sort_field {
  Field *field;				/* Field to sort */
  Item	*item;				/* Item if not sorting fields */
  uint	 length;			/* Length of sort field */
3169
  uint   suffix_length;                 /* Length suffix (0-4) */
unknown's avatar
unknown committed
3170
  Item_result result_type;		/* Type of item */
3171 3172
  bool reverse;				/* if descending sort */
  bool need_strxnfrm;			/* If we have to use strxnfrm() */
unknown's avatar
unknown committed
3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185
} SORT_FIELD;


typedef struct st_sort_buffer {
  uint index;					/* 0 or 1 */
  uint sort_orders;
  uint change_pos;				/* If sort-fields changed */
  char **buff;
  SORT_FIELD *sortorder;
} SORT_BUFFER;

/* Structure for db & table in sql_yacc */

3186 3187
class Table_ident :public Sql_alloc
{
unknown's avatar
unknown committed
3188
public:
unknown's avatar
unknown committed
3189 3190
  LEX_STRING db;
  LEX_STRING table;
unknown's avatar
unknown committed
3191
  SELECT_LEX_UNIT *sel;
unknown's avatar
unknown committed
3192 3193
  inline Table_ident(THD *thd, LEX_STRING db_arg, LEX_STRING table_arg,
		     bool force)
unknown's avatar
unknown committed
3194
    :table(table_arg), sel((SELECT_LEX_UNIT *)0)
unknown's avatar
unknown committed
3195
  {
unknown's avatar
unknown committed
3196
    if (!force && (thd->client_capabilities & CLIENT_NO_SCHEMA))
unknown's avatar
unknown committed
3197 3198 3199 3200
      db.str=0;
    else
      db= db_arg;
  }
unknown's avatar
unknown committed
3201 3202 3203 3204 3205
  inline Table_ident(LEX_STRING table_arg) 
    :table(table_arg), sel((SELECT_LEX_UNIT *)0)
  {
    db.str=0;
  }
3206 3207 3208 3209 3210 3211
  /*
    This constructor is used only for the case when we create a derived
    table. A derived table has no name and doesn't belong to any database.
    Later, if there was an alias specified for the table, it will be set
    by add_table_to_list.
  */
unknown's avatar
foo1  
unknown committed
3212
  inline Table_ident(SELECT_LEX_UNIT *s) : sel(s)
unknown's avatar
unknown committed
3213
  {
unknown's avatar
unknown committed
3214
    /* We must have a table name here as this is used with add_table_to_list */
3215 3216 3217 3218
    db.str= empty_c_string;                    /* a subject to casedn_str */
    db.length= 0;
    table.str= internal_table_name;
    table.length=1;
unknown's avatar
unknown committed
3219
  }
3220
  bool is_derived_table() const { return test(sel); }
unknown's avatar
unknown committed
3221
  inline void change_db(char *db_name)
unknown's avatar
unknown committed
3222 3223 3224
  {
    db.str= db_name; db.length= (uint) strlen(db_name);
  }
unknown's avatar
unknown committed
3225 3226 3227 3228 3229 3230
};

// this is needed for user_vars hash
class user_var_entry
{
 public:
3231
  user_var_entry() {}                         /* Remove gcc warning */
unknown's avatar
unknown committed
3232 3233
  LEX_STRING name;
  char *value;
3234 3235
  ulong length;
  query_id_t update_query_id, used_query_id;
unknown's avatar
unknown committed
3236
  Item_result type;
3237
  bool unsigned_flag;
3238

unknown's avatar
Merge  
unknown committed
3239
  double val_real(my_bool *null_value);
3240
  longlong val_int(my_bool *null_value) const;
3241
  String *val_str(my_bool *null_value, String *str, uint decimals);
unknown's avatar
Merge  
unknown committed
3242
  my_decimal *val_decimal(my_bool *null_value, my_decimal *result);
3243
  DTCollation collation;
unknown's avatar
unknown committed
3244 3245
};

3246 3247 3248 3249 3250 3251 3252
/*
   Unique -- class for unique (removing of duplicates). 
   Puts all values to the TREE. If the tree becomes too big,
   it's dumped to the file. User can request sorted values, or
   just iterate through them. In the last case tree merging is performed in
   memory simultaneously with iteration, so it should be ~2-3x faster.
 */
3253 3254 3255 3256

class Unique :public Sql_alloc
{
  DYNAMIC_ARRAY file_ptrs;
3257 3258
  ulong max_elements;
  ulonglong max_in_memory_size;
3259 3260
  IO_CACHE file;
  TREE tree;
3261
  uchar *record_pointers;
3262
  bool flush();
3263
  uint size;
3264 3265 3266

public:
  ulong elements;
3267
  Unique(qsort_cmp2 comp_func, void *comp_func_fixed_arg,
3268
	 uint size_arg, ulonglong max_in_memory_size_arg);
3269
  ~Unique();
3270
  ulong elements_in_tree() { return tree.elements_in_tree; }
3271
  inline bool unique_add(void *ptr)
3272
  {
unknown's avatar
Merge  
unknown committed
3273
    DBUG_ENTER("unique_add");
unknown's avatar
unknown committed
3274
    DBUG_PRINT("info", ("tree %u - %lu", tree.elements_in_tree, max_elements));
3275
    if (tree.elements_in_tree > max_elements && flush())
unknown's avatar
Merge  
unknown committed
3276 3277
      DBUG_RETURN(1);
    DBUG_RETURN(!tree_insert(&tree, ptr, 0, tree.custom_arg));
3278 3279 3280
  }

  bool get(TABLE *table);
3281
  static double get_use_cost(uint *buffer, uint nkeys, uint key_size, 
3282
                             ulonglong max_in_memory_size);
3283
  inline static int get_cost_calc_buff_size(ulong nkeys, uint key_size, 
3284
                                            ulonglong max_in_memory_size)
3285
  {
3286
    register ulonglong max_elems_in_tree=
3287
      (1 + max_in_memory_size / ALIGN_SIZE(sizeof(TREE_ELEMENT)+key_size));
3288
    return (int) (sizeof(uint)*(1 + nkeys/max_elems_in_tree));
3289 3290
  }

3291 3292 3293
  void reset();
  bool walk(tree_walk_action action, void *walk_action_arg);

3294 3295 3296
  uint get_size() const { return size; }
  ulonglong get_max_in_memory_size() const { return max_in_memory_size; }

3297 3298
  friend int unique_write_to_file(uchar* key, element_count count, Unique *unique);
  friend int unique_write_to_ptrs(uchar* key, element_count count, Unique *unique);
3299
};
3300

unknown's avatar
unknown committed
3301

3302
class multi_delete :public select_result_interceptor
unknown's avatar
unknown committed
3303 3304
{
  TABLE_LIST *delete_tables, *table_being_deleted;
unknown's avatar
unknown committed
3305
  Unique **tempfiles;
3306
  ha_rows deleted, found;
unknown's avatar
unknown committed
3307 3308
  uint num_of_tables;
  int error;
3309 3310 3311 3312 3313 3314
  bool do_delete;
  /* True if at least one table we delete from is transactional */
  bool transactional_tables;
  /* True if at least one table we delete from is not transactional */
  bool normal_tables;
  bool delete_while_scanning;
3315 3316 3317 3318 3319
  /*
     error handling (rollback and binlogging) can happen in send_eof()
     so that afterward send_error() needs to find out that.
  */
  bool error_handled;
3320

unknown's avatar
unknown committed
3321
public:
3322
  multi_delete(TABLE_LIST *dt, uint num_of_tables);
unknown's avatar
unknown committed
3323 3324 3325 3326 3327
  ~multi_delete();
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
  bool send_data(List<Item> &items);
  bool initialize_tables (JOIN *join);
  void send_error(uint errcode,const char *err);
3328 3329
  int do_deletes();
  int do_table_deletes(TABLE *table, bool ignore);
unknown's avatar
unknown committed
3330
  bool send_eof();
3331 3332 3333 3334
  inline ha_rows num_deleted()
  {
    return deleted;
  }
3335
  virtual void abort();
unknown's avatar
unknown committed
3336 3337
};

3338

3339
class multi_update :public select_result_interceptor
unknown's avatar
unknown committed
3340
{
3341 3342 3343
  TABLE_LIST *all_tables; /* query/update command tables */
  TABLE_LIST *leaves;     /* list of leves of join table tree */
  TABLE_LIST *update_tables, *table_being_updated;
unknown's avatar
unknown committed
3344
  TABLE **tmp_tables, *main_table, *table_to_update;
unknown's avatar
unknown committed
3345 3346 3347 3348 3349
  TMP_TABLE_PARAM *tmp_table_param;
  ha_rows updated, found;
  List <Item> *fields, *values;
  List <Item> **fields_for_table, **values_for_table;
  uint table_count;
unknown's avatar
unknown committed
3350 3351 3352 3353 3354
  /*
   List of tables referenced in the CHECK OPTION condition of
   the updated view excluding the updated table. 
  */
  List <TABLE> unupdated_check_opt_tables;
unknown's avatar
unknown committed
3355 3356
  Copy_field *copy_field;
  enum enum_duplicates handle_duplicates;
3357 3358 3359 3360
  bool do_update, trans_safe;
  /* True if the update operation has made a change in a transactional table */
  bool transactional_tables;
  bool ignore;
3361 3362 3363 3364 3365
  /* 
     error handling (rollback and binlogging) can happen in send_eof()
     so that afterward send_error() needs to find out that.
  */
  bool error_handled;
unknown's avatar
unknown committed
3366 3367

public:
3368
  multi_update(TABLE_LIST *ut, TABLE_LIST *leaves_list,
3369
	       List<Item> *fields, List<Item> *values,
3370
	       enum_duplicates handle_duplicates, bool ignore);
unknown's avatar
unknown committed
3371
  ~multi_update();
unknown's avatar
unknown committed
3372
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
unknown's avatar
unknown committed
3373 3374 3375
  bool send_data(List<Item> &items);
  bool initialize_tables (JOIN *join);
  void send_error(uint errcode,const char *err);
3376
  int  do_updates();
unknown's avatar
unknown committed
3377
  bool send_eof();
3378 3379 3380 3381 3382 3383 3384 3385
  inline ha_rows num_found()
  {
    return found;
  }
  inline ha_rows num_updated()
  {
    return updated;
  }
3386
  virtual void abort();
unknown's avatar
unknown committed
3387
};
3388

unknown's avatar
unknown committed
3389 3390 3391
class my_var : public Sql_alloc  {
public:
  LEX_STRING s;
unknown's avatar
unknown committed
3392
#ifndef DBUG_OFF
3393 3394 3395 3396
  /*
    Routine to which this Item_splocal belongs. Used for checking if correct
    runtime context is used for variable handling.
  */
3397
  sp_head *sp;
3398
#endif
unknown's avatar
unknown committed
3399 3400
  bool local;
  uint offset;
3401 3402 3403 3404
  enum_field_types type;
  my_var (LEX_STRING& j, bool i, uint o, enum_field_types t)
    :s(j), local(i), offset(o), type(t)
  {}
unknown's avatar
unknown committed
3405 3406
  ~my_var() {}
};
3407

3408
class select_dumpvar :public select_result_interceptor {
unknown's avatar
unknown committed
3409 3410
  ha_rows row_count;
public:
unknown's avatar
unknown committed
3411
  List<my_var> var_list;
3412
  select_dumpvar()  { var_list.empty(); row_count= 0;}
unknown's avatar
unknown committed
3413
  ~select_dumpvar() {}
3414
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
unknown's avatar
unknown committed
3415 3416
  bool send_data(List<Item> &items);
  bool send_eof();
3417
  virtual bool check_simple_select() const;
3418
  void cleanup();
unknown's avatar
unknown committed
3419
};
3420

3421 3422
/* Bits in sql_command_flags */

Marc Alff's avatar
Marc Alff committed
3423
#define CF_CHANGES_DATA           (1U << 0)
3424
/* The 2nd bit is unused -- it used to be CF_HAS_ROW_COUNT. */
Marc Alff's avatar
Marc Alff committed
3425 3426 3427
#define CF_STATUS_COMMAND         (1U << 2)
#define CF_SHOW_TABLE_COMMAND     (1U << 3)
#define CF_WRITE_LOGS_COMMAND     (1U << 4)
3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440
/**
  Must be set for SQL statements that may contain
  Item expressions and/or use joins and tables.
  Indicates that the parse tree of such statement may
  contain rule-based optimizations that depend on metadata
  (i.e. number of columns in a table), and consequently
  that the statement must be re-prepared whenever
  referenced metadata changes. Must not be set for
  statements that themselves change metadata, e.g. RENAME,
  ALTER and other DDL, since otherwise will trigger constant
  reprepare. Consequently, complex item expressions and
  joins are currently prohibited in these statements.
*/
Marc Alff's avatar
Marc Alff committed
3441
#define CF_REEXECUTION_FRAGILE    (1U << 5)
Konstantin Osipov's avatar
Konstantin Osipov committed
3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471
/**
  Implicitly commit before the SQL statement is executed.

  Statements marked with this flag will cause any active
  transaction to end (commit) before proceeding with the
  command execution.

  This flag should be set for statements that probably can't
  be rolled back or that do not expect any previously metadata
  locked tables.
*/
#define CF_IMPLICT_COMMIT_BEGIN   (1U << 6)
/**
  Implicitly commit after the SQL statement.

  Statements marked with this flag are automatically committed
  at the end of the statement.

  This flag should be set for statements that will implicitly
  open and take metadata locks on system tables that should not
  be carried for the whole duration of a active transaction.
*/
#define CF_IMPLICIT_COMMIT_END    (1U << 7)
/**
  CF_IMPLICT_COMMIT_BEGIN and CF_IMPLICIT_COMMIT_END are used
  to ensure that the active transaction is implicitly committed
  before and after every DDL statement and any statement that
  modifies our currently non-transactional system tables.
*/
#define CF_AUTO_COMMIT_TRANS  (CF_IMPLICT_COMMIT_BEGIN | CF_IMPLICIT_COMMIT_END)
Marc Alff's avatar
Marc Alff committed
3472 3473 3474 3475 3476 3477 3478 3479 3480 3481

/**
  Diagnostic statement.
  Diagnostic statements:
  - SHOW WARNING
  - SHOW ERROR
  - GET DIAGNOSTICS (WL#2111)
  do not modify the diagnostics area during execution.
*/
#define CF_DIAGNOSTIC_STMT        (1U << 8)
3482

Jon Olav Hauglid's avatar
Jon Olav Hauglid committed
3483 3484 3485 3486 3487 3488 3489 3490 3491 3492
/**
  SQL statements that must be protected against impending global read lock
  to prevent deadlock. This deadlock could otherwise happen if the statement
  starts waiting for the GRL to go away inside mysql_lock_tables while at the
  same time having "old" opened tables. The thread holding the GRL can be
  waiting for these "old" opened tables to be closed, causing a deadlock
  (FLUSH TABLES WITH READ LOCK).
 */
#define CF_PROTECT_AGAINST_GRL  (1U << 10)

3493 3494 3495 3496 3497 3498
/**
  Identifies statements that may generate row events
  and that may end up in the binary log.
*/
#define CF_CAN_GENERATE_ROW_EVENTS (1U << 11)

Konstantin Osipov's avatar
Konstantin Osipov committed
3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515
/* Bits in server_command_flags */

/**
  Skip the increase of the global query id counter. Commonly set for
  commands that are stateless (won't cause any change on the server
  internal states).
*/
#define CF_SKIP_QUERY_ID        (1U << 0)

/**
  Skip the increase of the number of statements that clients have
  sent to the server. Commonly used for commands that will cause
  a statement to be executed but the statement might have not been
  sent by the user (ie: stored procedure).
*/
#define CF_SKIP_QUESTIONS       (1U << 1)

3516
void add_to_status(STATUS_VAR *to_var, STATUS_VAR *from_var);
3517

3518 3519
void add_diff_to_status(STATUS_VAR *to_var, STATUS_VAR *from_var,
                        STATUS_VAR *dec_var);
3520 3521
void mark_transaction_to_rollback(THD *thd, bool all);

3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551
/*
  This prototype is placed here instead of in item_func.h because it
  depends on the definition of enum_sql_command, which is in this
  file.
 */
int get_var_with_binlog(THD *thd, enum_sql_command sql_command,
                        LEX_STRING &name, user_var_entry **out_entry);

/* Inline functions */

inline bool add_item_to_list(THD *thd, Item *item)
{
  return thd->lex->current_select->add_item_to_list(thd, item);
}

inline bool add_value_to_list(THD *thd, Item *value)
{
  return thd->lex->value_list.push_back(value);
}

inline bool add_order_to_list(THD *thd, Item *item, bool asc)
{
  return thd->lex->current_select->add_order_to_list(thd, item, asc);
}

inline bool add_group_to_list(THD *thd, Item *item, bool asc)
{
  return thd->lex->current_select->add_group_to_list(thd, item, asc);
}

3552
#endif /* MYSQL_SERVER */
3553 3554 3555 3556 3557 3558

/**
  The meat of thd_proc_info(THD*, char*), a macro that packs the last
  three calling-info parameters.
*/
extern "C"
3559
const char *set_thd_proc_info(void *thd_arg, const char *info,
3560 3561 3562 3563 3564 3565 3566
                              const char *calling_func,
                              const char *calling_file,
                              const unsigned int calling_line);

#define thd_proc_info(thd, msg) \
  set_thd_proc_info(thd, msg, __func__, __FILE__, __LINE__)

3567
#endif /* SQL_CLASS_INCLUDED */