sql_class.h 64.6 KB
Newer Older
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1
/* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
2

bk@work.mysql.com's avatar
bk@work.mysql.com committed
3 4 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
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
7

bk@work.mysql.com's avatar
bk@work.mysql.com committed
8 9 10 11
   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.
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
12

bk@work.mysql.com's avatar
bk@work.mysql.com committed
13 14 15 16 17 18 19
   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 */


/* Classes in mysql */

20
#ifdef USE_PRAGMA_INTERFACE
bk@work.mysql.com's avatar
bk@work.mysql.com committed
21 22 23
#pragma interface			/* gcc class implementation */
#endif

24 25
// TODO: create log.h and move all the log header stuff there

bk@work.mysql.com's avatar
bk@work.mysql.com committed
26 27
class Query_log_event;
class Load_log_event;
28
class Slave_log_event;
29
class Format_description_log_event;
30
class sp_rcontext;
31
class sp_cache;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
32

33
enum enum_enable_or_disable { LEAVE_AS_IS, ENABLE, DISABLE };
34
enum enum_ha_read_modes { RFIRST, RNEXT, RPREV, RLAST, RKEY, RNEXT_SAME };
35
enum enum_duplicates { DUP_ERROR, DUP_REPLACE, DUP_UPDATE };
36
enum enum_log_type { LOG_CLOSED, LOG_TO_BE_OPENED, LOG_NORMAL, LOG_NEW, LOG_BIN};
37 38
enum enum_delay_key_write { DELAY_KEY_WRITE_NONE, DELAY_KEY_WRITE_ON,
			    DELAY_KEY_WRITE_ALL };
bk@work.mysql.com's avatar
bk@work.mysql.com committed
39

40 41 42
enum enum_check_fields { CHECK_FIELD_IGNORE, CHECK_FIELD_WARN,
			 CHECK_FIELD_ERROR_FOR_NULL };

43
extern char internal_table_name[2];
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
44
extern const char **errmesg;
45

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
#define TC_LOG_PAGE_SIZE   8192
#define TC_LOG_MIN_SIZE    (3*TC_LOG_PAGE_SIZE)

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

/*
  Transaction Coordinator log - a base abstract class
  for two different implementations
*/
class TC_LOG
{
  public:
  int using_heuristic_recover();
  TC_LOG() {}
  virtual ~TC_LOG() {}

  virtual int open(const char *opt_name)=0;
  virtual void close()=0;
  virtual int log(THD *thd, my_xid xid)=0;
  virtual void unlog(ulong cookie, my_xid xid)=0;
};

class TC_LOG_DUMMY: public TC_LOG // use it to disable the logging
{
  public:
  int open(const char *opt_name)        { return 0; }
  void close()                          { }
  int log(THD *thd, my_xid xid)         { return 1; }
  void unlog(ulong cookie, my_xid xid)  { }
};

serg@serg.mylan's avatar
serg@serg.mylan committed
79
#ifdef HAVE_MMAP
80 81
class TC_LOG_MMAP: public TC_LOG
{
82
  public:                // only to keep Sun Forte on sol9x86 happy
83 84 85 86 87 88
  typedef enum {
    POOL,                 // page is in pool
    ERROR,                // last sync failed
    DIRTY                 // new xids added since last sync
  } PAGE_STATE;

89
  private:
90 91 92 93 94 95 96 97 98 99 100 101 102
  typedef struct st_page {
    struct st_page *next; // page a linked in a fifo queue
    my_xid *start, *end;  // usable area of a page
    my_xid *ptr;          // next xid will be written here
    int size, free;       // max and current number of free xid slots on the page
    int waiters;          // number of waiters on condition
    PAGE_STATE state;     // see above
    pthread_mutex_t lock; // to access page data or control structure
    pthread_cond_t  cond; // to wait for a sync
  } PAGE;

  char logname[FN_REFLEN];
  File fd;
serg@serg.mylan's avatar
serg@serg.mylan committed
103 104
  my_off_t file_length;
  uint npages, inited;
105
  uchar *data;
106 107 108 109 110 111 112
  struct st_page *pages, *syncing, *active, *pool, *pool_last;
  /*
    note that, e.g. LOCK_active is only used to protect
    'active' pointer, to protect the content of the active page
    one has to use active->lock.
    Same for LOCK_pool and LOCK_sync
  */
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
  pthread_mutex_t LOCK_active, LOCK_pool, LOCK_sync;
  pthread_cond_t COND_pool, COND_active;

  public:
  TC_LOG_MMAP(): inited(0) {}
  int open(const char *opt_name);
  void close();
  int log(THD *thd, my_xid xid);
  void unlog(ulong cookie, my_xid xid);
  int recover();

  private:
  void get_active_from_pool();
  int sync();
  int overflow();
};
serg@serg.mylan's avatar
serg@serg.mylan committed
129 130 131
#else
#define TC_LOG_MMAP TC_LOG_DUMMY
#endif
132 133 134 135 136

extern TC_LOG *tc_log;
extern TC_LOG_MMAP tc_log_mmap;
extern TC_LOG_DUMMY tc_log_dummy;

137
/* log info errors */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
138 139 140 141
#define LOG_INFO_EOF -1
#define LOG_INFO_IO  -2
#define LOG_INFO_INVALID -3
#define LOG_INFO_SEEK -4
142 143 144
#define LOG_INFO_MEM -6
#define LOG_INFO_FATAL -7
#define LOG_INFO_IN_USE -8
bk@work.mysql.com's avatar
bk@work.mysql.com committed
145

146 147 148 149 150
/* bitmap to SQL_LOG::close() */
#define LOG_CLOSE_INDEX		1
#define LOG_CLOSE_TO_BE_OPENED	2
#define LOG_CLOSE_STOP_EVENT	4

151 152
struct st_relay_log_info;

bk@work.mysql.com's avatar
bk@work.mysql.com committed
153 154 155
typedef struct st_log_info
{
  char log_file_name[FN_REFLEN];
156
  my_off_t index_file_offset, index_file_start_offset;
157 158 159
  my_off_t pos;
  bool fatal; // if the purge happens to give us a negative offset
  pthread_mutex_t lock;
160
  st_log_info():fatal(0) { pthread_mutex_init(&lock, MY_MUTEX_INIT_FAST);}
161
  ~st_log_info() { pthread_mutex_destroy(&lock);}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
162 163
} LOG_INFO;

164 165 166 167 168 169 170 171 172
typedef struct st_user_var_events
{
  user_var_entry *user_var_event;
  char *value;
  ulong length;
  Item_result type;
  uint charset_number;
} BINLOG_USER_VAR_EVENT;

173 174 175
#define RP_LOCK_LOG_IS_ALREADY_LOCKED 1
#define RP_FORCE_ROTATE               2

monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
176
class Log_event;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
177

178 179 180 181 182 183 184 185 186 187 188 189
/*
  TODO split MYSQL_LOG into base MYSQL_LOG and
  MYSQL_QUERY_LOG, MYSQL_SLOW_LOG, MYSQL_BIN_LOG
  most of the code from MYSQL_LOG should be in the MYSQL_BIN_LOG
  only (TC_LOG included)

  TODO use mmap instead of IO_CACHE for binlog
  (mmap+fsync is two times faster than write+fsync)
*/

class MYSQL_LOG: public TC_LOG
{
bk@work.mysql.com's avatar
bk@work.mysql.com committed
190
 private:
191
  /* LOCK_log and LOCK_index are inited by init_pthread_objects() */
192
  pthread_mutex_t LOCK_log, LOCK_index;
193 194
  pthread_mutex_t LOCK_prep_xids;
  pthread_cond_t  COND_prep_xids;
195 196
  pthread_cond_t update_cond;
  ulonglong bytes_written;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
197
  time_t last_time,query_start;
198
  IO_CACHE log_file;
199
  IO_CACHE index_file;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
200 201 202
  char *name;
  char time_buff[20],db[NAME_LEN+1];
  char log_file_name[FN_REFLEN],index_file_name[FN_REFLEN];
203
  /*
204 205 206 207 208 209 210
     The max size before rotation (usable only if log_type == LOG_BIN: binary
     logs and relay logs).
     For a binlog, max_size should be max_binlog_size.
     For a relay log, it should be max_relay_log_size if this is non-zero,
     max_binlog_size otherwise.
     max_size is set in init(), and dynamically changed (when one does SET
     GLOBAL MAX_BINLOG_SIZE|MAX_RELAY_LOG_SIZE) by fix_max_binlog_size and
211
     fix_max_relay_log_size).
212 213
  */
  ulong max_size;
214
  ulong prepared_xids; /* for tc log - number of xids to remember */
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
  volatile enum_log_type log_type;
  enum cache_type io_cache_type;
  // current file sequence number for load data infile binary logging
  uint file_id;
  uint open_count;				// For replication
  int readers_count;
  bool write_error, inited;
  bool need_start_event;
  /*
    no_auto_events means we don't want any of these automatic events :
    Start/Rotate/Stop. That is, in 4.x when we rotate a relay log, we don't
    want a Rotate_log event to be written to the relay log. When we start a
    relay log etc. So in 4.x this is 1 for relay logs, 0 for binlogs.
    In 5.0 it's 0 for relay logs too!
  */
  bool no_auto_events;
231 232
  friend class Log_event;

bk@work.mysql.com's avatar
bk@work.mysql.com committed
233
public:
234 235 236 237 238 239 240 241 242 243 244
  /*
    These describe the log's format. This is used only for relay logs.
    _for_exec is used by the SQL thread, _for_queue by the I/O thread. It's
    necessary to have 2 distinct objects, because the I/O thread may be reading
    events in a different format from what the SQL thread is reading (consider
    the case of a master which has been upgraded from 5.0 to 5.1 without doing
    RESET MASTER, or from 4.x to 5.0).
  */
  Format_description_log_event *description_event_for_exec,
    *description_event_for_queue;

bk@work.mysql.com's avatar
bk@work.mysql.com committed
245
  MYSQL_LOG();
246 247 248 249 250
  /*
    note that there's no destructor ~MYSQL_LOG() !
    The reason is that we don't want it to be automatically called
    on exit() - but only during the correct shutdown process
  */
251

252 253 254 255 256
  int open(const char *opt_name);
  void close();
  int log(THD *thd, my_xid xid);
  void unlog(ulong cookie, my_xid xid);
  int recover(IO_CACHE *log, Format_description_log_event *fdle);
257
  void reset_bytes_written()
258 259 260
  {
    bytes_written = 0;
  }
261
  void harvest_bytes_written(ulonglong* counter)
262
  {
263
#ifndef DBUG_OFF
264
    char buf1[22],buf2[22];
265
#endif
266 267 268 269 270 271 272
    DBUG_ENTER("harvest_bytes_written");
    (*counter)+=bytes_written;
    DBUG_PRINT("info",("counter: %s  bytes_written: %s", llstr(*counter,buf1),
		       llstr(bytes_written,buf2)));
    bytes_written=0;
    DBUG_VOID_RETURN;
  }
273
  void set_max_size(ulong max_size_arg);
monty@mysql.com's avatar
monty@mysql.com committed
274
  void signal_update();
275
  void wait_for_update(THD* thd, bool master_or_slave);
276 277
  void set_need_start_event() { need_start_event = 1; }
  void init(enum_log_type log_type_arg,
278 279
	    enum cache_type io_cache_type_arg,
	    bool no_auto_events_arg, ulong max_size);
guilhem@mysql.com's avatar
guilhem@mysql.com committed
280
  void init_pthread_objects();
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
281
  void cleanup();
282 283 284
  bool open(const char *log_name,
            enum_log_type log_type,
            const char *new_name,
285
	    enum cache_type io_cache_type_arg,
286 287
	    bool no_auto_events_arg, ulong max_size,
            bool null_created);
288 289 290 291 292 293 294
  const char *generate_name(const char *log_name, const char *suffix,
                            bool strip_ext, char *buff);
  /* simplified open_xxx wrappers for the gigantic open above */
  bool open_query_log(const char *log_name)
  {
    char buf[FN_REFLEN];
    return open(generate_name(log_name, ".log", 0, buf),
295
                LOG_NORMAL, 0, WRITE_CACHE, 0, 0, 0);
296 297 298 299 300
  }
  bool open_slow_log(const char *log_name)
  {
    char buf[FN_REFLEN];
    return open(generate_name(log_name, "-slow.log", 0, buf),
301
                LOG_NORMAL, 0, WRITE_CACHE, 0, 0, 0);
302 303 304
  }
  bool open_index_file(const char *index_file_name_arg,
                       const char *log_name);
305
  void new_file(bool need_lock);
306 307
  bool write(THD *thd, enum enum_server_command command,
	     const char *format,...);
308
  bool write(THD *thd, const char *query, uint query_length,
309
	     time_t query_start=0);
310
  bool write(Log_event* event_info); // binary log write
311
  bool write(THD *thd, IO_CACHE *cache, Log_event *commit_event);
312

313 314
  void start_union_events(THD *thd);
  void stop_union_events(THD *thd);
315
  bool is_query_in_union(THD *thd, query_id_t query_id_param);
316

317 318 319 320
  /*
    v stands for vector
    invoked as appendv(buf1,len1,buf2,len2,...,bufn,lenn,0)
  */
321
  bool appendv(const char* buf,uint len,...);
322
  bool append(Log_event* ev);
323

bk@work.mysql.com's avatar
bk@work.mysql.com committed
324 325 326
  int generate_new_name(char *new_name,const char *old_name);
  void make_log_name(char* buf, const char* log_ident);
  bool is_active(const char* log_file_name);
327
  int update_log_index(LOG_INFO* linfo, bool need_update_threads);
328
  void rotate_and_purge(uint flags);
329
  bool flush_and_sync();
330
  int purge_logs(const char *to_log, bool included,
331 332 333
                 bool need_mutex, bool need_update_threads,
                 ulonglong *decrease_log_space);
  int purge_logs_before_date(time_t purge_time);
334
  int purge_first_log(struct st_relay_log_info* rli, bool included);
335
  bool reset_logs(THD* thd);
336
  void close(uint exiting);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
337 338

  // iterating through the log index file
339
  int find_log_pos(LOG_INFO* linfo, const char* log_name,
340 341
		   bool need_mutex);
  int find_next_log(LOG_INFO* linfo, bool need_mutex);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
342
  int get_current_log(LOG_INFO* linfo);
343
  uint next_file_id();
344
  inline bool is_open() { return log_type != LOG_CLOSED; }
345 346
  inline char* get_index_fname() { return index_file_name;}
  inline char* get_log_fname() { return log_file_name; }
347
  inline char* get_name() { return name; }
348 349 350 351 352
  inline pthread_mutex_t* get_log_lock() { return &LOCK_log; }
  inline IO_CACHE* get_log_file() { return &log_file; }

  inline void lock_index() { pthread_mutex_lock(&LOCK_index);}
  inline void unlock_index() { pthread_mutex_unlock(&LOCK_index);}
353
  inline IO_CACHE *get_index_file() { return &index_file;}
354
  inline uint32 get_open_count() { return open_count; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
355 356 357 358 359 360
};


typedef struct st_copy_info {
  ha_rows records;
  ha_rows deleted;
vva@eagle.mysql.r18.ru's avatar
vva@eagle.mysql.r18.ru committed
361
  ha_rows updated;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
362
  ha_rows copied;
363
  ha_rows error_count;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
364
  enum enum_duplicates handle_duplicates;
365
  int escape_char, last_errno;
366 367
  bool ignore;
  /* for INSERT ... UPDATE */
368 369
  List<Item> *update_fields;
  List<Item> *update_values;
monty@mysql.com's avatar
monty@mysql.com committed
370
  /* for VIEW ... WITH CHECK OPTION */
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
371
  TABLE_LIST *view;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
372 373 374 375 376 377 378 379
} COPY_INFO;


class key_part_spec :public Sql_alloc {
public:
  const char *field_name;
  uint length;
  key_part_spec(const char *name,uint len=0) :field_name(name), length(len) {}
380
  bool operator==(const key_part_spec& other) const;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
};


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


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


class Key :public Sql_alloc {
public:
405
  enum Keytype { PRIMARY, UNIQUE, MULTIPLE, FULLTEXT, SPATIAL, FOREIGN_KEY};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
406
  enum Keytype type;
407
  enum ha_key_alg algorithm;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
408
  List<key_part_spec> columns;
409
  const char *name;
410
  bool generated;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
411

412
  Key(enum Keytype type_par, const char *name_arg, enum ha_key_alg alg_par,
413 414 415
      bool generated_arg, List<key_part_spec> &cols)
    :type(type_par), algorithm(alg_par), columns(cols), name(name_arg),
    generated(generated_arg)
416
  {}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
417
  ~Key() {}
418
  /* Equality comparison of keys (ignoring name) */
419
  friend bool foreign_key_prefix(Key *a, Key *b);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
420 421
};

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
class Table_ident;

class foreign_key: public Key {
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;
  List<key_part_spec> ref_columns;
  uint delete_opt, update_opt, match_opt;
  foreign_key(const char *name_arg, List<key_part_spec> &cols,
	      Table_ident *table,   List<key_part_spec> &ref_cols,
	      uint delete_opt_arg, uint update_opt_arg, uint match_opt_arg)
437
    :Key(FOREIGN_KEY, name_arg, HA_KEY_ALG_UNDEF, 0, cols),
438 439 440 441 442
    ref_table(table), ref_columns(cols),
    delete_opt(delete_opt_arg), update_opt(update_opt_arg),
    match_opt(match_opt_arg)
  {}
};
bk@work.mysql.com's avatar
bk@work.mysql.com committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

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

#include "sql_lex.h"				/* Must be here */

462 463
/* Needed to be able to have an I_List of char* strings in mysqld.cc. */

bk@work.mysql.com's avatar
bk@work.mysql.com committed
464 465 466 467 468 469 470 471
class i_string: public ilink
{
public:
  char* ptr;
  i_string():ptr(0) { }
  i_string(char* s) : ptr(s) {}
};

472
/* needed for linked list of two strings for replicate-rewrite-db */
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
473 474 475 476 477 478
class i_string_pair: public ilink
{
public:
  char* key;
  char* val;
  i_string_pair():key(0),val(0) { }
479
  i_string_pair(char* key_arg, char* val_arg) : key(key_arg),val(val_arg) {}
sasha@mysql.sashanet.com's avatar
sasha@mysql.sashanet.com committed
480 481 482
};


bk@work.mysql.com's avatar
bk@work.mysql.com committed
483
class delayed_insert;
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
484
class select_result;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
485

486 487 488 489 490
#define THD_SENTRY_MAGIC 0xfeedd1ff
#define THD_SENTRY_GONE  0xdeadbeef

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

491 492
struct system_variables
{
493 494
  ulonglong myisam_max_extra_sort_file_size;
  ulonglong myisam_max_sort_file_size;
495 496
  ha_rows select_limit;
  ha_rows max_join_size;
497
  ulong auto_increment_increment, auto_increment_offset;
498
  ulong bulk_insert_buff_size;
499 500
  ulong join_buff_size;
  ulong long_query_time;
501
  ulong max_allowed_packet;
502
  ulong max_error_count;
503
  ulong max_heap_table_size;
igor@hundin.mysql.fi's avatar
igor@hundin.mysql.fi committed
504
  ulong max_length_for_sort_data;
505
  ulong max_sort_length;
506
  ulong max_tmp_tables;
507
  ulong max_insert_delayed_threads;
ingo@mysql.com's avatar
ingo@mysql.com committed
508
  ulong multi_range_count;
509
  ulong myisam_repair_threads;
510
  ulong myisam_sort_buff_size;
511
  ulong myisam_stats_method;
512
  ulong net_buffer_length;
513
  ulong net_interactive_timeout;
514
  ulong net_read_timeout;
515
  ulong net_retry_count;
516
  ulong net_wait_timeout;
517
  ulong net_write_timeout;
518 519
  ulong optimizer_prune_level;
  ulong optimizer_search_depth;
igor@rurik.mysql.com's avatar
igor@rurik.mysql.com committed
520
  ulong preload_buff_size;
521 522 523
  ulong query_cache_type;
  ulong read_buff_size;
  ulong read_rnd_buff_size;
524
  ulong div_precincrement;
525
  ulong sortbuff_size;
526
  ulong table_type;
527
  ulong tmp_table_size;
528
  ulong tx_isolation;
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
529
  ulong completion_type;
530
  /* Determines which non-standard SQL behaviour should be enabled */
531
  ulong sql_mode;
532
  ulong max_sp_recursion_depth;
bell@sanja.is.com.ua's avatar
VIEW  
bell@sanja.is.com.ua committed
533
  /* check of key presence in updatable view */
534
  ulong updatable_views_with_limit;
535
  ulong default_week_format;
536
  ulong max_seeks_for_key;
537 538 539 540 541
  ulong range_alloc_block_size;
  ulong query_alloc_block_size;
  ulong query_prealloc_size;
  ulong trans_alloc_block_size;
  ulong trans_prealloc_size;
542
  ulong log_warnings;
543
  ulong group_concat_max_len;
544 545 546 547 548 549
  /*
    In slave thread we need to know in behalf of which
    thread the query is being run to replicate temp tables properly
  */
  ulong pseudo_thread_id;

550 551
  my_bool low_priority_updates;
  my_bool new_mode;
552
  my_bool query_cache_wlock_invalidate;
mskold@mysql.com's avatar
mskold@mysql.com committed
553
  my_bool engine_condition_pushdown;
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
554 555 556 557 558
#ifdef HAVE_REPLICATION
  ulong sync_replication;
  ulong sync_replication_slave_id;
  ulong sync_replication_timeout;
#endif /* HAVE_REPLICATION */
559
#ifdef HAVE_INNOBASE_DB
560
  my_bool innodb_table_locks;
561
  my_bool innodb_support_xa;
562
#endif /* HAVE_INNOBASE_DB */
563 564 565 566 567 568
#ifdef HAVE_NDBCLUSTER_DB
  ulong ndb_autoincrement_prefetch_sz;
  my_bool ndb_force_send;
  my_bool ndb_use_exact_count;
  my_bool ndb_use_transactions;
#endif /* HAVE_NDBCLUSTER_DB */
569
  my_bool old_passwords;
570

571
  /* Only charset part of these variables is sensible */
bar@mysql.com's avatar
bar@mysql.com committed
572
  CHARSET_INFO  *character_set_filesystem;
573
  CHARSET_INFO  *character_set_client;
574
  CHARSET_INFO  *character_set_results;
575

576 577 578
  /* Both charset and collation parts of these variables are important */
  CHARSET_INFO	*collation_server;
  CHARSET_INFO	*collation_database;
579
  CHARSET_INFO  *collation_connection;
580

581 582
  Time_zone *time_zone;

583 584 585 586
  /* DATE, DATETIME and TIME formats */
  DATE_TIME_FORMAT *date_format;
  DATE_TIME_FORMAT *datetime_format;
  DATE_TIME_FORMAT *time_format;
587 588
};

589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

/* per thread status variables */

typedef struct system_status_var
{
  ulong bytes_received;
  ulong bytes_sent;
  ulong com_other;
  ulong com_stat[(uint) SQLCOM_END];
  ulong created_tmp_disk_tables;
  ulong created_tmp_tables;
  ulong ha_commit_count;
  ulong ha_delete_count;
  ulong ha_read_first_count;
  ulong ha_read_last_count;
  ulong ha_read_key_count;
  ulong ha_read_next_count;
  ulong ha_read_prev_count;
  ulong ha_read_rnd_count;
  ulong ha_read_rnd_next_count;
  ulong ha_rollback_count;
  ulong ha_update_count;
  ulong ha_write_count;
612 613 614 615
  ulong ha_prepare_count;
  ulong ha_discover_count;
  ulong ha_savepoint_count;
  ulong ha_savepoint_rollback_count;
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637

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

  ulong net_big_packet_count;
  ulong opened_tables;
  ulong select_full_join_count;
  ulong select_full_range_join_count;
  ulong select_range_count;
  ulong select_range_check_count;
  ulong select_scan_count;
  ulong long_query_count;
  ulong filesort_merge_passes;
  ulong filesort_range_count;
  ulong filesort_rows;
  ulong filesort_scan_count;
638
  /* Prepared statements and binary protocol */
639 640 641 642 643 644
  ulong com_stmt_prepare;
  ulong com_stmt_execute;
  ulong com_stmt_send_long_data;
  ulong com_stmt_fetch;
  ulong com_stmt_reset;
  ulong com_stmt_close;
645 646

  double last_query_cost;
647 648 649 650 651 652 653
} STATUS_VAR;

/*
  This is used for 'show status'. It must be updated to the last ulong
  variable in system_status_var
*/

konstantin@mysql.com's avatar
konstantin@mysql.com committed
654
#define last_system_status_var com_stmt_close
655 656


657
void free_tmp_table(THD *thd, TABLE *entry);
658 659


660 661 662
/* The following macro is to make init of Query_arena simpler */
#ifndef DBUG_OFF
#define INIT_ARENA_DBUG_INFO is_backup_arena= 0
663 664
#else
#define INIT_ARENA_DBUG_INFO
665 666 667
#endif


serg@serg.mylan's avatar
serg@serg.mylan committed
668
class Query_arena
669 670 671 672 673 674 675
{
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;
676
  MEM_ROOT *mem_root;                   // Pointer to current memroot
monty@mysql.com's avatar
monty@mysql.com committed
677
#ifndef DBUG_OFF
678
  bool is_backup_arena; /* True if this arena is used for backup. */
monty@mysql.com's avatar
monty@mysql.com committed
679
#endif
serg@serg.mylan's avatar
serg@serg.mylan committed
680
  enum enum_state
681
  {
682 683
    INITIALIZED= 0, INITIALIZED_FOR_SP= 1, PREPARED= 2,
    CONVENTIONAL_EXECUTION= 3, EXECUTED= 4, ERROR= -1
684
  };
serg@serg.mylan's avatar
serg@serg.mylan committed
685

686
  enum_state state;
687 688 689 690 691 692 693

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

694 695
  Query_arena(MEM_ROOT *mem_root_arg, enum enum_state state_arg) :
    free_list(0), mem_root(mem_root_arg), state(state_arg)
696
  { INIT_ARENA_DBUG_INFO; }
697
  /*
serg@serg.mylan's avatar
serg@serg.mylan committed
698 699
    This constructor is used only when Query_arena is created as
    backup storage for another instance of Query_arena.
700
  */
701 702
  Query_arena() { INIT_ARENA_DBUG_INFO; }

703
  virtual Type type() const;
serg@serg.mylan's avatar
serg@serg.mylan committed
704
  virtual ~Query_arena() {};
705

706
  inline bool is_stmt_prepare() const { return state == INITIALIZED; }
707 708
  inline bool is_first_sp_execute() const
  { return state == INITIALIZED_FOR_SP; }
709 710
  inline bool is_stmt_prepare_or_first_sp_execute() const
  { return (int)state < (int)PREPARED; }
711
  inline bool is_first_stmt_execute() const { return state == PREPARED; }
712 713
  inline bool is_stmt_execute() const
  { return state == PREPARED || state == EXECUTED; }
monty@mysql.com's avatar
monty@mysql.com committed
714
  inline bool is_conventional() const
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
715
  { return state == CONVENTIONAL_EXECUTION; }
716

717
  inline gptr alloc(unsigned int size) { return alloc_root(mem_root,size); }
718 719 720
  inline gptr calloc(unsigned int size)
  {
    gptr ptr;
721
    if ((ptr=alloc_root(mem_root,size)))
722 723 724 725
      bzero((char*) ptr,size);
    return ptr;
  }
  inline char *strdup(const char *str)
726
  { return strdup_root(mem_root,str); }
727
  inline char *strmake(const char *str, uint size)
728
  { return strmake_root(mem_root,str,size); }
729
  inline char *memdup(const char *str, uint size)
730
  { return memdup_root(mem_root,str,size); }
731 732 733
  inline char *memdup_w_gap(const char *str, uint size, uint gap)
  {
    gptr ptr;
734
    if ((ptr=alloc_root(mem_root,size+gap)))
735 736 737 738
      memcpy(ptr,str,size);
    return ptr;
  }

konstantin@mysql.com's avatar
konstantin@mysql.com committed
739
  void set_query_arena(Query_arena *set);
740 741

  void free_items();
742 743
  /* Close the active state associated with execution of this statement */
  virtual void cleanup_stmt();
744 745
};

746

747
class Server_side_cursor;
748

749 750 751 752 753 754 755 756 757 758 759 760 761 762
/*
  State of a single command executed against this connection.
  One connection can contain a lot of simultaneously running statements,
  some of which could be:
   - prepared, that is, contain placeholders,
   - opened as cursors. We maintain 1 to 1 relationship between
     statement and cursor - if user wants to create another cursor for his
     query, we create another statement for it. 
  To perform some action with statement we reset THD part to the state  of
  that statement, do the action, and then save back modified state from THD
  to the statement. It will be changed in near future, and Statement will
  be used explicitly.
*/

763
class Statement: public ilink, public Query_arena
764
{
765 766
  Statement(const Statement &rhs);              /* not implemented: */
  Statement &operator=(const Statement &rhs);   /* non-copyable */
767
public:
768 769
  /* FIXME: these must be protected */
  MEM_ROOT main_mem_root;
770
  LEX     main_lex;
771

772
  /*
konstantin@oak.local's avatar
konstantin@oak.local committed
773
    Uniquely identifies each statement object in thread scope; change during
774
    statement lifetime. FIXME: must be const
775
  */
konstantin@oak.local's avatar
konstantin@oak.local committed
776
   ulong id;
777 778

  /*
779
    - if set_query_id=1, we set field->query_id for all fields. In that case 
780 781 782 783
    field list can not contain duplicates.
  */
  bool set_query_id;

784
  LEX_STRING name; /* name for named prepared statements */
785 786 787 788 789
  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.
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806

    Note that (A) if we set query = NULL, we must at the same time set
    query_length = 0, and protect the whole operation with the
    LOCK_thread_count mutex. And (B) we are ONLY allowed to set query to a
    non-NULL value if its previous value is NULL. We do not need to protect
    operation (B) with any mutex. To avoid crashes in races, if we do not
    know that thd->query cannot change at the moment, one should print
    thd->query like this:
      (1) reserve the LOCK_thread_count mutex;
      (2) check if thd->query is NULL;
      (3) if not NULL, then print at most thd->query_length characters from
      it. We will see the query_length field as either 0, or the right value
      for it.
    Assuming that the write and read of an n-bit memory field in an n-bit
    computer is atomic, we can avoid races in the above way. 
    This printing is needed at least in SHOW PROCESSLIST and SHOW INNODB
    STATUS.
807 808 809
  */
  char *query;
  uint32 query_length;                          // current query length
810
  Server_side_cursor *cursor;
811

812 813
public:

814 815
  /* This constructor is called for backup statements */
  Statement() { clear_alloc_root(&main_mem_root); }
816

817 818
  Statement(enum enum_state state_arg, ulong id_arg,
            ulong alloc_block_size, ulong prealloc_size);
819
  virtual ~Statement();
820 821 822

  /* Assign execution context (note: not all members) of given stmt to self */
  void set_statement(Statement *stmt);
823 824
  void set_n_backup_statement(Statement *stmt, Statement *backup);
  void restore_backup_statement(Statement *stmt, Statement *backup);
825 826
  /* return class type */
  virtual Type type() const;
827 828 829 830
};


/*
831 832 833 834 835
  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
836

837 838
  Statements are auto-deleted when they are removed from the map and when the
  map is deleted.
839 840 841 842 843 844
*/

class Statement_map
{
public:
  Statement_map();
845

846 847 848
  int insert(Statement *statement);

  Statement *find_by_name(LEX_STRING *name)
849
  {
850 851 852 853
    Statement *stmt;
    stmt= (Statement*)hash_search(&names_hash, (byte*)name->str,
                                  name->length);
    return stmt;
854
  }
855 856

  Statement *find(ulong id)
857
  {
858
    if (last_found_statement == 0 || id != last_found_statement->id)
859 860 861
    {
      Statement *stmt;
      stmt= (Statement *) hash_search(&st_hash, (byte *) &id, sizeof(id));
862
      if (stmt && stmt->name.str)
863 864 865
        return NULL;
      last_found_statement= stmt;
    }
866
    return last_found_statement;
867 868 869
  }
  void erase(Statement *statement)
  {
870 871
    if (statement == last_found_statement)
      last_found_statement= 0;
872 873 874 875
    if (statement->name.str)
    {
      hash_delete(&names_hash, (byte *) statement);  
    }
876 877
    hash_delete(&st_hash, (byte *) statement);
  }
878 879 880 881 882 883
  /*
    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();
884 885 886
  /* Erase all statements (calls Statement destructor) */
  void reset()
  {
887 888
    my_hash_reset(&names_hash);
    my_hash_reset(&st_hash);
889
    transient_cursor_list.empty();
890 891
    last_found_statement= 0;
  }
892

893
  void destroy()
894
  {
895
    hash_free(&names_hash);
896
    hash_free(&st_hash);
897
  }
898 899
private:
  HASH st_hash;
900
  HASH names_hash;
901
  I_List<Statement> transient_cursor_list;
902
  Statement *last_found_statement;
903 904
};

905 906 907 908 909 910 911
struct st_savepoint {
  struct st_savepoint *prev;
  char                *name;
  uint                 length, nht;
};

enum xa_states {XA_NOTR=0, XA_ACTIVE, XA_IDLE, XA_PREPARED};
912
extern const char *xa_state_names[];
913

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
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;
} XID_STATE;

extern pthread_mutex_t LOCK_xid_cache;
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);

930

931 932
class Security_context {
public:
933 934 935 936
  /*
    host - host of the client
    user - user of the client, set to NULL until the user has been read from
    the connection
937
    priv_user - The user privilege we are using. May be "" for anonymous user.
938 939 940
    ip - client IP
  */
  char   *host, *user, *priv_user, *ip;
941
  /* The host privilege we are using */
942 943 944 945 946 947 948 949 950
  char   priv_host[MAX_HOSTNAME];
  /* points to host if host is available, otherwise points to ip */
  const char *host_or_ip;
  ulong master_access;                 /* Global privileges from mysql.user */
  ulong db_access;                     /* Privileges for current db */

  void init();
  void destroy();
  void skip_grants();
951
  inline char *priv_host_name()
952 953 954 955 956 957
  {
    return (*priv_host ? priv_host : (char *)"%");
  }
};


958 959 960 961 962 963 964 965 966 967 968
/*
  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;


969 970 971 972 973 974 975 976 977
/*
  Type of prelocked mode.
  See comment for THD::prelocked_mode for complete description.
*/

enum prelocked_mode_type {NON_PRELOCKED= 0, PRELOCKED= 1,
                          PRELOCKED_UNDER_LOCK_TABLES= 2};


978
/*
979
  Class that holds information about tables which were opened and locked
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
  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:
  /*
    open_tables - list of regular tables in use by this thread
    temporary_tables - list of temp tables in use by this thread
    handler_tables - list of tables that were opened with HANDLER OPEN
     and are still in use by this thread
  */
  TABLE *open_tables, *temporary_tables, *handler_tables, *derived_tables;
  /*
    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.
    Trying to use any other tables will give an error. The locked tables are
    stored in 'locked_tables' member.  Manual locking is described in
    the 'LOCK_TABLES' chapter of the MySQL manual.
    See also lock_tables() for details.
  */
  MYSQL_LOCK *lock;
  /*
    Tables that were locked with explicit or implicit LOCK TABLES.
    (Implicit LOCK TABLES happens when we are prelocking tables for
     execution of statement which uses stored routines. See description
     THD::prelocked_mode for more info.)
  */
  MYSQL_LOCK *locked_tables;
  /*
    prelocked_mode_type enum and prelocked_mode member are used for
    indicating whenever "prelocked mode" is on, and what type of
    "prelocked mode" is it.

    Prelocked mode is used for execution of queries which explicitly
    or implicitly (via views or triggers) use functions, thus may need
    some additional tables (mentioned in query table list) for their
    execution.

    First open_tables() call for such query will analyse all functions
    used by it and add all additional tables to table its list. It will
    also mark this query as requiring prelocking. After that lock_tables()
    will issue implicit LOCK TABLES for the whole table list and change
    thd::prelocked_mode to non-0. All queries called in functions invoked
    by the main query will use prelocked tables. Non-0 prelocked_mode
    will also surpress mentioned analysys in those queries thus saving
    cycles. Prelocked mode will be turned off once close_thread_tables()
    for the main query will be called.

    Note: Since not all "tables" present in table list are really locked
    thd::prelocked_mode does not imply thd::locked_tables.
  */
  prelocked_mode_type prelocked_mode;
  ulong	version;
  uint current_tablenr;

1042 1043 1044 1045 1046 1047 1048
  /*
    This constructor serves for creation of Open_tables_state instances
    which are used as backup storage.
  */
  Open_tables_state() {};

  Open_tables_state(ulong version_arg);
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063

  void set_open_tables_state(Open_tables_state *state)
  {
    *this= *state;
  }

  void reset_open_tables_state()
  {
    open_tables= temporary_tables= handler_tables= derived_tables= 0;
    lock= locked_tables= 0;
    prelocked_mode= NON_PRELOCKED;
  }
};


1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
/* class to save context when executing a function or trigger */

/* Defines used for Sub_statement_state::in_sub_stmt */

#define SUB_STMT_TRIGGER 1
#define SUB_STMT_FUNCTION 2

class Sub_statement_state
{
public:
  ulonglong options;
  ulonglong last_insert_id, next_insert_id;
  ulonglong limit_found_rows;
  ha_rows    cuted_fields, sent_row_count, examined_row_count;
  ulong client_capabilities;
  uint in_sub_stmt;
1080
  bool enable_slow_log, insert_id_used, clear_next_insert_id;
1081
  my_bool no_send_ok;
1082
  SAVEPOINT *savepoints;
1083 1084 1085
};


1086 1087 1088 1089
/*
  For each client connection we create a separate thread with THD serving as
  a thread/connection descriptor
*/
1090

1091
class THD :public Statement,
1092
           public Open_tables_state
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1093
{
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1094
public:
1095 1096 1097 1098 1099 1100 1101 1102
  /*
    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;

1103 1104
#ifdef EMBEDDED_LIBRARY
  struct st_mysql  *mysql;
hf@deer.(none)'s avatar
SCRUM  
hf@deer.(none) committed
1105 1106 1107
  struct st_mysql_data *data;
  unsigned long	 client_stmt_id;
  unsigned long  client_param_count;
hf@deer.(none)'s avatar
hf@deer.(none) committed
1108
  struct st_mysql_bind *client_params;
hf@deer.(none)'s avatar
hf@deer.(none) committed
1109 1110
  char *extra_data;
  ulong extra_length;
hf@deer.(none)'s avatar
hf@deer.(none) committed
1111
  String query_rest;
1112
#endif
1113
  NET	  net;				// client connection descriptor
1114
  MEM_ROOT warn_root;			// For warnings and errors
1115 1116 1117
  Protocol *protocol;			// Current protocol
  Protocol_simple protocol_simple;	// Normal protocol
  Protocol_prep protocol_prep;		// Binary protocol
1118 1119
  HASH    user_vars;			// hash for user variables
  String  packet;			// dynamic buffer for network I/O
1120
  String  convert_buffer;               // buffer for charset conversions
1121 1122 1123
  struct  sockaddr_in remote;		// client socket address
  struct  rand_struct rand;		// used for authentication
  struct  system_variables variables;	// Changeable local variables
1124
  struct  system_status_var status_var; // Per thread statistic vars
1125 1126 1127 1128
  THR_LOCK_INFO lock_info;              // Locking info of this thread
  THR_LOCK_OWNER main_lock_id;          // To use for conventional queries
  THR_LOCK_OWNER *lock_id;              // If not main_lock_id, points to
                                        // the lock_id of a cursor.
1129
  pthread_mutex_t LOCK_delete;		// Locked before thd is deleted
1130
  /* all prepared statements and cursors of this connection */
1131
  Statement_map stmt_map;
1132 1133 1134 1135 1136 1137
  /*
    A pointer to the stack frame of handle_one_connection(),
    which is called first in the thread for handling a client
  */
  char	  *thread_stack;

1138 1139
  /*
    db - currently selected database
1140
    catalog - currently selected catalog
1141 1142 1143 1144 1145
    WARNING: some members of THD (currently 'db', '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
1146 1147
    properly. For details see the 'err:' label of the handle_slave_sql()
    in sql/slave.cc.
1148
   */
1149
  char   *db, *catalog;
1150 1151
  Security_context main_security_ctx;
  Security_context *security_ctx;
1152

1153 1154
  /* remote (peer) port */
  uint16 peer_port;
1155 1156 1157 1158 1159
  /*
    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.
  */
1160
  const char *proc_info;
1161

1162
  ulong client_capabilities;		/* What the client supports */
1163
  ulong max_client_packet_length;
1164

1165
  HASH		handler_tables_hash;
1166 1167 1168 1169 1170
  /*
    One thread can hold up to one named user-level lock. This variable
    points to a lock object if the lock is present. See item_func.cc and
    chapter 'Miscellaneous functions', for functions GET_LOCK, RELEASE_LOCK. 
  */
1171
  User_level_lock *ull;
1172 1173
#ifndef DBUG_OFF
  uint dbug_sentry; // watch out for memory corruption
1174
#endif
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1175
  struct st_my_thread_var *mysys_var;
1176
  /*
1177
    Type of current query: COM_STMT_PREPARE, COM_QUERY, etc. Set from
1178 1179 1180
    first byte of the packet in do_command()
  */
  enum enum_server_command command;
1181
  uint32     server_id;
1182
  uint32     file_id;			// for LOAD DATA INFILE
1183 1184 1185 1186 1187
  /*
    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.
  */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1188
  const char *where;
1189 1190
  time_t     start_time,time_after_lock,user_time;
  time_t     connect_time,thr_create_time; // track down slow pthread_create
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1191 1192
  thr_lock_type update_lock_default;
  delayed_insert *di;
1193

1194 1195
  /* <> 0 if we are inside of trigger or stored function. */
  uint in_sub_stmt;
1196

1197 1198
  /* container for handler's private per-connection data */
  void *ha_data[MAX_HA];
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1199
  struct st_transactions {
1200
    SAVEPOINT *savepoints;
1201 1202
    THD_TRANS all;			// Trans since BEGIN WORK
    THD_TRANS stmt;			// Trans for current statement
1203
    bool on;                            // see ha_enable_transaction()
1204
    XID_STATE xid_state;
1205
    /*
1206
       Tables changed in transaction (that must be invalidated in query cache).
1207
       List contain only transactional tables, that not invalidated in query
1208 1209 1210 1211 1212 1213
       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()
    {
1214 1215
      changed_tables= 0;
      savepoints= 0;
1216
#ifdef USING_TRANSACTIONS
1217
      free_root(&mem_root,MYF(MY_KEEP_PREALLOC));
1218
#endif
1219
    }
1220 1221
    st_transactions()
    {
1222
#ifdef USING_TRANSACTIONS
1223
      bzero((char*)this, sizeof(*this));
1224
      xid_state.xid.null();
1225
      init_sql_alloc(&mem_root, ALLOC_ROOT_MIN_BLOCK_SIZE, 0);
1226 1227
#else
      xid_state.xa_state= XA_NOTR;
1228
#endif
1229
    }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1230 1231 1232 1233 1234
  } transaction;
  Field      *dupp_field;
#ifndef __WIN__
  sigset_t signals,block_signals;
#endif
1235 1236
#ifdef SIGNAL_WITH_VIO_CLOSE
  Vio* active_vio;
1237
#endif
1238 1239 1240 1241
  /*
    This is to track items changed during execution of a prepared
    statement/stored procedure. It's created by
    register_item_tree_change() in memory root of THD, and freed in
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1242 1243
    rollback_item_tree_changes(). For conventional execution it's always
    empty.
1244 1245 1246
  */
  Item_change_list change_list;

1247
  /*
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1248 1249
    A permanent memory area of the statement. For conventional
    execution, the parsed tree and execution runtime reside in the same
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1250
    memory root. In this case stmt_arena points to THD. In case of
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1251
    a prepared statement or a stored procedure statement, thd->mem_root
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1252
    conventionally points to runtime memory, and thd->stmt_arena
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1253 1254 1255
    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
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1256 1257
    stmt_arena, to allow correct re-execution of PS/SP.
    Note: in the parser, stmt_arena == thd, even for PS/SP.
1258
  */
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1259
  Query_arena *stmt_arena;
1260 1261 1262 1263 1264
  /*
    next_insert_id is set on SET INSERT_ID= #. This is used as the next
    generated auto_increment value in handler.cc
  */
  ulonglong  next_insert_id;
1265 1266
  /* Remember last next_insert_id to reset it if something went wrong */
  ulonglong  prev_insert_id;
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
  /*
    The insert_id used for the last statement or set by SET LAST_INSERT_ID=#
    or SELECT LAST_INSERT_ID(#).  Used for binary log and returned by
    LAST_INSERT_ID()
  */
  ulonglong  last_insert_id;
  /*
    Set to the first value that LAST_INSERT_ID() returned for the last
    statement.  When this is set, last_insert_id_used is set to true.
  */
  ulonglong  current_insert_id;
  ulonglong  limit_found_rows;
1279 1280
  ulonglong  options;           /* Bitmap of states */
  longlong   row_count_func;	/* For the ROW_COUNT() function */
1281
  ha_rows    cuted_fields,
1282
             sent_row_count, examined_row_count;
1283 1284 1285 1286 1287 1288
  /*
    The set of those tables whose fields are referenced in all subqueries
    of the query.
    TODO: possibly this it is incorrect to have used tables in THD because
    with more than one subquery, it is not clear what does the field mean.
  */
1289
  table_map  used_tables;
1290
  USER_CONN *user_connect;
1291
  CHARSET_INFO *db_charset;
konstantin@oak.local's avatar
konstantin@oak.local committed
1292 1293 1294
  /*
    FIXME: this, and some other variables like 'count_cuted_fields'
    maybe should be statement/cursor local, that is, moved to Statement
1295 1296
    class. With current implementation warnings produced in each prepared
    statement/cursor settle here.
konstantin@oak.local's avatar
konstantin@oak.local committed
1297
  */
1298
  List	     <MYSQL_ERROR> warn_list;
1299
  uint	     warn_count[(uint) MYSQL_ERROR::WARN_LEVEL_END];
1300
  uint	     total_warn_count;
1301 1302 1303 1304 1305 1306 1307 1308
  /*
    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).
  */
1309
  query_id_t query_id, warn_id;
1310
  ulong      thread_id, col_access;
1311 1312 1313

  /* Statement id is thread-wide. This counter is used to generate ids */
  ulong      statement_id_counter;
1314
  ulong	     rand_saved_seed1, rand_saved_seed2;
1315
  ulong      row_count;  // Row counter, mainly for errors and warnings
1316
  long	     dbug_thread_id;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1317
  pthread_t  real_id;
1318
  uint	     tmp_table, global_read_lock;
1319
  uint	     server_status,open_options,system_thread;
1320
  uint32     db_length;
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
1321
  uint       select_number;             //number of select (used for EXPLAIN)
1322 1323
  /* variables.transaction_isolation is reset to this after each commit */
  enum_tx_isolation session_tx_isolation;
1324
  enum_check_fields count_cuted_fields;
1325 1326 1327

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

1329
  enum killed_state { NOT_KILLED=0, KILL_BAD_DATA=1, KILL_CONNECTION=ER_SERVER_SHUTDOWN, KILL_QUERY=ER_QUERY_INTERRUPTED };
1330 1331
  killed_state volatile killed;

1332
  /* scramble - random string sent to client on handshake */
1333
  char	     scramble[SCRAMBLE_LENGTH+1];
1334

1335
  bool       slave_thread, one_shot_set;
1336
  bool	     locked, some_tables_deleted;
1337
  bool       last_cuted_field;
1338
  bool	     no_errors, password, is_fatal_error;
1339 1340
  bool	     query_start_used, rand_used, time_zone_used;
  bool	     last_insert_id_used,insert_id_used, clear_next_insert_id;
1341
  bool	     in_lock_tables;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1342
  bool       query_error, bootstrap, cleanup_done;
1343
  bool	     tmp_table_used;
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1344
  bool	     charset_is_system_charset, charset_is_collation_connection;
bar@mysql.com's avatar
bar@mysql.com committed
1345
  bool       charset_is_character_set_filesystem;
1346
  bool       enable_slow_log;   /* enable slow log for current statement */
1347
  bool	     no_trans_update, abort_on_warning;
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1348
  bool 	     got_warning;       /* Set on call to push_warning() */
1349
  bool	     no_warnings_for_error; /* no warnings on call to my_error() */
1350 1351
  /* set during loop of derived table processing */
  bool       derived_tables_processing;
1352 1353
  my_bool    tablespace_op;	/* This is TRUE in DISCARD/IMPORT TABLESPACE */

1354
  sp_rcontext *spcont;		// SP runtime context
1355 1356
  sp_cache   *sp_proc_cache;
  sp_cache   *sp_func_cache;
1357

1358 1359 1360 1361 1362
  /*
    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
  */
1363
  LOG_INFO*  current_linfo;
1364
  NET*       slave_net;			// network connection from slave -> m.
1365 1366 1367 1368 1369 1370
  /* Used by the sys_var class to store temporary values */
  union
  {
    my_bool my_bool_value;
    long    long_value;
  } sys_var_tmp;
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
  
  struct {
    /* 
      If true, mysql_bin_log::write(Log_event) call will not write events to 
      binlog, and maintain 2 below variables instead (use
      mysql_bin_log.start_union_events to turn this on)
    */
    bool do_union;
    /*
      If TRUE, at least one mysql_bin_log::write(Log_event) call has been
      made after last mysql_bin_log.start_union_events() call.
    */
    bool unioned_events;
    /*
      If TRUE, at least one mysql_bin_log::write(Log_event e), where 
      e.cache_stmt == TRUE call has been made after last 
      mysql_bin_log.start_union_events() call.
    */
    bool unioned_events_trans;
1390 1391 1392 1393 1394 1395
    
    /* 
      'queries' (actually SP statements) that run under inside this binlog
      union have thd->query_id >= first_query_id.
    */
    query_id_t first_query_id;
1396 1397
  } binlog_evt_union;
  
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1398 1399
  THD();
  ~THD();
1400

1401
  void init(void);
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
  /*
    Initialize memory roots necessary for query processing and (!)
    pre-allocate memory for it. We can't do that in THD constructor because
    there are use cases (acl_init, delayed inserts, watcher threads,
    killing mysqld) where it's vital to not allocate excessive and not used
    memory. Note, that we still don't return error from init_for_queries():
    if preallocation fails, we should notice that at the first call to
    alloc_root. 
  */
  void init_for_queries();
1412
  void change_user(void);
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1413
  void cleanup(void);
1414
  void cleanup_after_query();
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1415
  bool store_globals();
1416 1417
#ifdef SIGNAL_WITH_VIO_CLOSE
  inline void set_active_vio(Vio* vio)
1418
  {
1419
    pthread_mutex_lock(&LOCK_delete);
1420
    active_vio = vio;
1421
    pthread_mutex_unlock(&LOCK_delete);
1422
  }
1423
  inline void clear_active_vio()
1424
  {
1425
    pthread_mutex_lock(&LOCK_delete);
1426
    active_vio = 0;
1427
    pthread_mutex_unlock(&LOCK_delete);
1428
  }
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1429
  void close_active_vio();
1430
#endif
hf@genie.(none)'s avatar
SCRUM  
hf@genie.(none) committed
1431
  void awake(THD::killed_state state_to_set);
1432 1433
  /*
    For enter_cond() / exit_cond() to work the mutex must be got before
1434 1435
    enter_cond(); this mutex is then released by exit_cond().
    Usage must be: lock mutex; enter_cond(); your code; exit_cond().
1436
  */
1437 1438 1439 1440
  inline const char* enter_cond(pthread_cond_t *cond, pthread_mutex_t* mutex,
			  const char* msg)
  {
    const char* old_msg = proc_info;
1441
    safe_mutex_assert_owner(mutex);
1442 1443 1444 1445 1446 1447 1448
    mysys_var->current_mutex = mutex;
    mysys_var->current_cond = cond;
    proc_info = msg;
    return old_msg;
  }
  inline void exit_cond(const char* old_msg)
  {
guilhem@mysql.com's avatar
guilhem@mysql.com committed
1449 1450 1451 1452 1453 1454 1455
    /*
      Putting the mutex unlock in 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).
    */
    pthread_mutex_unlock(mysys_var->current_mutex);
1456 1457 1458 1459 1460 1461
    pthread_mutex_lock(&mysys_var->mutex);
    mysys_var->current_mutex = 0;
    mysys_var->current_cond = 0;
    proc_info = old_msg;
    pthread_mutex_unlock(&mysys_var->mutex);
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1462
  inline time_t query_start() { query_start_used=1; return start_time; }
monty@donna.mysql.com's avatar
monty@donna.mysql.com committed
1463
  inline void	set_time()    { if (user_time) start_time=time_after_lock=user_time; else time_after_lock=time(&start_time); }
1464
  inline void	end_time()    { time(&start_time); }
monty@donna.mysql.com's avatar
monty@donna.mysql.com committed
1465
  inline void	set_time(time_t t) { time_after_lock=start_time=user_time=t; }
1466
  inline void	lock_time()   { time(&time_after_lock); }
1467 1468 1469 1470 1471
  inline void	insert_id(ulonglong id_arg)
  {
    last_insert_id= id_arg;
    insert_id_used=1;
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1472 1473 1474
  inline ulonglong insert_id(void)
  {
    if (!last_insert_id_used)
1475
    {
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1476 1477 1478 1479 1480
      last_insert_id_used=1;
      current_insert_id=last_insert_id;
    }
    return last_insert_id;
  }
1481 1482 1483
  inline ulonglong found_rows(void)
  {
    return limit_found_rows;
1484
  }
1485 1486
  inline bool active_transaction()
  {
1487 1488
#ifdef USING_TRANSACTIONS
    return server_status & SERVER_STATUS_IN_TRANS;
1489 1490 1491
#else
    return 0;
#endif
1492
  }
1493 1494
  inline bool fill_derived_tables()
  {
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1495
    return !stmt_arena->is_stmt_prepare() && !lex->only_view_structure();
1496 1497 1498
  }
  inline gptr trans_alloc(unsigned int size)
  {
1499 1500
    return alloc_root(&transaction.mem_root,size);
  }
1501 1502 1503 1504

  bool convert_string(LEX_STRING *to, CHARSET_INFO *to_cs,
		      const char *from, uint from_length,
		      CHARSET_INFO *from_cs);
1505 1506 1507

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

1508
  void add_changed_table(TABLE *table);
1509 1510
  void add_changed_table(const char *key, long key_length);
  CHANGED_TABLE_LIST * changed_table_dup(const char *key, long key_length);
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
1511
  int send_explain_fields(select_result *result);
1512
#ifndef EMBEDDED_LIBRARY
1513 1514 1515 1516 1517
  inline void clear_error()
  {
    net.last_error[0]= 0;
    net.last_errno= 0;
    net.report_error= 0;
1518
    query_error= 0;
1519
  }
1520
  inline bool vio_ok() const { return net.vio != 0; }
1521 1522
#else
  void clear_error();
1523
  inline bool vio_ok() const { return true; }
1524
#endif
1525 1526 1527
  inline void fatal_error()
  {
    is_fatal_error= 1;
serg@serg.mylan's avatar
serg@serg.mylan committed
1528
    net.report_error= 1;
1529
    DBUG_PRINT("error",("Fatal error set"));
1530
  }
1531
  inline CHARSET_INFO *charset() { return variables.character_set_client; }
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
1532
  void update_charset();
1533

konstantin@mysql.com's avatar
konstantin@mysql.com committed
1534
  inline Query_arena *activate_stmt_arena_if_needed(Query_arena *backup)
1535 1536
  {
    /*
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1537 1538
      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.
1539
    */
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1540
    if (!stmt_arena->is_conventional() && mem_root != stmt_arena->mem_root)
1541
    {
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1542 1543
      set_n_backup_active_arena(stmt_arena, backup);
      return stmt_arena;
1544 1545 1546 1547
    }
    return 0;
  }

1548
  void change_item_tree(Item **place, Item *new_value)
1549
  {
1550
    /* TODO: check for OOM condition here */
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1551
    if (!stmt_arena->is_conventional())
1552
      nocheck_register_item_tree_change(place, *place, mem_root);
1553
    *place= new_value;
1554 1555
  }
  void nocheck_register_item_tree_change(Item **place, Item *old_value,
1556
                                         MEM_ROOT *runtime_memroot);
1557
  void rollback_item_tree_changes();
1558 1559 1560 1561 1562 1563

  /*
    Cleanup statement parse state (parse tree, lex) and execution
    state after execution of a non-prepared SQL statement.
  */
  void end_statement();
1564 1565
  inline int killed_errno() const
  {
1566
    return killed != KILL_BAD_DATA ? killed : 0;
1567 1568 1569
  }
  inline void send_kill_message() const
  {
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
1570
    int err= killed_errno();
1571 1572
    if (err)
      my_message(err, ER(err), MYF(0));
1573
  }
1574 1575 1576 1577 1578 1579 1580
  /* return TRUE if we will abort query if we make a warning now */
  inline bool really_abort_on_warning()
  {
    return (abort_on_warning &&
            (!no_trans_update ||
             (variables.sql_mode & MODE_STRICT_ALL_TABLES)));
  }
1581
  void set_status_var_init();
1582
  bool is_context_analysis_only()
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1583
    { return stmt_arena->is_stmt_prepare() || lex->view_prepare_mode; }
1584 1585
  void reset_n_backup_open_tables_state(Open_tables_state *backup);
  void restore_backup_open_tables_state(Open_tables_state *backup);
1586 1587
  void reset_sub_statement_state(Sub_statement_state *backup, uint new_state);
  void restore_sub_statement_state(Sub_statement_state *backup);
konstantin@mysql.com's avatar
konstantin@mysql.com committed
1588 1589
  void set_n_backup_active_arena(Query_arena *set, Query_arena *backup);
  void restore_active_arena(Query_arena *set, Query_arena *backup);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1590 1591
};

1592

1593
#define tmp_disable_binlog(A)       \
1594
  {ulonglong tmp_disable_binlog__save_options= (A)->options; \
1595
  (A)->options&= ~OPTION_BIN_LOG
1596

1597
#define reenable_binlog(A)   (A)->options= tmp_disable_binlog__save_options;}
1598

1599 1600 1601 1602 1603
/* Flags for the THD::system_thread (bitmap) variable */
#define SYSTEM_THREAD_DELAYED_INSERT 1
#define SYSTEM_THREAD_SLAVE_IO 2
#define SYSTEM_THREAD_SLAVE_SQL 4

bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
1604 1605 1606
/*
  Used to hold information about file and file structure in exchainge 
  via non-DB file (...INTO OUTFILE..., ...LOAD DATA...)
1607
  XXX: We never call destructor for objects of this class.
bell@sanja.is.com.ua's avatar
bell@sanja.is.com.ua committed
1608
*/
1609

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1610 1611 1612 1613 1614 1615 1616
class sql_exchange :public Sql_alloc
{
public:
  char *file_name;
  String *field_term,*enclosed,*line_term,*line_start,*escaped;
  bool opt_enclosed;
  bool dumpfile;
1617
  ulong skip_lines;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1618 1619 1620 1621 1622 1623
  sql_exchange(char *name,bool dumpfile_flag);
};

#include "log_event.h"

/*
1624
  This is used to get result from a select
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1625 1626
*/

1627 1628
class JOIN;

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1629 1630 1631
class select_result :public Sql_alloc {
protected:
  THD *thd;
1632
  SELECT_LEX_UNIT *unit;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1633 1634 1635
public:
  select_result();
  virtual ~select_result() {};
1636 1637 1638 1639 1640
  virtual int prepare(List<Item> &list, SELECT_LEX_UNIT *u)
  {
    unit= u;
    return 0;
  }
1641
  virtual int prepare2(void) { return 0; }
1642 1643 1644 1645 1646 1647 1648
  /*
    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; }
1649
  virtual bool send_fields(List<Item> &list, uint flags)=0;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1650
  virtual bool send_data(List<Item> &items)=0;
1651
  virtual bool initialize_tables (JOIN *join=0) { return 0; }
1652
  virtual void send_error(uint errcode,const char *err);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1653
  virtual bool send_eof()=0;
monty@mysql.com's avatar
monty@mysql.com committed
1654
  virtual bool simple_select() { return 0; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1655
  virtual void abort() {}
1656 1657 1658 1659 1660
  /*
    Cleanup instance of this class for next execution of a prepared
    statement/stored procedure.
  */
  virtual void cleanup();
1661
  void set_thd(THD *thd_arg) { thd= thd_arg; }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1662 1663 1664
};


1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
/*
  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:
  uint field_count(List<Item> &fields) const { return 0; }
  bool send_fields(List<Item> &fields, uint flag) { return FALSE; }
};


bk@work.mysql.com's avatar
bk@work.mysql.com committed
1679
class select_send :public select_result {
1680
  int status;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1681
public:
1682
  select_send() :status(0) {}
1683
  bool send_fields(List<Item> &list, uint flags);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1684 1685
  bool send_data(List<Item> &items);
  bool send_eof();
monty@mysql.com's avatar
monty@mysql.com committed
1686
  bool simple_select() { return 1; }
1687
  void abort();
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1688 1689 1690
};


1691
class select_to_file :public select_result_interceptor {
1692
protected:
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1693 1694 1695 1696
  sql_exchange *exchange;
  File file;
  IO_CACHE cache;
  ha_rows row_count;
1697 1698 1699 1700 1701 1702 1703
  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);
1704 1705
  bool send_eof();
  void cleanup();
1706 1707 1708 1709
};


class select_export :public select_to_file {
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1710 1711 1712 1713
  uint field_term_length;
  int field_sep_char,escape_char,line_sep_char;
  bool fixed_row_size;
public:
1714
  select_export(sql_exchange *ex) :select_to_file(ex) {}
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1715
  ~select_export();
1716
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1717 1718 1719
  bool send_data(List<Item> &items);
};

monty@tik.mysql.fi's avatar
monty@tik.mysql.fi committed
1720

1721
class select_dump :public select_to_file {
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1722
public:
1723
  select_dump(sql_exchange *ex) :select_to_file(ex) {}
1724
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1725 1726
  bool send_data(List<Item> &items);
};
monty@tik.mysql.fi's avatar
monty@tik.mysql.fi committed
1727 1728


1729
class select_insert :public select_result_interceptor {
1730
 public:
bell@sanja.is.com.ua's avatar
VIEW  
bell@sanja.is.com.ua committed
1731
  TABLE_LIST *table_list;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1732 1733 1734 1735
  TABLE *table;
  List<Item> *fields;
  ulonglong last_insert_id;
  COPY_INFO info;
bell@sanja.is.com.ua's avatar
VIEW  
bell@sanja.is.com.ua committed
1736
  bool insert_into_view;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1737

monty@mishka.local's avatar
monty@mishka.local committed
1738 1739
  select_insert(TABLE_LIST *table_list_par,
		TABLE *table_par, List<Item> *fields_par,
1740
		List<Item> *update_fields, List<Item> *update_values,
1741
		enum_duplicates duplic, bool ignore);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1742
  ~select_insert();
1743
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
1744
  int prepare2(void);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1745
  bool send_data(List<Item> &items);
serg@serg.mylan's avatar
serg@serg.mylan committed
1746
  virtual void store_values(List<Item> &values);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1747 1748
  void send_error(uint errcode,const char *err);
  bool send_eof();
1749 1750
  /* not implemented: select_insert is never re-used in prepared statements */
  void cleanup();
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1751 1752
};

monty@tik.mysql.fi's avatar
monty@tik.mysql.fi committed
1753

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1754 1755
class select_create: public select_insert {
  ORDER *group;
bell@sanja.is.com.ua's avatar
VIEW  
bell@sanja.is.com.ua committed
1756
  TABLE_LIST *create_table;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1757 1758 1759 1760 1761 1762
  List<create_field> *extra_fields;
  List<Key> *keys;
  HA_CREATE_INFO *create_info;
  MYSQL_LOCK *lock;
  Field **field;
public:
bell@sanja.is.com.ua's avatar
VIEW  
bell@sanja.is.com.ua committed
1763 1764 1765 1766
  select_create (TABLE_LIST *table,
		 HA_CREATE_INFO *create_info_par,
		 List<create_field> &fields_par,
		 List<Key> &keys_par,
1767 1768
		 List<Item> &select_fields,enum_duplicates duplic, bool ignore)
    :select_insert (NULL, NULL, &select_fields, 0, 0, duplic, ignore), create_table(table),
bell@sanja.is.com.ua's avatar
VIEW  
bell@sanja.is.com.ua committed
1769 1770
    extra_fields(&fields_par),keys(&keys_par), create_info(create_info_par),
    lock(0)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1771
    {}
1772
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
serg@serg.mylan's avatar
serg@serg.mylan committed
1773
  void store_values(List<Item> &values);
1774
  void send_error(uint errcode,const char *err);
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1775 1776 1777 1778
  bool send_eof();
  void abort();
};

1779 1780
#include <myisam.h>

sergefp@mysql.com's avatar
sergefp@mysql.com committed
1781 1782 1783 1784 1785
/* 
  Param to create temporary tables when doing SELECT:s 
  NOTE
    This structure is copied using memcpy as a part of JOIN.
*/
1786 1787 1788

class TMP_TABLE_PARAM :public Sql_alloc
{
1789 1790 1791 1792 1793 1794
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:
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
  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;
  byte	    *group_buff;
  Item	    **items_to_copy;			/* Fields in tmp table */
  MI_COLUMNDEF *recinfo,*start_recinfo;
  KEY *keyinfo;
  ha_rows end_write_records;
  uint	field_count,sum_func_count,func_count;
  uint  hidden_field_count;
  uint	group_parts,group_length,group_null_parts;
  uint	quick_group;
  bool  using_indirect_summary_function;
1809 1810
  /* If >0 convert all blob fields to varchar(convert_blob_length) */
  uint  convert_blob_length; 
1811
  CHARSET_INFO *table_charset; 
1812
  bool schema_table;
1813 1814 1815 1816 1817 1818 1819
  /*
    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;
1820 1821

  TMP_TABLE_PARAM()
sergefp@mysql.com's avatar
sergefp@mysql.com committed
1822
    :copy_field(0), group_parts(0),
igor@rurik.mysql.com's avatar
igor@rurik.mysql.com committed
1823
     group_length(0), group_null_parts(0), convert_blob_length(0),
1824
     schema_table(0), precomputed_group_by(0)
1825 1826 1827 1828 1829
  {}
  ~TMP_TABLE_PARAM()
  {
    cleanup();
  }
1830
  void init(void);
1831 1832 1833 1834 1835
  inline void cleanup(void)
  {
    if (copy_field)				/* Fix for Intel compiler */
    {
      delete [] copy_field;
1836
      save_copy_field= copy_field= 0;
1837 1838 1839 1840
    }
  }
};

1841 1842
class select_union :public select_result_interceptor
{
1843
  TMP_TABLE_PARAM tmp_table_param;
1844 1845
public:
  TABLE *table;
monty@tik.mysql.fi's avatar
monty@tik.mysql.fi committed
1846

1847
  select_union() :table(0) {}
1848
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
monty@tik.mysql.fi's avatar
monty@tik.mysql.fi committed
1849 1850 1851
  bool send_data(List<Item> &items);
  bool send_eof();
  bool flush();
1852 1853 1854 1855

  bool create_result_table(THD *thd, List<Item> *column_types,
                           bool is_distinct, ulonglong options,
                           const char *alias);
monty@tik.mysql.fi's avatar
monty@tik.mysql.fi committed
1856 1857
};

1858
/* Base subselect interface class */
1859
class select_subselect :public select_result_interceptor
1860
{
1861
protected:
1862 1863 1864
  Item_subselect *item;
public:
  select_subselect(Item_subselect *item);
1865
  bool send_data(List<Item> &items)=0;
1866 1867 1868
  bool send_eof() { return 0; };
};

1869
/* Single value subselect interface class */
1870
class select_singlerow_subselect :public select_subselect
1871 1872
{
public:
1873
  select_singlerow_subselect(Item_subselect *item):select_subselect(item){}
1874 1875 1876
  bool send_data(List<Item> &items);
};

1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
/* used in independent ALL/ANY optimisation */
class select_max_min_finder_subselect :public select_subselect
{
  Item_cache *cache;
  bool (select_max_min_finder_subselect::*op)();
  bool fmax;
public:
  select_max_min_finder_subselect(Item_subselect *item, bool mx)
    :select_subselect(item), cache(0), fmax(mx)
  {}
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1887
  void cleanup();
1888 1889 1890
  bool send_data(List<Item> &items);
  bool cmp_real();
  bool cmp_int();
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1891
  bool cmp_decimal();
1892 1893 1894
  bool cmp_str();
};

1895 1896 1897 1898 1899 1900 1901 1902
/* EXISTS subselect interface class */
class select_exists_subselect :public select_subselect
{
public:
  select_exists_subselect(Item_subselect *item):select_subselect(item){}
  bool send_data(List<Item> &items);
};

bk@work.mysql.com's avatar
bk@work.mysql.com committed
1903 1904 1905 1906 1907 1908
/* 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 */
1909
  uint   suffix_length;                 /* Length suffix (0-4) */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1910
  Item_result result_type;		/* Type of item */
1911 1912
  bool reverse;				/* if descending sort */
  bool need_strxnfrm;			/* If we have to use strxnfrm() */
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925
} 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 */

1926 1927
class Table_ident :public Sql_alloc
{
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1928 1929 1930
 public:
  LEX_STRING db;
  LEX_STRING table;
1931
  SELECT_LEX_UNIT *sel;
1932 1933
  inline Table_ident(THD *thd, LEX_STRING db_arg, LEX_STRING table_arg,
		     bool force)
1934
    :table(table_arg), sel((SELECT_LEX_UNIT *)0)
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1935
  {
1936
    if (!force && (thd->client_capabilities & CLIENT_NO_SCHEMA))
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1937 1938 1939 1940
      db.str=0;
    else
      db= db_arg;
  }
1941 1942 1943 1944 1945 1946 1947
  inline Table_ident(LEX_STRING table_arg) 
    :table(table_arg), sel((SELECT_LEX_UNIT *)0)
  {
    db.str=0;
  }
  inline Table_ident(SELECT_LEX_UNIT *s) : sel(s) 
  {
1948 1949
    /* We must have a table name here as this is used with add_table_to_list */
    db.str=0; table.str= internal_table_name; table.length=1;
1950
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1951
  inline void change_db(char *db_name)
1952 1953 1954
  {
    db.str= db_name; db.length= (uint) strlen(db_name);
  }
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1955 1956 1957 1958 1959 1960 1961 1962
};

// this is needed for user_vars hash
class user_var_entry
{
 public:
  LEX_STRING name;
  char *value;
1963 1964
  ulong length;
  query_id_t update_query_id, used_query_id;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1965
  Item_result type;
1966

mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1967
  double val_real(my_bool *null_value);
1968 1969
  longlong val_int(my_bool *null_value);
  String *val_str(my_bool *null_value, String *str, uint decimals);
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
1970
  my_decimal *val_decimal(my_bool *null_value, my_decimal *result);
1971
  DTCollation collation;
bk@work.mysql.com's avatar
bk@work.mysql.com committed
1972 1973
};

1974 1975 1976 1977 1978 1979 1980
/*
   Unique -- class for unique (removing of duplicates). 
   Puts all values to the TREE. If the tree becomes too big,
   it's dumped to the file. User can request sorted values, or
   just iterate through them. In the last case tree merging is performed in
   memory simultaneously with iteration, so it should be ~2-3x faster.
 */
1981 1982 1983 1984 1985 1986 1987

class Unique :public Sql_alloc
{
  DYNAMIC_ARRAY file_ptrs;
  ulong max_elements, max_in_memory_size;
  IO_CACHE file;
  TREE tree;
monty@hundin.mysql.fi's avatar
monty@hundin.mysql.fi committed
1988
  byte *record_pointers;
1989
  bool flush();
1990
  uint size;
1991 1992 1993

public:
  ulong elements;
1994
  Unique(qsort_cmp2 comp_func, void *comp_func_fixed_arg,
1995
	 uint size_arg, ulong max_in_memory_size_arg);
1996
  ~Unique();
1997
  ulong elements_in_tree() { return tree.elements_in_tree; }
1998
  inline bool unique_add(void *ptr)
1999
  {
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
2000 2001
    DBUG_ENTER("unique_add");
    DBUG_PRINT("info", ("tree %u - %u", tree.elements_in_tree, max_elements));
2002
    if (tree.elements_in_tree > max_elements && flush())
mskold@mysql.com's avatar
Merge  
mskold@mysql.com committed
2003 2004
      DBUG_RETURN(1);
    DBUG_RETURN(!tree_insert(&tree, ptr, 0, tree.custom_arg));
2005 2006 2007
  }

  bool get(TABLE *table);
2008
  static double get_use_cost(uint *buffer, uint nkeys, uint key_size, 
2009
                             ulong max_in_memory_size);
2010 2011 2012 2013 2014 2015 2016 2017
  inline static int get_cost_calc_buff_size(ulong nkeys, uint key_size, 
                                            ulong max_in_memory_size)
  {
    register ulong max_elems_in_tree= 
      (1 + max_in_memory_size / ALIGN_SIZE(sizeof(TREE_ELEMENT)+key_size));
    return sizeof(uint)*(1 + nkeys/max_elems_in_tree);
  }

2018 2019 2020
  void reset();
  bool walk(tree_walk_action action, void *walk_action_arg);

2021 2022
  friend int unique_write_to_file(gptr key, element_count count, Unique *unique);
  friend int unique_write_to_ptrs(gptr key, element_count count, Unique *unique);
2023
};
2024

monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2025

2026
class multi_delete :public select_result_interceptor
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2027 2028
{
  TABLE_LIST *delete_tables, *table_being_deleted;
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2029
  Unique **tempfiles;
2030
  ha_rows deleted, found;
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2031 2032
  uint num_of_tables;
  int error;
2033 2034 2035 2036 2037 2038
  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;
2039

monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2040
public:
2041
  multi_delete(TABLE_LIST *dt, uint num_of_tables);
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2042 2043 2044 2045 2046
  ~multi_delete();
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
  bool send_data(List<Item> &items);
  bool initialize_tables (JOIN *join);
  void send_error(uint errcode,const char *err);
2047
  int  do_deletes();
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2048 2049 2050
  bool send_eof();
};

2051

2052
class multi_update :public select_result_interceptor
2053
{
2054 2055 2056
  TABLE_LIST *all_tables; /* query/update command tables */
  TABLE_LIST *leaves;     /* list of leves of join table tree */
  TABLE_LIST *update_tables, *table_being_updated;
2057
  TABLE **tmp_tables, *main_table, *table_to_update;
2058 2059 2060 2061 2062 2063 2064
  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;
  Copy_field *copy_field;
  enum enum_duplicates handle_duplicates;
2065 2066 2067 2068
  bool do_update, trans_safe;
  /* True if the update operation has made a change in a transactional table */
  bool transactional_tables;
  bool ignore;
2069 2070

public:
2071
  multi_update(TABLE_LIST *ut, TABLE_LIST *leaves_list,
2072
	       List<Item> *fields, List<Item> *values,
2073
	       enum_duplicates handle_duplicates, bool ignore);
2074
  ~multi_update();
monty@mashka.mysql.fi's avatar
monty@mashka.mysql.fi committed
2075
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
2076 2077 2078 2079 2080 2081
  bool send_data(List<Item> &items);
  bool initialize_tables (JOIN *join);
  void send_error(uint errcode,const char *err);
  int  do_updates (bool from_send_error);
  bool send_eof();
};
2082

2083 2084 2085
class my_var : public Sql_alloc  {
public:
  LEX_STRING s;
2086
#ifndef DBUG_OFF
2087 2088 2089 2090
  /*
    Routine to which this Item_splocal belongs. Used for checking if correct
    runtime context is used for variable handling.
  */
2091
  sp_head *sp;
2092
#endif
2093 2094
  bool local;
  uint offset;
2095 2096 2097 2098
  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)
  {}
2099 2100
  ~my_var() {}
};
2101

2102
class select_dumpvar :public select_result_interceptor {
Sinisa@sinisa.nasamreza.org's avatar
Sinisa@sinisa.nasamreza.org committed
2103 2104
  ha_rows row_count;
public:
2105
  List<my_var> var_list;
2106
  List<Item_func_set_user_var> vars;
2107 2108
  List<Item_splocal> local_vars;
  select_dumpvar(void)  { var_list.empty(); local_vars.empty(); vars.empty(); row_count=0;}
Sinisa@sinisa.nasamreza.org's avatar
Sinisa@sinisa.nasamreza.org committed
2109
  ~select_dumpvar() {}
2110
  int prepare(List<Item> &list, SELECT_LEX_UNIT *u);
Sinisa@sinisa.nasamreza.org's avatar
Sinisa@sinisa.nasamreza.org committed
2111 2112
  bool send_data(List<Item> &items);
  bool send_eof();
2113
  void cleanup();
Sinisa@sinisa.nasamreza.org's avatar
Sinisa@sinisa.nasamreza.org committed
2114
};
2115 2116 2117 2118

/* Functions in sql_class.cc */

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