~drizzle-trunk/drizzle/development

390.1.2 by Monty Taylor
Fixed copyright headers in drizzled/
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
 *
4
 *  Copyright (C) 2008 Sun Microsystems
5
 *
6
 *  This program is free software; you can redistribute it and/or modify
7
 *  it under the terms of the GNU General Public License as published by
8
 *  the Free Software Foundation; version 2 of the License.
9
 *
10
 *  This program is distributed in the hope that it will be useful,
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 *  GNU General Public License for more details.
14
 *
15
 *  You should have received a copy of the GNU General Public License
16
 *  along with this program; if not, write to the Free Software
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
 */
1 by brian
clean slate
19
20
584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
21
#ifndef DRIZZLED_SESSION_H
22
#define DRIZZLED_SESSION_H
520.6.7 by Monty Taylor
Moved a bunch of crap out of common_includes.
23
1 by brian
clean slate
24
/* Classes in mysql */
538 by Monty Taylor
Moved gettext.h into drizzled in anticipation of the new client lib.
25
1130.1.1 by Monty Taylor
Merged in plugin-slot-reorg patches.
26
#include "drizzled/plugin.h"
561.1.3 by Monty Taylor
Split some more things out of common_includes.h.
27
#include <drizzled/sql_locale.h>
575.1.3 by Monty Taylor
Moved some stuff out of handler.h.
28
#include <drizzled/ha_trx_info.h>
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
29
#include <mysys/my_alloc.h>
584.4.7 by Monty Taylor
Removed a big bank of includes from item.h.
30
#include <mysys/my_tree.h>
1183.1.2 by Brian Aker
Rename of handler to Cursor. You would not believe how long I have wanted
31
#include <drizzled/cursor.h>
670.2.1 by Monty Taylor
Moved pthread keys
32
#include <drizzled/current_session.h>
584.1.14 by Monty Taylor
Removed field.h from common_includes.
33
#include <drizzled/sql_error.h>
831.1.3 by Brian Aker
Moved over file_exchange class.
34
#include <drizzled/file_exchange.h>
837 by Brian Aker
Reworked some classes out of session.h
35
#include <drizzled/select_result_interceptor.h>
934.2.4 by Jay Pipes
This changeset pulls check_user(), check_connection(), and login_connection() out of sql_connect.cc and makes them member methods of Session, where they belong. Also, made sure that functions that return a bool return true when it succeeds, and not false...
36
#include <drizzled/db.h>
934.2.15 by Jay Pipes
Pulls remainder of XID and xid_cache implementation into xid.cc and xid.h from drizzled/session.cc.
37
#include <drizzled/xid.h>
934.2.4 by Jay Pipes
This changeset pulls check_user(), check_connection(), and login_connection() out of sql_connect.cc and makes them member methods of Session, where they belong. Also, made sure that functions that return a bool return true when it succeeds, and not false...
38
39
#include <netdb.h>
1183.1.29 by Brian Aker
Clean up interface so that Truncate sets the propper engine when
40
#include <map>
694 by Brian Aker
Refactor out char* strdup for string class in user.
41
#include <string>
590.2.18 by Monty Taylor
Changed the bitset<32> to a bitset<5>. Made the int constants into bitset constants.
42
#include <bitset>
1 by brian
clean slate
43
934.2.4 by Jay Pipes
This changeset pulls check_user(), check_connection(), and login_connection() out of sql_connect.cc and makes them member methods of Session, where they belong. Also, made sure that functions that return a bool return true when it succeeds, and not false...
44
#define MIN_HANDSHAKE_SIZE      6
45
971.6.1 by Eric Day
Renamed Protocol to Client, cleaned up some unnecessary methods along the way.
46
namespace drizzled
47
{
48
namespace plugin
49
{
50
class Client;
51
class Scheduler;
52
}
1143.2.10 by Jay Pipes
Phase 2 new replication work:
53
namespace message
54
{
55
class Transaction;
56
class Statement;
57
}
971.6.1 by Eric Day
Renamed Protocol to Client, cleaned up some unnecessary methods along the way.
58
}
59
1 by brian
clean slate
60
class Lex_input_stream;
584.1.12 by Monty Taylor
HA! Removed item.h from common_includes. woot.
61
class user_var_entry;
1052.2.2 by Nathan Williams
No actual code changes. Changed Copy_field to CopyField, to reflect the coding standards.
62
class CopyField;
584.1.15 by Monty Taylor
The mega-patch from hell. Renamed sql_class to session (since that's what it is) and removed it and field and table from common_includes.
63
class Table_ident;
1 by brian
clean slate
64
65
extern char internal_table_name[2];
66
extern char empty_c_string[1];
67
extern const char **errmesg;
68
69
#define TC_HEURISTIC_RECOVER_COMMIT   1
70
#define TC_HEURISTIC_RECOVER_ROLLBACK 2
482 by Brian Aker
Remove uint.
71
extern uint32_t tc_heuristic_recover;
1 by brian
clean slate
72
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
73
/**
1183.1.29 by Brian Aker
Clean up interface so that Truncate sets the propper engine when
74
  @brief
75
  Local storage for proto that are tmp table. This should be enlarged
76
  to hande the entire table-share for a local table. Once Hash is done,
77
  we should consider exchanging the map for it.
78
*/
79
typedef std::map <std::string, drizzled::message::Table> ProtoCache;
80
81
/**
1 by brian
clean slate
82
  The COPY_INFO structure is used by INSERT/REPLACE code.
83
  The schema of the row counting by the INSERT/INSERT ... ON DUPLICATE KEY
84
  UPDATE code:
85
    If a row is inserted then the copied variable is incremented.
86
    If a row is updated by the INSERT ... ON DUPLICATE KEY UPDATE and the
87
      new data differs from the old one then the copied and the updated
88
      variables are incremented.
89
    The touched variable is incremented if a row was touched by the update part
90
      of the INSERT ... ON DUPLICATE KEY UPDATE no matter whether the row
91
      was actually changed or not.
92
*/
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
93
typedef struct st_copy_info 
94
{
1 by brian
clean slate
95
  ha_rows records; /**< Number of processed records */
96
  ha_rows deleted; /**< Number of deleted records */
97
  ha_rows updated; /**< Number of updated records */
98
  ha_rows copied;  /**< Number of copied records */
99
  ha_rows error_count;
100
  ha_rows touched; /* Number of touched records */
101
  enum enum_duplicates handle_duplicates;
102
  int escape_char, last_errno;
103
  bool ignore;
104
  /* for INSERT ... UPDATE */
105
  List<Item> *update_fields;
106
  List<Item> *update_values;
107
  /* for VIEW ... WITH CHECK OPTION */
108
} COPY_INFO;
109
851 by Brian Aker
Class rewrite of Session (aka get all of the junk out)
110
typedef struct drizzled_lock_st
1 by brian
clean slate
111
{
327.1.5 by Brian Aker
Refactor around classes. TABLE_LIST has been factored out of table.h
112
  Table **table;
1054.1.6 by Brian Aker
Removed internal logic/dead variables for LOCK TABLES.
113
  uint32_t table_count;
114
  uint32_t lock_count;
1 by brian
clean slate
115
  THR_LOCK_DATA **locks;
319.1.1 by Grant Limberg
renamed all instances of MYSQL_ to DRIZZLE_
116
} DRIZZLE_LOCK;
1 by brian
clean slate
117
851 by Brian Aker
Class rewrite of Session (aka get all of the junk out)
118
#include <drizzled/lex_column.h>
1 by brian
clean slate
119
120
class select_result;
121
class Time_zone;
122
520.1.21 by Brian Aker
THD -> Session rename
123
#define Session_SENTRY_MAGIC 0xfeedd1ff
124
#define Session_SENTRY_GONE  0xdeadbeef
1 by brian
clean slate
125
520.1.22 by Brian Aker
Second pass of thd cleanup
126
#define Session_CHECK_SENTRY(session) assert(session->dbug_sentry == Session_SENTRY_MAGIC)
1 by brian
clean slate
127
128
struct system_variables
129
{
896.1.4 by Monty Taylor
Fixed compiler warnings.
130
  system_variables() {};
1 by brian
clean slate
131
  /*
132
    How dynamically allocated system variables are handled:
660.1.3 by Eric Herman
removed trailing whitespace with simple script:
133
1 by brian
clean slate
134
    The global_system_variables and max_system_variables are "authoritative"
135
    They both should have the same 'version' and 'size'.
136
    When attempting to access a dynamic variable, if the session version
137
    is out of date, then the session version is updated and realloced if
138
    neccessary and bytes copied from global to make up for missing data.
660.1.3 by Eric Herman
removed trailing whitespace with simple script:
139
  */
1 by brian
clean slate
140
  ulong dynamic_variables_version;
1030.1.1 by Brian Aker
Straighten out structures (remove some some dead bits).
141
  char * dynamic_variables_ptr;
482 by Brian Aker
Remove uint.
142
  uint32_t dynamic_variables_head;  /* largest valid variable offset */
143
  uint32_t dynamic_variables_size;  /* how many bytes are in use */
660.1.3 by Eric Herman
removed trailing whitespace with simple script:
144
151 by Brian Aker
Ulonglong to uint64_t
145
  uint64_t myisam_max_extra_sort_file_size;
146
  uint64_t max_heap_table_size;
147
  uint64_t tmp_table_size;
1 by brian
clean slate
148
  ha_rows select_limit;
149
  ha_rows max_join_size;
819.1.1 by Toru Maesaka
Removed the 16bit limitation of auto_increment_(increment|offset) system variables
150
  uint64_t auto_increment_increment;
151
  uint64_t auto_increment_offset;
616 by Brian Aker
ulong fixes.
152
  uint64_t bulk_insert_buff_size;
153
  uint64_t join_buff_size;
154
  uint32_t max_allowed_packet;
155
  uint64_t max_error_count;
156
  uint64_t max_length_for_sort_data;
910.4.4 by Stewart Smith
max_sort_length should be size_t everywhere. Causing numerous failures on SPARC and PowerPC due to strang value being retrieved in filesort. Basically, anything with filesort fails without this patch.
157
  size_t max_sort_length;
617 by Brian Aker
ulong fixes
158
  uint64_t min_examined_row_limit;
619 by Brian Aker
Removed ulong methods from vars.
159
  bool optimizer_prune_level;
1030.1.3 by Brian Aker
Final bits to structure alignment
160
  bool log_warnings;
161
619 by Brian Aker
Removed ulong methods from vars.
162
  uint32_t optimizer_search_depth;
1 by brian
clean slate
163
  /* A bitmap for switching optimizations on/off */
617 by Brian Aker
ulong fixes
164
  uint32_t optimizer_switch;
1030.1.3 by Brian Aker
Final bits to structure alignment
165
  uint32_t div_precincrement;
619 by Brian Aker
Removed ulong methods from vars.
166
  uint64_t preload_buff_size;
167
  uint32_t read_buff_size;
168
  uint32_t read_rnd_buff_size;
629.4.1 by Monty Taylor
First step in support size_t sys_var stuff.
169
  size_t sortbuff_size;
619 by Brian Aker
Removed ulong methods from vars.
170
  uint32_t thread_handling;
617 by Brian Aker
ulong fixes
171
  uint32_t tx_isolation;
619 by Brian Aker
Removed ulong methods from vars.
172
  uint32_t completion_type;
1 by brian
clean slate
173
  /* Determines which non-standard SQL behaviour should be enabled */
619 by Brian Aker
Removed ulong methods from vars.
174
  uint32_t sql_mode;
617 by Brian Aker
ulong fixes
175
  uint64_t max_seeks_for_key;
629.4.1 by Monty Taylor
First step in support size_t sys_var stuff.
176
  size_t range_alloc_block_size;
615 by Brian Aker
Added 32bit system variable support
177
  uint32_t query_alloc_block_size;
178
  uint32_t query_prealloc_size;
179
  uint32_t trans_alloc_block_size;
1124.2.7 by Diego Medina
reverted transaction_prealloc_size to an uint32_t
180
  uint32_t trans_prealloc_size;
617 by Brian Aker
ulong fixes
181
  uint64_t group_concat_max_len;
555 by Monty
Fixed 32-bit issues.
182
  /* TODO: change this to my_thread_id - but have to fix set_var first */
183
  uint64_t pseudo_thread_id;
1 by brian
clean slate
184
1130.1.4 by Monty Taylor
Moved StorageEngine into plugin namespace.
185
  drizzled::plugin::StorageEngine *storage_engine;
1 by brian
clean slate
186
187
  /* Only charset part of these variables is sensible */
264.2.6 by Andrey Hristov
Constify the usage of CHARSET_INFO almost to the last place in the code.
188
  const CHARSET_INFO  *character_set_filesystem;
1 by brian
clean slate
189
190
  /* Both charset and collation parts of these variables are important */
264.2.6 by Andrey Hristov
Constify the usage of CHARSET_INFO almost to the last place in the code.
191
  const CHARSET_INFO	*collation_server;
748 by Brian Aker
Removal of client side collation.
192
193
  inline const CHARSET_INFO  *getCollation(void) 
194
  {
1014.3.2 by Brian Aker
Factor out need for session in many "schema" calls. Removed variable about
195
    return collation_server;
748 by Brian Aker
Removal of client side collation.
196
  }
1 by brian
clean slate
197
198
  /* Locale Support */
199
  MY_LOCALE *lc_time_names;
200
201
  Time_zone *time_zone;
202
};
203
520.6.7 by Monty Taylor
Moved a bunch of crap out of common_includes.
204
extern struct system_variables global_system_variables;
205
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
206
#include "sql_lex.h"
207
208
/**
209
 * Per-session local status counters
210
 */
1 by brian
clean slate
211
typedef struct system_status_var
212
{
151 by Brian Aker
Ulonglong to uint64_t
213
  uint64_t bytes_received;
214
  uint64_t bytes_sent;
1 by brian
clean slate
215
  ulong com_other;
895 by Brian Aker
Completion (?) of uint conversion.
216
  ulong com_stat[(uint32_t) SQLCOM_END];
1 by brian
clean slate
217
  ulong created_tmp_disk_tables;
218
  ulong created_tmp_tables;
219
  ulong ha_commit_count;
220
  ulong ha_delete_count;
221
  ulong ha_read_first_count;
222
  ulong ha_read_last_count;
223
  ulong ha_read_key_count;
224
  ulong ha_read_next_count;
225
  ulong ha_read_prev_count;
226
  ulong ha_read_rnd_count;
227
  ulong ha_read_rnd_next_count;
228
  ulong ha_rollback_count;
229
  ulong ha_update_count;
230
  ulong ha_write_count;
231
  ulong ha_prepare_count;
232
  ulong ha_savepoint_count;
233
  ulong ha_savepoint_rollback_count;
234
235
  /* KEY_CACHE parts. These are copies of the original */
236
  ulong key_blocks_changed;
237
  ulong key_blocks_used;
238
  ulong key_cache_r_requests;
239
  ulong key_cache_read;
240
  ulong key_cache_w_requests;
241
  ulong key_cache_write;
242
  /* END OF KEY_CACHE parts */
243
244
  ulong net_big_packet_count;
245
  ulong opened_tables;
246
  ulong opened_shares;
247
  ulong select_full_join_count;
248
  ulong select_full_range_join_count;
249
  ulong select_range_count;
250
  ulong select_range_check_count;
251
  ulong select_scan_count;
252
  ulong long_query_count;
253
  ulong filesort_merge_passes;
254
  ulong filesort_range_count;
255
  ulong filesort_rows;
256
  ulong filesort_scan_count;
257
  /*
258
    Number of statements sent from the client
259
  */
260
  ulong questions;
261
262
  /*
263
    IMPORTANT!
264
    SEE last_system_status_var DEFINITION BELOW.
265
266
    Below 'last_system_status_var' are all variables which doesn't make any
267
    sense to add to the /global/ status variable counter.
268
  */
269
  double last_query_cost;
270
} STATUS_VAR;
271
272
/*
273
  This is used for 'SHOW STATUS'. It must be updated to the last ulong
274
  variable in system_status_var which is makes sens to add to the global
275
  counter
276
*/
277
278
#define last_system_status_var questions
279
520.1.22 by Brian Aker
Second pass of thd cleanup
280
void mark_transaction_to_rollback(Session *session, bool all);
1 by brian
clean slate
281
1100.3.29 by Padraig O'Sullivan
Removed the Statement class. Copied any members it had that were needed by
282
struct st_savepoint 
283
{
284
  struct st_savepoint *prev;
285
  char *name;
286
  uint32_t length;
287
  Ha_trx_info *ha_list;
288
};
289
290
extern pthread_mutex_t LOCK_xid_cache;
291
extern HASH xid_cache;
292
293
#include <drizzled/security_context.h>
294
#include <drizzled/open_tables_state.h>
295
296
#include <drizzled/internal_error_handler.h> 
297
#include <drizzled/diagnostics_area.h> 
298
299
/**
300
  Storage engine specific thread local data.
301
*/
302
struct Ha_data
303
{
304
  /**
305
    Storage engine specific thread local data.
306
    Lifetime: one user connection.
307
  */
308
  void *ha_ptr;
309
  /**
310
    0: Life time: one statement within a transaction. If @@autocommit is
311
    on, also represents the entire transaction.
312
    @sa trans_register_ha()
313
314
    1: Life time: one transaction within a connection.
315
    If the storage engine does not participate in a transaction,
316
    this should not be used.
317
    @sa trans_register_ha()
318
  */
319
  Ha_trx_info ha_info[2];
320
321
  Ha_data() :ha_ptr(NULL) {}
322
};
323
324
/**
325
 * Represents a client connection to the database server.
326
 *
327
 * Contains the client/server protocol object, the current statement
328
 * being executed, local-to-session variables and status counters, and
329
 * a host of other information.
330
 *
331
 * @todo
332
 *
1100.3.34 by Padraig O'Sullivan
Various updates after great code review from Jay. Thanks Jay!
333
 * The Session class should have a vector of Statement object pointers which
334
 * comprise the statements executed on the Session. Until this architectural
335
 * change is done, we can forget about parallel operations inside a session.
1100.3.29 by Padraig O'Sullivan
Removed the Statement class. Copied any members it had that were needed by
336
 *
337
 * @todo
338
 *
339
 * Make member variables private and have inlined accessors and setters.  Hide
340
 * all member variables that are not critical to non-internal operations of the
341
 * session object.
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
342
 */
1100.3.29 by Padraig O'Sullivan
Removed the Statement class. Copied any members it had that were needed by
343
class Session : public Open_tables_state
1 by brian
clean slate
344
{
345
public:
346
  /*
347
    MARK_COLUMNS_NONE:  Means mark_used_colums is not set and no indicator to
348
                        handler of fields used is set
349
    MARK_COLUMNS_READ:  Means a bit in read set is set to inform handler
350
	                that the field is to be read. If field list contains
520.1.22 by Brian Aker
Second pass of thd cleanup
351
                        duplicates, then session->dup_field is set to point
1 by brian
clean slate
352
                        to the last found duplicate.
353
    MARK_COLUMNS_WRITE: Means a bit is set in write set to inform handler
354
			that it needs to update this field in write_row
355
                        and update_row.
356
  */
357
  enum enum_mark_columns mark_used_columns;
1100.3.29 by Padraig O'Sullivan
Removed the Statement class. Copied any members it had that were needed by
358
  inline void* alloc(size_t size)
359
  {
360
    return alloc_root(mem_root,size);
361
  }
362
  inline void* calloc(size_t size)
363
  {
364
    void *ptr;
365
    if ((ptr= alloc_root(mem_root,size)))
366
      memset(ptr, 0, size);
367
    return ptr;
368
  }
369
  inline char *strdup(const char *str)
370
  {
371
    return strdup_root(mem_root,str);
372
  }
373
  inline char *strmake(const char *str, size_t size)
374
  {
375
    return strmake_root(mem_root,str,size);
376
  }
377
  inline void *memdup(const void *str, size_t size)
378
  {
379
    return memdup_root(mem_root,str,size);
380
  }
381
  inline void *memdup_w_gap(const void *str, size_t size, uint32_t gap)
382
  {
383
    void *ptr;
384
    if ((ptr= alloc_root(mem_root,size+gap)))
385
      memcpy(ptr,str,size);
386
    return ptr;
387
  }
388
  /** Frees all items attached to this Statement */
389
  void free_items();
390
  /**
391
   * List of items created in the parser for this query. Every item puts
392
   * itself to the list on creation (see Item::Item() for details))
393
   */
394
  Item *free_list;
395
  MEM_ROOT *mem_root; /**< Pointer to current memroot */
396
  /**
397
   * Uniquely identifies each statement object in thread scope; change during
398
   * statement lifetime.
399
   *
400
   * @todo should be const
401
   */
402
  uint32_t id;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
403
  LEX *lex; /**< parse tree descriptor */
404
  /**
1 by brian
clean slate
405
    Points to the query associated with this statement. It's const, but
406
    we need to declare it char * because all table handlers are written
407
    in C and need to point to it.
408
409
    Note that (A) if we set query = NULL, we must at the same time set
410
    query_length = 0, and protect the whole operation with the
411
    LOCK_thread_count mutex. And (B) we are ONLY allowed to set query to a
412
    non-NULL value if its previous value is NULL. We do not need to protect
413
    operation (B) with any mutex. To avoid crashes in races, if we do not
520.1.22 by Brian Aker
Second pass of thd cleanup
414
    know that session->query cannot change at the moment, one should print
415
    session->query like this:
1 by brian
clean slate
416
      (1) reserve the LOCK_thread_count mutex;
520.1.22 by Brian Aker
Second pass of thd cleanup
417
      (2) check if session->query is NULL;
418
      (3) if not NULL, then print at most session->query_length characters from
1 by brian
clean slate
419
      it. We will see the query_length field as either 0, or the right value
420
      for it.
421
    Assuming that the write and read of an n-bit memory field in an n-bit
660.1.3 by Eric Herman
removed trailing whitespace with simple script:
422
    computer is atomic, we can avoid races in the above way.
1 by brian
clean slate
423
    This printing is needed at least in SHOW PROCESSLIST and SHOW INNODB
424
    STATUS.
425
  */
426
  char *query;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
427
  uint32_t query_length; /**< current query length */
1 by brian
clean slate
428
429
  /**
430
    Name of the current (default) database.
431
432
    If there is the current (default) database, "db" contains its name. If
433
    there is no current (default) database, "db" is NULL and "db_length" is
434
    0. In other words, "db", "db_length" must either be NULL, or contain a
435
    valid database name.
436
437
    @note this attribute is set and alloced by the slave SQL thread (for
520.1.21 by Brian Aker
THD -> Session rename
438
    the Session of that thread); that thread is (and must remain, for now) the
1 by brian
clean slate
439
    only responsible for freeing this member.
440
  */
441
  char *db;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
442
  uint32_t db_length; /**< Length of current schema name */
1100.3.29 by Padraig O'Sullivan
Removed the Statement class. Copied any members it had that were needed by
443
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
444
  /**
520.1.21 by Brian Aker
THD -> Session rename
445
    Constant for Session::where initialization in the beginning of every query.
1 by brian
clean slate
446
520.1.21 by Brian Aker
THD -> Session rename
447
    It's needed because we do not save/restore Session::where normally during
1 by brian
clean slate
448
    primary (non subselect) query execution.
449
  */
450
  static const char * const DEFAULT_WHERE;
451
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
452
  MEM_ROOT warn_root; /**< Allocation area for warnings and errors */
971.6.1 by Eric Day
Renamed Protocol to Client, cleaned up some unnecessary methods along the way.
453
  drizzled::plugin::Client *client; /**< Pointer to client object */
971.3.65 by Eric Day
Namespace cleanup for Protocol and Listen.
454
  drizzled::plugin::Scheduler *scheduler; /**< Pointer to scheduler object */
971.3.64 by Eric Day
Cleaned up Scheduler plugin, moved more code to the schedular plugins, reworked some functions to be methods in Session, removed some dead code.
455
  void *scheduler_arg; /**< Pointer to the optional scheduler argument */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
456
  HASH user_vars; /**< Hash of user variables defined during the session's lifetime */
457
  struct system_variables variables; /**< Mutable local variables local to the session */
458
  struct system_status_var status_var; /**< Session-local status counters */
459
  struct system_status_var *initial_status_var; /* used by show status */
460
  THR_LOCK_INFO lock_info; /**< Locking information for this session */
461
  THR_LOCK_OWNER main_lock_id; /**< To use for conventional queries */
462
  THR_LOCK_OWNER *lock_id; /**< If not main_lock_id, points to the lock_id of a cursor. */
463
  pthread_mutex_t LOCK_delete; /**< Locked before session is deleted */
1039.1.16 by Brian Aker
A lot of little cleanups (most based off lcov)
464
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
465
  /**
466
   * A peek into the query string for the session. This is a best effort
467
   * delivery, there is no guarantee whether the content is meaningful.
468
   */
998 by Brian Aker
Patch on show processlist from davi@apache.org
469
  char process_list_info[PROCESS_LIST_WIDTH+1];
1039.1.16 by Brian Aker
A lot of little cleanups (most based off lcov)
470
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
471
  /**
971.3.64 by Eric Day
Cleaned up Scheduler plugin, moved more code to the schedular plugins, reworked some functions to be methods in Session, removed some dead code.
472
   * A pointer to the stack frame of the scheduler thread
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
473
   * which is called first in the thread for handling a client
474
   */
1039.1.16 by Brian Aker
A lot of little cleanups (most based off lcov)
475
  char *thread_stack;
1 by brian
clean slate
476
477
  /**
478
    @note
520.1.21 by Brian Aker
THD -> Session rename
479
    Some members of Session (currently 'Statement::db',
1055.2.16 by Jay Pipes
Removes dead Session::catalog member variable
480
    'query')  are set and alloced by the slave SQL thread
520.1.21 by Brian Aker
THD -> Session rename
481
    (for the Session of that thread); that thread is (and must remain, for now)
1 by brian
clean slate
482
    the only responsible for freeing these 3 members. If you add members
483
    here, and you add code to set them in replication, don't forget to
484
    free_them_and_set_them_to_0 in replication properly. For details see
485
    the 'err:' label of the handle_slave_sql() in sql/slave.cc.
486
487
    @see handle_slave_sql
488
  */
694 by Brian Aker
Refactor out char* strdup for string class in user.
489
  Security_context security_ctx;
1 by brian
clean slate
490
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
491
  /**
1 by brian
clean slate
492
    Used in error messages to tell user in what part of MySQL we found an
493
    error. E. g. when where= "having clause", if fix_fields() fails, user
494
    will know that the error was in having clause.
495
  */
496
  const char *where;
497
498
  /*
499
    One thread can hold up to one named user-level lock. This variable
500
    points to a lock object if the lock is present. See item_func.cc and
660.1.3 by Eric Herman
removed trailing whitespace with simple script:
501
    chapter 'Miscellaneous functions', for functions GET_LOCK, RELEASE_LOCK.
1 by brian
clean slate
502
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
503
  uint32_t dbug_sentry; /**< watch for memory corruption */
1 by brian
clean slate
504
  struct st_my_thread_var *mysys_var;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
505
  /**
506
   * Type of current query: COM_STMT_PREPARE, COM_QUERY, etc. Set from
507
   * first byte of the packet in executeStatement()
508
   */
1 by brian
clean slate
509
  enum enum_server_command command;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
510
  uint32_t file_id;	/**< File ID for LOAD DATA INFILE */
971.6.1 by Eric Day
Renamed Protocol to Client, cleaned up some unnecessary methods along the way.
511
  /* @note the following three members should likely move to Client */
1055.2.15 by Jay Pipes
Removed unused cached character set variables in Session along with dead update_charset() method.
512
  uint32_t max_client_packet_length; /**< Maximum number of bytes a client can send in a single packet */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
513
  time_t start_time;
514
  time_t user_time;
515
  uint64_t thr_create_utime; /**< track down slow pthread_create */
516
  uint64_t start_utime;
517
  uint64_t utime_after_lock;
660.1.3 by Eric Herman
removed trailing whitespace with simple script:
518
1 by brian
clean slate
519
  thr_lock_type update_lock_default;
520
661 by Brian Aker
First major pass through new replication.
521
  /*
522
    Both of the following container points in session will be converted to an API.
523
  */
524
1 by brian
clean slate
525
  /* container for handler's private per-connection data */
526
  Ha_data ha_data[MAX_HA];
527
661 by Brian Aker
First major pass through new replication.
528
  /* container for replication data */
529
  void *replication_data;
1 by brian
clean slate
530
531
  struct st_transactions {
532
    SAVEPOINT *savepoints;
520.1.21 by Brian Aker
THD -> Session rename
533
    Session_TRANS all;			// Trans since BEGIN WORK
534
    Session_TRANS stmt;			// Trans for current statement
1 by brian
clean slate
535
    bool on;                            // see ha_enable_transaction()
536
    XID_STATE xid_state;
537
538
    /*
539
       Tables changed in transaction (that must be invalidated in query cache).
540
       List contain only transactional tables, that not invalidated in query
541
       cache (instead of full list of changed in transaction tables).
542
    */
327.2.4 by Brian Aker
Refactoring table.h
543
    CHANGED_TableList* changed_tables;
1 by brian
clean slate
544
    MEM_ROOT mem_root; // Transaction-life memory allocation pool
545
    void cleanup()
546
    {
547
      changed_tables= 0;
548
      savepoints= 0;
549
      free_root(&mem_root,MYF(MY_KEEP_PREALLOC));
550
    }
551
    st_transactions()
552
    {
212.6.6 by Mats Kindahl
Removing redundant use of casts in drizzled/ for memcmp(), memcpy(), memset(), and memmove().
553
      memset(this, 0, sizeof(*this));
1 by brian
clean slate
554
      xid_state.xid.null();
555
      init_sql_alloc(&mem_root, ALLOC_ROOT_MIN_BLOCK_SIZE, 0);
556
    }
557
  } transaction;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
558
  Field *dup_field;
1 by brian
clean slate
559
  sigset_t signals;
560
561
  /* Tells if LAST_INSERT_ID(#) was called for the current statement */
562
  bool arg_of_last_insert_id_function;
563
  /*
564
    ALL OVER THIS FILE, "insert_id" means "*automatically generated* value for
565
    insertion into an auto_increment column".
566
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
567
  /**
1 by brian
clean slate
568
    This is the first autogenerated insert id which was *successfully*
569
    inserted by the previous statement (exactly, if the previous statement
570
    didn't successfully insert an autogenerated insert id, then it's the one
571
    of the statement before, etc).
572
    It can also be set by SET LAST_INSERT_ID=# or SELECT LAST_INSERT_ID(#).
573
    It is returned by LAST_INSERT_ID().
574
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
575
  uint64_t first_successful_insert_id_in_prev_stmt;
576
  /**
1 by brian
clean slate
577
    This is the first autogenerated insert id which was *successfully*
578
    inserted by the current statement. It is maintained only to set
579
    first_successful_insert_id_in_prev_stmt when statement ends.
580
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
581
  uint64_t first_successful_insert_id_in_cur_stmt;
582
  /**
1 by brian
clean slate
583
    We follow this logic:
584
    - when stmt starts, first_successful_insert_id_in_prev_stmt contains the
585
    first insert id successfully inserted by the previous stmt.
586
    - as stmt makes progress, handler::insert_id_for_cur_row changes;
587
    every time get_auto_increment() is called,
588
    auto_inc_intervals_in_cur_stmt_for_binlog is augmented with the
589
    reserved interval (if statement-based binlogging).
590
    - at first successful insertion of an autogenerated value,
591
    first_successful_insert_id_in_cur_stmt is set to
592
    handler::insert_id_for_cur_row.
593
    - when stmt goes to binlog,
594
    auto_inc_intervals_in_cur_stmt_for_binlog is binlogged if
595
    non-empty.
596
    - when stmt ends, first_successful_insert_id_in_prev_stmt is set to
597
    first_successful_insert_id_in_cur_stmt.
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
598
1 by brian
clean slate
599
    List of auto_increment intervals reserved by the thread so far, for
600
    storage in the statement-based binlog.
601
    Note that its minimum is not first_successful_insert_id_in_cur_stmt:
602
    assuming a table with an autoinc column, and this happens:
603
    INSERT INTO ... VALUES(3);
604
    SET INSERT_ID=3; INSERT IGNORE ... VALUES (NULL);
605
    then the latter INSERT will insert no rows
606
    (first_successful_insert_id_in_cur_stmt == 0), but storing "INSERT_ID=3"
607
    in the binlog is still needed; the list's minimum will contain 3.
608
  */
609
  Discrete_intervals_list auto_inc_intervals_in_cur_stmt_for_binlog;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
610
  /** Used by replication and SET INSERT_ID */
1 by brian
clean slate
611
  Discrete_intervals_list auto_inc_intervals_forced;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
612
613
  uint64_t limit_found_rows;
1055.2.15 by Jay Pipes
Removed unused cached character set variables in Session along with dead update_charset() method.
614
  uint64_t options; /**< Bitmap of options */
615
  int64_t row_count_func; /**< For the ROW_COUNT() function */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
616
  ha_rows cuted_fields; /**< Count of "cut" or truncated fields. @todo Kill this friggin thing. */
617
618
  /** 
619
   * Number of rows we actually sent to the client, including "synthetic"
620
   * rows in ROLLUP etc.
621
   */
622
  ha_rows sent_row_count;
623
624
  /**
625
   * Number of rows we read, sent or not, including in create_sort_index()
626
   */
627
  ha_rows examined_row_count;
628
629
  /**
630
   * The set of those tables whose fields are referenced in all subqueries
631
   * of the query.
632
   *
633
   * @todo
634
   * 
635
   * Possibly this it is incorrect to have used tables in Session because
636
   * with more than one subquery, it is not clear what does the field mean.
637
   */
638
  table_map used_tables;
639
640
  /**
641
    @todo
642
    
643
    This, and some other variables like 'count_cuted_fields'
1 by brian
clean slate
644
    maybe should be statement/cursor local, that is, moved to Statement
645
    class. With current implementation warnings produced in each prepared
646
    statement/cursor settle here.
647
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
648
  List<DRIZZLE_ERROR> warn_list;
649
  uint32_t warn_count[(uint32_t) DRIZZLE_ERROR::WARN_LEVEL_END];
650
  uint32_t total_warn_count;
1 by brian
clean slate
651
  Diagnostics_area main_da;
652
653
  /*
654
    Id of current query. Statement can be reused to execute several queries
655
    query_id is global in context of the whole MySQL server.
656
    ID is automatically generated from mutex-protected counter.
657
    It's used in handler code for various purposes: to check which columns
658
    from table are necessary for this select, to check if it's necessary to
659
    update auto-updatable fields (like auto_increment and timestamp).
660
  */
1055.2.15 by Jay Pipes
Removed unused cached character set variables in Session along with dead update_charset() method.
661
  query_id_t query_id;
662
  query_id_t warn_id;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
663
  ulong col_access;
1 by brian
clean slate
664
665
  /* Statement id is thread-wide. This counter is used to generate ids */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
666
  uint32_t statement_id_counter;
667
  uint32_t rand_saved_seed1;
668
  uint32_t rand_saved_seed2;
669
  /**
1 by brian
clean slate
670
    Row counter, mainly for errors and warnings. Not increased in
671
    create_sort_index(); may differ from examined_row_count.
672
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
673
  uint32_t row_count;
674
  pthread_t real_id; /**< For debugging */
675
  my_thread_id thread_id;
1046.1.7 by Brian Aker
Style cleanup.
676
  uint32_t tmp_table;
677
  uint32_t global_read_lock;
678
  uint32_t server_status;
679
  uint32_t open_options;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
680
  uint32_t select_number; /**< number of select (used for EXPLAIN) */
1 by brian
clean slate
681
  /* variables.transaction_isolation is reset to this after each commit */
682
  enum_tx_isolation session_tx_isolation;
683
  enum_check_fields count_cuted_fields;
684
685
  enum killed_state
686
  {
550 by Monty Taylor
Moved error.h into just the files that need it.
687
    NOT_KILLED,
688
    KILL_BAD_DATA,
689
    KILL_CONNECTION,
690
    KILL_QUERY,
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
691
    KILLED_NO_VALUE /* means none of the above states apply */
1 by brian
clean slate
692
  };
693
  killed_state volatile killed;
694
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
695
  bool some_tables_deleted;
696
  bool no_errors;
697
  bool password;
1 by brian
clean slate
698
  /**
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
699
    Set to true if execution of the current compound statement
1 by brian
clean slate
700
    can not continue. In particular, disables activation of
701
    CONTINUE or EXIT handlers of stored routines.
702
    Reset in the end of processing of the current user request, in
520.1.22 by Brian Aker
Second pass of thd cleanup
703
    @see mysql_reset_session_for_next_command().
1 by brian
clean slate
704
  */
705
  bool is_fatal_error;
706
  /**
707
    Set by a storage engine to request the entire
708
    transaction (that possibly spans multiple engines) to
709
    rollback. Reset in ha_rollback.
710
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
711
  bool transaction_rollback_request;
1 by brian
clean slate
712
  /**
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
713
    true if we are in a sub-statement and the current error can
1 by brian
clean slate
714
    not be safely recovered until we left the sub-statement mode.
715
    In particular, disables activation of CONTINUE and EXIT
716
    handlers inside sub-statements. E.g. if it is a deadlock
717
    error and requires a transaction-wide rollback, this flag is
718
    raised (traditionally, MySQL first has to close all the reads
719
    via @see handler::ha_index_or_rnd_end() and only then perform
720
    the rollback).
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
721
    Reset to false when we leave the sub-statement mode.
1 by brian
clean slate
722
  */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
723
  bool is_fatal_sub_stmt_error;
724
  /** for IS NULL => = last_insert_id() fix in remove_eq_conds() */
725
  bool substitute_null_with_insert_id;
726
  bool cleanup_done;
727
728
  bool abort_on_warning;
729
  bool got_warning; /**< Set on call to push_warning() */
730
  bool no_warnings_for_error; /**< no warnings on call to my_error() */
731
  /** set during loop of derived table processing */
732
  bool derived_tables_processing;
1055.2.15 by Jay Pipes
Removed unused cached character set variables in Session along with dead update_charset() method.
733
  bool tablespace_op; /**< This is true in DISCARD/IMPORT TABLESPACE */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
734
735
  /** Used by the sys_var class to store temporary values */
1 by brian
clean slate
736
  union
737
  {
1055.2.17 by Jay Pipes
More style cleanups in Session
738
    bool bool_value;
739
    uint32_t uint32_t_value;
740
    int32_t int32_t_value;
151 by Brian Aker
Ulonglong to uint64_t
741
    uint64_t uint64_t_value;
1 by brian
clean slate
742
  } sys_var_tmp;
660.1.3 by Eric Herman
removed trailing whitespace with simple script:
743
1 by brian
clean slate
744
  /**
745
    Character input stream consumed by the lexical analyser,
746
    used during parsing.
747
    Note that since the parser is not re-entrant, we keep only one input
748
    stream here. This member is valid only when executing code during parsing,
749
    and may point to invalid memory after that.
750
  */
751
  Lex_input_stream *m_lip;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
752
  
753
  /** Place to store various things */
754
  void *session_marker;
1183.1.29 by Brian Aker
Clean up interface so that Truncate sets the propper engine when
755
1055.2.17 by Jay Pipes
More style cleanups in Session
756
  /** Keeps a copy of the previous table around in case we are just slamming on particular table */
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
757
  Table *cached_table;
758
759
  /**
760
    Points to info-string that we show in SHOW PROCESSLIST
761
    You are supposed to call Session_SET_PROC_INFO only if you have coded
762
    a time-consuming piece that MySQL can get stuck in for a long time.
763
764
    Set it using the  session_proc_info(Session *thread, const char *message)
765
    macro/function.
766
  */
767
  inline void set_proc_info(const char *info)
768
  { 
769
    proc_info= info;
770
  }
771
  inline const char* get_proc_info() const
772
  {
773
    return proc_info;
774
  }
775
776
  inline void setReplicationData (void *data)
777
  {
778
    replication_data= data;
779
  }
780
  inline void *getReplicationData () const
781
  {
782
    return replication_data;
783
  }
784
785
  /** Returns the current query ID */
786
  inline query_id_t getQueryId()  const
787
  {
788
    return query_id;
789
  }
790
791
  /** Returns the current query text */
792
  inline const char *getQueryString()  const
793
  {
794
    return query;
795
  }
796
797
  /** Returns the length of the current query text */
798
  inline size_t getQueryLength() const
799
  {
1124.2.4 by Diego Medina
Fixes bug #421345 - Crash when calling getQueryLength() on query = NULL
800
    if (query != NULL)
801
      return strlen(query);
802
    else
803
      return 0;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
804
  }
805
1039.5.56 by Jay Pipes
Adds Session ID accessor, and output to replication messages
806
  /** Accessor method returning the session's ID. */
807
  inline uint64_t getSessionId()  const
808
  {
809
    return thread_id;
810
  }
811
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
812
  /** Accessor method returning the server's ID. */
813
  inline uint32_t getServerId()  const
814
  {
815
    /* We return the global server ID. */
816
    return server_id;
817
  }
818
819
  /** Returns the current transaction ID for the session's current statement */
820
  inline my_xid getTransactionId()
821
  {
822
    return transaction.xid_state.xid.quick_get_my_xid();
823
  }
824
  /**
825
    There is BUG#19630 where statement-based replication of stored
826
    functions/triggers with two auto_increment columns breaks.
827
    We however ensure that it works when there is 0 or 1 auto_increment
828
    column; our rules are
829
    a) on master, while executing a top statement involving substatements,
830
    first top- or sub- statement to generate auto_increment values wins the
831
    exclusive right to see its values be written to binlog (the write
832
    will be done by the statement or its caller), and the losers won't see
833
    their values be written to binlog.
834
    b) on slave, while replicating a top statement involving substatements,
835
    first top- or sub- statement to need to read auto_increment values from
836
    the master's binlog wins the exclusive right to read them (so the losers
837
    won't read their values from binlog but instead generate on their own).
838
    a) implies that we mustn't backup/restore
839
    auto_inc_intervals_in_cur_stmt_for_binlog.
840
    b) implies that we mustn't backup/restore auto_inc_intervals_forced.
841
842
    If there are more than 1 auto_increment columns, then intervals for
843
    different columns may mix into the
844
    auto_inc_intervals_in_cur_stmt_for_binlog list, which is logically wrong,
845
    but there is no point in preventing this mixing by preventing intervals
846
    from the secondly inserted column to come into the list, as such
847
    prevention would be wrong too.
848
    What will happen in the case of
849
    INSERT INTO t1 (auto_inc) VALUES(NULL);
850
    where t1 has a trigger which inserts into an auto_inc column of t2, is
851
    that in binlog we'll store the interval of t1 and the interval of t2 (when
852
    we store intervals, soon), then in slave, t1 will use both intervals, t2
853
    will use none; if t1 inserts the same number of rows as on master,
854
    normally the 2nd interval will not be used by t1, which is fine. t2's
855
    values will be wrong if t2's internal auto_increment counter is different
856
    from what it was on master (which is likely). In 5.1, in mixed binlogging
857
    mode, row-based binlogging is used for such cases where two
858
    auto_increment columns are inserted.
859
  */
860
  inline void record_first_successful_insert_id_in_cur_stmt(uint64_t id_arg)
861
  {
862
    if (first_successful_insert_id_in_cur_stmt == 0)
863
      first_successful_insert_id_in_cur_stmt= id_arg;
864
  }
865
  inline uint64_t read_first_successful_insert_id_in_prev_stmt(void)
866
  {
867
    return first_successful_insert_id_in_prev_stmt;
868
  }
869
  /**
870
    Used by Intvar_log_event::do_apply_event() and by "SET INSERT_ID=#"
871
    (mysqlbinlog). We'll soon add a variant which can take many intervals in
872
    argument.
873
  */
874
  inline void force_one_auto_inc_interval(uint64_t next_id)
875
  {
876
    auto_inc_intervals_forced.empty(); // in case of multiple SET INSERT_ID
877
    auto_inc_intervals_forced.append(next_id, UINT64_MAX, 0);
878
  }
1 by brian
clean slate
879
971.6.1 by Eric Day
Renamed Protocol to Client, cleaned up some unnecessary methods along the way.
880
  Session(drizzled::plugin::Client *client_arg);
1100.3.29 by Padraig O'Sullivan
Removed the Statement class. Copied any members it had that were needed by
881
  virtual ~Session();
1 by brian
clean slate
882
883
  void cleanup(void);
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
884
  /**
885
   * Cleans up after query.
886
   *
887
   * @details
888
   *
889
   * This function is used to reset thread data to its default state.
890
   *
891
   * This function is not suitable for setting thread data to some
892
   * non-default values, as there is only one replication thread, so
893
   * different master threads may overwrite data of each other on
894
   * slave.
895
   */
1 by brian
clean slate
896
  void cleanup_after_query();
971.3.64 by Eric Day
Cleaned up Scheduler plugin, moved more code to the schedular plugins, reworked some functions to be methods in Session, removed some dead code.
897
  bool storeGlobals();
520.1.21 by Brian Aker
THD -> Session rename
898
  void awake(Session::killed_state state_to_set);
934.2.6 by Jay Pipes
This changeset removes a few more C functions from sql_connect.cc/connect.h
899
  /**
900
   * Pulls thread-specific variables into Session state.
901
   *
902
   * Returns true most times, or false if there was a problem
903
   * allocating resources for thread-specific storage.
904
   *
905
   * @TODO Kill this.  It's not necessary once my_thr_init() is bye bye.
906
   *
907
   */
908
  bool initGlobals();
909
910
  /**
971.3.64 by Eric Day
Cleaned up Scheduler plugin, moved more code to the schedular plugins, reworked some functions to be methods in Session, removed some dead code.
911
    Initialize memory roots necessary for query processing and (!)
912
    pre-allocate memory for it. We can't do that in Session constructor because
971.3.70 by Eric Day
Fixed style issues found by Jay.
913
    there are use cases where it's vital to not allocate excessive and not used
914
    memory.
971.3.64 by Eric Day
Cleaned up Scheduler plugin, moved more code to the schedular plugins, reworked some functions to be methods in Session, removed some dead code.
915
  */
934.2.6 by Jay Pipes
This changeset removes a few more C functions from sql_connect.cc/connect.h
916
  void prepareForQueries();
1 by brian
clean slate
917
934.2.4 by Jay Pipes
This changeset pulls check_user(), check_connection(), and login_connection() out of sql_connect.cc and makes them member methods of Session, where they belong. Also, made sure that functions that return a bool return true when it succeeds, and not false...
918
  /**
934.2.8 by Jay Pipes
Refactors the do_command() function out of the sql_parse.cc stuff and implements it as a member method, executeStatement() on the Session object.
919
   * Executes a single statement received from the 
920
   * client connection.
921
   *
922
   * Returns true if the statement was successful, or false 
923
   * otherwise.
924
   *
925
   * @note
926
   *
927
   * For profiling to work, it must never be called recursively.
928
   *
929
   * In MySQL, this used to be the do_command() C function whic
930
   * accepted a single parameter of the THD pointer.
931
   */
932
  bool executeStatement();
933
934
  /**
934.2.9 by Jay Pipes
Pulls alloc_query() C function out of sql_parse.cc and adds readAndStoreQuery() member method of Session class.
935
   * Reads a query from packet and stores it.
936
   *
937
   * Returns true if query is read and allocated successfully, 
938
   * false otherwise.  On a return of false, Session::fatal_error
939
   * is set.
940
   *
941
   * @note Used in COM_QUERY and COM_STMT_PREPARE.
942
   *
943
   * Sets the following Session variables:
944
   *  - query
945
   *  - query_length
946
   *
947
   * @param The packet pointer to read from
948
   * @param The length of the query to read
949
   */
950
  bool readAndStoreQuery(const char *in_packet, uint32_t in_packet_length);
951
952
  /**
934.2.11 by Jay Pipes
Moves end_trans(), begin_trans(), end_active_trans() out of the parser module and adds startTransaction(), endTransaction(), and endActiveTransaction() member methods of Session object.
953
   * Ends the current transaction and (maybe) begins the next.
954
   *
955
   * Returns true if the transaction completed successfully, 
956
   * otherwise false.
957
   *
958
   * @param Completion type
959
   */
960
  bool endTransaction(enum enum_mysql_completiontype completion);
961
  bool endActiveTransaction();
1206.1.3 by Brian Aker
Valgrind fix for startTransaction()
962
  bool startTransaction(start_transaction_option_t opt= START_TRANS_NO_OPTIONS);
934.2.11 by Jay Pipes
Moves end_trans(), begin_trans(), end_active_trans() out of the parser module and adds startTransaction(), endTransaction(), and endActiveTransaction() member methods of Session object.
963
964
  /**
934.2.4 by Jay Pipes
This changeset pulls check_user(), check_connection(), and login_connection() out of sql_connect.cc and makes them member methods of Session, where they belong. Also, made sure that functions that return a bool return true when it succeeds, and not false...
965
   * Authenticates users, with error reporting.
966
   *
967
   * Returns true on success, or false on failure.
968
   */
969
  bool authenticate();
970
971.3.64 by Eric Day
Cleaned up Scheduler plugin, moved more code to the schedular plugins, reworked some functions to be methods in Session, removed some dead code.
971
  /**
972
   * Run a session.
973
   *
974
   * This will initialize the session and begin the command loop.
975
   */
976
  void run();
977
978
  /**
979
   * Schedule a session to be run on the default scheduler.
980
   */
981
  bool schedule();
982
1 by brian
clean slate
983
  /*
984
    For enter_cond() / exit_cond() to work the mutex must be got before
985
    enter_cond(); this mutex is then released by exit_cond().
986
    Usage must be: lock mutex; enter_cond(); your code; exit_cond().
987
  */
821 by Brian Aker
Removed dead prepare2 call.
988
  inline const char* enter_cond(pthread_cond_t *cond, pthread_mutex_t* mutex, const char* msg)
1 by brian
clean slate
989
  {
990
    const char* old_msg = get_proc_info();
991
    safe_mutex_assert_owner(mutex);
992
    mysys_var->current_mutex = mutex;
993
    mysys_var->current_cond = cond;
322.2.5 by Mats Kindahl
Replaced use of thd_proc_info() macro with calls to
994
    this->set_proc_info(msg);
1 by brian
clean slate
995
    return old_msg;
996
  }
997
  inline void exit_cond(const char* old_msg)
998
  {
999
    /*
1000
      Putting the mutex unlock in exit_cond() ensures that
1001
      mysys_var->current_mutex is always unlocked _before_ mysys_var->mutex is
1002
      locked (if that would not be the case, you'll get a deadlock if someone
520.1.21 by Brian Aker
THD -> Session rename
1003
      does a Session::awake() on you).
1 by brian
clean slate
1004
    */
1005
    pthread_mutex_unlock(mysys_var->current_mutex);
1006
    pthread_mutex_lock(&mysys_var->mutex);
1007
    mysys_var->current_mutex = 0;
1008
    mysys_var->current_cond = 0;
322.2.5 by Mats Kindahl
Replaced use of thd_proc_info() macro with calls to
1009
    this->set_proc_info(old_msg);
1 by brian
clean slate
1010
    pthread_mutex_unlock(&mysys_var->mutex);
1011
  }
735 by Brian Aker
Refactor session.
1012
  inline time_t query_start() { return start_time; }
1 by brian
clean slate
1013
  inline void set_time()
1014
  {
1015
    if (user_time)
1016
    {
1017
      start_time= user_time;
1055.3.6 by Jay Pipes
Adds public getConnectMicroseconds() call to Session object. Protects connect_microseconds member variable and sets it correctly. Corrects logging_xxx plugins to use getConnectMicroseconds() API call properly. Fixes Bug #402855
1018
      connect_microseconds= start_utime= utime_after_lock= my_micro_time();
1 by brian
clean slate
1019
    }
1020
    else
1021
      start_utime= utime_after_lock= my_micro_time_and_time(&start_time);
1022
  }
713.1.3 by Monty Taylor
Fixed one more my_time thing.
1023
  inline void	set_current_time()    { start_time= time(NULL); }
1 by brian
clean slate
1024
  inline void	set_time(time_t t)
1025
  {
1026
    start_time= user_time= t;
1027
    start_utime= utime_after_lock= my_micro_time();
1028
  }
1029
  void set_time_after_lock()  { utime_after_lock= my_micro_time(); }
988.1.5 by Jay Pipes
Removal of log.cc (binlog), added Applier plugin and fixed up Replicator
1030
  /**
1031
   * Returns the current micro-timestamp
1032
   */
1033
  inline uint64_t getCurrentTimestamp()  
1034
  { 
1035
    return my_micro_time(); 
1036
  }
151 by Brian Aker
Ulonglong to uint64_t
1037
  inline uint64_t found_rows(void)
1 by brian
clean slate
1038
  {
1039
    return limit_found_rows;
1040
  }
934.2.28 by Jay Pipes
Renamed some things to our standards and made private methods private...
1041
  /** Returns whether the session is currently inside a transaction */
1042
  inline bool inTransaction()
1 by brian
clean slate
1043
  {
1044
    return server_status & SERVER_STATUS_IN_TRANS;
1045
  }
1046
  inline bool fill_derived_tables()
1047
  {
1048
    return !lex->only_view_structure();
1049
  }
1050
  inline void* trans_alloc(unsigned int size)
1051
  {
1052
    return alloc_root(&transaction.mem_root,size);
1053
  }
1054
1055
  LEX_STRING *make_lex_string(LEX_STRING *lex_str,
482 by Brian Aker
Remove uint.
1056
                              const char* str, uint32_t length,
1 by brian
clean slate
1057
                              bool allocate_lex_string);
1058
327.1.5 by Brian Aker
Refactor around classes. TABLE_LIST has been factored out of table.h
1059
  void add_changed_table(Table *table);
1 by brian
clean slate
1060
  void add_changed_table(const char *key, long key_length);
327.2.4 by Brian Aker
Refactoring table.h
1061
  CHANGED_TableList * changed_table_dup(const char *key, long key_length);
1 by brian
clean slate
1062
  int send_explain_fields(select_result *result);
1063
  /**
1064
    Clear the current error, if any.
1065
    We do not clear is_fatal_error or is_fatal_sub_stmt_error since we
1066
    assume this is never called if the fatal error is set.
1067
    @todo: To silence an error, one should use Internal_error_handler
1068
    mechanism. In future this function will be removed.
1069
  */
1070
  inline void clear_error()
1071
  {
1072
    if (main_da.is_error())
1073
      main_da.reset_diagnostics_area();
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
1074
    return;
1 by brian
clean slate
1075
  }
383.1.55 by Monty Taylor
Removed libvio deps from drizzled.
1076
1 by brian
clean slate
1077
  /**
1078
    Mark the current error as fatal. Warning: this does not
1079
    set any error, it sets a property of the error, so must be
1080
    followed or prefixed with my_error().
1081
  */
1082
  inline void fatal_error()
1083
  {
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
1084
    assert(main_da.is_error());
1055.2.17 by Jay Pipes
More style cleanups in Session
1085
    is_fatal_error= true;
1 by brian
clean slate
1086
  }
1087
  /**
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
1088
    true if there is an error in the error stack.
1 by brian
clean slate
1089
1090
    Please use this method instead of direct access to
1091
    net.report_error.
1092
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
1093
    If true, the current (sub)-statement should be aborted.
1 by brian
clean slate
1094
    The main difference between this member and is_fatal_error
1095
    is that a fatal error can not be handled by a stored
1096
    procedure continue handler, whereas a normal error can.
1097
1098
    To raise this flag, use my_error().
1099
  */
1100
  inline bool is_error() const { return main_da.is_error(); }
748 by Brian Aker
Removal of client side collation.
1101
  inline const CHARSET_INFO *charset() { return default_charset_info; }
1 by brian
clean slate
1102
1103
  void change_item_tree(Item **place, Item *new_value)
1104
  {
1105
    *place= new_value;
1106
  }
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
1107
  /**
1 by brian
clean slate
1108
    Cleanup statement parse state (parse tree, lex) and execution
1109
    state after execution of a non-prepared SQL statement.
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
1110
1111
    @todo
1112
1113
    Move this to Statement::~Statement
1 by brian
clean slate
1114
  */
1115
  void end_statement();
1116
  inline int killed_errno() const
1117
  {
1118
    killed_state killed_val; /* to cache the volatile 'killed' */
1119
    return (killed_val= killed) != KILL_BAD_DATA ? killed_val : 0;
1120
  }
202.3.6 by Monty Taylor
First pass at gettexizing the error messages.
1121
  void send_kill_message() const;
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
1122
  /* return true if we will abort query if we make a warning now */
1 by brian
clean slate
1123
  inline bool really_abort_on_warning()
1124
  {
1125
    return (abort_on_warning);
1126
  }
1127
  void set_status_var_init();
1128
  void reset_n_backup_open_tables_state(Open_tables_state *backup);
1129
  void restore_backup_open_tables_state(Open_tables_state *backup);
1130
1131
  /**
1132
    Set the current database; use deep copy of C-string.
1133
1134
    @param new_db     a pointer to the new database name.
1135
    @param new_db_len length of the new database name.
1136
1137
    Initialize the current database from a NULL-terminated string with
1138
    length. If we run out of memory, we free the current database and
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
1139
    return true.  This way the user will notice the error as there will be
1 by brian
clean slate
1140
    no current database selected (in addition to the error message set by
1141
    malloc).
1142
1143
    @note This operation just sets {db, db_length}. Switching the current
1144
    database usually involves other actions, like switching other database
1145
    attributes including security context. In the future, this operation
1146
    will be made private and more convenient interface will be provided.
1147
1148
    @return Operation status
51.1.50 by Jay Pipes
Removed/replaced DBUG symbols and standardized TRUE/FALSE
1149
      @retval false Success
1150
      @retval true  Out-of-memory error
1 by brian
clean slate
1151
  */
656.1.22 by Monty Taylor
Removed my_malloc related stuff from log_event and session.
1152
  bool set_db(const char *new_db, size_t new_db_len);
1 by brian
clean slate
1153
1154
  /**
1155
    Set the current database; use shallow copy of C-string.
1156
1157
    @param new_db     a pointer to the new database name.
1158
    @param new_db_len length of the new database name.
1159
1160
    @note This operation just sets {db, db_length}. Switching the current
1161
    database usually involves other actions, like switching other database
1162
    attributes including security context. In the future, this operation
1163
    will be made private and more convenient interface will be provided.
1164
  */
1165
  void reset_db(char *new_db, size_t new_db_len)
1166
  {
1167
    db= new_db;
1168
    db_length= new_db_len;
1169
  }
1170
  /*
1171
    Copy the current database to the argument. Use the current arena to
1172
    allocate memory for a deep copy: current database may be freed after
1173
    a statement is parsed but before it's executed.
1174
  */
202.3.6 by Monty Taylor
First pass at gettexizing the error messages.
1175
  bool copy_db_to(char **p_db, size_t *p_db_length);
1 by brian
clean slate
1176
1177
public:
1178
  /**
1179
    Add an internal error handler to the thread execution context.
1180
    @param handler the exception handler to add
1181
  */
1182
  void push_internal_handler(Internal_error_handler *handler);
1183
1184
  /**
1185
    Handle an error condition.
1186
    @param sql_errno the error number
1187
    @param level the error level
1188
    @return true if the error is handled
1189
  */
482 by Brian Aker
Remove uint.
1190
  virtual bool handle_error(uint32_t sql_errno, const char *message,
261.4.1 by Felipe
- Renamed MYSQL_ERROR to DRIZZLE_ERROR.
1191
                            DRIZZLE_ERROR::enum_warning_level level);
1 by brian
clean slate
1192
1193
  /**
1194
    Remove the error handler last pushed.
1195
  */
1196
  void pop_internal_handler();
1197
693 by Brian Aker
Cleaning up session class.
1198
  /**
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
1199
    Resets Session part responsible for command processing state.
1200
1201
    This needs to be called before execution of every statement
1202
    (prepared or conventional).
1203
    It is not called by substatements of routines.
1204
1205
    @todo
1206
    Make it a method of Session and align its name with the rest of
1207
    reset/end/start/init methods.
1208
    @todo
1209
    Call it after we use Session for queries, not before.
735 by Brian Aker
Refactor session.
1210
  */
1211
  void reset_for_next_command();
1212
1213
  /**
934.2.6 by Jay Pipes
This changeset removes a few more C functions from sql_connect.cc/connect.h
1214
   * Disconnects the session from a client connection and
1215
   * updates any status variables necessary.
1216
   *
1217
   * @param errcode	Error code to print to console
1218
   * @param should_lock 1 if we have have to lock LOCK_thread_count
1219
   *
1220
   * @note  For the connection that is doing shutdown, this is called twice
1221
   */
1222
  void disconnect(uint32_t errcode, bool lock);
693 by Brian Aker
Cleaning up session class.
1223
934.2.28 by Jay Pipes
Renamed some things to our standards and made private methods private...
1224
  /**
1225
   * Check if user exists and the password supplied is correct.
1226
   *
1227
   * Returns true on success, and false on failure.
1228
   *
1229
   * @note Host, user and passwd may point to communication buffer.
1230
   * Current implementation does not depend on that, but future changes
1231
   * should be done with this in mind; 
1232
   *
1233
   * @param  Scrambled password received from client
1234
   * @param  Length of scrambled password
1235
   * @param  Database name to connect to, may be NULL
1236
   */
965 by Brian Aker
Merge with Jay
1237
  bool checkUser(const char *passwd, uint32_t passwd_len, const char *db);
1055.3.6 by Jay Pipes
Adds public getConnectMicroseconds() call to Session object. Protects connect_microseconds member variable and sets it correctly. Corrects logging_xxx plugins to use getConnectMicroseconds() API call properly. Fixes Bug #402855
1238
  
1239
  /**
1240
   * Returns the timestamp (in microseconds) of when the Session 
1241
   * connected to the server.
1242
   */
1243
  inline uint64_t getConnectMicroseconds() const
1244
  {
1245
    return connect_microseconds;
1246
  }
971.3.6 by Eric Day
Moved the last of the libdrizzleclient calls into Protocol.
1247
1143.2.10 by Jay Pipes
Phase 2 new replication work:
1248
  /**
1249
   * Returns a pointer to the active Transaction message for this
1250
   * Session being managed by the ReplicationServices component, or
1251
   * NULL if no active message.
1252
   */
1253
  drizzled::message::Transaction *getTransactionMessage() const
1254
  {
1255
    return transaction_message;
1256
  }
1257
1258
  /**
1259
   * Returns a pointer to the active Statement message for this
1260
   * Session, or NULL if no active message.
1261
   */
1262
  drizzled::message::Statement *getStatementMessage() const
1263
  {
1264
    return statement_message;
1265
  }
1266
1267
  /**
1268
   * Sets the active transaction message used by the ReplicationServices
1269
   * component.
1270
   *
1271
   * @param[in] Pointer to the message
1272
   */
1273
  void setTransactionMessage(drizzled::message::Transaction *in_message)
1274
  {
1275
    transaction_message= in_message;
1276
  }
1277
1278
  /**
1279
   * Sets the active statement message used by the ReplicationServices
1280
   * component.
1281
   *
1282
   * @param[in] Pointer to the message
1283
   */
1284
  void setStatementMessage(drizzled::message::Statement *in_message)
1285
  {
1286
    statement_message= in_message;
1287
  }
971.3.6 by Eric Day
Moved the last of the libdrizzleclient calls into Protocol.
1288
private:
1143.2.10 by Jay Pipes
Phase 2 new replication work:
1289
  /** Pointers to memory managed by the ReplicationServices component */
1290
  drizzled::message::Transaction *transaction_message;
1291
  drizzled::message::Statement *statement_message;
1055.3.6 by Jay Pipes
Adds public getConnectMicroseconds() call to Session object. Protects connect_microseconds member variable and sets it correctly. Corrects logging_xxx plugins to use getConnectMicroseconds() API call properly. Fixes Bug #402855
1292
  /** Microsecond timestamp of when Session connected */
1293
  uint64_t connect_microseconds;
322.2.2 by Mats Kindahl
Hiding THD::proc_info field and providing a setter and getter.
1294
  const char *proc_info;
1295
1 by brian
clean slate
1296
  /** The current internal error handler for this thread, or NULL. */
1297
  Internal_error_handler *m_internal_handler;
1298
  /**
1299
    The lex to hold the parsed tree of conventional (non-prepared) queries.
1300
    Whereas for prepared and stored procedure statements we use an own lex
1301
    instance for each new query, for conventional statements we reuse
1302
    the same lex. (@see mysql_parse for details).
1303
  */
1304
  LEX main_lex;
1305
  /**
1306
    This memory root is used for two purposes:
1307
    - for conventional queries, to allocate structures stored in main_lex
1308
    during parsing, and allocate runtime data (execution plan, etc.)
1309
    during execution.
1310
    - for prepared queries, only to allocate runtime data. The parsed
1311
    tree itself is reused between executions and thus is stored elsewhere.
1312
  */
1313
  MEM_ROOT main_mem_root;
836 by Brian Aker
Fixed session call from function to method.
1314
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
1315
  /**
1316
   * Marks all tables in the list which were used by current substatement
1317
   * as free for reuse.
1318
   *
1319
   * @param Head of the list of tables
1320
   *
1321
   * @note
1322
   *
1323
   * The reason we reset query_id is that it's not enough to just test
1324
   * if table->query_id != session->query_id to know if a table is in use.
1325
   *
1326
   * For example
1327
   * 
1328
   *  SELECT f1_that_uses_t1() FROM t1;
1329
   *  
1330
   * In f1_that_uses_t1() we will see one instance of t1 where query_id is
1331
   * set to query_id of original query.
1332
   */
1039.1.16 by Brian Aker
A lot of little cleanups (most based off lcov)
1333
  void mark_used_tables_as_free_for_reuse(Table *table);
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
1334
  /**
1335
    Mark all temporary tables which were used by the current statement or
1336
    substatement as free for reuse, but only if the query_id can be cleared.
1337
1338
    @param session thread context
1339
1340
    @remark For temp tables associated with a open SQL HANDLER the query_id
1341
            is not reset until the HANDLER is closed.
1342
  */
1039.1.16 by Brian Aker
A lot of little cleanups (most based off lcov)
1343
  void mark_temp_tables_as_free_for_reuse();
1344
836 by Brian Aker
Fixed session call from function to method.
1345
public:
1046.1.4 by Brian Aker
Move lazy read of refresh to outside of LOCK_open (we don't lock the refresh
1346
836 by Brian Aker
Fixed session call from function to method.
1347
  /** A short cut for session->main_da.set_ok_status(). */
971.3.59 by Eric Day
Removed client_capabilities from session and pushed functionality into protocol plugin.
1348
  inline void my_ok(ha_rows affected_rows= 0, ha_rows found_rows_arg= 0,
1349
                    uint64_t passed_id= 0, const char *message= NULL)
836 by Brian Aker
Fixed session call from function to method.
1350
  {
971.3.59 by Eric Day
Removed client_capabilities from session and pushed functionality into protocol plugin.
1351
    main_da.set_ok_status(this, affected_rows, found_rows_arg, passed_id, message);
836 by Brian Aker
Fixed session call from function to method.
1352
  }
1353
1354
1355
  /** A short cut for session->main_da.set_eof_status(). */
1356
1357
  inline void my_eof()
1358
  {
1359
    main_da.set_eof_status(this);
1360
  }
838 by Brian Aker
More class adoption/method
1361
1362
  /* Some inline functions for more speed */
1363
1364
  inline bool add_item_to_list(Item *item)
1365
  {
1366
    return lex->current_select->add_item_to_list(this, item);
1367
  }
1368
1369
  inline bool add_value_to_list(Item *value)
1370
  {
1371
    return lex->value_list.push_back(value);
1372
  }
1373
1374
  inline bool add_order_to_list(Item *item, bool asc)
1375
  {
1376
    return lex->current_select->add_order_to_list(this, item, asc);
1377
  }
1378
1379
  inline bool add_group_to_list(Item *item, bool asc)
1380
  {
1381
    return lex->current_select->add_group_to_list(this, item, asc);
1382
  }
855 by Brian Aker
Refactor reset of status.
1383
  void refresh_status();
995 by Brian Aker
Refactor get_variable to session
1384
  user_var_entry *getVariable(LEX_STRING &name, bool create_if_not_exists);
1046.1.14 by Brian Aker
More redactoring of all lock issue code that is session bound, to be a
1385
  
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
1386
  /**
1387
   * Closes all tables used by the current substatement, or all tables
1388
   * used by this thread if we are on the upper level.
1389
   */
1039.1.16 by Brian Aker
A lot of little cleanups (most based off lcov)
1390
  void close_thread_tables();
1089.1.7 by Brian Aker
Shuffled free_cached_table() to table
1391
  void close_old_data_files(bool morph_locks= false,
1392
                            bool send_refresh= false);
1046.1.14 by Brian Aker
More redactoring of all lock issue code that is session bound, to be a
1393
  void close_open_tables();
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1394
  void close_data_files_and_morph_locks(const char *db, const char *table_name);
1089.1.7 by Brian Aker
Shuffled free_cached_table() to table
1395
1396
private:
1397
  bool free_cached_table();
1398
public:
1399
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
1400
  /**
1401
   * Prepares statement for reopening of tables and recalculation of set of
1402
   * prelocked tables.
1403
   *
1404
   * @param Pointer to a pointer to a list of tables which we were trying to open and lock
1405
   */
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1406
  void close_tables_for_reopen(TableList **tables);
1089.1.7 by Brian Aker
Shuffled free_cached_table() to table
1407
1408
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
1409
  /**
1410
   * Open all tables in list, locks them (all, including derived)
1411
   *
1412
   * @param Pointer to a list of tables for open & locking
1413
   *
1414
   * @retval
1415
   *  false - ok
1416
   * @retval
1417
   *  true  - error
1418
   *
1419
   * @note
1420
   * 
1421
   * The lock will automaticaly be freed by close_thread_tables()
1422
   */
1109.1.3 by Brian Aker
Move names around a bit (to align similar methods)
1423
  bool openTablesLock(TableList *tables);
1109.1.2 by Brian Aker
More from the table patch
1424
1055.2.24 by Jay Pipes
Merge with trunk and resolve conflicts.
1425
  /**
1426
   * Open all tables in list and process derived tables
1427
   *
1428
   * @param Pointer to a list of tables for open
1429
   * @param Bitmap of flags to modify how the tables will be open:
1430
   *        DRIZZLE_LOCK_IGNORE_FLUSH - open table even if someone has
1431
   *        done a flush or namelock on it.
1432
   *
1433
   * @retval
1434
   *  false - ok
1435
   * @retval
1436
   *  true  - error
1437
   *
1438
   * @note
1439
   *
1440
   * This is to be used on prepare stage when you don't read any
1441
   * data from the tables.
1442
   */
1109.1.3 by Brian Aker
Move names around a bit (to align similar methods)
1443
  bool openTables(TableList *tables, uint32_t flags= 0);
1109.1.2 by Brian Aker
More from the table patch
1444
1445
  int open_tables_from_list(TableList **start, uint32_t *counter, uint32_t flags= 0);
1109.1.3 by Brian Aker
Move names around a bit (to align similar methods)
1446
1447
  Table *openTableLock(TableList *table_list, thr_lock_type lock_type);
1448
  Table *openTable(TableList *table_list, bool *refresh, uint32_t flags= 0);
1449
1054.1.11 by Brian Aker
Remove dead lock.cc commands.
1450
  void unlink_open_table(Table *find);
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1451
  void drop_open_table(Table *table, const char *db_name,
1452
                       const char *table_name);
1054.1.11 by Brian Aker
Remove dead lock.cc commands.
1453
  void close_cached_table(Table *table);
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1454
1455
  /* Create a lock in the cache */
1456
  Table *table_cache_insert_placeholder(const char *key, uint32_t key_length);
1457
  bool lock_table_name_if_not_cached(const char *db, 
1458
                                     const char *table_name, Table **table);
1459
1460
  /* Work with temporary tables */
1461
  Table *find_temporary_table(TableList *table_list);
1462
  Table *find_temporary_table(const char *db, const char *table_name);
1046.1.14 by Brian Aker
More redactoring of all lock issue code that is session bound, to be a
1463
  void close_temporary_tables();
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1464
  void close_temporary_table(Table *table, bool free_share, bool delete_table);
1109.1.1 by Brian Aker
Applying refactor of tmp table bits back to session. (this all needs to be
1465
  void close_temporary(Table *table, bool free_share, bool delete_table);
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1466
  int drop_temporary_table(TableList *table_list);
1130.1.4 by Monty Taylor
Moved StorageEngine into plugin namespace.
1467
  bool rm_temporary_table(drizzled::plugin::StorageEngine *base, char *path);
1109.1.1 by Brian Aker
Applying refactor of tmp table bits back to session. (this all needs to be
1468
  Table *open_temporary_table(const char *path, const char *db,
1217.1.1 by Brian Aker
Remove open_table_mode (no longer in use).
1469
                              const char *table_name, bool link_in_list);
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1470
  
1471
  /* Reopen operations */
1046.1.14 by Brian Aker
More redactoring of all lock issue code that is session bound, to be a
1472
  bool reopen_tables(bool get_locks, bool mark_share_as_old);
1054.1.9 by Brian Aker
This is a large number of refactors against the Session class for its
1473
  bool reopen_name_locked_table(TableList* table_list, bool link_in);
1109.1.4 by Brian Aker
More Table refactor
1474
  bool close_cached_tables(TableList *tables, bool wait_for_refresh, bool wait_for_placeholders);
1054.1.10 by Brian Aker
Move open_table() to session.
1475
1476
  void wait_for_condition(pthread_mutex_t *mutex, pthread_cond_t *cond);
1109.1.5 by Brian Aker
More extraction from sql_base
1477
  int setup_conds(TableList *leaves, COND **conds);
1478
  int lock_tables(TableList *tables, uint32_t count, bool *need_reopen);
1183.1.1 by Brian Aker
Rework interface pieces on SE (sort of... dumb ones...)
1479
1480
1481
  /**
1482
    Return the default storage engine
1483
1484
    @param getDefaultStorageEngine()
1485
1486
    @return
1487
    pointer to plugin::StorageEngine
1488
  */
1489
  drizzled::plugin::StorageEngine *getDefaultStorageEngine()
1490
  {
1491
    if (variables.storage_engine)
1492
      return variables.storage_engine;
1493
    return global_system_variables.storage_engine;
1494
  };
1 by brian
clean slate
1495
};
1496
1497
class JOIN;
1498
1499
#define ESCAPE_CHARS "ntrb0ZN" // keep synchronous with READ_INFO::unescape
1500
850 by Brian Aker
More class creation.
1501
#include <drizzled/select_to_file.h>
1502
#include <drizzled/select_export.h>
1503
#include <drizzled/select_dump.h>
1504
#include <drizzled/select_insert.h>
1505
#include <drizzled/select_create.h>
992.1.25 by Monty Taylor
Moved myisam to new plugin system.
1506
#include <plugin/myisam/myisam.h>
851 by Brian Aker
Class rewrite of Session (aka get all of the junk out)
1507
#include <drizzled/tmp_table_param.h>
1508
#include <drizzled/select_union.h>
1509
#include <drizzled/select_subselect.h>
1510
#include <drizzled/select_singlerow_subselect.h>
1511
#include <drizzled/select_max_min_finder_subselect.h>
1512
#include <drizzled/select_exists_subselect.h>
1 by brian
clean slate
1513
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
1514
/**
1515
 * A structure used to describe sort information
1516
 * for a field or item used in ORDER BY.
1517
 */
1518
typedef struct st_sort_field 
1519
{
1520
  Field *field;	/**< Field to sort */
1521
  Item	*item; /**< Item if not sorting fields */
1522
  size_t length; /**< Length of sort field */
1523
  uint32_t suffix_length; /**< Length suffix (0-4) */
1524
  Item_result result_type; /**< Type of item */
1525
  bool reverse; /**< if descending sort */
1526
  bool need_strxnfrm;	/**< If we have to use strxnfrm() */
1 by brian
clean slate
1527
} SORT_FIELD;
1528
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
1529
typedef struct st_sort_buffer 
1530
{
1531
  uint32_t index;	/* 0 or 1 */
482 by Brian Aker
Remove uint.
1532
  uint32_t sort_orders;
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
1533
  uint32_t change_pos; /* If sort-fields changed */
1 by brian
clean slate
1534
  char **buff;
1535
  SORT_FIELD *sortorder;
1536
} SORT_BUFFER;
1537
851 by Brian Aker
Class rewrite of Session (aka get all of the junk out)
1538
#include <drizzled/table_ident.h>
1539
#include <drizzled/user_var_entry.h>
1540
#include <drizzled/unique.h>
1541
#include <drizzled/my_var.h>
1542
#include <drizzled/select_dumpvar.h>
1 by brian
clean slate
1543
1544
/* Bits in sql_command_flags */
1545
1055.2.13 by Jay Pipes
Documentation and style fixes in Session class. Doxygen should finally pick up the Statement and Session classes now. Removes the silly Query_arena class, as it's not needed anymore.
1546
enum sql_command_flag_bits 
1547
{
590.2.17 by Monty Taylor
Changed CF_BIT_* to an enum.
1548
  CF_BIT_CHANGES_DATA,
1549
  CF_BIT_HAS_ROW_COUNT,
1550
  CF_BIT_STATUS_COMMAND,
1551
  CF_BIT_SHOW_TABLE_COMMAND,
590.2.18 by Monty Taylor
Changed the bitset<32> to a bitset<5>. Made the int constants into bitset constants.
1552
  CF_BIT_WRITE_LOGS_COMMAND,
1553
  CF_BIT_SIZE
590.2.17 by Monty Taylor
Changed CF_BIT_* to an enum.
1554
};
602.2.2 by Yoshinori Sano
Fix bugs in params of sql_command_flags[...].test(). Previously, the value such as, 0, 1, 2, 4, 8 and 16 is given to std::bitset.test() in that place, which is misunderstanding of the spec of the test(). The test(size_t n) returns true if bit n is set.
1555
590.2.18 by Monty Taylor
Changed the bitset<32> to a bitset<5>. Made the int constants into bitset constants.
1556
static const std::bitset<CF_BIT_SIZE> CF_CHANGES_DATA(1 << CF_BIT_CHANGES_DATA);
1557
static const std::bitset<CF_BIT_SIZE> CF_HAS_ROW_COUNT(1 << CF_BIT_HAS_ROW_COUNT);
1558
static const std::bitset<CF_BIT_SIZE> CF_STATUS_COMMAND(1 << CF_BIT_STATUS_COMMAND);
1559
static const std::bitset<CF_BIT_SIZE> CF_SHOW_TABLE_COMMAND(1 << CF_BIT_SHOW_TABLE_COMMAND);
1560
static const std::bitset<CF_BIT_SIZE> CF_WRITE_LOGS_COMMAND(1 << CF_BIT_WRITE_LOGS_COMMAND);
1 by brian
clean slate
1561
1562
/* Functions in sql_class.cc */
1563
void add_to_status(STATUS_VAR *to_var, STATUS_VAR *from_var);
1564
1565
void add_diff_to_status(STATUS_VAR *to_var, STATUS_VAR *from_var,
1566
                        STATUS_VAR *dec_var);
1567
897.2.2 by Jay Pipes
Replaced custom List in select_dumpvar.h with std::vector<>
1568
#endif /* DRIZZLED_SESSION_H */