sql_class.h 143 KB
Newer Older
1
/*
Sergei Golubchik's avatar
Sergei Golubchik committed
2 3
   Copyright (c) 2000, 2012, Oracle and/or its affiliates.
   Copyright (c) 2009, 2012, Monty Program Ab
unknown's avatar
unknown committed
4

unknown's avatar
unknown committed
5 6
   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
7
   the Free Software Foundation; version 2 of the License.
unknown's avatar
unknown committed
8

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

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


19 20 21
#ifndef SQL_CLASS_INCLUDED
#define SQL_CLASS_INCLUDED

unknown's avatar
unknown committed
22 23
/* Classes in mysql */

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

28
#include "my_global.h"                          /* NO_EMBEDDED_ACCESS_CHECKS */
29 30 31
#ifdef MYSQL_SERVER
#include "unireg.h"                    // REQUIRED: for other includes
#endif
Sergei Golubchik's avatar
Sergei Golubchik committed
32
#include <waiting_threads.h>
33
#include "sql_const.h"
34
#include <mysql/plugin_audit.h>
35 36
#include "log.h"
#include "rpl_tblmap.h"
37
#include "mdl.h"
38
#include "probes_mysql.h"
39 40 41 42 43 44
#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,
45
                                     THR_LOCK_INFO */
46
#include "my_apc.h"
unknown's avatar
unknown committed
47

48
class Reprepare_observer;
49
class Relay_log_info;
50

unknown's avatar
unknown committed
51 52
class Query_log_event;
class Load_log_event;
53
class Slave_log_event;
54
class sp_rcontext;
55
class sp_cache;
56
class Lex_input_stream;
57
class Parser_state;
58
class Rows_log_event;
Konstantin Osipov's avatar
Konstantin Osipov committed
59
class Sroutine_hash_entry;
60 61
class User_level_lock;
class user_var_entry;
unknown's avatar
unknown committed
62

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

77 78 79 80 81
/* 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
Sergei Golubchik's avatar
Sergei Golubchik committed
82
#define MODE_IGNORE_BAD_TABLE_OPTIONS   16
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
#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
111
extern char internal_table_name[2];
112
extern char empty_c_string[1];
113
extern MYSQL_PLUGIN_IMPORT const char **errmesg;
unknown's avatar
unknown committed
114

115 116
extern bool volatile shutdown_in_progress;

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
extern "C" LEX_STRING * thd_query_string (MYSQL_THD thd);
extern "C" char **thd_query(MYSQL_THD thd);

/**
  @class CSET_STRING
  @brief Character set armed LEX_STRING
*/
class CSET_STRING
{
private:
  LEX_STRING string;
  CHARSET_INFO *cs;
public:
  CSET_STRING() : cs(&my_charset_bin)
  {
    string.str= NULL;
    string.length= 0;
  }
  CSET_STRING(char *str_arg, size_t length_arg, CHARSET_INFO *cs_arg) :
  cs(cs_arg)
  {
    DBUG_ASSERT(cs_arg != NULL);
    string.str= str_arg;
    string.length= length_arg;
  }

  inline char *str() const { return string.str; }
  inline uint32 length() const { return string.length; }
  CHARSET_INFO *charset() const { return cs; }

  friend LEX_STRING * thd_query_string (MYSQL_THD thd);
  friend char **thd_query(MYSQL_THD thd);
};


152 153
#define TC_HEURISTIC_RECOVER_COMMIT   1
#define TC_HEURISTIC_RECOVER_ROLLBACK 2
Georgi Kodinov's avatar
merge  
Georgi Kodinov committed
154
extern ulong tc_heuristic_recover;
155

unknown's avatar
unknown committed
156 157 158 159 160 161 162
typedef struct st_user_var_events
{
  user_var_entry *user_var_event;
  char *value;
  ulong length;
  Item_result type;
  uint charset_number;
163
  bool unsigned_flag;
unknown's avatar
unknown committed
164 165
} BINLOG_USER_VAR_EVENT;

166 167 168 169 170 171 172 173 174 175 176 177
/*
  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
178
typedef struct st_copy_info {
unknown's avatar
unknown committed
179 180 181 182
  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 */
183
  ha_rows error_count;
184
  ha_rows touched; /* Number of touched records */
unknown's avatar
unknown committed
185
  enum enum_duplicates handle_duplicates;
186
  int escape_char, last_errno;
187 188
  bool ignore;
  /* for INSERT ... UPDATE */
189 190
  List<Item> *update_fields;
  List<Item> *update_values;
unknown's avatar
unknown committed
191
  /* for VIEW ... WITH CHECK OPTION */
unknown's avatar
unknown committed
192
  TABLE_LIST *view;
unknown's avatar
unknown committed
193 194 195
} COPY_INFO;


unknown's avatar
unknown committed
196
class Key_part_spec :public Sql_alloc {
unknown's avatar
unknown committed
197
public:
198
  LEX_STRING field_name;
unknown's avatar
unknown committed
199
  uint length;
200 201 202 203 204 205
  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
206
  bool operator==(const Key_part_spec& other) const;
207
  /**
unknown's avatar
unknown committed
208
    Construct a copy of this Key_part_spec. field_name is copied
209 210 211 212 213 214 215
    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
216 217
  Key_part_spec *clone(MEM_ROOT *mem_root) const
  { return new (mem_root) Key_part_spec(*this); }
unknown's avatar
unknown committed
218 219 220 221 222 223 224 225 226 227
};


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) {}
228 229
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
230
    @sa comment for Key_part_spec::clone
231 232 233
  */
  Alter_drop *clone(MEM_ROOT *mem_root) const
    { return new (mem_root) Alter_drop(*this); }
unknown's avatar
unknown committed
234 235 236 237 238 239 240 241 242
};


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) {}
243 244
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
245
    @sa comment for Key_part_spec::clone
246 247 248
  */
  Alter_column *clone(MEM_ROOT *mem_root) const
    { return new (mem_root) Alter_column(*this); }
unknown's avatar
unknown committed
249 250 251 252 253
};


class Key :public Sql_alloc {
public:
254
  enum Keytype { PRIMARY, UNIQUE, MULTIPLE, FULLTEXT, SPATIAL, FOREIGN_KEY};
unknown's avatar
unknown committed
255
  enum Keytype type;
unknown's avatar
unknown committed
256
  KEY_CREATE_INFO key_create_info;
unknown's avatar
unknown committed
257
  List<Key_part_spec> columns;
258
  LEX_STRING name;
259
  engine_option_value *option_list;
260
  bool generated;
unknown's avatar
unknown committed
261

262
  Key(enum Keytype type_par, const LEX_STRING &name_arg,
263
      KEY_CREATE_INFO *key_info_arg,
264 265
      bool generated_arg, List<Key_part_spec> &cols,
      engine_option_value *create_opt)
unknown's avatar
unknown committed
266
    :type(type_par), key_create_info(*key_info_arg), columns(cols),
267
    name(name_arg), option_list(create_opt), generated(generated_arg)
268
  {}
269 270
  Key(enum Keytype type_par, const char *name_arg, size_t name_len_arg,
      KEY_CREATE_INFO *key_info_arg, bool generated_arg,
271 272
      List<Key_part_spec> &cols,
      engine_option_value *create_opt)
273
    :type(type_par), key_create_info(*key_info_arg), columns(cols),
274
    option_list(create_opt), generated(generated_arg)
275 276 277 278
  {
    name.str= (char *)name_arg;
    name.length= name_len_arg;
  }
279 280
  Key(const Key &rhs, MEM_ROOT *mem_root);
  virtual ~Key() {}
281
  /* Equality comparison of keys (ignoring name) */
282
  friend bool foreign_key_prefix(Key *a, Key *b);
283 284
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
285
    @sa comment for Key_part_spec::clone
286 287 288
  */
  virtual Key *clone(MEM_ROOT *mem_root) const
    { return new (mem_root) Key(*this, mem_root); }
unknown's avatar
unknown committed
289 290
};

291 292
class Table_ident;

unknown's avatar
unknown committed
293
class Foreign_key: public Key {
294 295 296 297 298 299 300
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
301
  List<Key_part_spec> ref_columns;
302
  uint delete_opt, update_opt, match_opt;
303
  Foreign_key(const LEX_STRING &name_arg, List<Key_part_spec> &cols,
unknown's avatar
unknown committed
304
	      Table_ident *table,   List<Key_part_spec> &ref_cols,
305
	      uint delete_opt_arg, uint update_opt_arg, uint match_opt_arg)
306
    :Key(FOREIGN_KEY, name_arg, &default_key_create_info, 0, cols, NULL),
307
    ref_table(table), ref_columns(ref_cols),
308 309 310
    delete_opt(delete_opt_arg), update_opt(update_opt_arg),
    match_opt(match_opt_arg)
  {}
unknown's avatar
unknown committed
311
  Foreign_key(const Foreign_key &rhs, MEM_ROOT *mem_root);
312 313
  /**
    Used to make a clone of this object for ALTER/CREATE TABLE
unknown's avatar
unknown committed
314
    @sa comment for Key_part_spec::clone
315 316
  */
  virtual Key *clone(MEM_ROOT *mem_root) const
unknown's avatar
unknown committed
317
  { return new (mem_root) Foreign_key(*this, mem_root); }
318 319
  /* Used to validate foreign key options */
  bool validate(List<Create_field> &table_fields);
320
};
unknown's avatar
unknown committed
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337

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) {}
};

338 339
class MY_LOCALE;

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
/**
  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
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
/* 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[];

396 397 398 399
/**
  These states are bit coded with HARD. For each state there must be a pair
  <state_even_num>, and <state_odd_num>_HARD.
*/
400 401 402 403 404 405 406 407
enum killed_state
{
  NOT_KILLED= 0,
  KILL_HARD_BIT= 1,                             /* Bit for HARD KILL */
  KILL_BAD_DATA= 2,
  KILL_BAD_DATA_HARD= 3,
  KILL_QUERY= 4,
  KILL_QUERY_HARD= 5,
408 409 410 411 412 413 414
  /*
    ABORT_QUERY signals to the query processor to stop execution ASAP without
    issuing an error. Instead a warning is issued, and when possible a partial
    query result is returned to the client.
  */
  ABORT_QUERY= 6,
  ABORT_QUERY_HARD= 7,
415 416
  /*
    All of the following killed states will kill the connection
417 418 419 420 421 422 423 424 425
    KILL_CONNECTION must be the first of these and it must start with
    an even number (becasue of HARD bit)!
  */
  KILL_CONNECTION= 8,
  KILL_CONNECTION_HARD= 9,
  KILL_SYSTEM_THREAD= 10,
  KILL_SYSTEM_THREAD_HARD= 11,
  KILL_SERVER= 12,
  KILL_SERVER_HARD= 13
426 427 428 429 430 431 432 433 434 435 436
};

extern int killed_errno(killed_state killed);
#define killed_mask_hard(killed) ((killed_state) ((killed) & ~KILL_HARD_BIT))

enum killed_type
{
  KILL_TYPE_ID,
  KILL_TYPE_USER
};

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

439
class Delayed_insert;
unknown's avatar
unknown committed
440
class select_result;
441
class Time_zone;
unknown's avatar
unknown committed
442

443 444 445 446 447
#define THD_SENTRY_MAGIC 0xfeedd1ff
#define THD_SENTRY_GONE  0xdeadbeef

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

448
typedef struct system_variables
449
{
unknown's avatar
unknown committed
450 451
  /*
    How dynamically allocated system variables are handled:
452

unknown's avatar
unknown committed
453 454 455 456 457
    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.
458 459 460

    Note that one should use my_bool instead of bool here, as the variables
    are used with my_getopt.c
461
  */
unknown's avatar
unknown committed
462 463
  ulong dynamic_variables_version;
  char* dynamic_variables_ptr;
464 465
  uint dynamic_variables_head;    /* largest valid variable offset */
  uint dynamic_variables_size;    /* how many bytes are in use */
unknown's avatar
unknown committed
466
  
467 468
  ulonglong max_heap_table_size;
  ulonglong tmp_table_size;
469
  ulonglong long_query_time;
470 471 472
  ulonglong optimizer_switch;
  ulonglong sql_mode; ///< which non-standard SQL behaviour should be enabled
  ulonglong option_bits; ///< OPTION_xxx constants, e.g. OPTION_PROFILING
473
  ulonglong join_buff_space_limit;
Sergei Golubchik's avatar
Sergei Golubchik committed
474 475
  ulonglong log_slow_filter; 
  ulonglong log_slow_verbosity; 
476 477 478 479
  ulonglong bulk_insert_buff_size;
  ulonglong join_buff_size;
  ulonglong sortbuff_size;
  ulonglong group_concat_max_len;
480 481
  ha_rows select_limit;
  ha_rows max_join_size;
482
  ha_rows expensive_subquery_limit;
483
  ulong auto_increment_increment, auto_increment_offset;
484
  ulong lock_wait_timeout;
485
  ulong join_cache_level;
unknown's avatar
unknown committed
486
  ulong max_allowed_packet;
487
  ulong max_error_count;
unknown's avatar
unknown committed
488
  ulong max_length_for_sort_data;
489
  ulong max_sort_length;
490
  ulong max_tmp_tables;
491
  ulong max_insert_delayed_threads;
492
  ulong min_examined_row_limit;
Sergei Golubchik's avatar
Sergei Golubchik committed
493
  ulong multi_range_count;
unknown's avatar
unknown committed
494
  ulong net_buffer_length;
495
  ulong net_interactive_timeout;
unknown's avatar
unknown committed
496
  ulong net_read_timeout;
497
  ulong net_retry_count;
498
  ulong net_wait_timeout;
unknown's avatar
unknown committed
499
  ulong net_write_timeout;
500 501
  ulong optimizer_prune_level;
  ulong optimizer_search_depth;
502
  ulong use_stat_tables;
unknown's avatar
unknown committed
503
  ulong preload_buff_size;
504
  ulong profiling_history_size;
unknown's avatar
unknown committed
505 506
  ulong read_buff_size;
  ulong read_rnd_buff_size;
Sergey Petrunya's avatar
Sergey Petrunya committed
507
  ulong mrr_buff_size;
unknown's avatar
unknown committed
508
  ulong div_precincrement;
509 510
  /* Total size of all buffers used by the subselect_rowid_merge_engine. */
  ulong rowid_merge_buff_size;
511
  ulong max_sp_recursion_depth;
unknown's avatar
unknown committed
512
  ulong default_week_format;
513
  ulong max_seeks_for_key;
514 515 516 517 518
  ulong range_alloc_block_size;
  ulong query_alloc_block_size;
  ulong query_prealloc_size;
  ulong trans_alloc_block_size;
  ulong trans_prealloc_size;
519
  ulong log_warnings;
520 521
  /* Flags for slow log filtering */
  ulong log_slow_rate_limit; 
Georgi Kodinov's avatar
merge  
Georgi Kodinov committed
522
  ulong binlog_format; ///< binlog format for this thd (see enum_binlog_format)
523
  ulong progress_report_time;
524
  my_bool binlog_annotate_row_events;
525
  my_bool binlog_direct_non_trans_update;
526
  my_bool sql_log_bin;
Georgi Kodinov's avatar
merge  
Georgi Kodinov committed
527 528 529 530
  ulong completion_type;
  ulong query_cache_type;
  ulong tx_isolation;
  ulong updatable_views_with_limit;
531
  int max_user_connections;
532
  /**
unknown's avatar
unknown committed
533 534 535
    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
536
  my_thread_id pseudo_thread_id;
537 538 539 540 541 542
  /**
     When replicating an event group with GTID, keep these values around so
     slave binlog can receive the same GTID as the original.
  */
  uint32     gtid_domain_id;
  uint64     gtid_seq_no;
543
  /**
544
     Place holders to store Multi-source variables in sys_var.cc during
545 546
     update and show of variables.
  */
547 548
  ulong slave_skip_counter;
  ulong max_relay_log_size;
unknown's avatar
unknown committed
549

unknown's avatar
unknown committed
550
  my_bool low_priority_updates;
551
  my_bool query_cache_wlock_invalidate;
unknown's avatar
unknown committed
552
  my_bool engine_condition_pushdown;
unknown's avatar
unknown committed
553
  my_bool keep_files_on_create;
554

Sergei Golubchik's avatar
Sergei Golubchik committed
555
  my_bool old_mode;
unknown's avatar
unknown committed
556
  my_bool old_alter_table;
557
  my_bool old_passwords;
558
  my_bool big_tables;
Sergei Golubchik's avatar
Sergei Golubchik committed
559
  my_bool query_cache_strip_comments;
560

unknown's avatar
unknown committed
561
  plugin_ref table_plugin;
unknown's avatar
unknown committed
562

563
  /* Only charset part of these variables is sensible */
unknown's avatar
unknown committed
564
  CHARSET_INFO  *character_set_filesystem;
565
  CHARSET_INFO  *character_set_client;
566
  CHARSET_INFO  *character_set_results;
567

568 569 570
  /* Both charset and collation parts of these variables are important */
  CHARSET_INFO	*collation_server;
  CHARSET_INFO	*collation_database;
unknown's avatar
unknown committed
571
  CHARSET_INFO  *collation_connection;
572

573 574 575
  /* Names. These will be allocated in buffers in thd */
  LEX_STRING default_master_connection;

576 577
  /* Error messages */
  MY_LOCALE *lc_messages;
unknown's avatar
unknown committed
578 579 580
  /* Locale Support */
  MY_LOCALE *lc_time_names;

581 582
  Time_zone *time_zone;

583
  my_bool sysdate_is_now;
584

585 586 587
  /* deadlock detection */
  ulong wt_timeout_short, wt_deadlock_search_depth_short;
  ulong wt_timeout_long, wt_deadlock_search_depth_long;
unknown's avatar
unknown committed
588

Sergei Golubchik's avatar
Sergei Golubchik committed
589
  double long_query_time_double;
590
} SV;
unknown's avatar
unknown committed
591

592 593 594 595 596
/**
  Per thread status variables.
  Must be long/ulong up to last_system_status_var so that
  add_to_status/add_diff_to_status can work.
*/
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612

typedef struct system_status_var
{
  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;
613
  ulong ha_read_rnd_deleted_count;
614 615 616 617 618
  /*
    This number doesn't include calls to the default implementation and
    calls made by range access. The intent is to count only calls made by
    BatchedKeyAccess.
  */
619 620 621
  ulong ha_mrr_init_count;
  ulong ha_mrr_key_refills_count;
  ulong ha_mrr_rowid_refills_count;
622

623 624 625
  ulong ha_rollback_count;
  ulong ha_update_count;
  ulong ha_write_count;
626 627 628
  /* The following are for internal temporary tables */
  ulong ha_tmp_update_count;
  ulong ha_tmp_write_count;
629
  ulong ha_prepare_count;
630 631
  ulong ha_icp_attempts;
  ulong ha_icp_match;
632 633 634
  ulong ha_discover_count;
  ulong ha_savepoint_count;
  ulong ha_savepoint_rollback_count;
635 636 637

  ulong net_big_packet_count;
  ulong opened_tables;
unknown's avatar
unknown committed
638
  ulong opened_shares;
639 640
  ulong opened_views;               /* +1 opening a view */

641 642 643 644 645
  ulong select_full_join_count;
  ulong select_full_range_join_count;
  ulong select_range_count;
  ulong select_range_check_count;
  ulong select_scan_count;
646
  ulong executed_triggers;
647 648 649 650 651
  ulong long_query_count;
  ulong filesort_merge_passes;
  ulong filesort_range_count;
  ulong filesort_rows;
  ulong filesort_scan_count;
652
  /* Prepared statements and binary protocol */
unknown's avatar
unknown committed
653
  ulong com_stmt_prepare;
unknown's avatar
unknown committed
654
  ulong com_stmt_reprepare;
unknown's avatar
unknown committed
655 656 657 658 659
  ulong com_stmt_execute;
  ulong com_stmt_send_long_data;
  ulong com_stmt_fetch;
  ulong com_stmt_reset;
  ulong com_stmt_close;
Sergei Golubchik's avatar
Sergei Golubchik committed
660

661 662 663 664 665 666 667 668 669 670
  /* Features used */
  ulong feature_dynamic_columns;    /* +1 when creating a dynamic column */
  ulong feature_fulltext;	    /* +1 when MATCH is used */
  ulong feature_gis;                /* +1 opening a table with GIS features */
  ulong feature_locale;		    /* +1 when LOCALE is set */
  ulong feature_subquery;	    /* +1 when subqueries are used */
  ulong feature_timezone;	    /* +1 when XPATH is used */
  ulong feature_trigger;	    /* +1 opening a table with triggers */
  ulong feature_xml;		    /* +1 when XPATH is used */

Sergei Golubchik's avatar
Sergei Golubchik committed
671 672 673
  ulong empty_queries;
  ulong access_denied_errors;
  ulong lost_connections;
674
  /*
675 676 677 678 679 680
    Number of statements sent from the client
  */
  ulong questions;
  /*
    IMPORTANT!
    SEE last_system_status_var DEFINITION BELOW.
681 682
    Below 'last_system_status_var' are all variables that cannot be handled
    automatically by add_to_status()/add_diff_to_status().
683
  */
684 685
  ulonglong bytes_received;
  ulonglong bytes_sent;
686 687
  ulonglong rows_read;
  ulonglong rows_sent;
688
  ulonglong rows_tmp_read;
689
  ulonglong binlog_bytes_written;
690
  double last_query_cost;
691
  double cpu_time, busy_time;
692 693
  /* Don't initialize */
  volatile int64 memory_used;             /* This shouldn't be accumulated */
694 695 696
} STATUS_VAR;

/*
697
  This is used for 'SHOW STATUS'. It must be updated to the last ulong
698
  variable in system_status_var which is makes sense to add to the global
699
  counter
700 701
*/

702
#define last_system_status_var questions
703
#define last_cleared_system_status_var memory_used
704

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

707 708
#ifdef MYSQL_SERVER

709
void free_tmp_table(THD *thd, TABLE *entry);
710 711


unknown's avatar
unknown committed
712 713
/* The following macro is to make init of Query_arena simpler */
#ifndef DBUG_OFF
unknown's avatar
unknown committed
714
#define INIT_ARENA_DBUG_INFO is_backup_arena= 0; is_reprepared= FALSE;
715 716
#else
#define INIT_ARENA_DBUG_INFO
unknown's avatar
unknown committed
717 718
#endif

unknown's avatar
unknown committed
719
class Query_arena
720 721 722 723 724 725 726
{
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
727
  MEM_ROOT *mem_root;                   // Pointer to current memroot
unknown's avatar
unknown committed
728
#ifndef DBUG_OFF
729
  bool is_backup_arena; /* True if this arena is used for backup. */
unknown's avatar
unknown committed
730
  bool is_reprepared;
unknown's avatar
unknown committed
731
#endif
732 733 734
  /*
    The states relfects three diffrent life cycles for three
    different types of statements:
735 736 737
    Prepared statement: STMT_INITIALIZED -> STMT_PREPARED -> STMT_EXECUTED.
    Stored procedure:   STMT_INITIALIZED_FOR_SP -> STMT_EXECUTED.
    Other statements:   STMT_CONVENTIONAL_EXECUTION never changes.
738
  */
unknown's avatar
unknown committed
739
  enum enum_state
740
  {
741 742
    STMT_INITIALIZED= 0, STMT_INITIALIZED_FOR_SP= 1, STMT_PREPARED= 2,
    STMT_CONVENTIONAL_EXECUTION= 3, STMT_EXECUTED= 4, STMT_ERROR= -1
743
  };
unknown's avatar
unknown committed
744

unknown's avatar
unknown committed
745
  enum_state state;
746 747 748 749 750 751 752

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

753 754
  Query_arena(MEM_ROOT *mem_root_arg, enum enum_state state_arg) :
    free_list(0), mem_root(mem_root_arg), state(state_arg)
755
  { INIT_ARENA_DBUG_INFO; }
756
  /*
unknown's avatar
unknown committed
757 758
    This constructor is used only when Query_arena is created as
    backup storage for another instance of Query_arena.
759
  */
760 761
  Query_arena() { INIT_ARENA_DBUG_INFO; }

762
  virtual Type type() const;
unknown's avatar
unknown committed
763
  virtual ~Query_arena() {};
764

765
  inline bool is_stmt_prepare() const { return state == STMT_INITIALIZED; }
766
  inline bool is_stmt_prepare_or_first_sp_execute() const
767
  { return (int)state < (int)STMT_PREPARED; }
768
  inline bool is_stmt_prepare_or_first_stmt_execute() const
769
  { return (int)state <= (int)STMT_PREPARED; }
770
  inline bool is_stmt_execute() const
Sergei Golubchik's avatar
Sergei Golubchik committed
771
  { return state == STMT_PREPARED || state == STMT_EXECUTED; }
unknown's avatar
unknown committed
772
  inline bool is_conventional() const
773
  { return state == STMT_CONVENTIONAL_EXECUTION; }
774

775 776
  inline void* alloc(size_t size) { return alloc_root(mem_root,size); }
  inline void* calloc(size_t size)
777
  {
778
    void *ptr;
unknown's avatar
unknown committed
779
    if ((ptr=alloc_root(mem_root,size)))
780
      bzero(ptr, size);
781 782 783
    return ptr;
  }
  inline char *strdup(const char *str)
unknown's avatar
unknown committed
784
  { return strdup_root(mem_root,str); }
785
  inline char *strmake(const char *str, size_t size)
unknown's avatar
unknown committed
786
  { return strmake_root(mem_root,str,size); }
787
  inline void *memdup(const void *str, size_t size)
unknown's avatar
unknown committed
788
  { return memdup_root(mem_root,str,size); }
789
  inline void *memdup_w_gap(const void *str, size_t size, uint gap)
790
  {
791 792
    void *ptr;
    if ((ptr= alloc_root(mem_root,size+gap)))
793 794 795 796
      memcpy(ptr,str,size);
    return ptr;
  }

unknown's avatar
unknown committed
797
  void set_query_arena(Query_arena *set);
798 799

  void free_items();
800 801
  /* Close the active state associated with execution of this statement */
  virtual void cleanup_stmt();
802 803
};

804

805
class Server_side_cursor;
806

807 808 809 810
/**
  @class Statement
  @brief State of a single command executed against this connection.

811 812 813 814 815
  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
816
     query, we create another statement for it.
817 818 819 820 821 822
  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.
*/

823
class Statement: public ilink, public Query_arena
824
{
825 826
  Statement(const Statement &rhs);              /* not implemented: */
  Statement &operator=(const Statement &rhs);   /* non-copyable */
827 828
public:
  /*
unknown's avatar
unknown committed
829
    Uniquely identifies each statement object in thread scope; change during
830
    statement lifetime. FIXME: must be const
831
  */
unknown's avatar
unknown committed
832
   ulong id;
833 834

  /*
835 836 837 838 839 840 841 842 843
    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.
844
  */
845
  enum enum_mark_columns mark_used_columns;
846

847
  LEX_STRING name; /* name for named prepared statements */
848 849 850 851 852
  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.
853

854 855 856 857
    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
858
    thd->query like this:
859 860 861 862 863
      (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.
864
  */
865
  CSET_STRING query_string;
866 867 868 869 870
  /*
    If opt_query_cache_strip_comments is set, this contains query without
    comments. If not set, it contains pointer to query_string.
  */
  String base_query;
871 872


873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
  inline char *query() const { return query_string.str(); }
  inline uint32 query_length() const { return query_string.length(); }
  CHARSET_INFO *query_charset() const { return query_string.charset(); }
  void set_query_inner(const CSET_STRING &string_arg)
  {
    query_string= string_arg;
  }
  void set_query_inner(char *query_arg, uint32 query_length_arg,
                       CHARSET_INFO *cs_arg)
  {
    set_query_inner(CSET_STRING(query_arg, query_length_arg, cs_arg));
  }
  void reset_query_inner()
  {
    set_query_inner(CSET_STRING());
  }
889 890 891 892 893 894 895 896 897 898 899 900 901 902
  /**
    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;
903
  size_t db_length;
904

905 906
  /* This is set to 1 of last call to send_result_to_client() was ok */
  my_bool query_cache_is_applicable;
907

unknown's avatar
unknown committed
908
  /* This constructor is called for backup statements */
909
  Statement() {}
910

911 912
  Statement(LEX *lex_arg, MEM_ROOT *mem_root_arg,
            enum enum_state state_arg, ulong id_arg);
913
  virtual ~Statement();
914 915

  /* Assign execution context (note: not all members) of given stmt to self */
916
  virtual void set_statement(Statement *stmt);
917 918
  void set_n_backup_statement(Statement *stmt, Statement *backup);
  void restore_backup_statement(Statement *stmt, Statement *backup);
919 920
  /* return class type */
  virtual Type type() const;
921 922 923
};


924
/**
925 926 927 928 929
  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
930

931 932
  Statements are auto-deleted when they are removed from the map and when the
  map is deleted.
933 934 935 936 937 938
*/

class Statement_map
{
public:
  Statement_map();
939

940
  int insert(THD *thd, Statement *statement);
941 942

  Statement *find_by_name(LEX_STRING *name)
943
  {
944
    Statement *stmt;
Konstantin Osipov's avatar
Konstantin Osipov committed
945 946
    stmt= (Statement*)my_hash_search(&names_hash, (uchar*)name->str,
                                     name->length);
947
    return stmt;
948
  }
949 950

  Statement *find(ulong id)
951
  {
952
    if (last_found_statement == 0 || id != last_found_statement->id)
953 954
    {
      Statement *stmt;
Konstantin Osipov's avatar
Konstantin Osipov committed
955
      stmt= (Statement *) my_hash_search(&st_hash, (uchar *) &id, sizeof(id));
956
      if (stmt && stmt->name.str)
957 958 959
        return NULL;
      last_found_statement= stmt;
    }
960
    return last_found_statement;
961
  }
962 963 964 965 966 967
  /*
    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();
968
  void erase(Statement *statement);
969
  /* Erase all statements (calls Statement destructor) */
970 971
  void reset();
  ~Statement_map();
972 973
private:
  HASH st_hash;
974
  HASH names_hash;
975
  I_List<Statement> transient_cursor_list;
976
  Statement *last_found_statement;
977 978
};

979 980 981
struct st_savepoint {
  struct st_savepoint *prev;
  char                *name;
982 983
  uint                 length;
  Ha_trx_info         *ha_list;
984 985
  /** State of metadata locks before this savepoint was set. */
  MDL_savepoint        mdl_savepoint;
986 987
};

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

991 992 993 994 995
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;
996 997
  /* Error reported by the Resource Manager (RM) to the Transaction Manager. */
  uint rm_error;
998 999
} XID_STATE;

Marc Alff's avatar
Marc Alff committed
1000
extern mysql_mutex_t LOCK_xid_cache;
1001 1002 1003 1004 1005 1006 1007 1008
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);

1009 1010 1011 1012
/**
  @class Security_context
  @brief A set of THD members describing the current authenticated user.
*/
1013

1014 1015
class Security_context {
public:
1016
  Security_context() {}                       /* Remove gcc warning */
1017 1018 1019 1020
  /*
    host - host of the client
    user - user of the client, set to NULL until the user has been read from
    the connection
1021
    priv_user - The user privilege we are using. May be "" for anonymous user.
1022 1023
    ip - client IP
  */
1024 1025
  char   *host, *user, *ip;
  char   priv_user[USERNAME_LENGTH];
1026
  char   proxy_user[USERNAME_LENGTH + MAX_HOSTNAME + 5];
1027
  /* The host privilege we are using */
1028
  char   priv_host[MAX_HOSTNAME];
1029 1030
  /* The external user (if available) */
  char   *external_user;
1031 1032 1033 1034 1035 1036 1037 1038
  /* 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();
1039
  inline char *priv_host_name()
1040 1041 1042
  {
    return (*priv_host ? priv_host : (char *)"%");
  }
1043

1044
  bool set_user(char *user_arg);
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056

#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
1057
  bool user_matches(Security_context *);
1058 1059 1060
};


1061
/**
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
  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;


1072
/**
Konstantin Osipov's avatar
Konstantin Osipov committed
1073 1074
  Type of locked tables mode.
  See comment for THD::locked_tables_mode for complete description.
1075 1076
*/

Konstantin Osipov's avatar
Konstantin Osipov committed
1077 1078 1079 1080 1081 1082 1083
enum enum_locked_tables_mode
{
  LTM_NONE= 0,
  LTM_LOCK_TABLES,
  LTM_PRELOCKED,
  LTM_PRELOCKED_UNDER_LOCK_TABLES
};
1084 1085


1086
/**
1087
  Class that holds information about tables which were opened and locked
1088 1089 1090 1091 1092 1093 1094
  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
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
  /**
    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.
1105
    @sa check_and_update_table_version()
unknown's avatar
unknown committed
1106
  */
1107
  Reprepare_observer *m_reprepare_observer;
unknown's avatar
unknown committed
1108

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
  /**
    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?
1120
  */
1121 1122
  TABLE *temporary_tables;
  TABLE *derived_tables;
1123 1124 1125 1126 1127 1128 1129 1130
  /*
    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
1131 1132 1133
    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
1134 1135 1136 1137
    the 'LOCK_TABLES' chapter of the MySQL manual.
    See also lock_tables() for details.
  */
  MYSQL_LOCK *lock;
1138 1139 1140 1141 1142 1143 1144 1145

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

1146
  /*
Konstantin Osipov's avatar
Konstantin Osipov committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
    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.
1173
  */
Konstantin Osipov's avatar
Konstantin Osipov committed
1174
  enum enum_locked_tables_mode locked_tables_mode;
1175 1176
  uint current_tablenr;

1177 1178 1179 1180 1181 1182 1183 1184
  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
1185 1186 1187 1188 1189
  /**
     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().
1190
  */
1191
  Open_tables_state() : state_flags(0U) { }
1192

1193 1194 1195 1196 1197
  void set_open_tables_state(Open_tables_state *state)
  {
    *this= *state;
  }

1198
  void reset_open_tables_state(THD *thd)
1199
  {
1200
    open_tables= temporary_tables= derived_tables= 0;
Konstantin Osipov's avatar
Konstantin Osipov committed
1201 1202
    extra_lock= lock= 0;
    locked_tables_mode= LTM_NONE;
1203
    state_flags= 0U;
1204
    m_reprepare_observer= NULL;
1205 1206 1207
  }
};

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219

/**
  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
1220 1221 1222
    table or tables, we want to save state of metadata
    locks which were acquired before the backup. It is used
    to release metadata locks on system tables after they are
1223 1224
    no longer used.
  */
1225
  MDL_savepoint mdl_system_tables_svp;
1226 1227
};

1228 1229 1230 1231
/**
  @class Sub_statement_state
  @brief Used to save context when executing a function or trigger
*/
1232 1233 1234 1235 1236 1237

/* Defines used for Sub_statement_state::in_sub_stmt */

#define SUB_STMT_TRIGGER 1
#define SUB_STMT_FUNCTION 2

1238

1239 1240 1241
class Sub_statement_state
{
public:
1242
  ulonglong option_bits;
1243 1244 1245
  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;
1246
  Discrete_intervals_list auto_inc_intervals_forced;
1247 1248 1249
  ulonglong limit_found_rows;
  ha_rows    cuted_fields, sent_row_count, examined_row_count;
  ulong client_capabilities;
1250
  ulong query_plan_flags; 
1251
  uint in_sub_stmt;
1252
  bool enable_slow_log;
unknown's avatar
unknown committed
1253
  bool last_insert_id_used;
1254
  SAVEPOINT *savepoints;
1255
  enum enum_check_fields count_cuted_fields;
1256 1257 1258
};


1259 1260 1261 1262 1263 1264 1265 1266 1267
/* 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,
1268 1269
  SYSTEM_THREAD_EVENT_WORKER= 32,
  SYSTEM_THREAD_BINLOG_BACKGROUND= 64
1270 1271
};

1272 1273 1274 1275 1276
inline char const *
show_system_thread(enum_thread_type thread)
{
#define RETURN_NAME_AS_STRING(NAME) case (NAME): return #NAME
  switch (thread) {
1277
    static char buf[64];
1278 1279 1280 1281 1282 1283 1284
    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);
1285 1286 1287
  default:
    sprintf(buf, "<UNKNOWN SYSTEM THREAD: %d>", thread);
    return buf;
1288 1289 1290
  }
#undef RETURN_NAME_AS_STRING
}
1291

unknown's avatar
unknown committed
1292 1293 1294 1295 1296 1297 1298 1299
/**
  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:
1300 1301 1302 1303
  Internal_error_handler() :
    m_prev_internal_handler(NULL)
  {}

unknown's avatar
unknown committed
1304 1305 1306 1307
  virtual ~Internal_error_handler() {}

public:
  /**
Marc Alff's avatar
Marc Alff committed
1308
    Handle a sql condition.
unknown's avatar
unknown committed
1309 1310
    This method can be implemented by a subclass to achieve any of the
    following:
Marc Alff's avatar
Marc Alff committed
1311 1312 1313
    - 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
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
    '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
1328 1329
    @param cond the condition raised.
    @return true if the condition is handled
unknown's avatar
unknown committed
1330
  */
Marc Alff's avatar
Marc Alff committed
1331 1332 1333 1334 1335 1336 1337
  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;

1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
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
1352
  bool handle_condition(THD *thd,
1353
                        uint sql_errno,
Marc Alff's avatar
Marc Alff committed
1354 1355 1356 1357
                        const char* sqlstate,
                        MYSQL_ERROR::enum_warning_level level,
                        const char* msg,
                        MYSQL_ERROR ** cond_hdl)
1358 1359 1360 1361
  {
    /* Ignore error */
    return TRUE;
  }
Michael Widenius's avatar
Michael Widenius committed
1362
  Dummy_error_handler() {}                    /* Remove gcc warning */
unknown's avatar
unknown committed
1363 1364 1365
};


1366
/**
1367
  This class is an internal error handler implementation for
1368 1369 1370 1371 1372 1373 1374 1375
  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:
1376
  Drop_table_error_handler() {}
1377 1378

public:
1379 1380 1381 1382 1383 1384
  bool handle_condition(THD *thd,
                        uint sql_errno,
                        const char* sqlstate,
                        MYSQL_ERROR::enum_warning_level level,
                        const char* msg,
                        MYSQL_ERROR ** cond_hdl);
1385 1386 1387 1388 1389

private:
};


Konstantin Osipov's avatar
Konstantin Osipov committed
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
/**
  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
1402
  The locks are allocated in the memory root encapsulated in this
Konstantin Osipov's avatar
Konstantin Osipov committed
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
  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
1421 1422 1423 1424 1425 1426 1427 1428 1429
  /** 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
1430 1431 1432
public:
  Locked_tables_list()
    :m_locked_tables(NULL),
Konstantin Osipov's avatar
Konstantin Osipov committed
1433 1434 1435
    m_locked_tables_last(&m_locked_tables),
    m_reopen_array(NULL),
    m_locked_tables_count(0)
Konstantin Osipov's avatar
Konstantin Osipov committed
1436
  {
1437
    init_sql_alloc(&m_locked_tables_root, MEM_ROOT_BLOCK_SIZE, 0,
1438
                   MYF(MY_THREAD_SPECIFIC));
Konstantin Osipov's avatar
Konstantin Osipov committed
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
  }
  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
1449 1450 1451
  void unlink_all_closed_tables(THD *thd,
                                MYSQL_LOCK *lock,
                                size_t reopen_count);
Konstantin Osipov's avatar
Konstantin Osipov committed
1452 1453 1454
  bool reopen_tables(THD *thd);
};

1455

1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477
/**
  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];
1478 1479 1480 1481 1482
  /**
    NULL: engine is not bound to this thread
    non-NULL: engine is bound to this thread, engine shutdown forbidden
  */
  plugin_ref lock;
1483 1484 1485
  Ha_data() :ha_ptr(NULL) {}
};

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
/**
  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()
1502 1503 1504
    : m_state(GRL_NONE),
      m_mdl_global_shared_lock(NULL),
      m_mdl_blocks_commits_lock(NULL)
1505 1506 1507 1508
  {}

  bool lock_global_read_lock(THD *thd);
  void unlock_global_read_lock(THD *thd);
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
  /**
    Check if this connection can acquire protection against GRL and
    emit error if otherwise.
  */
  bool can_acquire_protection() const
  {
    if (m_state)
    {
      my_error(ER_CANT_UPDATE_WITH_READLOCK, MYF(0));
      return TRUE;
    }
    return FALSE;
  }
1522 1523
  bool make_global_read_lock_block_commit(THD *thd);
  bool is_acquired() const { return m_state != GRL_NONE; }
1524
  void set_explicit_lock_duration(THD *thd);
1525
private:
1526
  enum_grl_state m_state;
1527 1528
  /**
    In order to acquire the global read lock, the connection must
1529 1530
    acquire shared metadata lock in GLOBAL namespace, to prohibit
    all DDL.
1531 1532
  */
  MDL_ticket *m_mdl_global_shared_lock;
1533 1534 1535 1536 1537 1538
  /**
    Also in order to acquire the global read lock, the connection
    must acquire a shared metadata lock in COMMIT namespace, to
    prohibit commits.
  */
  MDL_ticket *m_mdl_blocks_commits_lock;
1539 1540 1541
};


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

1544 1545 1546 1547 1548
class THD;
#ifndef DBUG_OFF
void dbug_serve_apcs(THD *thd, int n_calls);
#endif 

1549 1550
/**
  @class THD
unknown's avatar
unknown committed
1551 1552 1553
  For each client connection we create a separate thread with THD serving as
  a thread/connection descriptor
*/
1554

1555
class THD :public Statement,
1556
           public Open_tables_state
unknown's avatar
unknown committed
1557
{
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
private:
  inline bool is_stmt_prepare() const
  { DBUG_ASSERT(0); return Statement::is_stmt_prepare(); }

  inline bool is_stmt_prepare_or_first_sp_execute() const
  { DBUG_ASSERT(0); return Statement::is_stmt_prepare_or_first_sp_execute(); }

  inline bool is_stmt_prepare_or_first_stmt_execute() const
  { DBUG_ASSERT(0); return Statement::is_stmt_prepare_or_first_stmt_execute(); }

  inline bool is_conventional() const
  { DBUG_ASSERT(0); return Statement::is_conventional(); }

unknown's avatar
unknown committed
1571
public:
1572 1573
  MDL_context mdl_context;

1574
  /* Used to execute base64 coded binlog events in MySQL server */
1575
  Relay_log_info* rli_fake;
1576 1577
  /* Slave applier execution context */
  Relay_log_info* rli_slave;
1578

Sergei Golubchik's avatar
Sergei Golubchik committed
1579
  void reset_for_next_command(bool calculate_userstat);
1580 1581 1582 1583 1584 1585 1586 1587
  /*
    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;

1588 1589
#ifdef EMBEDDED_LIBRARY
  struct st_mysql  *mysql;
unknown's avatar
SCRUM  
unknown committed
1590 1591
  unsigned long	 client_stmt_id;
  unsigned long  client_param_count;
unknown's avatar
unknown committed
1592
  struct st_mysql_bind *client_params;
unknown's avatar
unknown committed
1593 1594
  char *extra_data;
  ulong extra_length;
1595 1596 1597 1598 1599
  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();
1600 1601 1602 1603 1604 1605
  /*
    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;
1606 1607 1608
#endif
#ifdef HAVE_QUERY_CACHE
  Query_cache_tls query_cache_tls;
1609
#endif
unknown's avatar
unknown committed
1610
  NET	  net;				// client connection descriptor
1611
  scheduler_functions *scheduler;       // Scheduler for this connection
1612
  Protocol *protocol;			// Current protocol
unknown's avatar
unknown committed
1613 1614
  Protocol_text   protocol_text;	// Normal protocol
  Protocol_binary protocol_binary;	// Binary protocol
unknown's avatar
unknown committed
1615 1616
  HASH    user_vars;			// hash for user variables
  String  packet;			// dynamic buffer for network I/O
1617
  String  convert_buffer;               // buffer for charset conversions
1618
  struct  my_rnd_struct rand;		// used for authentication
unknown's avatar
unknown committed
1619
  struct  system_variables variables;	// Changeable local variables
1620
  struct  system_status_var status_var; // Per thread statistic vars
1621
  struct  system_status_var org_status_var; // For user statistics
1622
  struct  system_status_var *initial_status_var; /* used by show status */
1623
  THR_LOCK_INFO lock_info;              // Locking info of this thread
1624 1625 1626 1627 1628 1629 1630
  /**
    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
1631
  mysql_mutex_t LOCK_thd_data;
1632

1633
  /* all prepared statements and cursors of this connection */
1634
  Statement_map stmt_map;
unknown's avatar
unknown committed
1635 1636 1637 1638 1639 1640
  /*
    A pointer to the stack frame of handle_one_connection(),
    which is called first in the thread for handling a client
  */
  char	  *thread_stack;

1641 1642 1643 1644 1645
  /**
    Currently selected catalog.
  */
  char *catalog;

unknown's avatar
unknown committed
1646 1647 1648
  /**
    @note
    Some members of THD (currently 'Statement::db',
1649 1650 1651 1652 1653 1654
    '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
1655 1656

    @see handle_slave_sql
1657 1658
  */

1659 1660
  Security_context main_security_ctx;
  Security_context *security_ctx;
1661

1662 1663 1664 1665
  /*
    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.
1666 1667 1668

    Set it using the  thd_proc_info(THD *thread, const char *message)
    macro/function.
1669 1670 1671 1672

    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.
1673
  */
unknown's avatar
unknown committed
1674
  const char *proc_info;
1675

1676 1677 1678 1679 1680 1681 1682
  /*
    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;

1683
  ulong client_capabilities;		/* What the client supports */
1684
  ulong max_client_packet_length;
1685

unknown's avatar
unknown committed
1686
  HASH		handler_tables_hash;
unknown's avatar
unknown committed
1687 1688 1689
  /*
    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
1690
    chapter 'Miscellaneous functions', for functions GET_LOCK, RELEASE_LOCK.
unknown's avatar
unknown committed
1691
  */
1692
  User_level_lock *ull;
1693 1694
#ifndef DBUG_OFF
  uint dbug_sentry; // watch out for memory corruption
1695
#endif
unknown's avatar
unknown committed
1696
  struct st_my_thread_var *mysys_var;
1697
  /*
1698
    Type of current query: COM_STMT_PREPARE, COM_QUERY, etc. Set from
1699 1700 1701
    first byte of the packet in do_command()
  */
  enum enum_server_command command;
unknown's avatar
unknown committed
1702
  uint32     server_id;
unknown's avatar
unknown committed
1703
  uint32     file_id;			// for LOAD DATA INFILE
1704
  /* remote (peer) port */
1705
  uint16     peer_port;
1706 1707 1708
  my_time_t  start_time;             // start_time and its sec_part 
  ulong      start_time_sec_part;    // are almost always used separately
  my_hrtime_t user_time;
1709 1710
  // track down slow pthread_create
  ulonglong  prior_thr_create_utime, thr_create_utime;
1711
  ulonglong  start_utime, utime_after_lock, utime_after_query;
1712

1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
  // Process indicator
  struct {
    /*
      true, if the currently running command can send progress report
      packets to a client. Set by mysql_execute_command() for safe commands
      See CF_REPORT_PROGRESS
    */
    bool       report_to_client;
    /*
      true, if we will send progress report packets to a client
      (client has requested them, see CLIENT_PROGRESS; report_to_client
      is true; not in sub-statement)
    */
    bool       report;
    uint       stage, max_stage;
    ulonglong  counter, max_counter;
    ulonglong  next_report_time;
1730
    Query_arena *arena;
1731 1732
  } progress;

unknown's avatar
unknown committed
1733
  thr_lock_type update_lock_default;
1734
  Delayed_insert *di;
1735

1736 1737
  /* <> 0 if we are inside of trigger or stored function. */
  uint in_sub_stmt;
1738 1739
  /* True when opt_userstat_running is set at start of query */
  bool userstat_running;
1740 1741
  /* True if we want to log all errors */
  bool log_all_errors;
1742

1743 1744 1745
  /* Do not set socket timeouts for wait_timeout (used with threadpool) */
  bool skip_wait_timeout;

1746
  /* container for handler's private per-connection data */
1747
  Ha_data ha_data[MAX_HA];
1748

1749 1750
  bool prepare_derived_at_open;

Igor Babaev's avatar
Igor Babaev committed
1751 1752 1753 1754 1755 1756
  /* 
    To signal that the tmp table to be created is created for materialized
    derived table or a view.
  */ 
  bool create_tmp_table_for_derived;

Igor Babaev's avatar
Igor Babaev committed
1757 1758
  bool save_prep_leaf_list;

1759
#ifndef MYSQL_CLIENT
1760
  binlog_cache_mngr *  binlog_setup_trx_data();
1761

1762
  /*
1763
    Public interface to write RBR events to the binlog
1764
  */
1765
  void binlog_start_trans_and_stmt();
1766
  void binlog_set_stmt_begin();
1767 1768
  int binlog_write_table_map(TABLE *table, bool is_transactional,
                             my_bool *with_annotate= 0);
1769
  int binlog_write_row(TABLE* table, bool is_transactional,
1770 1771
                       MY_BITMAP const* cols, size_t colcnt,
                       const uchar *buf);
1772
  int binlog_delete_row(TABLE* table, bool is_transactional,
1773 1774
                        MY_BITMAP const* cols, size_t colcnt,
                        const uchar *buf);
1775
  int binlog_update_row(TABLE* table, bool is_transactional,
1776 1777
                        MY_BITMAP const* cols, size_t colcnt,
                        const uchar *old_data, const uchar *new_data);
1778 1779 1780 1781 1782 1783 1784 1785 1786

  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,
1787 1788
                                      size_t colcnt,
                                      size_t needed,
unknown's avatar
unknown committed
1789 1790
                                      bool is_transactional,
				      RowsEventT* hint);
1791 1792 1793 1794 1795 1796 1797 1798 1799
  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);
1800

1801 1802 1803 1804 1805 1806 1807 1808 1809
  /**
    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 {
1810 1811 1812 1813
    DBUG_ASSERT(current_stmt_binlog_format == BINLOG_FORMAT_STMT ||
                current_stmt_binlog_format == BINLOG_FORMAT_ROW);
    return current_stmt_binlog_format == BINLOG_FORMAT_ROW;
  }
1814

1815
private:
1816 1817 1818
  /**
    Indicates the format in which the current statement will be
    logged.  This can only be set from @c decide_logging_format().
1819
  */
1820 1821
  enum_binlog_format current_stmt_binlog_format;

1822
  /**
1823
    Bit field for the state of binlog warnings.
1824

1825 1826
    The first Lex::BINLOG_STMT_UNSAFE_COUNT bits list all types of
    unsafeness that the current statement has.
1827 1828 1829 1830 1831 1832

    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.
1833
  */
1834 1835
  uint32 binlog_unsafe_warning_flags;

1836 1837 1838 1839 1840
  /*
    Number of outstanding table maps, i.e., table maps in the
    transaction cache.
  */
  uint binlog_table_maps;
1841
public:
1842 1843
  void issue_unsafe_warnings();

1844 1845 1846
  uint get_binlog_table_maps() const {
    return binlog_table_maps;
  }
1847 1848 1849
  void clear_binlog_table_maps() {
    binlog_table_maps= 0;
  }
1850 1851
#endif /* MYSQL_CLIENT */

1852 1853
public:

unknown's avatar
unknown committed
1854
  struct st_transactions {
1855
    SAVEPOINT *savepoints;
unknown's avatar
unknown committed
1856 1857
    THD_TRANS all;			// Trans since BEGIN WORK
    THD_TRANS stmt;			// Trans for current statement
1858
    bool on;                            // see ha_enable_transaction()
1859
    XID_STATE xid_state;
Sergei Golubchik's avatar
Sergei Golubchik committed
1860
    WT_THD wt;                          ///< for deadlock detection
1861 1862
    Rows_log_event *m_pending_rows_event;

1863
    /*
1864
       Tables changed in transaction (that must be invalidated in query cache).
1865
       List contain only transactional tables, that not invalidated in query
1866 1867 1868 1869 1870 1871
       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()
    {
1872
      DBUG_ENTER("thd::cleanup");
1873 1874
      changed_tables= 0;
      savepoints= 0;
1875 1876 1877 1878 1879 1880 1881 1882
      /*
        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();
1883
      free_root(&mem_root,MYF(MY_KEEP_PREALLOC));
1884
      DBUG_VOID_RETURN;
1885
    }
1886 1887 1888 1889
    my_bool is_active()
    {
      return (all.ha_list != NULL);
    }
1890 1891 1892
    st_transactions()
    {
      bzero((char*)this, sizeof(*this));
1893
      xid_state.xid.null();
1894
      init_sql_alloc(&mem_root, ALLOC_ROOT_MIN_BLOCK_SIZE, 0,
1895
                     MYF(MY_THREAD_SPECIFIC));
1896
    }
unknown's avatar
unknown committed
1897
  } transaction;
1898
  Global_read_lock global_read_lock;
1899
  Field      *dup_field;
unknown's avatar
unknown committed
1900
#ifndef __WIN__
unknown's avatar
unknown committed
1901
  sigset_t signals;
unknown's avatar
unknown committed
1902
#endif
1903 1904
#ifdef SIGNAL_WITH_VIO_CLOSE
  Vio* active_vio;
1905
#endif
1906 1907 1908
  /*
    This is to track items changed during execution of a prepared
    statement/stored procedure. It's created by
unknown's avatar
unknown committed
1909
    nocheck_register_item_tree_change() in memory root of THD, and freed in
unknown's avatar
unknown committed
1910 1911
    rollback_item_tree_changes(). For conventional execution it's always
    empty.
1912 1913 1914
  */
  Item_change_list change_list;

unknown's avatar
unknown committed
1915
  /*
unknown's avatar
unknown committed
1916 1917
    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
1918
    memory root. In this case stmt_arena points to THD. In case of
unknown's avatar
unknown committed
1919
    a prepared statement or a stored procedure statement, thd->mem_root
unknown's avatar
unknown committed
1920
    conventionally points to runtime memory, and thd->stmt_arena
unknown's avatar
unknown committed
1921 1922 1923
    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
1924 1925
    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
1926
  */
unknown's avatar
unknown committed
1927
  Query_arena *stmt_arena;
1928 1929 1930 1931 1932 1933 1934

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

1935 1936
  /* Tells if LAST_INSERT_ID(#) was called for the current statement */
  bool arg_of_last_insert_id_function;
1937
  /*
1938 1939
    ALL OVER THIS FILE, "insert_id" means "*automatically generated* value for
    insertion into an auto_increment column".
1940 1941
  */
  /*
1942 1943 1944 1945 1946 1947
    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().
1948
  */
1949
  ulonglong  first_successful_insert_id_in_prev_stmt;
1950
  /*
1951 1952 1953 1954
    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).
1955
  */
1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
  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.
1967 1968 1969 1970
    - 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).
1971 1972 1973
    - at first successful insertion of an autogenerated value,
    first_successful_insert_id_in_cur_stmt is set to
    handler::insert_id_for_cur_row.
1974 1975 1976
    - when stmt goes to binlog,
    auto_inc_intervals_in_cur_stmt_for_binlog is binlogged if
    non-empty.
1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001
    - 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
2002 2003 2004
    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.
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015
  */
  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
2016 2017 2018
    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.
2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
    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.
  */
2045
  inline void record_first_successful_insert_id_in_cur_stmt(ulonglong id_arg)
2046 2047
  {
    if (first_successful_insert_id_in_cur_stmt == 0)
2048
      first_successful_insert_id_in_cur_stmt= id_arg;
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
  }
  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;
  }
  /*
2062
    Used by Intvar_log_event::do_apply_event() and by "SET INSERT_ID=#"
2063 2064 2065 2066 2067
    (mysqlbinlog). We'll soon add a variant which can take many intervals in
    argument.
  */
  inline void force_one_auto_inc_interval(ulonglong next_id)
  {
2068
    auto_inc_intervals_forced.empty(); // in case of multiple SET INSERT_ID
2069 2070 2071
    auto_inc_intervals_forced.append(next_id, ULONGLONG_MAX, 0);
  }

2072
  ulonglong  limit_found_rows;
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116

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;
  }

2117 2118 2119 2120 2121 2122 2123 2124
  ha_rows    cuted_fields;

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

2125 2126 2127 2128 2129 2130 2131 2132 2133
  /**
    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.
2134 2135
  */
  ha_rows    examined_row_count;
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149
  /**
    The number of rows and/or keys examined by the query, both read,
    changed or written.
  */
  ulonglong accessed_rows_and_keys;
  /**
    Check if the number of rows accessed by a statement exceeded
    LIMIT ROWS EXAMINED. If so, signal the query engine to stop execution.
  */
  void check_limit_rows_examined()
  {
    if (++accessed_rows_and_keys > lex->limit_rows_examined_cnt)
      killed= ABORT_QUERY;
  }
2150

2151
  USER_CONN *user_connect;
2152
  CHARSET_INFO *db_charset;
Marc Alff's avatar
Marc Alff committed
2153 2154
  Warning_info *warning_info;
  Diagnostics_area *stmt_da;
2155
#if defined(ENABLED_PROFILING)
unknown's avatar
unknown committed
2156
  PROFILING  profiling;
2157
#endif
unknown's avatar
unknown committed
2158

2159 2160 2161 2162 2163 2164 2165 2166
  /*
    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
2167
  query_id_t query_id;
unknown's avatar
unknown committed
2168
  ulong      col_access;
2169 2170 2171

  /* Statement id is thread-wide. This counter is used to generate ids */
  ulong      statement_id_counter;
2172
  ulong	     rand_saved_seed1, rand_saved_seed2;
2173 2174
  ulong      query_plan_flags; 
  ulong      query_plan_fsort_passes; 
unknown's avatar
unknown committed
2175 2176
  pthread_t  real_id;                           /* For debugging */
  my_thread_id  thread_id;
Sergei Golubchik's avatar
Sergei Golubchik committed
2177
  uint	     tmp_table, global_disable_checkpoint;
2178 2179
  uint	     server_status,open_options;
  enum enum_thread_type system_thread;
unknown's avatar
unknown committed
2180
  uint       select_number;             //number of select (used for EXPLAIN)
2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
  /*
    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;
2206
  enum_check_fields count_cuted_fields;
2207 2208 2209

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

2211 2212 2213 2214 2215 2216
  /*
    If checking this in conjunction with a wait condition, please
    include a check after enter_cond() if you want to avoid a race
    condition. For details see the implementation of awake(),
    especially the "broadcast" part.
  */
2217 2218
  killed_state volatile killed;

2219
  /* See also thd_killed() */
2220 2221 2222 2223 2224 2225 2226 2227
  inline bool check_killed()
  {
    if (killed)
      return TRUE;
    if (apc_target.have_apc_requests())
      apc_target.process_apc_requests(); 
    return FALSE;
  }
2228

2229
  /* scramble - random string sent to client on handshake */
unknown's avatar
unknown committed
2230
  char	     scramble[SCRAMBLE_LENGTH+1];
2231

2232 2233 2234 2235 2236
  /*
    If this is a slave, the name of the connection stored here.
    This is used for taging error messages in the log files.
  */
  LEX_STRING connection_name;
2237
  char       default_master_connection_buff[MAX_CONNECTION_NAME+1];
2238
  bool       slave_thread, one_shot_set;
2239 2240
  bool       extra_port;                        /* If extra connection */

2241
  bool	     no_errors;
Sergei Golubchik's avatar
Sergei Golubchik committed
2242
  uint8      password;
2243
  uint8      failed_com_change_user;
Sergei Golubchik's avatar
Sergei Golubchik committed
2244

2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270
  /**
    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;
2271
  bool	     query_start_used, rand_used, time_zone_used;
2272
  bool       query_start_sec_part_used;
2273 2274
  /* for IS NULL => = last_insert_id() fix in remove_eq_conds() */
  bool       substitute_null_with_insert_id;
2275
  bool	     in_lock_tables;
2276 2277
  /**
    True if a slave error. Causes the slave to stop. Not the same
2278
    as the statement execution error (is_error()), since
2279 2280 2281 2282 2283
    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;
2284

2285 2286
  /**  is set if some thread specific value(s) used in a statement. */
  bool       thread_specific_used;
2287 2288 2289 2290
  /**  
    is set if a statement accesses a temporary table created through
    CREATE TEMPORARY TABLE. 
  */
unknown's avatar
unknown committed
2291
  bool	     charset_is_system_charset, charset_is_collation_connection;
unknown's avatar
unknown committed
2292
  bool       charset_is_character_set_filesystem;
2293
  bool       enable_slow_log;   /* enable slow log for current statement */
2294
  bool	     abort_on_warning;
unknown's avatar
Merge  
unknown committed
2295
  bool 	     got_warning;       /* Set on call to push_warning() */
2296 2297
  /* set during loop of derived table processing */
  bool       derived_tables_processing;
2298
  bool       tablespace_op;	/* This is TRUE in DISCARD/IMPORT TABLESPACE */
2299

2300
  sp_rcontext *spcont;		// SP runtime context
2301 2302
  sp_cache   *sp_proc_cache;
  sp_cache   *sp_func_cache;
unknown's avatar
unknown committed
2303

2304 2305 2306
  /** number of name_const() substitutions, see sp_head.cc:subst_spvars() */
  uint       query_name_consts;

unknown's avatar
unknown committed
2307 2308 2309 2310 2311
  /*
    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
2312
  LOG_INFO*  current_linfo;
unknown's avatar
unknown committed
2313
  NET*       slave_net;			// network connection from slave -> m.
2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328

  /*
    Used to update global user stats.  The global user stats are updated
    occasionally with the 'diff' variables.  After the update, the 'diff'
    variables are reset to 0.
  */
  /* Time when the current thread connected to MySQL. */
  time_t current_connect_time;
  /* Last time when THD stats were updated in global_user_stats. */
  time_t last_global_update_time;
  /* Number of commands not reflected in global_user_stats yet. */
  uint select_commands, update_commands, other_commands;
  ulonglong start_cpu_time;
  ulonglong start_bytes_received;

unknown's avatar
unknown committed
2329 2330 2331
  /* Used by the sys_var class to store temporary values */
  union
  {
2332 2333 2334 2335
    my_bool   my_bool_value;
    long      long_value;
    ulong     ulong_value;
    ulonglong ulonglong_value;
2336
    double    double_value;
unknown's avatar
unknown committed
2337
  } sys_var_tmp;
2338

2339
  struct {
2340 2341
    /*
      If true, mysql_bin_log::write(Log_event) call will not write events to
2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
      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;
    /*
2352 2353
      If TRUE, at least one mysql_bin_log::write(Log_event e), where
      e.cache_stmt == TRUE call has been made after last
2354 2355 2356
      mysql_bin_log.start_union_events() call.
    */
    bool unioned_events_trans;
2357 2358

    /*
2359 2360 2361 2362
      'queries' (actually SP statements) that run under inside this binlog
      union have thd->query_id >= first_query_id.
    */
    query_id_t first_query_id;
2363
  } binlog_evt_union;
2364 2365

  /**
2366 2367 2368
    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.
2369
  */
2370
  Parser_state *m_parser_state;
2371

Konstantin Osipov's avatar
Konstantin Osipov committed
2372 2373
  Locked_tables_list locked_tables_list;

unknown's avatar
unknown committed
2374
#ifdef WITH_PARTITION_STORAGE_ENGINE
unknown's avatar
unknown committed
2375
  partition_info *work_part_info;
unknown's avatar
unknown committed
2376
#endif
unknown's avatar
foo1  
unknown committed
2377

2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391
#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

2392 2393 2394 2395
#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
2396 2397
  THD();
  ~THD();
2398

unknown's avatar
unknown committed
2399
  void init(void);
2400 2401 2402 2403 2404 2405 2406
  /*
    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
2407
    alloc_root.
2408 2409
  */
  void init_for_queries();
2410 2411
  void update_all_stats();
  void update_stats(void);
unknown's avatar
unknown committed
2412
  void change_user(void);
unknown's avatar
unknown committed
2413
  void cleanup(void);
2414
  void cleanup_after_query();
unknown's avatar
unknown committed
2415
  bool store_globals();
2416
  void reset_globals();
2417 2418
#ifdef SIGNAL_WITH_VIO_CLOSE
  inline void set_active_vio(Vio* vio)
2419
  {
Marc Alff's avatar
Marc Alff committed
2420
    mysql_mutex_lock(&LOCK_thd_data);
2421
    active_vio = vio;
2422
    vio_set_thread_id(vio, pthread_self());
Marc Alff's avatar
Marc Alff committed
2423
    mysql_mutex_unlock(&LOCK_thd_data);
2424
  }
2425
  inline void clear_active_vio()
2426
  {
Marc Alff's avatar
Marc Alff committed
2427
    mysql_mutex_lock(&LOCK_thd_data);
2428
    active_vio = 0;
Marc Alff's avatar
Marc Alff committed
2429
    mysql_mutex_unlock(&LOCK_thd_data);
2430
  }
unknown's avatar
unknown committed
2431
  void close_active_vio();
2432
#endif
2433
  void awake(killed_state state_to_set);
2434
 
2435 2436 2437
  /** Disconnect the associated communication endpoint. */
  void disconnect();

2438 2439

  /*
2440 2441
    Allows this thread to serve as a target for others to schedule Async 
    Procedure Calls on.
2442

2443 2444
    It's possible to schedule any code to be executed this way, by
    inheriting from the Apc_call object. Currently, only
2445
    Show_explain_request uses this.
2446 2447
  */
  Apc_target apc_target;
unknown's avatar
unknown committed
2448 2449 2450

#ifndef MYSQL_CLIENT
  enum enum_binlog_query_type {
2451
    /* The query can be logged in row format or in statement format. */
unknown's avatar
unknown committed
2452 2453
    ROW_QUERY_TYPE,
    
2454
    /* The query has to be logged in statement format. */
unknown's avatar
unknown committed
2455 2456 2457 2458
    STMT_QUERY_TYPE,
    
    QUERY_TYPE_COUNT
  };
2459

unknown's avatar
unknown committed
2460
  int binlog_query(enum_binlog_query_type qtype,
2461 2462
                   char const *query, ulong query_len, bool is_trans,
                   bool direct, bool suppress_use,
2463
                   int errcode);
unknown's avatar
unknown committed
2464 2465
#endif

2466 2467
  /*
    For enter_cond() / exit_cond() to work the mutex must be got before
2468 2469
    enter_cond(); this mutex is then released by exit_cond().
    Usage must be: lock mutex; enter_cond(); your code; exit_cond().
2470
  */
Marc Alff's avatar
Marc Alff committed
2471 2472
  inline const char* enter_cond(mysql_cond_t *cond, mysql_mutex_t* mutex,
                                const char* msg)
unknown's avatar
unknown committed
2473
  {
2474
    const char* old_msg = proc_info;
Marc Alff's avatar
Marc Alff committed
2475
    mysql_mutex_assert_owner(mutex);
2476 2477 2478 2479
    mysys_var->current_mutex = mutex;
    mysys_var->current_cond = cond;
    proc_info = msg;
    return old_msg;
unknown's avatar
unknown committed
2480 2481 2482
  }
  inline void exit_cond(const char* old_msg)
  {
2483 2484 2485 2486 2487 2488
    /*
      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
2489 2490
    mysql_mutex_unlock(mysys_var->current_mutex);
    mysql_mutex_lock(&mysys_var->mutex);
2491 2492 2493
    mysys_var->current_mutex = 0;
    mysys_var->current_cond = 0;
    proc_info = old_msg;
Marc Alff's avatar
Marc Alff committed
2494
    mysql_mutex_unlock(&mysys_var->mutex);
2495
    return;
unknown's avatar
unknown committed
2496
  }
2497 2498 2499
  inline my_time_t query_start() { query_start_used=1; return start_time; }
  inline ulong query_start_sec_part()
  { query_start_sec_part_used=1; return start_time_sec_part; }
2500
  inline void set_current_time()
2501
  {
2502 2503 2504 2505
    my_hrtime_t hrtime= my_hrtime();
    start_time= hrtime_to_my_time(hrtime);
    start_time_sec_part= hrtime_sec_part(hrtime);
  }
Sergei Golubchik's avatar
Sergei Golubchik committed
2506
  inline void set_start_time()
2507
  {
2508
    if (user_time.val)
2509
    {
2510
      start_time= hrtime_to_my_time(user_time);
2511
      start_time_sec_part= hrtime_sec_part(user_time);
2512 2513
    }
    else
2514
      set_current_time();
2515
  }
Sergei Golubchik's avatar
Sergei Golubchik committed
2516
  inline void set_time()
2517
  {
Sergei Golubchik's avatar
Sergei Golubchik committed
2518
    set_start_time();
2519
    start_utime= utime_after_lock= microsecond_interval_timer();
2520
  }
2521
  inline void	set_time(my_hrtime_t t)
2522
  {
2523
    user_time= t;
Sergei Golubchik's avatar
Sergei Golubchik committed
2524
    set_time();
2525
  }
2526 2527 2528 2529
  inline void	set_time(my_time_t t, ulong sec_part)
  {
    my_hrtime_t hrtime= { hrtime_from_time(t) + sec_part };
    set_time(hrtime);
2530
  }
2531 2532
  void set_time_after_lock()  { utime_after_lock= microsecond_interval_timer(); }
  ulonglong current_utime()  { return microsecond_interval_timer(); }
2533

2534 2535 2536 2537 2538 2539 2540 2541 2542
  /**
   Update server status after execution of a top level statement.
   Currently only checks if a query was slow, and assigns
   the status accordingly.
   Evaluate the current time, and if it exceeds the long-query-time
   setting, mark the query as slow.
  */
  void update_server_status()
  {
2543 2544
    utime_after_query= current_utime();
    if (utime_after_query > utime_after_lock + variables.long_query_time)
2545 2546
      server_status|= SERVER_QUERY_WAS_SLOW;
  }
2547 2548 2549
  inline ulonglong found_rows(void)
  {
    return limit_found_rows;
2550
  }
2551 2552
  /**
    Returns TRUE if session is in a multi-statement transaction mode.
2553

2554 2555 2556
    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.
2557

2558 2559 2560
    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.
2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572

    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()
2573
  */
2574
  inline bool in_multi_stmt_transaction_mode()
2575
  {
unknown's avatar
unknown committed
2576
    return variables.option_bits & (OPTION_NOT_AUTOCOMMIT | OPTION_BEGIN);
2577
  }
2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614
  /**
    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
2615 2616
  inline bool fill_derived_tables()
  {
unknown's avatar
unknown committed
2617
    return !stmt_arena->is_stmt_prepare() && !lex->only_view_structure();
unknown's avatar
unknown committed
2618
  }
2619 2620 2621 2622
  inline bool fill_information_schema_tables()
  {
    return !stmt_arena->is_stmt_prepare();
  }
2623
  inline void* trans_alloc(unsigned int size)
unknown's avatar
unknown committed
2624
  {
2625 2626
    return alloc_root(&transaction.mem_root,size);
  }
2627

2628 2629 2630 2631
  LEX_STRING *make_lex_string(LEX_STRING *lex_str,
                              const char* str, uint length,
                              bool allocate_lex_string);

2632 2633 2634
  bool convert_string(LEX_STRING *to, CHARSET_INFO *to_cs,
		      const char *from, uint from_length,
		      CHARSET_INFO *from_cs);
2635 2636 2637

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

2638
  void add_changed_table(TABLE *table);
unknown's avatar
unknown committed
2639 2640
  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
2641
  int send_explain_fields(select_result *result);
2642
  void make_explain_field_list(List<Item> &field_list);
2643 2644 2645 2646 2647 2648 2649
  /**
    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
2650 2651
  inline void clear_error()
  {
2652
    DBUG_ENTER("clear_error");
Marc Alff's avatar
Marc Alff committed
2653 2654
    if (stmt_da->is_error())
      stmt_da->reset_diagnostics_area();
2655
    is_slave_error= 0;
2656
    DBUG_VOID_RETURN;
unknown's avatar
unknown committed
2657
  }
2658
#ifndef EMBEDDED_LIBRARY
2659
  inline bool vio_ok() const { return net.vio != 0; }
2660
  /** Return FALSE if connection to client is broken. */
2661 2662
  bool is_connected()
  {
2663 2664 2665 2666 2667 2668
    /*
      All system threads (e.g., the slave IO thread) are connected but
      not using vio. So this function always returns true for all
      system threads.
    */
    return system_thread || (vio_ok() ? vio_is_connected(net.vio) : FALSE);
2669
  }
2670
#else
2671
  inline bool vio_ok() const { return TRUE; }
2672
  inline bool is_connected() { return TRUE; }
2673
#endif
2674 2675 2676 2677 2678
  /**
    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().
  */
2679 2680
  inline void fatal_error()
  {
2681
    DBUG_ASSERT(stmt_da->is_error() || killed);
2682
    is_fatal_error= 1;
unknown's avatar
unknown committed
2683
    DBUG_PRINT("error",("Fatal error set"));
2684
  }
2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697
  /**
    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
2698
  inline bool is_error() const { return stmt_da->is_error(); }
2699
  inline CHARSET_INFO *charset() { return variables.character_set_client; }
unknown's avatar
unknown committed
2700
  void update_charset();
2701

unknown's avatar
unknown committed
2702
  inline Query_arena *activate_stmt_arena_if_needed(Query_arena *backup)
unknown's avatar
unknown committed
2703 2704
  {
    /*
unknown's avatar
unknown committed
2705 2706
      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
2707
    */
unknown's avatar
unknown committed
2708
    if (!stmt_arena->is_conventional() && mem_root != stmt_arena->mem_root)
unknown's avatar
unknown committed
2709
    {
unknown's avatar
unknown committed
2710 2711
      set_n_backup_active_arena(stmt_arena, backup);
      return stmt_arena;
unknown's avatar
unknown committed
2712 2713 2714 2715
    }
    return 0;
  }

2716
  void change_item_tree(Item **place, Item *new_value)
2717
  {
2718
    /* TODO: check for OOM condition here */
unknown's avatar
unknown committed
2719
    if (!stmt_arena->is_conventional())
unknown's avatar
unknown committed
2720
      nocheck_register_item_tree_change(place, *place, mem_root);
2721
    *place= new_value;
2722
  }
unknown's avatar
unknown committed
2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736
  /**
    Make change in item tree after checking whether it needs registering


    @param place         place where we should assign new value
    @param new_value     place of the new value

    @details
    see check_and_register_item_tree_change details
  */
  void check_and_register_item_tree(Item **place, Item **new_value)
  {
    if (!stmt_arena->is_conventional())
      check_and_register_item_tree_change(place, new_value, mem_root);
2737 2738 2739 2740 2741
    /*
      We have to use memcpy instead of  *place= *new_value merge to
      avoid problems with strict aliasing.
    */
    memcpy((char*) place, new_value, sizeof(*new_value));
unknown's avatar
unknown committed
2742
  }
2743
  void nocheck_register_item_tree_change(Item **place, Item *old_value,
2744
                                         MEM_ROOT *runtime_memroot);
unknown's avatar
unknown committed
2745 2746
  void check_and_register_item_tree_change(Item **place, Item **new_value,
                                           MEM_ROOT *runtime_memroot);
2747
  void rollback_item_tree_changes();
2748 2749 2750 2751 2752 2753

  /*
    Cleanup statement parse state (parse tree, lex) and execution
    state after execution of a non-prepared SQL statement.
  */
  void end_statement();
2754 2755
  inline int killed_errno() const
  {
2756
    return ::killed_errno(killed);
2757
  }
2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770
  inline void reset_killed()
  {
    /*
      Resetting killed has to be done under a mutex to ensure
      its not done during an awake() call.
    */
    if (killed != NOT_KILLED)
    {
      mysql_mutex_lock(&LOCK_thd_data);
      killed= NOT_KILLED;
      mysql_mutex_unlock(&LOCK_thd_data);
    }
  }
2771 2772
  inline void send_kill_message() const
  {
unknown's avatar
unknown committed
2773
    int err= killed_errno();
2774 2775
    if (err)
      my_message(err, ER(err), MYF(0));
2776
  }
unknown's avatar
unknown committed
2777 2778 2779 2780
  /* 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
2781
            (!transaction.stmt.modified_non_trans_table ||
unknown's avatar
unknown committed
2782 2783
             (variables.sql_mode & MODE_STRICT_ALL_TABLES)));
  }
2784
  void set_status_var_init();
2785 2786
  void reset_n_backup_open_tables_state(Open_tables_backup *backup);
  void restore_backup_open_tables_state(Open_tables_backup *backup);
2787 2788
  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
2789 2790
  void set_n_backup_active_arena(Query_arena *set, Query_arena *backup);
  void restore_active_arena(Query_arena *set, Query_arena *backup);
2791

2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
  inline void get_binlog_format(enum_binlog_format *format,
                                enum_binlog_format *current_format)
  {
    *format= (enum_binlog_format) variables.binlog_format;
    *current_format= current_stmt_binlog_format;
  }
  inline void set_binlog_format(enum_binlog_format format,
                                enum_binlog_format current_format)
  {
    DBUG_ENTER("set_binlog_format");
    variables.binlog_format= format;
    current_stmt_binlog_format= current_format;
    DBUG_VOID_RETURN;
  }
  inline void set_binlog_format_stmt()
  {
    DBUG_ENTER("set_binlog_format_stmt");
    variables.binlog_format=    BINLOG_FORMAT_STMT;
    current_stmt_binlog_format= BINLOG_FORMAT_STMT;
    DBUG_VOID_RETURN;
  }
2813 2814 2815 2816
  /*
    @todo Make these methods private or remove them completely.  Only
    decide_logging_format should call them. /Sven
  */
2817
  inline void set_current_stmt_binlog_format_row_if_mixed()
2818
  {
2819
    DBUG_ENTER("set_current_stmt_binlog_format_row_if_mixed");
2820 2821 2822 2823 2824 2825 2826 2827
    /*
      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
2828 2829 2830 2831 2832
    /*
      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
2833
      reset_current_stmt_binlog_format_row()); this condition will make their
unknown's avatar
unknown committed
2834 2835 2836 2837 2838
      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))
2839
      set_current_stmt_binlog_format_row();
2840 2841

    DBUG_VOID_RETURN;
unknown's avatar
unknown committed
2842
  }
2843

2844
  inline void set_current_stmt_binlog_format_row()
unknown's avatar
unknown committed
2845
  {
2846
    DBUG_ENTER("set_current_stmt_binlog_format_row");
2847 2848
    current_stmt_binlog_format= BINLOG_FORMAT_ROW;
    DBUG_VOID_RETURN;
2849
  }
2850 2851
  /* Set binlog format temporarily to statement. Returns old format */
  inline enum_binlog_format set_current_stmt_binlog_format_stmt()
2852
  {
2853 2854
    enum_binlog_format orig_format= current_stmt_binlog_format;
    DBUG_ENTER("set_current_stmt_binlog_format_stmt");
2855
    current_stmt_binlog_format= BINLOG_FORMAT_STMT;
2856 2857 2858 2859 2860 2861 2862
    DBUG_RETURN(orig_format);
  }
  inline void restore_stmt_binlog_format(enum_binlog_format format)
  {
    DBUG_ENTER("restore_stmt_binlog_format");
    DBUG_ASSERT(!is_current_stmt_binlog_format_row());
    current_stmt_binlog_format= format;
2863
    DBUG_VOID_RETURN;
2864
  }
2865
  inline void reset_current_stmt_binlog_format_row()
2866
  {
2867
    DBUG_ENTER("reset_current_stmt_binlog_format_row");
unknown's avatar
unknown committed
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882
    /*
      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...).
    */
2883
    DBUG_PRINT("debug",
2884 2885
               ("temporary_tables: %s, in_sub_stmt: %s, system_thread: %s",
                YESNO(temporary_tables), YESNO(in_sub_stmt),
2886
                show_system_thread(system_thread)));
2887
    if (in_sub_stmt == 0)
unknown's avatar
unknown committed
2888
    {
2889
      if (variables.binlog_format == BINLOG_FORMAT_ROW)
2890
        set_current_stmt_binlog_format_row();
2891
      else if (temporary_tables == NULL)
2892
        set_current_stmt_binlog_format_stmt();
unknown's avatar
unknown committed
2893
    }
2894
    DBUG_VOID_RETURN;
2895
  }
unknown's avatar
unknown committed
2896

2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908
  /**
    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).

2909 2910 2911 2912
    @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.
2913 2914 2915 2916

    @return Operation status
      @retval FALSE Success
      @retval TRUE  Out-of-memory error
unknown's avatar
unknown committed
2917
  */
2918
  bool set_db(const char *new_db, size_t new_db_len)
unknown's avatar
unknown committed
2919
  {
2920 2921 2922 2923
    /* 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
2924
    {
2925
      my_free(db);
2926 2927 2928 2929
      if (new_db)
        db= my_strndup(new_db, new_db_len, MYF(MY_WME | ME_FATALERROR));
      else
        db= NULL;
unknown's avatar
unknown committed
2930
    }
2931 2932
    db_length= db ? new_db_len : 0;
    return new_db && !db;
unknown's avatar
unknown committed
2933
  }
2934 2935 2936 2937 2938 2939 2940

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

2941 2942 2943 2944
    @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.
2945
  */
2946
  void reset_db(char *new_db, size_t new_db_len)
unknown's avatar
unknown committed
2947 2948 2949 2950 2951 2952 2953 2954 2955
  {
    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.
  */
2956
  bool copy_db_to(char **p_db, size_t *p_db_length)
unknown's avatar
unknown committed
2957 2958 2959 2960 2961 2962 2963
  {
    if (db == NULL)
    {
      my_message(ER_NO_DB_ERROR, ER(ER_NO_DB_ERROR), MYF(0));
      return TRUE;
    }
    *p_db= strmake(db, db_length);
2964
    *p_db_length= db_length;
unknown's avatar
unknown committed
2965 2966
    return FALSE;
  }
2967
  thd_scheduler event_scheduler;
unknown's avatar
unknown committed
2968 2969

public:
2970 2971 2972
  inline Internal_error_handler *get_internal_handler()
  { return m_internal_handler; }

unknown's avatar
unknown committed
2973 2974 2975 2976 2977 2978 2979
  /**
    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
2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992
    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
2993 2994 2995 2996

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

Marc Alff's avatar
Marc Alff committed
2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 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 3061 3062 3063
  /**
    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);

public:
3064 3065 3066 3067
  /** Overloaded to guard query/query_length fields */
  virtual void set_statement(Statement *stmt);

  /**
3068
    Assign a new value to thd->query and thd->query_id and mysys_var.
3069 3070
    Protected with LOCK_thd_data mutex.
  */
3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082
  void set_query(char *query_arg, uint32 query_length_arg,
                 CHARSET_INFO *cs_arg)
  {
    set_query(CSET_STRING(query_arg, query_length_arg, cs_arg));
  }
  void set_query(char *query_arg, uint32 query_length_arg) /*Mutex protected*/
  {
    set_query(CSET_STRING(query_arg, query_length_arg, charset()));
  }
  void set_query(const CSET_STRING &str); /* Mutex protected */
  void reset_query()               /* Mutex protected */
  { set_query(CSET_STRING()); }
3083
  void set_query_and_id(char *query_arg, uint32 query_length_arg,
3084
                        CHARSET_INFO *cs, query_id_t new_query_id);
3085
  void set_query_id(query_id_t new_query_id);
3086 3087 3088 3089 3090 3091
  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);
  }
3092
  void set_mysys_var(struct st_my_thread_var *new_mysys_var);
3093 3094 3095
  void enter_locked_tables_mode(enum_locked_tables_mode mode_arg)
  {
    DBUG_ASSERT(locked_tables_mode == LTM_NONE);
3096

3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109
    if (mode_arg == LTM_LOCK_TABLES)
    {
      /*
        When entering LOCK TABLES mode we should set explicit duration
        for all metadata locks acquired so far in order to avoid releasing
        them till UNLOCK TABLES statement.
        We don't do this when entering prelocked mode since sub-statements
        don't release metadata locks and restoring status-quo after leaving
        prelocking mode gets complicated.
      */
      mdl_context.set_explicit_duration_for_all_locks();
    }

3110 3111
    locked_tables_mode= mode_arg;
  }
3112
  void leave_locked_tables_mode();
3113
  int decide_logging_format(TABLE_LIST *tables);
3114 3115
  void binlog_invoker() { m_binlog_invoker= TRUE; }
  bool need_binlog_invoker() { return m_binlog_invoker; }
3116 3117 3118 3119 3120 3121 3122 3123 3124
  void get_definer(LEX_USER *definer);
  void set_invoker(const LEX_STRING *user, const LEX_STRING *host)
  {
    invoker_user= *user;
    invoker_host= *host;
  }
  LEX_STRING get_invoker_user() { return invoker_user; }
  LEX_STRING get_invoker_host() { return invoker_host; }
  bool has_invoker() { return invoker_user.length > 0; }
Igor Babaev's avatar
Igor Babaev committed
3125

Sergei Golubchik's avatar
Sergei Golubchik committed
3126 3127 3128 3129 3130
  void print_aborted_warning(uint threshold, const char *reason)
  {
    if (global_system_variables.log_warnings > threshold)
    {
      Security_context *sctx= &main_security_ctx;
3131
      sql_print_warning(ER_THD(this, ER_NEW_ABORTING_CONNECTION),
Sergei Golubchik's avatar
Sergei Golubchik committed
3132 3133 3134 3135 3136 3137
                        thread_id, (db ? db : "unconnected"),
                        sctx->user ? sctx->user : "unauthenticated",
                        sctx->host_or_ip, reason);
    }
  }

Igor Babaev's avatar
Igor Babaev committed
3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157
private:
  /* 
    This reference points to the table arena when the expression
    for a virtual column is being evaluated
  */ 
  Query_arena *arena_for_cached_items;

public:
  void reset_arena_for_cached_items(Query_arena *new_arena)
  {
    arena_for_cached_items= new_arena;
  }
  Query_arena *switch_to_arena_for_cached_items(Query_arena *backup)
  {
    if (!arena_for_cached_items)
      return 0;
    set_n_backup_active_arena(arena_for_cached_items, backup);
    return backup;
  }

3158 3159 3160 3161 3162 3163 3164 3165
  void clear_wakeup_ready() { wakeup_ready= false; }
  /*
    Sleep waiting for others to wake us up with signal_wakeup_ready().
    Must call clear_wakeup_ready() before waiting.
  */
  void wait_for_wakeup_ready();
  /* Wake this thread up from wait_for_wakeup_ready(). */
  void signal_wakeup_ready();
unknown's avatar
unknown committed
3166
private:
3167

unknown's avatar
unknown committed
3168 3169
  /** The current internal error handler for this thread, or NULL. */
  Internal_error_handler *m_internal_handler;
3170

3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186
  /**
    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
3187 3188
  Warning_info main_warning_info;
  Diagnostics_area main_da;
3189 3190 3191 3192 3193 3194

  /**
    It will be set TURE if CURRENT_USER() is called in account management
    statements or default definer is set in CREATE/ALTER SP, SF, Event,
    TRIGGER or VIEW statements.

Michael Widenius's avatar
Michael Widenius committed
3195
    Current user will be binlogged into Query_log_event if m_binlog_invoker
3196 3197
    is TRUE; It will be stored into invoker_host and invoker_user by SQL thread.
   */
3198
  bool m_binlog_invoker;
3199 3200 3201 3202 3203 3204 3205 3206 3207

  /**
    It points to the invoker in the Query_log_event.
    SQL thread use it as the default definer in CREATE/ALTER SP, SF, Event,
    TRIGGER or VIEW statements or current user in account management
    statements if it is not NULL.
   */
  LEX_STRING invoker_user;
  LEX_STRING invoker_host;
3208 3209 3210 3211 3212 3213 3214 3215
  /*
    Flag, mutex and condition for a thread to wait for a signal from another
    thread.

    Currently used to wait for group commit to complete, can also be used for
    other purposes.
  */
  bool wakeup_ready;
Sergei Golubchik's avatar
Sergei Golubchik committed
3216 3217
  mysql_mutex_t LOCK_wakeup_ready;
  mysql_cond_t COND_wakeup_ready;
unknown's avatar
unknown committed
3218 3219
};

3220

Marc Alff's avatar
Marc Alff committed
3221
/** A short cut for thd->stmt_da->set_ok_status(). */
3222 3223

inline void
Marc Alff's avatar
Marc Alff committed
3224
my_ok(THD *thd, ulonglong affected_rows= 0, ulonglong id= 0,
3225 3226
        const char *message= NULL)
{
3227
  thd->set_row_count_func(affected_rows);
Marc Alff's avatar
Marc Alff committed
3228
  thd->stmt_da->set_ok_status(thd, affected_rows, id, message);
3229 3230 3231
}


Marc Alff's avatar
Marc Alff committed
3232
/** A short cut for thd->stmt_da->set_eof_status(). */
3233 3234

inline void
3235
my_eof(THD *thd)
3236
{
3237
  thd->set_row_count_func(-1);
Marc Alff's avatar
Marc Alff committed
3238
  thd->stmt_da->set_eof_status(thd);
3239 3240
}

3241
#define tmp_disable_binlog(A)       \
3242 3243
  {ulonglong tmp_disable_binlog__save_options= (A)->variables.option_bits; \
  (A)->variables.option_bits&= ~OPTION_BIN_LOG
3244

3245
#define reenable_binlog(A)   (A)->variables.option_bits= tmp_disable_binlog__save_options;}
3246

3247

3248 3249 3250 3251 3252
/*
  These functions are for making it later easy to add strict
  checking for all date handling.
*/

Sergei Golubchik's avatar
Sergei Golubchik committed
3253
const my_bool strict_date_checking= 0;
3254 3255 3256

inline ulong sql_mode_for_dates(THD *thd)
{
Sergei Golubchik's avatar
Sergei Golubchik committed
3257
  if (strict_date_checking)
3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268
    return (thd->variables.sql_mode &
            (MODE_NO_ZERO_DATE | MODE_NO_ZERO_IN_DATE |
             MODE_INVALID_DATES));
  return (thd->variables.sql_mode & MODE_INVALID_DATES);
}

inline ulong sql_mode_for_dates()
{
  return sql_mode_for_dates(current_thd);
}

unknown's avatar
unknown committed
3269
/*
3270
  Used to hold information about file and file structure in exchange
unknown's avatar
unknown committed
3271
  via non-DB file (...INTO OUTFILE..., ...LOAD DATA...)
3272
  XXX: We never call destructor for objects of this class.
unknown's avatar
unknown committed
3273
*/
3274

unknown's avatar
unknown committed
3275 3276 3277
class sql_exchange :public Sql_alloc
{
public:
3278
  enum enum_filetype filetype; /* load XML, Added by Arnold & Erik */
unknown's avatar
unknown committed
3279 3280 3281 3282
  char *file_name;
  String *field_term,*enclosed,*line_term,*line_start,*escaped;
  bool opt_enclosed;
  bool dumpfile;
3283
  ulong skip_lines;
3284
  CHARSET_INFO *cs;
3285 3286
  sql_exchange(char *name, bool dumpfile_flag,
               enum_filetype filetype_arg= FILETYPE_CSV);
3287
  bool escaped_given(void);
unknown's avatar
unknown committed
3288 3289 3290
};

/*
3291
  This is used to get result from a select
unknown's avatar
unknown committed
3292 3293
*/

unknown's avatar
unknown committed
3294 3295
class JOIN;

3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322
/* Pure interface for sending tabular data */
class select_result_sink: public Sql_alloc
{
public:
  /*
    send_data returns 0 on ok, 1 on error and -1 if data was ignored, for
    example for a duplicate row entry written to a temp table.
  */
  virtual int send_data(List<Item> &items)=0;
  virtual ~select_result_sink() {};
};


/*
  Interface for sending tabular data, together with some other stuff:

  - Primary purpose seems to be seding typed tabular data:
     = the DDL is sent with send_fields()
     = the rows are sent with send_data()
  Besides that,
  - there seems to be an assumption that the sent data is a result of 
    SELECT_LEX_UNIT *unit,
  - nest_level is used by SQL parser
*/

class select_result :public select_result_sink 
{
unknown's avatar
unknown committed
3323 3324
protected:
  THD *thd;
3325 3326 3327 3328 3329
  /* 
    All descendant classes have their send_data() skip the first 
    unit->offset_limit_cnt rows sent.  Select_materialize
    also uses unit->get_unit_column_types().
  */
3330
  SELECT_LEX_UNIT *unit;
3331
  /* Something used only by the parser: */
unknown's avatar
unknown committed
3332 3333 3334
public:
  select_result();
  virtual ~select_result() {};
3335 3336 3337 3338 3339
  virtual int prepare(List<Item> &list, SELECT_LEX_UNIT *u)
  {
    unit= u;
    return 0;
  }
3340
  virtual int prepare2(void) { return 0; }
3341 3342 3343 3344 3345 3346 3347
  /*
    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; }
3348
  virtual bool send_result_set_metadata(List<Item> &list, uint flags)=0;
unknown's avatar
unknown committed
3349
  virtual bool initialize_tables (JOIN *join=0) { return 0; }
3350
  virtual void send_error(uint errcode,const char *err);
unknown's avatar
unknown committed
3351
  virtual bool send_eof()=0;
3352 3353 3354 3355 3356 3357 3358 3359
  /**
    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;
3360
  virtual void abort_result_set() {}
3361 3362 3363 3364 3365
  /*
    Cleanup instance of this class for next execution of a prepared
    statement/stored procedure.
  */
  virtual void cleanup();
3366
  void set_thd(THD *thd_arg) { thd= thd_arg; }
3367 3368 3369 3370 3371
#ifdef EMBEDDED_LIBRARY
  virtual void begin_dataset() {}
#else
  void begin_dataset() {}
#endif
unknown's avatar
unknown committed
3372 3373 3374
};


3375
/*
3376 3377 3378 3379
  This is a select_result_sink which simply writes all data into a (temporary)
  table. Creation/deletion of the table is outside of the scope of the class
  
  It is aimed at capturing SHOW EXPLAIN output, so:
3380 3381 3382
  - Unlike select_result class, we don't assume that the sent data is an 
    output of a SELECT_LEX_UNIT (and so we dont apply "LIMIT x,y" from the
    unit)
3383
  - We don't try to convert the target table to MyISAM 
3384 3385 3386 3387 3388
*/

class select_result_explain_buffer : public select_result_sink
{
public:
3389 3390 3391
  select_result_explain_buffer(THD *thd_arg, TABLE *table_arg) : 
    thd(thd_arg), dst_table(table_arg) {};

3392
  THD *thd;
3393
  TABLE *dst_table; /* table to write into */
3394 3395 3396 3397 3398 3399 3400

  /* The following is called in the child thread: */
  int send_data(List<Item> &items);
};



3401 3402 3403 3404 3405 3406 3407 3408 3409
/*
  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:
3410 3411 3412 3413 3414 3415
  select_result_interceptor()
  {
    DBUG_ENTER("select_result_interceptor::select_result_interceptor");
    DBUG_PRINT("enter", ("this 0x%lx", (ulong) this));
    DBUG_VOID_RETURN;
  }              /* Remove gcc warning */
3416
  uint field_count(List<Item> &fields) const { return 0; }
3417
  bool send_result_set_metadata(List<Item> &fields, uint flag) { return FALSE; }
3418 3419 3420
};


unknown's avatar
unknown committed
3421
class select_send :public select_result {
3422 3423 3424 3425 3426 3427
  /**
    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
3428
public:
3429
  select_send() :is_result_set_started(FALSE) {}
3430
  bool send_result_set_metadata(List<Item> &list, uint flags);
3431
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
3432
  bool send_eof();
3433
  virtual bool check_simple_select() const { return FALSE; }
3434
  void abort_result_set();
3435
  virtual void cleanup();
unknown's avatar
unknown committed
3436 3437 3438
};


3439
class select_to_file :public select_result_interceptor {
3440
protected:
unknown's avatar
unknown committed
3441 3442 3443 3444
  sql_exchange *exchange;
  File file;
  IO_CACHE cache;
  ha_rows row_count;
3445 3446 3447 3448 3449 3450 3451
  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);
3452 3453
  bool send_eof();
  void cleanup();
3454 3455 3456
};


unknown's avatar
unknown committed
3457 3458 3459
#define ESCAPE_CHARS "ntrb0ZN" // keep synchronous with READ_INFO::unescape


unknown's avatar
unknown committed
3460 3461 3462 3463 3464 3465
/*
 List of all possible characters of a numeric value text representation.
*/
#define NUMERIC_CHARS ".0123456789e+-"


3466
class select_export :public select_to_file {
unknown's avatar
unknown committed
3467 3468
  uint field_term_length;
  int field_sep_char,escape_char,line_sep_char;
3469
  int field_term_char; // first char of FIELDS TERMINATED BY or MAX_INT
unknown's avatar
unknown committed
3470 3471 3472 3473 3474 3475
  /*
    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;
3476 3477 3478 3479 3480 3481
  /*
     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
3482 3483 3484 3485 3486 3487
  /*
    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
3488
  bool fixed_row_size;
3489
  CHARSET_INFO *write_cs; // output charset
unknown's avatar
unknown committed
3490
public:
3491
  select_export(sql_exchange *ex) :select_to_file(ex) {}
unknown's avatar
unknown committed
3492
  ~select_export();
3493
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
3494
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
3495 3496
};

unknown's avatar
unknown committed
3497

3498
class select_dump :public select_to_file {
unknown's avatar
unknown committed
3499
public:
3500
  select_dump(sql_exchange *ex) :select_to_file(ex) {}
3501
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
3502
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
3503
};
unknown's avatar
unknown committed
3504 3505


3506
class select_insert :public select_result_interceptor {
unknown's avatar
unknown committed
3507
 public:
unknown's avatar
VIEW  
unknown committed
3508
  TABLE_LIST *table_list;
unknown's avatar
unknown committed
3509 3510
  TABLE *table;
  List<Item> *fields;
3511
  ulonglong autoinc_value_of_last_inserted_row; // autogenerated or not
unknown's avatar
unknown committed
3512
  COPY_INFO info;
unknown's avatar
VIEW  
unknown committed
3513
  bool insert_into_view;
unknown's avatar
unknown committed
3514 3515
  select_insert(TABLE_LIST *table_list_par,
		TABLE *table_par, List<Item> *fields_par,
unknown's avatar
unknown committed
3516
		List<Item> *update_fields, List<Item> *update_values,
3517
		enum_duplicates duplic, bool ignore);
unknown's avatar
unknown committed
3518
  ~select_insert();
3519
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
3520
  virtual int prepare2(void);
3521
  virtual int send_data(List<Item> &items);
unknown's avatar
unknown committed
3522
  virtual void store_values(List<Item> &values);
3523
  virtual bool can_rollback_data() { return 0; }
unknown's avatar
unknown committed
3524 3525
  void send_error(uint errcode,const char *err);
  bool send_eof();
3526
  virtual void abort_result_set();
3527 3528
  /* not implemented: select_insert is never re-used in prepared statements */
  void cleanup();
unknown's avatar
unknown committed
3529 3530
};

unknown's avatar
unknown committed
3531

unknown's avatar
unknown committed
3532 3533
class select_create: public select_insert {
  ORDER *group;
unknown's avatar
VIEW  
unknown committed
3534
  TABLE_LIST *create_table;
unknown's avatar
unknown committed
3535
  HA_CREATE_INFO *create_info;
3536
  TABLE_LIST *select_tables;
3537
  Alter_info *alter_info;
unknown's avatar
unknown committed
3538
  Field **field;
3539 3540 3541 3542
  /* lock data for tmp table */
  MYSQL_LOCK *m_lock;
  /* m_lock or thd->extra_lock */
  MYSQL_LOCK **m_plock;
unknown's avatar
unknown committed
3543
public:
unknown's avatar
unknown committed
3544
  select_create (TABLE_LIST *table_arg,
unknown's avatar
VIEW  
unknown committed
3545
		 HA_CREATE_INFO *create_info_par,
3546
                 Alter_info *alter_info_arg,
3547 3548
		 List<Item> &select_fields,enum_duplicates duplic, bool ignore,
                 TABLE_LIST *select_tables_arg)
3549
    :select_insert (NULL, NULL, &select_fields, 0, 0, duplic, ignore),
3550
    create_table(table_arg),
3551 3552
    create_info(create_info_par),
    select_tables(select_tables_arg),
3553 3554
    alter_info(alter_info_arg),
    m_plock(NULL)
unknown's avatar
unknown committed
3555
    {}
3556
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
3557

3558
  int binlog_show_create_table(TABLE **tables, uint count);
unknown's avatar
unknown committed
3559
  void store_values(List<Item> &values);
3560
  void send_error(uint errcode,const char *err);
unknown's avatar
unknown committed
3561
  bool send_eof();
3562
  virtual void abort_result_set();
3563 3564
  virtual bool can_rollback_data() { return 1; }

3565
  // Needed for access from local class MY_HOOKS in prepare(), since thd is proteted.
3566 3567
  const THD *get_thd(void) { return thd; }
  const HA_CREATE_INFO *get_create_info() { return create_info; };
3568
  int prepare2(void) { return 0; }
unknown's avatar
unknown committed
3569 3570
};

3571
#include <myisam.h>
3572

3573
#ifdef WITH_ARIA_STORAGE_ENGINE
3574
#include <maria.h>
3575 3576 3577
#endif

#ifdef USE_ARIA_FOR_TMP_TABLES
3578 3579 3580 3581
#define ENGINE_COLUMNDEF MARIA_COLUMNDEF
#else
#define ENGINE_COLUMNDEF MI_COLUMNDEF
#endif
3582

3583 3584
/*
  Param to create temporary tables when doing SELECT:s
unknown's avatar
unknown committed
3585 3586 3587
  NOTE
    This structure is copied using memcpy as a part of JOIN.
*/
3588 3589 3590

class TMP_TABLE_PARAM :public Sql_alloc
{
3591 3592 3593 3594 3595 3596
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:
3597 3598 3599 3600
  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;
3601
  uchar	    *group_buff;
3602
  Item	    **items_to_copy;			/* Fields in tmp table */
3603
  ENGINE_COLUMNDEF *recinfo, *start_recinfo;
3604 3605
  KEY *keyinfo;
  ha_rows end_write_records;
3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631
  /**
    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;   
3632 3633 3634 3635
  uint  hidden_field_count;
  uint	group_parts,group_length,group_null_parts;
  uint	quick_group;
  bool  using_indirect_summary_function;
3636
  /* If >0 convert all blob fields to varchar(convert_blob_length) */
3637 3638
  uint  convert_blob_length;
  CHARSET_INFO *table_charset;
3639
  bool schema_table;
3640 3641
  /* TRUE if the temp table is created for subquery materialization. */
  bool materialized_subquery;
Igor Babaev's avatar
Igor Babaev committed
3642 3643
  /* TRUE if all columns of the table are guaranteed to be non-nullable */
  bool force_not_null_cols;
3644 3645 3646 3647 3648 3649 3650
  /*
    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;
3651
  bool force_copy_fields;
3652 3653 3654 3655 3656 3657
  /*
    If TRUE, create_tmp_field called from create_tmp_table will convert
    all BIT fields to 64-bit longs. This is a workaround the limitation
    that MEMORY tables cannot index BIT columns.
  */
  bool bit_fields_as_long;
unknown's avatar
unknown committed
3658 3659 3660 3661 3662
  /*
    Whether to create or postpone actual creation of this temporary table.
    TRUE <=> create_tmp_table will create only the TABLE structure.
  */
  bool skip_create_table;
3663 3664

  TMP_TABLE_PARAM()
unknown's avatar
unknown committed
3665
    :copy_field(0), group_parts(0),
unknown's avatar
unknown committed
3666
     group_length(0), group_null_parts(0), convert_blob_length(0),
Igor Babaev's avatar
Igor Babaev committed
3667 3668
    schema_table(0), materialized_subquery(0), force_not_null_cols(0),
    precomputed_group_by(0),
3669
    force_copy_fields(0), bit_fields_as_long(0), skip_create_table(0)
3670 3671 3672 3673 3674
  {}
  ~TMP_TABLE_PARAM()
  {
    cleanup();
  }
3675
  void init(void);
3676 3677 3678 3679 3680
  inline void cleanup(void)
  {
    if (copy_field)				/* Fix for Intel compiler */
    {
      delete [] copy_field;
unknown's avatar
unknown committed
3681 3682
      save_copy_field= copy_field= NULL;
      save_copy_field_end= copy_field_end= NULL;
3683 3684 3685 3686
    }
  }
};

3687 3688 3689
class select_union :public select_result_interceptor
{
public:
3690
  TMP_TABLE_PARAM tmp_table_param;
unknown's avatar
unknown committed
3691
  int write_err; /* Error code from the last send_data->ha_write_row call. */
3692 3693
public:
  TABLE *table;
3694
  ha_rows records;
unknown's avatar
unknown committed
3695

3696
  select_union() :write_err(0), table(0), records(0) { tmp_table_param.init(); }
3697
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
3698
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
3699 3700
  bool send_eof();
  bool flush();
3701
  void cleanup();
3702 3703
  virtual bool create_result_table(THD *thd, List<Item> *column_types,
                                   bool is_distinct, ulonglong options,
3704 3705 3706
                                   const char *alias, 
                                   bool bit_fields_as_long,
                                   bool create_table);
unknown's avatar
unknown committed
3707
  TMP_TABLE_PARAM *get_tmp_table_param() { return &tmp_table_param; }
unknown's avatar
unknown committed
3708 3709
};

unknown's avatar
unknown committed
3710
/* Base subselect interface class */
3711
class select_subselect :public select_result_interceptor
3712
{
unknown's avatar
unknown committed
3713
protected:
3714 3715 3716
  Item_subselect *item;
public:
  select_subselect(Item_subselect *item);
3717
  int send_data(List<Item> &items)=0;
3718 3719 3720
  bool send_eof() { return 0; };
};

unknown's avatar
unknown committed
3721
/* Single value subselect interface class */
unknown's avatar
unknown committed
3722
class select_singlerow_subselect :public select_subselect
unknown's avatar
unknown committed
3723 3724
{
public:
3725 3726 3727
  select_singlerow_subselect(Item_subselect *item_arg)
    :select_subselect(item_arg)
  {}
3728
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
3729 3730
};

3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758

/*
  This class specializes select_union to collect statistics about the
  data stored in the temp table. Currently the class collects statistcs
  about NULLs.
*/

class select_materialize_with_stats : public select_union
{
protected:
  class Column_statistics
  {
  public:
    /* Count of NULLs per column. */
    ha_rows null_count;
    /* The row number that contains the first NULL in a column. */
    ha_rows min_null_row;
    /* The row number that contains the last NULL in a column. */
    ha_rows max_null_row;
  };

  /* Array of statistics data per column. */
  Column_statistics* col_stat;

  /*
    The number of columns in the biggest sub-row that consists of only
    NULL values.
  */
3759
  uint max_nulls_in_row;
3760 3761 3762 3763 3764 3765 3766
  /*
    Count of rows writtent to the temp table. This is redundant as it is
    already stored in handler::stats.records, however that one is relatively
    expensive to compute (given we need that for evry row).
  */
  ha_rows count_rows;

3767 3768 3769
protected:
  void reset();

3770
public:
3771
  select_materialize_with_stats() { tmp_table_param.init(); }
3772 3773 3774 3775 3776
  bool create_result_table(THD *thd, List<Item> *column_types,
                           bool is_distinct, ulonglong options,
                           const char *alias, 
                           bool bit_fields_as_long,
                           bool create_table);
3777
  bool init_result_table(ulonglong select_options);
Michael Widenius's avatar
Michael Widenius committed
3778
  int send_data(List<Item> &items);
3779
  void cleanup();
3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794
  ha_rows get_null_count_of_col(uint idx)
  {
    DBUG_ASSERT(idx < table->s->fields);
    return col_stat[idx].null_count;
  }
  ha_rows get_max_null_of_col(uint idx)
  {
    DBUG_ASSERT(idx < table->s->fields);
    return col_stat[idx].max_null_row;
  }
  ha_rows get_min_null_of_col(uint idx)
  {
    DBUG_ASSERT(idx < table->s->fields);
    return col_stat[idx].min_null_row;
  }
3795
  uint get_max_nulls_in_row() { return max_nulls_in_row; }
3796 3797 3798
};


3799 3800 3801 3802 3803 3804
/* 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;
unknown's avatar
unknown committed
3805
  bool is_all;
3806
public:
unknown's avatar
unknown committed
3807 3808 3809
  select_max_min_finder_subselect(Item_subselect *item_arg, bool mx,
                                  bool all)
    :select_subselect(item_arg), cache(0), fmax(mx), is_all(all)
3810
  {}
unknown's avatar
Merge  
unknown committed
3811
  void cleanup();
3812
  int send_data(List<Item> &items);
3813 3814
  bool cmp_real();
  bool cmp_int();
unknown's avatar
Merge  
unknown committed
3815
  bool cmp_decimal();
3816 3817 3818
  bool cmp_str();
};

unknown's avatar
unknown committed
3819 3820 3821 3822
/* EXISTS subselect interface class */
class select_exists_subselect :public select_subselect
{
public:
3823 3824
  select_exists_subselect(Item_subselect *item_arg)
    :select_subselect(item_arg){}
3825
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
3826 3827
};

3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888



/*
  Optimizer and executor structure for the materialized semi-join info. This
  structure contains
   - The sj-materialization temporary table
   - Members needed to make index lookup or a full scan of the temptable.
*/
class SJ_MATERIALIZATION_INFO : public Sql_alloc
{
public:
  /* Optimal join sub-order */
  struct st_position *positions;

  uint tables; /* Number of tables in the sj-nest */

  /* Expected #rows in the materialized table */
  double rows;

  /* 
    Cost to materialize - execute the sub-join and write rows into temp.table
  */
  COST_VECT materialization_cost;

  /* Cost to make one lookup in the temptable */
  COST_VECT lookup_cost;
  
  /* Cost of scanning the materialized table */
  COST_VECT scan_cost;

  /* --- Execution structures ---------- */
  
  /*
    TRUE <=> This structure is used for execution. We don't necessarily pick
    sj-materialization, so some of SJ_MATERIALIZATION_INFO structures are not
    used by materialization
  */
  bool is_used;
  
  bool materialized; /* TRUE <=> materialization already performed */
  /*
    TRUE  - the temptable is read with full scan
    FALSE - we use the temptable for index lookups
  */
  bool is_sj_scan; 
  
  /* The temptable and its related info */
  TMP_TABLE_PARAM sjm_table_param;
  List<Item> sjm_table_cols;
  TABLE *table;

  /* Structure used to make index lookups */
  struct st_table_ref *tab_ref;
  Item *in_equality; /* See create_subq_in_equalities() */

  Item *join_cond; /* See comments in make_join_select() */
  Copy_field *copy_field; /* Needed for SJ_Materialization scan */
};


unknown's avatar
unknown committed
3889 3890 3891 3892 3893 3894
/* 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 */
3895
  uint   suffix_length;                 /* Length suffix (0-4) */
unknown's avatar
unknown committed
3896
  Item_result result_type;		/* Type of item */
3897 3898
  bool reverse;				/* if descending sort */
  bool need_strxnfrm;			/* If we have to use strxnfrm() */
unknown's avatar
unknown committed
3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911
} 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 */

3912 3913
class Table_ident :public Sql_alloc
{
unknown's avatar
unknown committed
3914
public:
unknown's avatar
unknown committed
3915 3916
  LEX_STRING db;
  LEX_STRING table;
unknown's avatar
unknown committed
3917
  SELECT_LEX_UNIT *sel;
unknown's avatar
unknown committed
3918 3919
  inline Table_ident(THD *thd, LEX_STRING db_arg, LEX_STRING table_arg,
		     bool force)
unknown's avatar
unknown committed
3920
    :table(table_arg), sel((SELECT_LEX_UNIT *)0)
unknown's avatar
unknown committed
3921
  {
unknown's avatar
unknown committed
3922
    if (!force && (thd->client_capabilities & CLIENT_NO_SCHEMA))
unknown's avatar
unknown committed
3923 3924 3925 3926
      db.str=0;
    else
      db= db_arg;
  }
3927
  inline Table_ident(LEX_STRING table_arg)
unknown's avatar
unknown committed
3928 3929 3930 3931
    :table(table_arg), sel((SELECT_LEX_UNIT *)0)
  {
    db.str=0;
  }
3932 3933 3934 3935 3936 3937
  /*
    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
3938
  inline Table_ident(SELECT_LEX_UNIT *s) : sel(s)
unknown's avatar
unknown committed
3939
  {
unknown's avatar
unknown committed
3940
    /* We must have a table name here as this is used with add_table_to_list */
3941 3942 3943 3944
    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
3945
  }
3946
  bool is_derived_table() const { return test(sel); }
unknown's avatar
unknown committed
3947
  inline void change_db(char *db_name)
unknown's avatar
unknown committed
3948 3949 3950
  {
    db.str= db_name; db.length= (uint) strlen(db_name);
  }
unknown's avatar
unknown committed
3951 3952 3953 3954 3955 3956
};

// this is needed for user_vars hash
class user_var_entry
{
 public:
3957
  user_var_entry() {}                         /* Remove gcc warning */
unknown's avatar
unknown committed
3958 3959
  LEX_STRING name;
  char *value;
3960 3961
  ulong length;
  query_id_t update_query_id, used_query_id;
unknown's avatar
unknown committed
3962
  Item_result type;
3963
  bool unsigned_flag;
3964

3965 3966 3967 3968
  double val_real(bool *null_value);
  longlong val_int(bool *null_value) const;
  String *val_str(bool *null_value, String *str, uint decimals);
  my_decimal *val_decimal(bool *null_value, my_decimal *result);
3969
  DTCollation collation;
unknown's avatar
unknown committed
3970 3971
};

3972 3973
user_var_entry *get_variable(HASH *hash, LEX_STRING &name,
				    bool create_if_not_exists);
3974

3975
/*
3976
   Unique -- class for unique (removing of duplicates).
3977 3978 3979 3980 3981
   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.
 */
3982 3983 3984 3985

class Unique :public Sql_alloc
{
  DYNAMIC_ARRAY file_ptrs;
3986 3987
  ulong max_elements;
  ulonglong max_in_memory_size;
3988 3989
  IO_CACHE file;
  TREE tree;
3990
  uchar *record_pointers;
3991
  ulong filtered_out_elems;
3992
  bool flush();
3993
  uint size;
3994
  uint full_size;
3995
  uint min_dupl_count;   /* always 0 for unions, > 0 for intersections */
3996

3997 3998
  bool merge(TABLE *table, uchar *buff, bool without_last_merge);

3999 4000
public:
  ulong elements;
4001
  Unique(qsort_cmp2 comp_func, void *comp_func_fixed_arg,
4002 4003
	 uint size_arg, ulonglong max_in_memory_size_arg,
         uint min_dupl_count_arg= 0);
4004
  ~Unique();
4005
  ulong elements_in_tree() { return tree.elements_in_tree; }
4006
  inline bool unique_add(void *ptr)
4007
  {
unknown's avatar
Merge  
unknown committed
4008
    DBUG_ENTER("unique_add");
unknown's avatar
unknown committed
4009
    DBUG_PRINT("info", ("tree %u - %lu", tree.elements_in_tree, max_elements));
4010 4011
    if (!(tree.flag & TREE_ONLY_DUPS) && 
        tree.elements_in_tree >= max_elements && flush())
unknown's avatar
Merge  
unknown committed
4012 4013
      DBUG_RETURN(1);
    DBUG_RETURN(!tree_insert(&tree, ptr, 0, tree.custom_arg));
4014 4015
  }

4016 4017 4018
  bool is_in_memory() { return (my_b_tell(&file) == 0); }
  void close_for_expansion() { tree.flag= TREE_ONLY_DUPS; }

4019
  bool get(TABLE *table);
4020
  
4021
  /* Cost of searching for an element in the tree */
4022
  inline static double get_search_cost(ulonglong tree_elems, uint compare_factor)
4023 4024 4025 4026
  {
    return log((double) tree_elems) / (compare_factor * M_LN2);
  }  

4027
  static double get_use_cost(uint *buffer, size_t nkeys, uint key_size,
4028 4029
                             ulonglong max_in_memory_size, uint compare_factor,
                             bool intersect_fl, bool *in_memory);
4030
  inline static int get_cost_calc_buff_size(size_t nkeys, uint key_size,
4031
                                            ulonglong max_in_memory_size)
4032
  {
4033
    register ulonglong max_elems_in_tree=
4034
      max_in_memory_size / ALIGN_SIZE(sizeof(TREE_ELEMENT)+key_size);
4035
    return (int) (sizeof(uint)*(1 + nkeys/max_elems_in_tree));
4036 4037
  }

4038
  void reset();
4039
  bool walk(TABLE *table, tree_walk_action action, void *walk_action_arg);
4040

4041 4042 4043
  uint get_size() const { return size; }
  ulonglong get_max_in_memory_size() const { return max_in_memory_size; }

4044 4045
  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);
4046 4047 4048 4049 4050

  friend int unique_write_to_file_with_count(uchar* key, element_count count,
                                             Unique *unique);
  friend int unique_intersect_write_to_ptrs(uchar* key, element_count count, 
				            Unique *unique);
4051
};
4052

unknown's avatar
unknown committed
4053

4054
class multi_delete :public select_result_interceptor
unknown's avatar
unknown committed
4055 4056
{
  TABLE_LIST *delete_tables, *table_being_deleted;
unknown's avatar
unknown committed
4057
  Unique **tempfiles;
4058
  ha_rows deleted, found;
unknown's avatar
unknown committed
4059 4060
  uint num_of_tables;
  int error;
4061 4062 4063 4064 4065 4066
  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;
4067 4068 4069 4070 4071
  /*
     error handling (rollback and binlogging) can happen in send_eof()
     so that afterward send_error() needs to find out that.
  */
  bool error_handled;
4072

unknown's avatar
unknown committed
4073
public:
4074
  multi_delete(TABLE_LIST *dt, uint num_of_tables);
unknown's avatar
unknown committed
4075 4076
  ~multi_delete();
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
4077
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
4078 4079
  bool initialize_tables (JOIN *join);
  void send_error(uint errcode,const char *err);
4080 4081
  int do_deletes();
  int do_table_deletes(TABLE *table, bool ignore);
unknown's avatar
unknown committed
4082
  bool send_eof();
4083 4084 4085 4086
  inline ha_rows num_deleted()
  {
    return deleted;
  }
4087
  virtual void abort_result_set();
unknown's avatar
unknown committed
4088 4089
};

4090

4091
class multi_update :public select_result_interceptor
unknown's avatar
unknown committed
4092
{
4093
  TABLE_LIST *all_tables; /* query/update command tables */
4094
  List<TABLE_LIST> *leaves;     /* list of leves of join table tree */
4095
  TABLE_LIST *update_tables, *table_being_updated;
unknown's avatar
unknown committed
4096
  TABLE **tmp_tables, *main_table, *table_to_update;
unknown's avatar
unknown committed
4097 4098 4099 4100 4101
  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
4102 4103
  /*
   List of tables referenced in the CHECK OPTION condition of
4104
   the updated view excluding the updated table.
unknown's avatar
unknown committed
4105 4106
  */
  List <TABLE> unupdated_check_opt_tables;
unknown's avatar
unknown committed
4107 4108
  Copy_field *copy_field;
  enum enum_duplicates handle_duplicates;
4109 4110 4111 4112
  bool do_update, trans_safe;
  /* True if the update operation has made a change in a transactional table */
  bool transactional_tables;
  bool ignore;
4113 4114 4115 4116 4117
  /* 
     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
4118 4119

public:
4120
  multi_update(TABLE_LIST *ut, List<TABLE_LIST> *leaves_list,
4121
	       List<Item> *fields, List<Item> *values,
4122
	       enum_duplicates handle_duplicates, bool ignore);
unknown's avatar
unknown committed
4123
  ~multi_update();
unknown's avatar
unknown committed
4124
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
4125
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
4126 4127
  bool initialize_tables (JOIN *join);
  void send_error(uint errcode,const char *err);
4128
  int  do_updates();
unknown's avatar
unknown committed
4129
  bool send_eof();
4130 4131 4132 4133 4134 4135 4136 4137
  inline ha_rows num_found()
  {
    return found;
  }
  inline ha_rows num_updated()
  {
    return updated;
  }
4138
  virtual void abort_result_set();
unknown's avatar
unknown committed
4139
};
4140

unknown's avatar
unknown committed
4141 4142 4143
class my_var : public Sql_alloc  {
public:
  LEX_STRING s;
unknown's avatar
unknown committed
4144
#ifndef DBUG_OFF
4145 4146 4147 4148
  /*
    Routine to which this Item_splocal belongs. Used for checking if correct
    runtime context is used for variable handling.
  */
4149
  sp_head *sp;
4150
#endif
unknown's avatar
unknown committed
4151 4152
  bool local;
  uint offset;
4153 4154 4155 4156
  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
4157 4158
  ~my_var() {}
};
4159

4160
class select_dumpvar :public select_result_interceptor {
unknown's avatar
unknown committed
4161
  ha_rows row_count;
4162
  Item_func_set_user_var **set_var_items;
unknown's avatar
unknown committed
4163
public:
unknown's avatar
unknown committed
4164
  List<my_var> var_list;
4165
  select_dumpvar()  { var_list.empty(); row_count= 0;}
unknown's avatar
unknown committed
4166
  ~select_dumpvar() {}
4167
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
4168
  int send_data(List<Item> &items);
unknown's avatar
unknown committed
4169
  bool send_eof();
4170
  virtual bool check_simple_select() const;
4171
  void cleanup();
unknown's avatar
unknown committed
4172
};
4173

4174 4175
/* Bits in sql_command_flags */

Marc Alff's avatar
Marc Alff committed
4176
#define CF_CHANGES_DATA           (1U << 0)
Sergei Golubchik's avatar
Sergei Golubchik committed
4177
#define CF_REPORT_PROGRESS        (1U << 1)
Marc Alff's avatar
Marc Alff committed
4178 4179 4180
#define CF_STATUS_COMMAND         (1U << 2)
#define CF_SHOW_TABLE_COMMAND     (1U << 3)
#define CF_WRITE_LOGS_COMMAND     (1U << 4)
4181

4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194
/**
  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
4195
#define CF_REEXECUTION_FRAGILE    (1U << 5)
Konstantin Osipov's avatar
Konstantin Osipov committed
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225
/**
  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
4226 4227 4228 4229 4230 4231 4232 4233 4234 4235

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

4237 4238 4239 4240
/**
  Identifies statements that may generate row events
  and that may end up in the binary log.
*/
4241
#define CF_CAN_GENERATE_ROW_EVENTS (1U << 9)
4242

4243 4244 4245 4246 4247
/**
  Statement that need the binlog format to be unchanged.
*/
#define CF_FORCE_ORIGINAL_BINLOG_FORMAT (1U << 10)

4248
/**
4249
  Statement that inserts new rows (INSERT, REPLACE, LOAD, ALTER TABLE)
4250 4251 4252 4253 4254 4255 4256 4257
*/
#define CF_INSERTS_DATA (1U << 11)

/**
  Statement that updates existing rows (UPDATE, multi-update)
*/
#define CF_UPDATES_DATA (1U << 12)

Konstantin Osipov's avatar
Konstantin Osipov committed
4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274
/* 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)

4275
void add_to_status(STATUS_VAR *to_var, STATUS_VAR *from_var);
4276

4277 4278
void add_diff_to_status(STATUS_VAR *to_var, STATUS_VAR *from_var,
                        STATUS_VAR *dec_var);
4279 4280
void mark_transaction_to_rollback(THD *thd, bool all);

4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302
/* 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);
}

Sergei Golubchik's avatar
Sergei Golubchik committed
4303
/* inline handler methods that need to know TABLE and THD structures */
4304 4305 4306
inline void handler::increment_statistics(ulong SSV::*offset) const
{
  status_var_increment(table->in_use->status_var.*offset);
4307
  table->in_use->check_limit_rows_examined();
4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319
}

inline void handler::decrement_statistics(ulong SSV::*offset) const
{
  status_var_decrement(table->in_use->status_var.*offset);
}

inline int handler::ha_index_read_map(uchar * buf, const uchar * key,
                                      key_part_map keypart_map,
                                      enum ha_rkey_function find_flag)
{
  DBUG_ASSERT(inited==INDEX);
4320
  MYSQL_INDEX_READ_ROW_START(table_share->db.str, table_share->table_name.str);
4321 4322 4323 4324 4325
  increment_statistics(&SSV::ha_read_key_count);
  int error= index_read_map(buf, key, keypart_map, find_flag);
  if (!error)
    update_index_statistics();
  table->status=error ? STATUS_NOT_FOUND: 0;
4326
  MYSQL_INDEX_READ_ROW_DONE(error);
4327 4328 4329
  return error;
}

4330 4331 4332 4333 4334 4335 4336

/*
  @note: Other index lookup/navigation functions require prior
  handler->index_init() call. This function is different, it requires
  that the scan is not initialized, and accepts "uint index" as an argument.
*/

4337 4338 4339 4340 4341
inline int handler::ha_index_read_idx_map(uchar * buf, uint index,
                                          const uchar * key,
                                          key_part_map keypart_map,
                                          enum ha_rkey_function find_flag)
{
4342
  DBUG_ASSERT(inited==NONE);
4343
  MYSQL_INDEX_READ_ROW_START(table_share->db.str, table_share->table_name.str);
4344 4345 4346 4347
  increment_statistics(&SSV::ha_read_key_count);
  int error= index_read_idx_map(buf, index, key, keypart_map, find_flag);
  if (!error)
  {
4348
    update_rows_read();
4349 4350 4351
    index_rows_read[index]++;
  }
  table->status=error ? STATUS_NOT_FOUND: 0;
4352
  MYSQL_INDEX_READ_ROW_DONE(error);
4353 4354 4355 4356 4357 4358
  return error;
}

inline int handler::ha_index_next(uchar * buf)
{
  DBUG_ASSERT(inited==INDEX);
4359
  MYSQL_INDEX_READ_ROW_START(table_share->db.str, table_share->table_name.str);
4360 4361 4362 4363 4364
  increment_statistics(&SSV::ha_read_next_count);
  int error= index_next(buf);
  if (!error)
    update_index_statistics();
  table->status=error ? STATUS_NOT_FOUND: 0;
4365
  MYSQL_INDEX_READ_ROW_DONE(error);
4366 4367 4368 4369 4370 4371
  return error;
}

inline int handler::ha_index_prev(uchar * buf)
{
  DBUG_ASSERT(inited==INDEX);
4372
  MYSQL_INDEX_READ_ROW_START(table_share->db.str, table_share->table_name.str);
4373 4374 4375 4376 4377
  increment_statistics(&SSV::ha_read_prev_count);
  int error= index_prev(buf);
  if (!error)
    update_index_statistics();
  table->status=error ? STATUS_NOT_FOUND: 0;
4378
  MYSQL_INDEX_READ_ROW_DONE(error);
4379 4380 4381 4382 4383 4384
  return error;
}

inline int handler::ha_index_first(uchar * buf)
{
  DBUG_ASSERT(inited==INDEX);
4385
  MYSQL_INDEX_READ_ROW_START(table_share->db.str, table_share->table_name.str);
4386 4387 4388 4389 4390
  increment_statistics(&SSV::ha_read_first_count);
  int error= index_first(buf);
  if (!error)
    update_index_statistics();
  table->status=error ? STATUS_NOT_FOUND: 0;
4391
  MYSQL_INDEX_READ_ROW_DONE(error);
4392 4393 4394 4395 4396 4397
  return error;
}

inline int handler::ha_index_last(uchar * buf)
{
  DBUG_ASSERT(inited==INDEX);
4398
  MYSQL_INDEX_READ_ROW_START(table_share->db.str, table_share->table_name.str);
4399 4400 4401 4402 4403
  increment_statistics(&SSV::ha_read_last_count);
  int error= index_last(buf);
  if (!error)
    update_index_statistics();
  table->status=error ? STATUS_NOT_FOUND: 0;
4404
  MYSQL_INDEX_READ_ROW_DONE(error);
4405 4406 4407 4408 4409 4410 4411
  return error;
}

inline int handler::ha_index_next_same(uchar *buf, const uchar *key,
                                       uint keylen)
{
  DBUG_ASSERT(inited==INDEX);
4412
  MYSQL_INDEX_READ_ROW_START(table_share->db.str, table_share->table_name.str);
4413 4414 4415 4416 4417
  increment_statistics(&SSV::ha_read_next_count);
  int error= index_next_same(buf, key, keylen);
  if (!error)
    update_index_statistics();
  table->status=error ? STATUS_NOT_FOUND: 0;
4418
  MYSQL_INDEX_READ_ROW_DONE(error);
4419 4420 4421 4422 4423 4424 4425
  return error;
}

inline int handler::ha_ft_read(uchar *buf)
{
  int error= ft_read(buf);
  if (!error)
4426 4427
    update_rows_read();

4428 4429 4430 4431 4432 4433
  table->status=error ? STATUS_NOT_FOUND: 0;
  return error;
}

inline int handler::ha_rnd_next(uchar *buf)
{
4434
  MYSQL_READ_ROW_START(table_share->db.str, table_share->table_name.str, TRUE);
4435 4436
  int error= rnd_next(buf);
  if (!error)
4437
  {
4438
    update_rows_read();
4439 4440 4441 4442 4443 4444 4445
    increment_statistics(&SSV::ha_read_rnd_next_count);
  }
  else if (error == HA_ERR_RECORD_DELETED)
    increment_statistics(&SSV::ha_read_rnd_deleted_count);
  else
    increment_statistics(&SSV::ha_read_rnd_next_count);

4446
  table->status=error ? STATUS_NOT_FOUND: 0;
4447
  MYSQL_READ_ROW_DONE(error);
4448 4449 4450 4451 4452
  return error;
}

inline int handler::ha_rnd_pos(uchar *buf, uchar *pos)
{
4453
  MYSQL_READ_ROW_START(table_share->db.str, table_share->table_name.str, FALSE);
4454 4455 4456
  increment_statistics(&SSV::ha_read_rnd_count);
  int error= rnd_pos(buf, pos);
  if (!error)
4457
    update_rows_read();
4458
  table->status=error ? STATUS_NOT_FOUND: 0;
4459
  MYSQL_READ_ROW_DONE(error);
4460 4461 4462 4463 4464 4465 4466
  return error;
}

inline int handler::ha_rnd_pos_by_record(uchar *buf)
{
  int error= rnd_pos_by_record(buf);
  if (!error)
4467
    update_rows_read();
4468 4469 4470 4471 4472 4473 4474 4475
  table->status=error ? STATUS_NOT_FOUND: 0;
  return error;
}

inline int handler::ha_read_first_row(uchar *buf, uint primary_key)
{
  int error= read_first_row(buf, primary_key);
  if (!error)
4476
    update_rows_read();
4477 4478 4479 4480
  table->status=error ? STATUS_NOT_FOUND: 0;
  return error;
}

4481 4482
inline int handler::ha_write_tmp_row(uchar *buf)
{
Sergei Golubchik's avatar
Sergei Golubchik committed
4483
  MYSQL_INSERT_ROW_START(table_share->db.str, table_share->table_name.str);
4484
  increment_statistics(&SSV::ha_tmp_write_count);
Sergei Golubchik's avatar
Sergei Golubchik committed
4485 4486 4487
  int error= write_row(buf);
  MYSQL_INSERT_ROW_DONE(error);
  return error;
4488
}
4489

4490 4491
inline int handler::ha_update_tmp_row(const uchar *old_data, uchar *new_data)
{
Sergei Golubchik's avatar
Sergei Golubchik committed
4492
  MYSQL_UPDATE_ROW_START(table_share->db.str, table_share->table_name.str);
4493
  increment_statistics(&SSV::ha_tmp_update_count);
Sergei Golubchik's avatar
Sergei Golubchik committed
4494 4495 4496
  int error= update_row(old_data, new_data);
  MYSQL_UPDATE_ROW_DONE(error);
  return error;
4497 4498
}

4499 4500
extern pthread_attr_t *get_connection_attrib(void);

4501
#endif /* MYSQL_SERVER */
4502

4503
#endif /* SQL_CLASS_INCLUDED */