handler.h 79 KB
Newer Older
1 2 3
#ifndef HANDLER_INCLUDED
#define HANDLER_INCLUDED

4
/* Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
5

6 7 8 9
   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; version 2 of
   the License.
10

unknown's avatar
unknown committed
11 12
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
13
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
unknown's avatar
unknown committed
14
   GNU General Public License for more details.
15

unknown's avatar
unknown committed
16 17
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
18 19
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   02110-1301  USA */
unknown's avatar
unknown committed
20 21 22

/* Definitions for parameters to do with handler-routines */

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

27 28 29 30 31 32 33
#include "sql_const.h"
#include "mysqld.h"                             /* server_id */
#include "sql_plugin.h"        /* plugin_ref, st_plugin_int, plugin */
#include "thr_lock.h"          /* thr_lock_type, THR_LOCK_DATA */
#include "sql_cache.h"
#include "structs.h"                            /* SHOW_COMP_OPTION */

34
#include <my_compare.h>
unknown's avatar
unknown committed
35
#include <ft_global.h>
unknown's avatar
unknown committed
36
#include <keycache.h>
unknown's avatar
unknown committed
37

unknown's avatar
unknown committed
38 39
// the following is for checking tables

40 41 42 43 44 45
#define HA_ADMIN_ALREADY_DONE	  1
#define HA_ADMIN_OK               0
#define HA_ADMIN_NOT_IMPLEMENTED -1
#define HA_ADMIN_FAILED		 -2
#define HA_ADMIN_CORRUPT         -3
#define HA_ADMIN_INTERNAL_ERROR  -4
unknown's avatar
unknown committed
46
#define HA_ADMIN_INVALID         -5
unknown's avatar
unknown committed
47
#define HA_ADMIN_REJECT          -6
48
#define HA_ADMIN_TRY_ALTER       -7
49
#define HA_ADMIN_WRONG_CHECKSUM  -8
unknown's avatar
unknown committed
50
#define HA_ADMIN_NOT_BASE_TABLE  -9
unknown's avatar
unknown committed
51 52 53
#define HA_ADMIN_NEEDS_UPGRADE  -10
#define HA_ADMIN_NEEDS_ALTER    -11
#define HA_ADMIN_NEEDS_CHECK    -12
unknown's avatar
unknown committed
54

55
/* Bits in table_flags() to show what database can do */
56

57 58 59
#define HA_NO_TRANSACTIONS     (1 << 0) /* Doesn't support transactions */
#define HA_PARTIAL_COLUMN_READ (1 << 1) /* read may not return all columns */
#define HA_TABLE_SCAN_ON_INDEX (1 << 2) /* No separate data/index file */
60
/*
61 62 63 64
  The following should be set if the following is not true when scanning
  a table with rnd_next()
  - We will see all rows (including deleted ones)
  - Row positions are 'table->s->db_record_offset' apart
65
  If this flag is not set, filesort will do a position() call for each matched
66
  row to be able to find the row later.
67
*/
68
#define HA_REC_NOT_IN_SEQ      (1 << 3)
unknown's avatar
unknown committed
69
#define HA_CAN_GEOMETRY        (1 << 4)
70 71 72 73 74 75
/*
  Reading keys in random order is as fast as reading keys in sort order
  (Used in records.cc to decide if we should use a record cache and by
  filesort to decide if we should sort key + data or key + pointer-to-row
*/
#define HA_FAST_KEY_READ       (1 << 5)
76 77 78 79 80
/*
  Set the following flag if we on delete should force all key to be read
  and on update read all keys that changes
*/
#define HA_REQUIRES_KEY_COLUMNS_FOR_DELETE (1 << 6)
unknown's avatar
unknown committed
81
#define HA_NULL_IN_KEY         (1 << 7) /* One can have keys with NULL */
82
#define HA_DUPLICATE_POS       (1 << 8)    /* ha_position() gives dup row */
unknown's avatar
unknown committed
83
#define HA_NO_BLOBS            (1 << 9) /* Doesn't support blobs */
unknown's avatar
unknown committed
84 85 86
#define HA_CAN_INDEX_BLOBS     (1 << 10)
#define HA_AUTO_PART_KEY       (1 << 11) /* auto-increment in multi-part key */
#define HA_REQUIRE_PRIMARY_KEY (1 << 12) /* .. and can't create a hidden one */
87
#define HA_STATS_RECORDS_IS_EXACT (1 << 13) /* stats.records is exact */
88 89 90 91 92
/*
  INSERT_DELAYED only works with handlers that uses MySQL internal table
  level locks
*/
#define HA_CAN_INSERT_DELAYED  (1 << 14)
93 94 95 96 97
/*
  If we get the primary key columns for free when we do an index read
  It also implies that we have to retrive the primary key when using
  position() and rnd_pos().
*/
unknown's avatar
unknown committed
98
#define HA_PRIMARY_KEY_IN_READ_INDEX (1 << 15)
99
/*
100
  If HA_PRIMARY_KEY_REQUIRED_FOR_POSITION is set, it means that to position()
101 102 103 104
  uses a primary key given by the record argument.
  Without primary key, we can't call position().
  If not set, the position is returned as the current rows position
  regardless of what argument is given.
105
*/ 
106
#define HA_PRIMARY_KEY_REQUIRED_FOR_POSITION (1 << 16) 
107
#define HA_CAN_RTREEKEYS       (1 << 17)
unknown's avatar
unknown committed
108
#define HA_NOT_DELETE_WITH_CACHE (1 << 18)
109 110 111 112 113
/*
  The following is we need to a primary key to delete (and update) a row.
  If there is no primary key, all columns needs to be read on update and delete
*/
#define HA_PRIMARY_KEY_REQUIRED_FOR_DELETE (1 << 19)
unknown's avatar
unknown committed
114 115 116 117 118
#define HA_NO_PREFIX_CHAR_KEYS (1 << 20)
#define HA_CAN_FULLTEXT        (1 << 21)
#define HA_CAN_SQL_HANDLER     (1 << 22)
#define HA_NO_AUTO_INCREMENT   (1 << 23)
#define HA_HAS_CHECKSUM        (1 << 24)
unknown's avatar
unknown committed
119
/* Table data are stored in separate files (for lower_case_table_names) */
unknown's avatar
unknown committed
120
#define HA_FILE_BASED	       (1 << 26)
121
#define HA_NO_VARCHAR	       (1 << 27)
unknown's avatar
unknown committed
122
#define HA_CAN_BIT_FIELD       (1 << 28) /* supports bit fields */
unknown's avatar
unknown committed
123
#define HA_NEED_READ_RANGE_BUFFER (1 << 29) /* for read_multi_range */
124
#define HA_ANY_INDEX_MAY_BE_UNIQUE (1 << 30)
125 126
#define HA_NO_COPY_ON_ALTER    (LL(1) << 31)
#define HA_HAS_RECORDS	       (LL(1) << 32) /* records() gives exact count*/
127 128
/* Has it's own method of binlog logging */
#define HA_HAS_OWN_BINLOGGING  (LL(1) << 33)
129 130 131 132 133 134
/*
  Engine is capable of row-format and statement-format logging,
  respectively
*/
#define HA_BINLOG_ROW_CAPABLE  (LL(1) << 34)
#define HA_BINLOG_STMT_CAPABLE (LL(1) << 35)
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
/*
    When a multiple key conflict happens in a REPLACE command mysql
    expects the conflicts to be reported in the ascending order of
    key names.

    For e.g.

    CREATE TABLE t1 (a INT, UNIQUE (a), b INT NOT NULL, UNIQUE (b), c INT NOT
                     NULL, INDEX(c));

    REPLACE INTO t1 VALUES (1,1,1),(2,2,2),(2,1,3);

    MySQL expects the conflict with 'a' to be reported before the conflict with
    'b'.

    If the underlying storage engine does not report the conflicting keys in
    ascending order, it causes unexpected errors when the REPLACE command is
    executed.

    This flag helps the underlying SE to inform the server that the keys are not
    ordered.
*/
#define HA_DUPLICATE_KEY_NOT_IN_ORDER    (LL(1) << 36)
158 159 160 161 162 163
/*
  Engine supports REPAIR TABLE. Used by CHECK TABLE FOR UPGRADE if an
  incompatible table is detected. If this flag is set, CHECK TABLE FOR UPGRADE
  will report ER_TABLE_NEEDS_UPGRADE, otherwise ER_TABLE_NEED_REBUILD.
*/
#define HA_CAN_REPAIR                    (LL(1) << 37)
164 165 166 167 168 169

/*
  Set of all binlog flags. Currently only contain the capabilities
  flags.
 */
#define HA_BINLOG_FLAGS (HA_BINLOG_ROW_CAPABLE | HA_BINLOG_STMT_CAPABLE)
unknown's avatar
unknown committed
170

171
/* bits in index_flags(index_number) for what you can do with index */
unknown's avatar
unknown committed
172 173 174 175
#define HA_READ_NEXT            1       /* TODO really use this flag */
#define HA_READ_PREV            2       /* supports ::index_prev */
#define HA_READ_ORDER           4       /* index_next/prev follow sort order */
#define HA_READ_RANGE           8       /* can find all records in a range */
176
#define HA_ONLY_WHOLE_INDEX	16	/* Can't use part key searches */
unknown's avatar
unknown committed
177
#define HA_KEYREAD_ONLY         64	/* Support HA_EXTRA_KEYREAD */
178

unknown's avatar
unknown committed
179 180 181
/*
  bits in alter_table_flags:
*/
182
/*
183 184 185 186
  These bits are set if different kinds of indexes can be created or dropped
  in-place without re-creating the table using a temporary table.
  NO_READ_WRITE indicates that the handler needs concurrent reads and writes
  of table data to be blocked.
187 188
  Partitioning needs both ADD and DROP to be supported by its underlying
  handlers, due to error handling, see bug#57778.
189
*/
190 191 192 193 194 195
#define HA_INPLACE_ADD_INDEX_NO_READ_WRITE         (1L << 0)
#define HA_INPLACE_DROP_INDEX_NO_READ_WRITE        (1L << 1)
#define HA_INPLACE_ADD_UNIQUE_INDEX_NO_READ_WRITE  (1L << 2)
#define HA_INPLACE_DROP_UNIQUE_INDEX_NO_READ_WRITE (1L << 3)
#define HA_INPLACE_ADD_PK_INDEX_NO_READ_WRITE      (1L << 4)
#define HA_INPLACE_DROP_PK_INDEX_NO_READ_WRITE     (1L << 5)
196
/*
197 198 199 200
  These are set if different kinds of indexes can be created or dropped
  in-place while still allowing concurrent reads (but not writes) of table
  data. If a handler is capable of one or more of these, it should also set
  the corresponding *_NO_READ_WRITE bit(s).
201
*/
202 203 204 205 206 207
#define HA_INPLACE_ADD_INDEX_NO_WRITE              (1L << 6)
#define HA_INPLACE_DROP_INDEX_NO_WRITE             (1L << 7)
#define HA_INPLACE_ADD_UNIQUE_INDEX_NO_WRITE       (1L << 8)
#define HA_INPLACE_DROP_UNIQUE_INDEX_NO_WRITE      (1L << 9)
#define HA_INPLACE_ADD_PK_INDEX_NO_WRITE           (1L << 10)
#define HA_INPLACE_DROP_PK_INDEX_NO_WRITE          (1L << 11)
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
/*
  HA_PARTITION_FUNCTION_SUPPORTED indicates that the function is
  supported at all.
  HA_FAST_CHANGE_PARTITION means that optimised variants of the changes
  exists but they are not necessarily done online.

  HA_ONLINE_DOUBLE_WRITE means that the handler supports writing to both
  the new partition and to the old partitions when updating through the
  old partitioning schema while performing a change of the partitioning.
  This means that we can support updating of the table while performing
  the copy phase of the change. For no lock at all also a double write
  from new to old must exist and this is not required when this flag is
  set.
  This is actually removed even before it was introduced the first time.
  The new idea is that handlers will handle the lock level already in
  store_lock for ALTER TABLE partitions.

  HA_PARTITION_ONE_PHASE is a flag that can be set by handlers that take
  care of changing the partitions online and in one phase. Thus all phases
  needed to handle the change are implemented inside the storage engine.
  The storage engine must also support auto-discovery since the frm file
  is changed as part of the change and this change must be controlled by
  the storage engine. A typical engine to support this is NDB (through
  WL #2498).
*/
#define HA_PARTITION_FUNCTION_SUPPORTED         (1L << 12)
#define HA_FAST_CHANGE_PARTITION                (1L << 13)
#define HA_PARTITION_ONE_PHASE                  (1L << 14)
unknown's avatar
unknown committed
236

237 238 239 240 241 242
/*
  Index scan will not return records in rowid order. Not guaranteed to be
  set for unordered (e.g. HASH) indexes.
*/
#define HA_KEY_SCAN_NOT_ROR     128 

243 244 245 246 247 248
/* operations for disable/enable indexes */
#define HA_KEY_SWITCH_NONUNIQ      0
#define HA_KEY_SWITCH_ALL          1
#define HA_KEY_SWITCH_NONUNIQ_SAVE 2
#define HA_KEY_SWITCH_ALL_SAVE     3

249 250
/*
  Note: the following includes binlog and closing 0.
251 252 253
  so: innodb + bdb + ndb + binlog + myisam + myisammrg + archive +
      example + csv + heap + blackhole + federated + 0
  (yes, the sum is deliberately inaccurate)
unknown's avatar
unknown committed
254
  TODO remove the limit, use dynarrays
255
*/
256
#define MAX_HA 15
257

258 259 260 261 262 263 264
/*
  Use this instead of 0 as the initial value for the slot number of
  handlerton, so that we can distinguish uninitialized slot number
  from slot 0.
*/
#define HA_SLOT_UNDEF ((uint)-1)

265 266 267 268
/*
  Parameters for open() (in register form->filestat)
  HA_GET_INFO does an implicit HA_ABORT_IF_LOCKED
*/
unknown's avatar
unknown committed
269 270 271 272 273 274

#define HA_OPEN_KEYFILE		1
#define HA_OPEN_RNDFILE		2
#define HA_GET_INDEX		4
#define HA_GET_INFO		8	/* do a ha_info() after open */
#define HA_READ_ONLY		16	/* File opened as readonly */
275 276
/* Try readonly if can't open with read and write */
#define HA_TRY_READ_ONLY	32
unknown's avatar
unknown committed
277 278 279 280 281 282 283 284 285 286 287
#define HA_WAIT_IF_LOCKED	64	/* Wait if locked on open */
#define HA_ABORT_IF_LOCKED	128	/* skip if locked on open.*/
#define HA_BLOCK_LOCK		256	/* unlock when reading some records */
#define HA_OPEN_TEMPORARY	512

	/* Some key definitions */
#define HA_KEY_NULL_LENGTH	1
#define HA_KEY_BLOB_LENGTH	2

#define HA_LEX_CREATE_TMP_TABLE	1
#define HA_LEX_CREATE_IF_NOT_EXISTS 2
unknown's avatar
unknown committed
288
#define HA_LEX_CREATE_TABLE_LIKE 4
unknown's avatar
unknown committed
289 290 291 292
#define HA_OPTION_NO_CHECKSUM	(1L << 17)
#define HA_OPTION_NO_DELAY_KEY_WRITE (1L << 18)
#define HA_MAX_REC_LENGTH	65535

293 294
/* Table caching type */
#define HA_CACHE_TBL_NONTRANSACT 0
295 296 297 298
#define HA_CACHE_TBL_NOCACHE     1
#define HA_CACHE_TBL_ASKTRANSACT 2
#define HA_CACHE_TBL_TRANSACT    4

299 300
/* Options of START TRANSACTION statement (and later of SET TRANSACTION stmt) */
#define MYSQL_START_TRANS_OPT_WITH_CONS_SNAPSHOT 1
301

302 303 304 305 306
/* Flags for method is_fatal_error */
#define HA_CHECK_DUP_KEY 1
#define HA_CHECK_DUP_UNIQUE 2
#define HA_CHECK_DUP (HA_CHECK_DUP_KEY + HA_CHECK_DUP_UNIQUE)

unknown's avatar
unknown committed
307
enum legacy_db_type
308
{
unknown's avatar
unknown committed
309 310 311 312
  DB_TYPE_UNKNOWN=0,DB_TYPE_DIAB_ISAM=1,
  DB_TYPE_HASH,DB_TYPE_MISAM,DB_TYPE_PISAM,
  DB_TYPE_RMS_ISAM, DB_TYPE_HEAP, DB_TYPE_ISAM,
  DB_TYPE_MRG_ISAM, DB_TYPE_MYISAM, DB_TYPE_MRG_MYISAM,
313
  DB_TYPE_BERKELEY_DB, DB_TYPE_INNODB,
unknown's avatar
unknown committed
314
  DB_TYPE_GEMINI, DB_TYPE_NDBCLUSTER,
315
  DB_TYPE_EXAMPLE_DB, DB_TYPE_ARCHIVE_DB, DB_TYPE_CSV_DB,
316
  DB_TYPE_FEDERATED_DB,
317
  DB_TYPE_BLACKHOLE_DB,
318
  DB_TYPE_PARTITION_DB,
319
  DB_TYPE_BINLOG,
320 321 322 323
  DB_TYPE_SOLID,
  DB_TYPE_PBXT,
  DB_TYPE_TABLE_FUNCTION,
  DB_TYPE_MEMCACHE,
324
  DB_TYPE_FALCON,
325
  DB_TYPE_MARIA,
Marc Alff's avatar
Marc Alff committed
326 327
  /** Performance schema engine. */
  DB_TYPE_PERFORMANCE_SCHEMA,
328
  DB_TYPE_FIRST_DYNAMIC=42,
unknown's avatar
unknown committed
329
  DB_TYPE_DEFAULT=127 // Must be last
unknown's avatar
unknown committed
330
};
unknown's avatar
unknown committed
331

332
enum row_type { ROW_TYPE_NOT_USED=-1, ROW_TYPE_DEFAULT, ROW_TYPE_FIXED,
333
		ROW_TYPE_DYNAMIC, ROW_TYPE_COMPRESSED,
334 335 336
		ROW_TYPE_REDUNDANT, ROW_TYPE_COMPACT,
                /** Unused. Reserved for future versions. */
                ROW_TYPE_PAGE };
unknown's avatar
unknown committed
337

unknown's avatar
unknown committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
enum enum_binlog_func {
  BFN_RESET_LOGS=        1,
  BFN_RESET_SLAVE=       2,
  BFN_BINLOG_WAIT=       3,
  BFN_BINLOG_END=        4,
  BFN_BINLOG_PURGE_FILE= 5
};

enum enum_binlog_command {
  LOGCOM_CREATE_TABLE,
  LOGCOM_ALTER_TABLE,
  LOGCOM_RENAME_TABLE,
  LOGCOM_DROP_TABLE,
  LOGCOM_CREATE_DB,
  LOGCOM_ALTER_DB,
  LOGCOM_DROP_DB
};

unknown's avatar
unknown committed
356 357 358
/* struct to hold information about the table that should be created */

/* Bits in used_fields */
359
#define HA_CREATE_USED_AUTO             (1L << 0)
360
#define HA_CREATE_USED_RAID             (1L << 1) //RAID is no longer availble
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
#define HA_CREATE_USED_UNION            (1L << 2)
#define HA_CREATE_USED_INSERT_METHOD    (1L << 3)
#define HA_CREATE_USED_MIN_ROWS         (1L << 4)
#define HA_CREATE_USED_MAX_ROWS         (1L << 5)
#define HA_CREATE_USED_AVG_ROW_LENGTH   (1L << 6)
#define HA_CREATE_USED_PACK_KEYS        (1L << 7)
#define HA_CREATE_USED_CHARSET          (1L << 8)
#define HA_CREATE_USED_DEFAULT_CHARSET  (1L << 9)
#define HA_CREATE_USED_DATADIR          (1L << 10)
#define HA_CREATE_USED_INDEXDIR         (1L << 11)
#define HA_CREATE_USED_ENGINE           (1L << 12)
#define HA_CREATE_USED_CHECKSUM         (1L << 13)
#define HA_CREATE_USED_DELAY_KEY_WRITE  (1L << 14)
#define HA_CREATE_USED_ROW_FORMAT       (1L << 15)
#define HA_CREATE_USED_COMMENT          (1L << 16)
#define HA_CREATE_USED_PASSWORD         (1L << 17)
377
#define HA_CREATE_USED_CONNECTION       (1L << 18)
378
#define HA_CREATE_USED_KEY_BLOCK_SIZE   (1L << 19)
379
/** Unused. Reserved for future versions. */
380
#define HA_CREATE_USED_TRANSACTIONAL    (1L << 20)
381
/** Unused. Reserved for future versions. */
382
#define HA_CREATE_USED_PAGE_CHECKSUM    (1L << 21)
unknown's avatar
unknown committed
383

384
typedef ulonglong my_xid; // this line is the same as in log_event.h
385 386 387 388
#define MYSQL_XID_PREFIX "MySQLXid"
#define MYSQL_XID_PREFIX_LEN 8 // must be a multiple of 8
#define MYSQL_XID_OFFSET (MYSQL_XID_PREFIX_LEN+sizeof(server_id))
#define MYSQL_XID_GTRID_LEN (MYSQL_XID_OFFSET+sizeof(my_xid))
389

390
#define XIDDATASIZE MYSQL_XIDDATASIZE
391 392 393
#define MAXGTRIDSIZE 64
#define MAXBQUALSIZE 64

unknown's avatar
unknown committed
394 395 396
#define COMPATIBLE_DATA_YES 0
#define COMPATIBLE_DATA_NO  1

397 398 399 400 401 402 403 404
/**
  struct xid_t is binary compatible with the XID structure as
  in the X/Open CAE Specification, Distributed Transaction Processing:
  The XA Specification, X/Open Company Ltd., 1991.
  http://www.opengroup.org/bookstore/catalog/c193.htm

  @see MYSQL_XID in mysql/plugin.h
*/
405 406 407 408
struct xid_t {
  long formatID;
  long gtrid_length;
  long bqual_length;
409
  char data[XIDDATASIZE];  // not \0-terminated !
410

411
  xid_t() {}                                /* Remove gcc warning */  
unknown's avatar
unknown committed
412
  bool eq(struct xid_t *xid)
413
  { return eq(xid->gtrid_length, xid->bqual_length, xid->data); }
414 415
  bool eq(long g, long b, const char *d)
  { return g == gtrid_length && b == bqual_length && !memcmp(d, data, g+b); }
unknown's avatar
unknown committed
416
  void set(struct xid_t *xid)
417
  { memcpy(this, xid, xid->length()); }
unknown's avatar
unknown committed
418 419 420 421 422 423
  void set(long f, const char *g, long gl, const char *b, long bl)
  {
    formatID= f;
    memcpy(data, g, gtrid_length= gl);
    memcpy(data+gl, b, bqual_length= bl);
  }
424
  void set(ulonglong xid)
425
  {
426
    my_xid tmp;
unknown's avatar
unknown committed
427
    formatID= 1;
428
    set(MYSQL_XID_PREFIX_LEN, 0, MYSQL_XID_PREFIX);
429 430 431
    memcpy(data+MYSQL_XID_PREFIX_LEN, &server_id, sizeof(server_id));
    tmp= xid;
    memcpy(data+MYSQL_XID_OFFSET, &tmp, sizeof(tmp));
432 433 434 435
    gtrid_length=MYSQL_XID_GTRID_LEN;
  }
  void set(long g, long b, const char *d)
  {
unknown's avatar
unknown committed
436
    formatID= 1;
437 438 439 440 441 442 443 444
    gtrid_length= g;
    bqual_length= b;
    memcpy(data, d, g+b);
  }
  bool is_null() { return formatID == -1; }
  void null() { formatID= -1; }
  my_xid quick_get_my_xid()
  {
445 446 447
    my_xid tmp;
    memcpy(&tmp, data+MYSQL_XID_OFFSET, sizeof(tmp));
    return tmp;
448 449 450 451 452 453 454
  }
  my_xid get_my_xid()
  {
    return gtrid_length == MYSQL_XID_GTRID_LEN && bqual_length == 0 &&
           !memcmp(data, MYSQL_XID_PREFIX, MYSQL_XID_PREFIX_LEN) ?
           quick_get_my_xid() : 0;
  }
455 456 457 458 459
  uint length()
  {
    return sizeof(formatID)+sizeof(gtrid_length)+sizeof(bqual_length)+
           gtrid_length+bqual_length;
  }
460
  uchar *key()
461
  {
462
    return (uchar *)&gtrid_length;
463 464 465 466 467
  }
  uint key_length()
  {
    return sizeof(gtrid_length)+sizeof(bqual_length)+gtrid_length+bqual_length;
  }
468
};
469 470
typedef struct xid_t XID;

471 472 473
/* for recover() handlerton call */
#define MIN_XID_LIST_SIZE  128
#define MAX_XID_LIST_SIZE  (1024*128)
474

unknown's avatar
unknown committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
/*
  These structures are used to pass information from a set of SQL commands
  on add/drop/change tablespace definitions to the proper hton.
*/
#define UNDEF_NODEGROUP 65535
enum ts_command_type
{
  TS_CMD_NOT_DEFINED = -1,
  CREATE_TABLESPACE = 0,
  ALTER_TABLESPACE = 1,
  CREATE_LOGFILE_GROUP = 2,
  ALTER_LOGFILE_GROUP = 3,
  DROP_TABLESPACE = 4,
  DROP_LOGFILE_GROUP = 5,
  CHANGE_FILE_TABLESPACE = 6,
  ALTER_ACCESS_MODE_TABLESPACE = 7
};

enum ts_alter_tablespace_type
{
  TS_ALTER_TABLESPACE_TYPE_NOT_DEFINED = -1,
  ALTER_TABLESPACE_ADD_FILE = 1,
  ALTER_TABLESPACE_DROP_FILE = 2
};

enum tablespace_access_mode
{
  TS_NOT_DEFINED= -1,
  TS_READ_ONLY = 0,
  TS_READ_WRITE = 1,
  TS_NOT_ACCESSIBLE = 2
};

508
struct handlerton;
unknown's avatar
unknown committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
class st_alter_tablespace : public Sql_alloc
{
  public:
  const char *tablespace_name;
  const char *logfile_group_name;
  enum ts_command_type ts_cmd_type;
  enum ts_alter_tablespace_type ts_alter_tablespace_type;
  const char *data_file_name;
  const char *undo_file_name;
  const char *redo_file_name;
  ulonglong extent_size;
  ulonglong undo_buffer_size;
  ulonglong redo_buffer_size;
  ulonglong initial_size;
  ulonglong autoextend_size;
  ulonglong max_size;
  uint nodegroup_id;
526
  handlerton *storage_engine;
unknown's avatar
unknown committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
  bool wait_until_completed;
  const char *ts_comment;
  enum tablespace_access_mode ts_access_mode;
  st_alter_tablespace()
  {
    tablespace_name= NULL;
    logfile_group_name= "DEFAULT_LG"; //Default log file group
    ts_cmd_type= TS_CMD_NOT_DEFINED;
    data_file_name= NULL;
    undo_file_name= NULL;
    redo_file_name= NULL;
    extent_size= 1024*1024;        //Default 1 MByte
    undo_buffer_size= 8*1024*1024; //Default 8 MByte
    redo_buffer_size= 8*1024*1024; //Default 8 MByte
    initial_size= 128*1024*1024;   //Default 128 MByte
    autoextend_size= 0;            //No autoextension as default
    max_size= 0;                   //Max size == initial size => no extension
544
    storage_engine= NULL;
unknown's avatar
unknown committed
545 546 547 548 549 550 551
    nodegroup_id= UNDEF_NODEGROUP;
    wait_until_completed= TRUE;
    ts_comment= NULL;
    ts_access_mode= TS_NOT_DEFINED;
  }
};

552 553
/* The handler for a table type.  Will be included in the TABLE structure */

Konstantin Osipov's avatar
Konstantin Osipov committed
554
struct TABLE;
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572

/*
  Make sure that the order of schema_tables and enum_schema_tables are the same.
*/
enum enum_schema_tables
{
  SCH_CHARSETS= 0,
  SCH_COLLATIONS,
  SCH_COLLATION_CHARACTER_SET_APPLICABILITY,
  SCH_COLUMNS,
  SCH_COLUMN_PRIVILEGES,
  SCH_ENGINES,
  SCH_EVENTS,
  SCH_FILES,
  SCH_GLOBAL_STATUS,
  SCH_GLOBAL_VARIABLES,
  SCH_KEY_COLUMN_USAGE,
  SCH_OPEN_TABLES,
Sergey Glukhov's avatar
Sergey Glukhov committed
573
  SCH_PARAMETERS,
574 575 576 577 578 579 580 581 582 583 584 585 586
  SCH_PARTITIONS,
  SCH_PLUGINS,
  SCH_PROCESSLIST,
  SCH_PROFILES,
  SCH_REFERENTIAL_CONSTRAINTS,
  SCH_PROCEDURES,
  SCH_SCHEMATA,
  SCH_SCHEMA_PRIVILEGES,
  SCH_SESSION_STATUS,
  SCH_SESSION_VARIABLES,
  SCH_STATISTICS,
  SCH_STATUS,
  SCH_TABLES,
587
  SCH_TABLESPACES,
588 589 590 591 592 593 594 595 596
  SCH_TABLE_CONSTRAINTS,
  SCH_TABLE_NAMES,
  SCH_TABLE_PRIVILEGES,
  SCH_TRIGGERS,
  SCH_USER_PRIVILEGES,
  SCH_VARIABLES,
  SCH_VIEWS
};

Konstantin Osipov's avatar
Konstantin Osipov committed
597
struct TABLE_SHARE;
598 599
struct st_foreign_key_info;
typedef struct st_foreign_key_info FOREIGN_KEY_INFO;
unknown's avatar
unknown committed
600 601 602
typedef bool (stat_print_fn)(THD *thd, const char *type, uint type_len,
                             const char *file, uint file_len,
                             const char *status, uint status_len);
603
enum ha_stat_type { HA_ENGINE_STATUS, HA_ENGINE_LOGS, HA_ENGINE_MUTEX };
unknown's avatar
unknown committed
604
extern st_plugin_int *hton2plugin[MAX_HA];
605

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
/* Transaction log maintains type definitions */
enum log_status
{
  HA_LOG_STATUS_FREE= 0,      /* log is free and can be deleted */
  HA_LOG_STATUS_INUSE= 1,     /* log can't be deleted because it is in use */
  HA_LOG_STATUS_NOSUCHLOG= 2  /* no such log (can't be returned by
                                the log iterator status) */
};
/*
  Function for signaling that the log file changed its state from
  LOG_STATUS_INUSE to LOG_STATUS_FREE

  Now it do nothing, will be implemented as part of new transaction
  log management for engines.
  TODO: implement the function.
*/
void signal_log_not_needed(struct handlerton, char *log_file);
/*
  Data of transaction log iterator.
*/
struct handler_log_file_data {
  LEX_STRING filename;
  enum log_status status;
};


enum handler_iterator_type
{
  /* request of transaction log iterator */
  HA_TRANSACTLOG_ITERATOR= 1
};
enum handler_create_iterator_result
{
  HA_ITERATOR_OK,          /* iterator created */
  HA_ITERATOR_UNSUPPORTED, /* such type of iterator is not supported */
  HA_ITERATOR_ERROR        /* error during iterator creation */
};

/*
  Iterator structure. Can be used by handler/handlerton for different purposes.

  Iterator should be created in the way to point "before" the first object
  it iterate, so next() call move it to the first object or return !=0 if
  there is nothing to iterate through.
*/
struct handler_iterator {
  /*
    Moves iterator to next record and return 0 or return !=0
    if there is no records.
    iterator_object will be filled by this function if next() returns 0.
    Content of the iterator_object depend on iterator type.
  */
  int (*next)(struct handler_iterator *, void *iterator_object);
  /*
    Free resources allocated by iterator, after this call iterator
    is not usable.
  */
  void (*destroy)(struct handler_iterator *);
  /*
    Pointer to buffer for the iterator to use.
    Should be allocated by function which created the iterator and
    destroied by freed by above "destroy" call
  */
  void *buffer;
};

Konstantin Osipov's avatar
Konstantin Osipov committed
672
class handler;
unknown's avatar
unknown committed
673 674
/*
  handlerton is a singleton structure - one instance per storage engine -
unknown's avatar
unknown committed
675 676
  to provide access to storage engine functionality that works on the
  "global" level (unlike handler class that works on a per-table basis)
unknown's avatar
unknown committed
677 678

  usually handlerton instance is defined statically in ha_xxx.cc as
679

unknown's avatar
unknown committed
680 681 682 683
  static handlerton { ... } xxx_hton;

  savepoint_*, prepare, recover, and *_by_xid pointers can be 0.
*/
684
struct handlerton
685
{
unknown's avatar
unknown committed
686
  /*
unknown's avatar
unknown committed
687
    Historical marker for if the engine is available of not
688 689 690 691 692 693 694
  */
  SHOW_COMP_OPTION state;

  /*
    Historical number used for frm file to determine the correct storage engine.
    This is going away and new engines will just use "name" for this.
  */
unknown's avatar
unknown committed
695
  enum legacy_db_type db_type;
unknown's avatar
unknown committed
696 697 698 699 700 701 702 703 704
  /*
    each storage engine has it's own memory area (actually a pointer)
    in the thd, for storing per-connection information.
    It is accessed as

      thd->ha_data[xxx_hton.slot]

   slot number is initialized by MySQL after xxx_init() is called.
   */
705
   uint slot;
unknown's avatar
unknown committed
706 707 708 709 710 711 712 713 714
   /*
     to store per-savepoint data storage engine is provided with an area
     of a requested size (0 is ok here).
     savepoint_offset must be initialized statically to the size of
     the needed memory to store per-savepoint information.
     After xxx_init it is changed to be an offset to savepoint storage
     area and need not be used by storage engine.
     see binlog_hton and binlog_savepoint_set/rollback for an example.
   */
715
   uint savepoint_offset;
unknown's avatar
unknown committed
716 717 718 719 720 721 722 723
   /*
     handlerton methods:

     close_connection is only called if
     thd->ha_data[xxx_hton.slot] is non-zero, so even if you don't need
     this storage area - set it to something, so that MySQL would know
     this storage engine was accessed in this connection
   */
724
   int  (*close_connection)(handlerton *hton, THD *thd);
unknown's avatar
unknown committed
725 726 727 728
   /*
     sv points to an uninitialized storage area of requested size
     (see savepoint_offset description)
   */
729
   int  (*savepoint_set)(handlerton *hton, THD *thd, void *sv);
unknown's avatar
unknown committed
730 731 732 733
   /*
     sv points to a storage area, that was earlier passed
     to the savepoint_set call
   */
734 735
   int  (*savepoint_rollback)(handlerton *hton, THD *thd, void *sv);
   int  (*savepoint_release)(handlerton *hton, THD *thd, void *sv);
unknown's avatar
unknown committed
736 737 738 739 740 741 742
   /*
     'all' is true if it's a real commit, that makes persistent changes
     'all' is false if it's not in fact a commit but an end of the
     statement that is part of the transaction.
     NOTE 'all' is also false in auto-commit mode where 'end of statement'
     and 'real commit' mean the same event.
   */
743 744 745 746 747 748
   int  (*commit)(handlerton *hton, THD *thd, bool all);
   int  (*rollback)(handlerton *hton, THD *thd, bool all);
   int  (*prepare)(handlerton *hton, THD *thd, bool all);
   int  (*recover)(handlerton *hton, XID *xid_list, uint len);
   int  (*commit_by_xid)(handlerton *hton, XID *xid);
   int  (*rollback_by_xid)(handlerton *hton, XID *xid);
749 750 751
   void *(*create_cursor_read_view)(handlerton *hton, THD *thd);
   void (*set_cursor_read_view)(handlerton *hton, THD *thd, void *read_view);
   void (*close_cursor_read_view)(handlerton *hton, THD *thd, void *read_view);
752
   handler *(*create)(handlerton *hton, TABLE_SHARE *table, MEM_ROOT *mem_root);
753 754 755 756 757
   void (*drop_database)(handlerton *hton, char* path);
   int (*panic)(handlerton *hton, enum ha_panic_function flag);
   int (*start_consistent_snapshot)(handlerton *hton, THD *thd);
   bool (*flush_logs)(handlerton *hton);
   bool (*show_status)(handlerton *hton, THD *thd, stat_print_fn *print, enum ha_stat_type stat);
unknown's avatar
unknown committed
758 759
   uint (*partition_flags)();
   uint (*alter_table_flags)(uint flags);
760
   int (*alter_tablespace)(handlerton *hton, THD *thd, st_alter_tablespace *ts_info);
761 762 763
   int (*fill_is_table)(handlerton *hton, THD *thd, TABLE_LIST *tables, 
                        class Item *cond, 
                        enum enum_schema_tables);
764
   uint32 flags;                                /* global handler flags */
765 766 767
   /*
      Those handlerton functions below are properly initialized at handler
      init.
unknown's avatar
unknown committed
768
   */
769 770 771
   int (*binlog_func)(handlerton *hton, THD *thd, enum_binlog_func fn, void *arg);
   void (*binlog_log_query)(handlerton *hton, THD *thd, 
                            enum_binlog_command binlog_command,
unknown's avatar
unknown committed
772 773
                            const char *query, uint query_length,
                            const char *db, const char *table_name);
774
   int (*release_temporary_latches)(handlerton *hton, THD *thd);
775 776 777 778 779 780 781 782

   /*
     Get log status.
     If log_status is null then the handler do not support transaction
     log information (i.e. log iterator can't be created).
     (see example of implementation in handler.cc, TRANS_LOG_MGM_EXAMPLE_CODE)

   */
783
   enum log_status (*get_log_status)(handlerton *hton, char *log);
784 785 786 787 788 789

   /*
     Iterators creator.
     Presence of the pointer should be checked before using
   */
   enum handler_create_iterator_result
790
     (*create_iterator)(handlerton *hton, enum handler_iterator_type type,
791
                        struct handler_iterator *fill_this_in);
792 793
   int (*discover)(handlerton *hton, THD* thd, const char *db, 
                   const char *name,
794 795
                   uchar **frmblob, 
                   size_t *frmlen);
796 797 798
   int (*find_files)(handlerton *hton, THD *thd,
                     const char *db,
                     const char *path,
799
                     const char *wild, bool dir, List<LEX_STRING> *files);
800
   int (*table_exists_in_engine)(handlerton *hton, THD* thd, const char *db,
801
                                 const char *name);
802
   uint32 license; /* Flag for Engine License */
803
   void *data; /* Location for engines to keep personal structures */
804
};
805

806

807
/* Possible flags of a handlerton (there can be 32 of them) */
808 809
#define HTON_NO_FLAGS                 0
#define HTON_CLOSE_CURSORS_AT_COMMIT (1 << 0)
810 811 812
#define HTON_ALTER_NOT_SUPPORTED     (1 << 1) //Engine does not support alter
#define HTON_CAN_RECREATE            (1 << 2) //Delete all is used fro truncate
#define HTON_HIDDEN                  (1 << 3) //Engine does not appear in lists
813 814
#define HTON_FLUSH_AFTER_RENAME      (1 << 4)
#define HTON_NOT_USER_SELECTABLE     (1 << 5)
815
#define HTON_TEMPORARY_NOT_SUPPORTED (1 << 6) //Having temporary tables not supported
unknown's avatar
unknown committed
816
#define HTON_SUPPORT_LOG_TABLES      (1 << 7) //Engine supports log tables
817
#define HTON_NO_PARTITION            (1 << 8) //You can not partition these tables
818

819 820 821
class Ha_trx_info;

struct THD_TRANS
822
{
unknown's avatar
unknown committed
823
  /* true is not all entries in the ht[] support 2pc */
824
  bool        no_2pc;
825 826
  /* storage engines that registered in this transaction */
  Ha_trx_info *ha_list;
unknown's avatar
unknown committed
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
  /* 
    The purpose of this flag is to keep track of non-transactional
    tables that were modified in scope of:
    - transaction, when the variable is a member of
    THD::transaction.all
    - top-level statement or sub-statement, when the variable is a
    member of THD::transaction.stmt
    This member has the following life cycle:
    * stmt.modified_non_trans_table is used to keep track of
    modified non-transactional tables of top-level statements. At
    the end of the previous statement and at the beginning of the session,
    it is reset to FALSE.  If such functions
    as mysql_insert, mysql_update, mysql_delete etc modify a
    non-transactional table, they set this flag to TRUE.  At the
    end of the statement, the value of stmt.modified_non_trans_table 
    is merged with all.modified_non_trans_table and gets reset.
    * all.modified_non_trans_table is reset at the end of transaction
    
    * Since we do not have a dedicated context for execution of a
    sub-statement, to keep track of non-transactional changes in a
    sub-statement, we re-use stmt.modified_non_trans_table. 
    At entrance into a sub-statement, a copy of the value of
    stmt.modified_non_trans_table (containing the changes of the
    outer statement) is saved on stack. Then 
    stmt.modified_non_trans_table is reset to FALSE and the
    substatement is executed. Then the new value is merged with the
    saved value.
  */
  bool modified_non_trans_table;
856 857

  void reset() { no_2pc= FALSE; modified_non_trans_table= FALSE; }
858
  bool is_empty() const { return ha_list == NULL; }
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
};


/**
  Either statement transaction or normal transaction - related
  thread-specific storage engine data.

  If a storage engine participates in a statement/transaction,
  an instance of this class is present in
  thd->transaction.{stmt|all}.ha_list. The addition to
  {stmt|all}.ha_list is made by trans_register_ha().

  When it's time to commit or rollback, each element of ha_list
  is used to access storage engine's prepare()/commit()/rollback()
  methods, and also to evaluate if a full two phase commit is
  necessary.

  @sa General description of transaction handling in handler.cc.
*/

class Ha_trx_info
{
public:
  /** Register this storage engine in the given transaction context. */
  void register_ha(THD_TRANS *trans, handlerton *ht_arg)
  {
    DBUG_ASSERT(m_flags == 0);
    DBUG_ASSERT(m_ht == NULL);
    DBUG_ASSERT(m_next == NULL);

    m_ht= ht_arg;
    m_flags= (int) TRX_READ_ONLY; /* Assume read-only at start. */

    m_next= trans->ha_list;
    trans->ha_list= this;
  }

  /** Clear, prepare for reuse. */
  void reset()
  {
    m_next= NULL;
    m_ht= NULL;
    m_flags= 0;
  }

  Ha_trx_info() { reset(); }

  void set_trx_read_write()
  {
    DBUG_ASSERT(is_started());
    m_flags|= (int) TRX_READ_WRITE;
  }
  bool is_trx_read_write() const
  {
    DBUG_ASSERT(is_started());
    return m_flags & (int) TRX_READ_WRITE;
  }
  bool is_started() const { return m_ht != NULL; }
  /** Mark this transaction read-write if the argument is read-write. */
  void coalesce_trx_with(const Ha_trx_info *stmt_trx)
  {
    /*
      Must be called only after the transaction has been started.
      Can be called many times, e.g. when we have many
      read-write statements in a transaction.
    */
    DBUG_ASSERT(is_started());
    if (stmt_trx->is_trx_read_write())
      set_trx_read_write();
  }
  Ha_trx_info *next() const
  {
    DBUG_ASSERT(is_started());
    return m_next;
  }
  handlerton *ht() const
  {
    DBUG_ASSERT(is_started());
    return m_ht;
  }
private:
  enum { TRX_READ_ONLY= 0, TRX_READ_WRITE= 1 };
  /** Auxiliary, used for ha_list management */
  Ha_trx_info *m_next;
  /**
    Although a given Ha_trx_info instance is currently always used
    for the same storage engine, 'ht' is not-NULL only when the
    corresponding storage is a part of a transaction.
  */
  handlerton *m_ht;
  /**
    Transaction flags related to this engine.
    Not-null only if this instance is a part of transaction.
    May assume a combination of enum values above.
  */
  uchar       m_flags;
};

957

unknown's avatar
unknown committed
958 959 960
enum enum_tx_isolation { ISO_READ_UNCOMMITTED, ISO_READ_COMMITTED,
			 ISO_REPEATABLE_READ, ISO_SERIALIZABLE};

961

962 963 964 965 966 967 968
typedef struct {
  ulonglong data_file_length;
  ulonglong max_data_file_length;
  ulonglong index_file_length;
  ulonglong delete_length;
  ha_rows records;
  ulong mean_rec_length;
969 970 971
  ulong create_time;
  ulong check_time;
  ulong update_time;
972
  ulonglong check_sum;
973
} PARTITION_STATS;
974

975 976
#define UNDEF_NODEGROUP 65535
class Item;
unknown's avatar
unknown committed
977
struct st_table_log_memory_entry;
978 979 980

class partition_info;

unknown's avatar
unknown committed
981 982 983
struct st_partition_iter;
#define NOT_A_PARTITION_ID ((uint32)-1)

984 985
enum enum_ha_unused { HA_CHOICE_UNDEF, HA_CHOICE_NO, HA_CHOICE_YES };

unknown's avatar
unknown committed
986 987
typedef struct st_ha_create_information
{
988
  CHARSET_INFO *table_charset, *default_table_charset;
989
  LEX_STRING connect_string;
990
  const char *password, *tablespace;
991
  LEX_STRING comment;
unknown's avatar
unknown committed
992 993
  const char *data_file_name, *index_file_name;
  const char *alias;
994 995 996 997
  ulonglong max_rows,min_rows;
  ulonglong auto_increment_value;
  ulong table_options;
  ulong avg_row_length;
unknown's avatar
unknown committed
998
  ulong used_fields;
999
  ulong key_block_size;
1000
  SQL_I_List<TABLE_LIST> merge_list;
unknown's avatar
unknown committed
1001
  handlerton *db_type;
1002 1003 1004 1005 1006 1007 1008 1009 1010
  /**
    Row type of the table definition.

    Defaults to ROW_TYPE_DEFAULT for all non-ALTER statements.
    For ALTER TABLE defaults to ROW_TYPE_NOT_USED (means "keep the current").

    Can be changed either explicitly by the parser.
    If nothing speficied inherits the value of the original table (if present).
  */
1011
  enum row_type row_type;
1012
  uint null_bits;                       /* NULL bits at start of record */
1013
  uint options;				/* OR of HA_CREATE_ options */
1014
  uint merge_insert_method;
1015
  uint extra_size;                      /* length of extra data segment */
1016
  enum enum_ha_unused unused1;
1017
  bool frm_only;                        /* 1 if no ha_create_table() */
1018
  bool varchar;                         /* 1 if table has a VARCHAR */
1019
  enum ha_storage_media storage_media;  /* DEFAULT, DISK or MEMORY */
1020
  enum enum_ha_unused unused2;
unknown's avatar
unknown committed
1021 1022
} HA_CREATE_INFO;

1023 1024 1025 1026 1027 1028

typedef struct st_key_create_information
{
  enum ha_key_alg algorithm;
  ulong block_size;
  LEX_STRING parser_name;
1029
  LEX_STRING comment;
1030 1031 1032
} KEY_CREATE_INFO;


1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049
/*
  Class for maintaining hooks used inside operations on tables such
  as: create table functions, delete table functions, and alter table
  functions.

  Class is using the Template Method pattern to separate the public
  usage interface from the private inheritance interface.  This
  imposes no overhead, since the public non-virtual function is small
  enough to be inlined.

  The hooks are usually used for functions that does several things,
  e.g., create_table_from_items(), which both create a table and lock
  it.
 */
class TABLEOP_HOOKS
{
public:
1050 1051 1052
  TABLEOP_HOOKS() {}
  virtual ~TABLEOP_HOOKS() {}

1053 1054 1055 1056
  inline void prelock(TABLE **tables, uint count)
  {
    do_prelock(tables, count);
  }
unknown's avatar
unknown committed
1057

1058 1059 1060 1061
  inline int postlock(TABLE **tables, uint count)
  {
    return do_postlock(tables, count);
  }
1062 1063 1064 1065 1066 1067
private:
  /* Function primitive that is called prior to locking tables */
  virtual void do_prelock(TABLE **tables, uint count)
  {
    /* Default is to do nothing */
  }
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080

  /**
     Primitive called after tables are locked.

     If an error is returned, the tables will be unlocked and error
     handling start.

     @return Error code or zero.
   */
  virtual int do_postlock(TABLE **tables, uint count)
  {
    return 0;                           /* Default is to do nothing */
  }
1081
};
unknown's avatar
unknown committed
1082

1083 1084
typedef struct st_savepoint SAVEPOINT;
extern ulong savepoint_alloc_size;
1085
extern KEY_CREATE_INFO default_key_create_info;
1086

1087
/* Forward declaration for condition pushdown to storage engine */
1088
typedef class Item COND;
unknown's avatar
Merge  
unknown committed
1089

unknown's avatar
unknown committed
1090 1091
typedef struct st_ha_check_opt
{
1092
  st_ha_check_opt() {}                        /* Remove gcc warning */
unknown's avatar
unknown committed
1093 1094
  uint flags;       /* isam layer flags (e.g. for myisamchk) */
  uint sql_flags;   /* sql layer flags - for something myisamchk cannot do */
unknown's avatar
unknown committed
1095
  KEY_CACHE *key_cache;	/* new key cache when changing key cache */
unknown's avatar
unknown committed
1096
  void init();
unknown's avatar
unknown committed
1097 1098
} HA_CHECK_OPT;

1099

1100

unknown's avatar
unknown committed
1101 1102 1103 1104 1105 1106 1107 1108 1109
/*
  This is a buffer area that the handler can use to store rows.
  'end_of_used_area' should be kept updated after calls to
  read-functions so that other parts of the code can use the
  remaining area (until next read calls is issued).
*/

typedef struct st_handler_buffer
{
1110 1111 1112
  const uchar *buffer;         /* Buffer one can start using */
  const uchar *buffer_end;     /* End of buffer */
  uchar *end_of_used_area;     /* End of area that was used by handler */
unknown's avatar
unknown committed
1113 1114
} HANDLER_BUFFER;

1115 1116
typedef struct system_status_var SSV;

1117 1118 1119 1120 1121 1122 1123 1124 1125
class ha_statistics
{
public:
  ulonglong data_file_length;		/* Length off data file */
  ulonglong max_data_file_length;	/* Length off data file */
  ulonglong index_file_length;
  ulonglong max_index_file_length;
  ulonglong delete_length;		/* Free bytes */
  ulonglong auto_increment_value;
1126 1127 1128 1129 1130 1131 1132 1133 1134
  /*
    The number of records in the table. 
      0    - means the table has exactly 0 rows
    other  - if (table_flags() & HA_STATS_RECORDS_IS_EXACT)
               the value is the exact number of records in the table
             else
               it is an estimate
  */
  ha_rows records;
1135 1136
  ha_rows deleted;			/* Deleted records */
  ulong mean_rec_length;		/* physical reclength */
1137 1138 1139
  ulong create_time;			/* When table was created */
  ulong check_time;
  ulong update_time;
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
  uint block_size;			/* index block size */

  ha_statistics():
    data_file_length(0), max_data_file_length(0),
    index_file_length(0), delete_length(0), auto_increment_value(0),
    records(0), deleted(0), mean_rec_length(0), create_time(0),
    check_time(0), update_time(0), block_size(0)
  {}
};

1150
uint calculate_key_len(TABLE *, uint, const uchar *, key_part_map);
1151 1152 1153 1154
/*
  bitmap with first N+1 bits set
  (keypart_map for a key prefix of [0..N] keyparts)
*/
unknown's avatar
unknown committed
1155
#define make_keypart_map(N) (((key_part_map)2 << (N)) - 1)
1156 1157 1158 1159
/*
  bitmap with first N bits set
  (keypart_map for a key prefix of [0..N-1] keyparts)
*/
unknown's avatar
unknown committed
1160
#define make_prev_keypart_map(N) (((key_part_map)1 << (N)) - 1)
1161

1162
/**
1163 1164 1165
  The handler class is the interface for dynamically loadable
  storage engines. Do not add ifdefs and take care when adding or
  changing virtual functions to avoid vtable confusion
1166
*/
1167

unknown's avatar
unknown committed
1168 1169
class handler :public Sql_alloc
{
1170 1171
public:
  typedef ulonglong Table_flags;
1172
protected:
Konstantin Osipov's avatar
Konstantin Osipov committed
1173 1174
  TABLE_SHARE *table_share;   /* The table definition */
  TABLE *table;               /* The current open table */
1175
  Table_flags cached_table_flags;       /* Set on init() and open() */
unknown's avatar
unknown committed
1176

1177
  ha_rows estimation_rows_to_insert;
unknown's avatar
unknown committed
1178
public:
1179
  handlerton *ht;                 /* storage engine of this handler */
1180 1181
  uchar *ref;				/* Pointer to current row */
  uchar *dup_ref;			/* Pointer to duplicate row */
1182 1183

  ha_statistics stats;
1184

1185
  /** The following are for read_multi_range */
unknown's avatar
unknown committed
1186 1187 1188 1189 1190
  bool multi_range_sorted;
  KEY_MULTI_RANGE *multi_range_curr;
  KEY_MULTI_RANGE *multi_range_end;
  HANDLER_BUFFER *multi_range_buffer;

1191
  /** The following are for read_range() */
1192 1193 1194
  key_range save_end_range, *end_range;
  KEY_PART_INFO *range_key_part;
  int key_compare_result_on_equal;
unknown's avatar
unknown committed
1195
  bool eq_range;
1196

1197
  uint errkey;				/* Last dup key */
1198
  uint key_used_on_scan;
1199
  uint active_index;
1200
  /** Length of ref (1-8 or the clustered key length) */
1201
  uint ref_length;
unknown's avatar
unknown committed
1202
  FT_INFO *ft_handler;
1203
  enum {NONE=0, INDEX, RND} inited;
1204
  bool locked;
1205
  bool implicit_emptied;                /* Can be !=0 only if HEAP */
1206
  const COND *pushed_cond;
1207
  /**
1208 1209 1210 1211 1212 1213 1214 1215 1216
    next_insert_id is the next value which should be inserted into the
    auto_increment column: in a inserting-multi-row statement (like INSERT
    SELECT), for the first row where the autoinc value is not specified by the
    statement, get_auto_increment() called and asked to generate a value,
    next_insert_id is set to the next value, then for all other rows
    next_insert_id is used (and increased each time) without calling
    get_auto_increment().
  */
  ulonglong next_insert_id;
1217
  /**
1218 1219 1220 1221 1222 1223
    insert id for the current row (*autogenerated*; if not
    autogenerated, it's 0).
    At first successful insertion, this variable is stored into
    THD::first_successful_insert_id_in_cur_stmt.
  */
  ulonglong insert_id_for_cur_row;
1224
  /**
1225 1226 1227 1228
    Interval returned by get_auto_increment() and being consumed by the
    inserter.
  */
  Discrete_interval auto_inc_interval_for_cur_row;
Guilhem Bichot's avatar
Guilhem Bichot committed
1229 1230 1231 1232 1233 1234 1235
  /**
     Number of reserved auto-increment intervals. Serves as a heuristic
     when we have no estimation of how many records the statement will insert:
     the more intervals we have reserved, the bigger the next one. Reset in
     handler::ha_release_auto_increment().
  */
  uint auto_inc_intervals_count;
1236

Marc Alff's avatar
Marc Alff committed
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
  /**
    Instrumented table associated with this handler.
    This member should be set to NULL when no instrumentation is in place,
    so that linking an instrumented/non instrumented server/plugin works.
    For example:
    - the server is compiled with the instrumentation.
    The server expects either NULL or valid pointers in m_psi.
    - an engine plugin is compiled without instrumentation.
    The plugin can not leave this pointer uninitialized,
    or can not leave a trash value on purpose in this pointer,
    as this would crash the server.
  */
  PSI_table *m_psi;

1251
  handler(handlerton *ht_arg, TABLE_SHARE *share_arg)
unknown's avatar
unknown committed
1252 1253
    :table_share(share_arg), table(0),
    estimation_rows_to_insert(0), ht(ht_arg),
1254 1255
    ref(0), key_used_on_scan(MAX_KEY), active_index(MAX_KEY),
    ref_length(sizeof(my_off_t)),
1256
    ft_handler(0), inited(NONE),
1257
    locked(FALSE), implicit_emptied(0),
Guilhem Bichot's avatar
Guilhem Bichot committed
1258
    pushed_cond(0), next_insert_id(0), insert_id_for_cur_row(0),
Marc Alff's avatar
Marc Alff committed
1259 1260
    auto_inc_intervals_count(0),
    m_psi(NULL)
unknown's avatar
unknown committed
1261
    {}
1262 1263
  virtual ~handler(void)
  {
1264
    DBUG_ASSERT(locked == FALSE);
Konstantin Osipov's avatar
Konstantin Osipov committed
1265
    DBUG_ASSERT(inited == NONE);
1266
  }
1267
  virtual handler *clone(const char *name, MEM_ROOT *mem_root);
1268
  /** This is called after create to allow us to set up cached variables */
1269 1270 1271 1272
  void init()
  {
    cached_table_flags= table_flags();
  }
1273 1274
  /* ha_ methods: pubilc wrappers for private virtual API */

unknown's avatar
unknown committed
1275
  int ha_open(TABLE *table, const char *name, int mode, int test_if_locked);
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
  int ha_index_init(uint idx, bool sorted)
  {
    int result;
    DBUG_ENTER("ha_index_init");
    DBUG_ASSERT(inited==NONE);
    if (!(result= index_init(idx, sorted)))
      inited=INDEX;
    DBUG_RETURN(result);
  }
  int ha_index_end()
  {
    DBUG_ENTER("ha_index_end");
    DBUG_ASSERT(inited==INDEX);
    inited=NONE;
    DBUG_RETURN(index_end());
  }
  int ha_rnd_init(bool scan)
  {
    int result;
    DBUG_ENTER("ha_rnd_init");
    DBUG_ASSERT(inited==NONE || (inited==RND && scan));
    inited= (result= rnd_init(scan)) ? NONE: RND;
    DBUG_RETURN(result);
  }
  int ha_rnd_end()
  {
    DBUG_ENTER("ha_rnd_end");
    DBUG_ASSERT(inited==RND);
    inited=NONE;
    DBUG_RETURN(rnd_end());
  }
  int ha_reset();
  /* this is necessary in many places, e.g. in HANDLER command */
  int ha_index_or_rnd_end()
  {
    return inited == INDEX ? ha_index_end() : inited == RND ? ha_rnd_end() : 0;
  }
1313 1314 1315
  /**
    The cached_table_flags is set at ha_open and ha_external_lock
  */
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
  Table_flags ha_table_flags() const { return cached_table_flags; }
  /**
    These functions represent the public interface to *users* of the
    handler class, hence they are *not* virtual. For the inheritance
    interface, see the (private) functions write_row(), update_row(),
    and delete_row() below.
  */
  int ha_external_lock(THD *thd, int lock_type);
  int ha_write_row(uchar * buf);
  int ha_update_row(const uchar * old_data, uchar * new_data);
  int ha_delete_row(const uchar * buf);
  void ha_release_auto_increment();

1329
  int check_collation_compatibility();
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
  int ha_check_for_upgrade(HA_CHECK_OPT *check_opt);
  /** to be actually called to get 'check()' functionality*/
  int ha_check(THD *thd, HA_CHECK_OPT *check_opt);
  int ha_repair(THD* thd, HA_CHECK_OPT* check_opt);
  void ha_start_bulk_insert(ha_rows rows)
  {
    estimation_rows_to_insert= rows;
    start_bulk_insert(rows);
  }
  int ha_end_bulk_insert()
  {
    estimation_rows_to_insert= 0;
    return end_bulk_insert();
  }
1344 1345 1346
  int ha_bulk_update_row(const uchar *old_data, uchar *new_data,
                         uint *dup_key_found);
  int ha_delete_all_rows();
1347
  int ha_truncate();
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
  int ha_reset_auto_increment(ulonglong value);
  int ha_optimize(THD* thd, HA_CHECK_OPT* check_opt);
  int ha_analyze(THD* thd, HA_CHECK_OPT* check_opt);
  bool ha_check_and_repair(THD *thd);
  int ha_disable_indexes(uint mode);
  int ha_enable_indexes(uint mode);
  int ha_discard_or_import_tablespace(my_bool discard);
  void ha_prepare_for_alter();
  int ha_rename_table(const char *from, const char *to);
  int ha_delete_table(const char *name);
  void ha_drop_table(const char *name);

  int ha_create(const char *name, TABLE *form, HA_CREATE_INFO *info);

  int ha_create_handler_files(const char *name, const char *old_name,
                              int action_flag, HA_CREATE_INFO *info);

  int ha_change_partitions(HA_CREATE_INFO *create_info,
                           const char *path,
1367 1368
                           ulonglong * const copied,
                           ulonglong * const deleted,
1369 1370 1371 1372
                           const uchar *pack_frm_data,
                           size_t pack_frm_len);
  int ha_drop_partitions(const char *path);
  int ha_rename_partitions(const char *path);
1373

1374
  void adjust_next_insert_id_after_explicit_value(ulonglong nr);
unknown's avatar
unknown committed
1375
  int update_auto_increment();
1376
  void print_keydup_error(uint key_nr, const char *msg);
unknown's avatar
unknown committed
1377
  virtual void print_error(int error, myf errflag);
1378
  virtual bool get_error_message(int error, String *buf);
unknown's avatar
unknown committed
1379
  uint get_dup_key(int error);
1380
  virtual void change_table_ptr(TABLE *table_arg, TABLE_SHARE *share)
unknown's avatar
unknown committed
1381 1382 1383 1384
  {
    table= table_arg;
    table_share= share;
  }
unknown's avatar
unknown committed
1385
  virtual double scan_time()
1386
  { return ulonglong2double(stats.data_file_length) / IO_SIZE + 2; }
unknown's avatar
unknown committed
1387
  virtual double read_time(uint index, uint ranges, ha_rows rows)
1388
  { return rows2double(ranges+rows); }
unknown's avatar
unknown committed
1389
  virtual const key_map *keys_to_use_for_scanning() { return &key_map_empty; }
1390 1391
  bool has_transactions()
  { return (ha_table_flags() & HA_NO_TRANSACTIONS) == 0; }
1392
  virtual uint extra_rec_buf_length() const { return 0; }
1393

1394
  /**
1395 1396 1397 1398 1399
    This method is used to analyse the error to see whether the error
    is ignorable or not, certain handlers can have more error that are
    ignorable than others. E.g. the partition handler can get inserts
    into a range where there is no partition and this is an ignorable
    error.
1400 1401
    HA_ERR_FOUND_DUP_UNIQUE is a special case in MyISAM that means the
    same thing as HA_ERR_FOUND_DUP_KEY but can in some cases lead to
1402
    a slightly different error message.
1403
  */
1404
  virtual bool is_fatal_error(int error, uint flags)
1405 1406
  {
    if (!error ||
1407
        ((flags & HA_CHECK_DUP_KEY) &&
1408 1409
         (error == HA_ERR_FOUND_DUPP_KEY ||
          error == HA_ERR_FOUND_DUPP_UNIQUE)))
1410 1411 1412 1413
      return FALSE;
    return TRUE;
  }

1414
  /**
1415 1416 1417 1418
    Number of rows in table. It will only be called if
    (table_flags() & (HA_HAS_RECORDS | HA_STATS_RECORDS_IS_EXACT)) != 0
  */
  virtual ha_rows records() { return stats.records; }
1419
  /**
unknown's avatar
unknown committed
1420 1421 1422 1423 1424 1425
    Return upper bound of current number of records in the table
    (max. of how many records one will retrieve when doing a full table scan)
    If upper bound is not known, HA_POS_ERROR should be returned as a max
    possible upper bound.
  */
  virtual ha_rows estimate_rows_upper_bound()
1426
  { return stats.records+EXTRA_RECORDS; }
unknown's avatar
unknown committed
1427

1428
  /**
1429 1430 1431 1432 1433
    Get the row type from the storage engine.  If this method returns
    ROW_TYPE_NOT_USED, the information in HA_CREATE_INFO should be used.
  */
  virtual enum row_type get_row_type() const { return ROW_TYPE_NOT_USED; }

unknown's avatar
unknown committed
1434 1435
  virtual const char *index_type(uint key_number) { DBUG_ASSERT(0); return "";}

1436

1437
  /**
1438 1439 1440 1441 1442
    Signal that the table->read_set and table->write_set table maps changed
    The handler is allowed to set additional bits in the above map in this
    call. Normally the handler should ignore all calls until we have done
    a ha_rnd_init() or ha_index_init(), write_row(), update_row or delete_row()
    as there may be several calls to this routine.
1443
  */
1444
  virtual void column_bitmaps_signal();
unknown's avatar
unknown committed
1445 1446
  uint get_index(void) const { return active_index; }
  virtual int close(void)=0;
1447

1448 1449 1450
  /**
    @retval  0   Bulk update used by handler
    @retval  1   Bulk update not used, normal operation used
unknown's avatar
unknown committed
1451 1452
  */
  virtual bool start_bulk_update() { return 1; }
1453 1454 1455
  /**
    @retval  0   Bulk delete used by handler
    @retval  1   Bulk delete not used, normal operation used
unknown's avatar
unknown committed
1456 1457
  */
  virtual bool start_bulk_delete() { return 1; }
1458
  /**
unknown's avatar
unknown committed
1459 1460 1461 1462 1463
    After this call all outstanding updates must be performed. The number
    of duplicate key errors are reported in the duplicate key parameter.
    It is allowed to continue to the batched update after this call, the
    handler has to wait until end_bulk_update with changing state.

1464 1465 1466 1467
    @param    dup_key_found       Number of duplicate keys found

    @retval  0           Success
    @retval  >0          Error code
unknown's avatar
unknown committed
1468
  */
unknown's avatar
unknown committed
1469 1470 1471 1472 1473
  virtual int exec_bulk_update(uint *dup_key_found)
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
1474
  /**
unknown's avatar
unknown committed
1475 1476 1477
    Perform any needed clean-up, no outstanding updates are there at the
    moment.
  */
unknown's avatar
unknown committed
1478
  virtual void end_bulk_update() { return; }
1479
  /**
unknown's avatar
unknown committed
1480 1481
    Execute all outstanding deletes and close down the bulk delete.

1482 1483
    @retval 0             Success
    @retval >0            Error code
unknown's avatar
unknown committed
1484
  */
unknown's avatar
unknown committed
1485 1486 1487 1488 1489
  virtual int end_bulk_delete()
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
1490 1491 1492 1493 1494 1495 1496
  /**
     @brief
     Positions an index cursor to the index specified in the handle. Fetches the
     row if available. If the key value is null, begin at the first key of the
     index.
  */
  virtual int index_read_map(uchar * buf, const uchar * key,
unknown's avatar
unknown committed
1497
                             key_part_map keypart_map,
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
                             enum ha_rkey_function find_flag)
  {
    uint key_len= calculate_key_len(table, active_index, key, keypart_map);
    return  index_read(buf, key, key_len, find_flag);
  }
  /**
     @brief
     Positions an index cursor to the index specified in the handle. Fetches the
     row if available. If the key value is null, begin at the first key of the
     index.
  */
  virtual int index_read_idx_map(uchar * buf, uint index, const uchar * key,
                                 key_part_map keypart_map,
                                 enum ha_rkey_function find_flag);
1512
  virtual int index_next(uchar * buf)
unknown's avatar
unknown committed
1513
   { return  HA_ERR_WRONG_COMMAND; }
1514
  virtual int index_prev(uchar * buf)
unknown's avatar
unknown committed
1515
   { return  HA_ERR_WRONG_COMMAND; }
1516
  virtual int index_first(uchar * buf)
unknown's avatar
unknown committed
1517
   { return  HA_ERR_WRONG_COMMAND; }
1518
  virtual int index_last(uchar * buf)
unknown's avatar
unknown committed
1519
   { return  HA_ERR_WRONG_COMMAND; }
1520
  virtual int index_next_same(uchar *buf, const uchar *key, uint keylen);
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
  /**
     @brief
     The following functions works like index_read, but it find the last
     row with the current key value or prefix.
  */
  virtual int index_read_last_map(uchar * buf, const uchar * key,
                                  key_part_map keypart_map)
  {
    uint key_len= calculate_key_len(table, active_index, key, keypart_map);
    return index_read_last(buf, key, key_len);
  }
unknown's avatar
unknown committed
1532 1533 1534 1535
  virtual int read_multi_range_first(KEY_MULTI_RANGE **found_range_p,
                                     KEY_MULTI_RANGE *ranges, uint range_count,
                                     bool sorted, HANDLER_BUFFER *buffer);
  virtual int read_multi_range_next(KEY_MULTI_RANGE **found_range_p);
1536
  virtual int read_range_first(const key_range *start_key,
unknown's avatar
unknown committed
1537 1538 1539
                               const key_range *end_key,
                               bool eq_range, bool sorted);
  virtual int read_range_next();
1540
  int compare_key(key_range *range);
unknown's avatar
unknown committed
1541
  virtual int ft_init() { return HA_ERR_WRONG_COMMAND; }
1542
  void ft_end() { ft_handler=NULL; }
1543
  virtual FT_INFO *ft_init_ext(uint flags, uint inx,String *key)
unknown's avatar
unknown committed
1544
    { return NULL; }
1545 1546 1547
  virtual int ft_read(uchar *buf) { return HA_ERR_WRONG_COMMAND; }
  virtual int rnd_next(uchar *buf)=0;
  virtual int rnd_pos(uchar * buf, uchar *pos)=0;
1548
  /**
1549 1550 1551
    This function only works for handlers having
    HA_PRIMARY_KEY_REQUIRED_FOR_POSITION set.
    It will return the row with the PK given in the record argument.
1552 1553 1554 1555 1556 1557
  */
  virtual int rnd_pos_by_record(uchar *record)
    {
      position(record);
      return rnd_pos(record, ref);
    }
1558
  virtual int read_first_row(uchar *buf, uint primary_key);
1559
  /**
unknown's avatar
unknown committed
1560
    The following function is only needed for tables that may be temporary
1561
    tables during joins.
unknown's avatar
unknown committed
1562
  */
1563
  virtual int restart_rnd_next(uchar *buf, uchar *pos)
unknown's avatar
unknown committed
1564
    { return HA_ERR_WRONG_COMMAND; }
1565
  virtual int rnd_same(uchar *buf, uint inx)
unknown's avatar
unknown committed
1566
    { return HA_ERR_WRONG_COMMAND; }
1567
  virtual ha_rows records_in_range(uint inx, key_range *min_key, key_range *max_key)
unknown's avatar
unknown committed
1568
    { return (ha_rows) 10; }
1569 1570 1571 1572 1573 1574
  /*
    If HA_PRIMARY_KEY_REQUIRED_FOR_POSITION is set, then it sets ref
    (reference to the row, aka position, with the primary key given in
    the record).
    Otherwise it set ref to the current row.
  */
1575
  virtual void position(const uchar *record)=0;
1576
  virtual int info(uint)=0; // see my_base.h for full description
1577
  virtual void get_dynamic_partition_info(PARTITION_STATS *stat_info,
1578
                                          uint part_id);
unknown's avatar
unknown committed
1579 1580
  virtual int extra(enum ha_extra_function operation)
  { return 0; }
unknown's avatar
unknown committed
1581
  virtual int extra_opt(enum ha_extra_function operation, ulong cache_size)
unknown's avatar
unknown committed
1582
  { return extra(operation); }
1583

1584
  /**
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
    In an UPDATE or DELETE, if the row under the cursor was locked by another
    transaction, and the engine used an optimistic read of the last
    committed row value under the cursor, then the engine returns 1 from this
    function. MySQL must NOT try to update this optimistic value. If the
    optimistic value does not match the WHERE condition, MySQL can decide to
    skip over this row. Currently only works for InnoDB. This can be used to
    avoid unnecessary lock waits.

    If this method returns nonzero, it will also signal the storage
    engine that the next read will be a locking re-read of the row.
  */
  virtual bool was_semi_consistent_read() { return 0; }
1597
  /**
1598 1599 1600 1601 1602 1603
    Tell the engine whether it should avoid unnecessary lock waits.
    If yes, in an UPDATE or DELETE, if the row under the cursor was locked
    by another transaction, the engine may try an optimistic read of
    the last committed row value under the cursor.
  */
  virtual void try_semi_consistent_read(bool) {}
unknown's avatar
unknown committed
1604
  virtual void unlock_row() {}
unknown's avatar
unknown committed
1605
  virtual int start_stmt(THD *thd, thr_lock_type lock_type) {return 0;}
1606 1607 1608 1609
  virtual void get_auto_increment(ulonglong offset, ulonglong increment,
                                  ulonglong nb_desired_values,
                                  ulonglong *first_value,
                                  ulonglong *nb_reserved_values);
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
  void set_next_insert_id(ulonglong id)
  {
    DBUG_PRINT("info",("auto_increment: next value %lu", (ulong)id));
    next_insert_id= id;
  }
  void restore_auto_increment(ulonglong prev_insert_id)
  {
    /*
      Insertion of a row failed, re-use the lastly generated auto_increment
      id, for the next row. This is achieved by resetting next_insert_id to
      what it was before the failed insertion (that old value is provided by
      the caller). If that value was 0, it was the first row of the INSERT;
      then if insert_id_for_cur_row contains 0 it means no id was generated
      for this first row, so no id was generated since the INSERT started, so
      we should set next_insert_id to 0; if insert_id_for_cur_row is not 0, it
      is the generated id of the first and failed row, so we use it.
    */
    next_insert_id= (prev_insert_id > 0) ? prev_insert_id :
      insert_id_for_cur_row;
  }
1630

unknown's avatar
unknown committed
1631
  virtual void update_create_info(HA_CREATE_INFO *create_info) {}
unknown's avatar
unknown committed
1632
  int check_old_types();
unknown's avatar
unknown committed
1633 1634 1635 1636 1637 1638
  virtual int assign_to_keycache(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  virtual int preload_keys(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  /* end of the list of admin commands */

1639
  virtual int indexes_are_disabled(void) {return 0;}
1640 1641 1642
  virtual char *update_table_comment(const char * comment)
  { return (char*) comment;}
  virtual void append_create_info(String *packet) {}
1643 1644 1645 1646 1647 1648 1649 1650 1651
  /**
    If index == MAX_KEY then a check for table is made and if index <
    MAX_KEY then a check is made if the table has foreign keys and if
    a foreign key uses this index (and thus the index cannot be dropped).

    @param  index            Index to check if foreign key uses it

    @retval   TRUE            Foreign key defined on table or index
    @retval   FALSE           No foreign key defined
unknown's avatar
unknown committed
1652 1653 1654
  */
  virtual bool is_fk_defined_on_table_or_index(uint index)
  { return FALSE; }
1655 1656
  virtual char* get_foreign_key_create_info()
  { return(NULL);}  /* gets foreign key create string from InnoDB */
1657
  virtual char* get_tablespace_name(THD *thd, char *name, uint name_len)
1658
  { return(NULL);}  /* gets tablespace name from handler */
1659
  /** used in ALTER TABLE; 1 if changing storage engine is allowed */
1660
  virtual bool can_switch_engines() { return 1; }
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
  /**
    Get the list of foreign keys in this table.

    @remark Returns the set of foreign keys where this table is the
            dependent or child table.

    @param thd  The thread handle.
    @param f_key_list[out]  The list of foreign keys.

    @return The handler error code or zero for success.
  */
  virtual int
  get_foreign_key_list(THD *thd, List<FOREIGN_KEY_INFO> *f_key_list)
  { return 0; }
  /**
    Get the list of foreign keys referencing this table.

    @remark Returns the set of foreign keys where this table is the
            referenced or parent table.

    @param thd  The thread handle.
    @param f_key_list[out]  The list of foreign keys.

    @return The handler error code or zero for success.
  */
  virtual int
  get_parent_foreign_key_list(THD *thd, List<FOREIGN_KEY_INFO> *f_key_list)
1688
  { return 0; }
unknown's avatar
unknown committed
1689
  virtual uint referenced_by_foreign_key() { return 0;}
unknown's avatar
unknown committed
1690
  virtual void init_table_handle_for_HANDLER()
unknown's avatar
unknown committed
1691 1692
  { return; }       /* prepare InnoDB for HANDLER */
  virtual void free_foreign_key_create_info(char* str) {}
1693
  /** The following can be called without an open handler */
unknown's avatar
unknown committed
1694
  virtual const char *table_type() const =0;
1695
  /**
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705
    If frm_error() is called then we will use this to find out what file
    extentions exist for the storage engine. This is also used by the default
    rename_table and delete_table method in handler.cc.

    For engines that have two file name extentions (separate meta/index file
    and data file), the order of elements is relevant. First element of engine
    file name extentions array should be meta/index file extention. Second
    element - data file extention. This order is assumed by
    prepare_for_repair() when REPAIR TABLE ... USE_FRM is issued.
  */
unknown's avatar
unknown committed
1706
  virtual const char **bas_ext() const =0;
1707

1708
  virtual int get_default_no_partitions(HA_CREATE_INFO *info) { return 1;}
unknown's avatar
unknown committed
1709 1710 1711 1712 1713 1714 1715 1716
  virtual void set_auto_partitions(partition_info *part_info) { return; }
  virtual bool get_no_parts(const char *name,
                            uint *no_parts)
  {
    *no_parts= 0;
    return 0;
  }
  virtual void set_part_info(partition_info *part_info) {return;}
1717

1718
  virtual ulong index_flags(uint idx, uint part, bool all_parts) const =0;
1719

1720
  virtual int add_index(TABLE *table_arg, KEY *key_info, uint num_of_keys)
unknown's avatar
unknown committed
1721
  { return (HA_ERR_WRONG_COMMAND); }
1722 1723 1724 1725
  virtual int prepare_drop_index(TABLE *table_arg, uint *key_num,
                                 uint num_of_keys)
  { return (HA_ERR_WRONG_COMMAND); }
  virtual int final_drop_index(TABLE *table_arg)
unknown's avatar
unknown committed
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
  { return (HA_ERR_WRONG_COMMAND); }

  uint max_record_length() const
  { return min(HA_MAX_REC_LENGTH, max_supported_record_length()); }
  uint max_keys() const
  { return min(MAX_KEY, max_supported_keys()); }
  uint max_key_parts() const
  { return min(MAX_REF_PARTS, max_supported_key_parts()); }
  uint max_key_length() const
  { return min(MAX_KEY_LENGTH, max_supported_key_length()); }
unknown's avatar
unknown committed
1736
  uint max_key_part_length() const
unknown's avatar
unknown committed
1737 1738 1739 1740 1741 1742
  { return min(MAX_KEY_LENGTH, max_supported_key_part_length()); }

  virtual uint max_supported_record_length() const { return HA_MAX_REC_LENGTH; }
  virtual uint max_supported_keys() const { return 0; }
  virtual uint max_supported_key_parts() const { return MAX_REF_PARTS; }
  virtual uint max_supported_key_length() const { return MAX_KEY_LENGTH; }
1743
  virtual uint max_supported_key_part_length() const { return 255; }
unknown's avatar
unknown committed
1744
  virtual uint min_record_length(uint options) const { return 1; }
unknown's avatar
unknown committed
1745

unknown's avatar
unknown committed
1746
  virtual bool low_byte_first() const { return 1; }
unknown's avatar
unknown committed
1747
  virtual uint checksum() const { return 0; }
1748 1749
  virtual bool is_crashed() const  { return 0; }
  virtual bool auto_repair() const { return 0; }
unknown's avatar
unknown committed
1750

1751

1752
#define CHF_CREATE_FLAG 0
1753 1754
#define CHF_DELETE_FLAG 1
#define CHF_RENAME_FLAG 2
1755
#define CHF_INDEX_FLAG  3
1756

unknown's avatar
unknown committed
1757

1758 1759 1760
  /**
    @note lock_count() can return > 1 if the table is MERGE or partitioned.
  */
unknown's avatar
unknown committed
1761
  virtual uint lock_count(void) const { return 1; }
1762 1763
  /**
    Is not invoked for non-transactional temporary tables.
1764

1765 1766 1767
    @note store_lock() can return more than one lock if the table is MERGE
    or partitioned.

1768
    @note that one can NOT rely on table->in_use in store_lock().  It may
unknown's avatar
unknown committed
1769
    refer to a different thread if called from mysql_lock_abort_for_thread().
1770 1771 1772 1773

    @note If the table is MERGE, store_lock() can return less locks
    than lock_count() claimed. This can happen when the MERGE children
    are not attached when this is called from another thread.
unknown's avatar
unknown committed
1774
  */
unknown's avatar
unknown committed
1775 1776 1777
  virtual THR_LOCK_DATA **store_lock(THD *thd,
				     THR_LOCK_DATA **to,
				     enum thr_lock_type lock_type)=0;
1778

1779
  /** Type of table for caching query */
1780
  virtual uint8 table_cache_type() { return HA_CACHE_TBL_NONTRANSACT; }
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812


  /**
    @brief Register a named table with a call back function to the query cache.

    @param thd The thread handle
    @param table_key A pointer to the table name in the table cache
    @param key_length The length of the table name
    @param[out] engine_callback The pointer to the storage engine call back
      function
    @param[out] engine_data Storage engine specific data which could be
      anything

    This method offers the storage engine, the possibility to store a reference
    to a table name which is going to be used with query cache. 
    The method is called each time a statement is written to the cache and can
    be used to verify if a specific statement is cachable. It also offers
    the possibility to register a generic (but static) call back function which
    is called each time a statement is matched against the query cache.

    @note If engine_data supplied with this function is different from
      engine_data supplied with the callback function, and the callback returns
      FALSE, a table invalidation on the current table will occur.

    @return Upon success the engine_callback will point to the storage engine
      call back function, if any, and engine_data will point to any storage
      engine data used in the specific implementation.
      @retval TRUE Success
      @retval FALSE The specified table or current statement should not be
        cached
  */

1813
  virtual my_bool register_query_cache_table(THD *thd, char *table_key,
1814 1815 1816 1817
                                             uint key_length,
                                             qc_engine_callback
                                             *engine_callback,
                                             ulonglong *engine_data)
unknown's avatar
unknown committed
1818 1819
  {
    *engine_callback= 0;
1820
    return TRUE;
unknown's avatar
unknown committed
1821
  }
1822 1823


unknown's avatar
unknown committed
1824
 /*
1825 1826 1827
   @retval TRUE   Primary key (if there is one) is clustered
                  key covering all fields
   @retval FALSE  otherwise
unknown's avatar
unknown committed
1828 1829
 */
 virtual bool primary_key_is_clustered() { return FALSE; }
1830
 virtual int cmp_ref(const uchar *ref1, const uchar *ref2)
unknown's avatar
unknown committed
1831 1832 1833
 {
   return memcmp(ref1, ref2, ref_length);
 }
1834

unknown's avatar
Merge  
unknown committed
1835 1836 1837
 /*
   Condition pushdown to storage engines
 */
1838

1839
 /**
1840
   Push condition down to the table handler.
1841

1842 1843 1844 1845
   @param  cond   Condition to be pushed. The condition tree must not be
                  modified by the by the caller.

   @return
1846 1847 1848
     The 'remainder' condition that caller must use to filter out records.
     NULL means the handler will not return rows that do not match the
     passed condition.
1849

1850
   @note
1851 1852 1853 1854 1855
   The pushed conditions form a stack (from which one can remove the
   last pushed condition using cond_pop).
   The table handler filters out rows using (pushed_cond1 AND pushed_cond2 
   AND ... AND pushed_condN)
   or less restrictive condition, depending on handler's capabilities.
1856

1857
   handler->ha_reset() call empties the condition stack.
1858 1859 1860
   Calls to rnd_init/rnd_end, index_init/index_end etc do not affect the
   condition stack.
 */ 
unknown's avatar
Merge  
unknown committed
1861
 virtual const COND *cond_push(const COND *cond) { return cond; };
1862
 /**
1863
   Pop the top condition from the condition stack of the handler instance.
1864 1865

   Pops the top if condition stack, if stack is not empty.
1866
 */
unknown's avatar
Merge  
unknown committed
1867
 virtual void cond_pop() { return; };
unknown's avatar
unknown committed
1868 1869 1870
 virtual bool check_if_incompatible_data(HA_CREATE_INFO *create_info,
					 uint table_changes)
 { return COMPATIBLE_DATA_NO; }
1871

1872
  /**
1873 1874 1875 1876 1877
    use_hidden_primary_key() is called in case of an update/delete when
    (table_flags() and HA_PRIMARY_KEY_REQUIRED_FOR_DELETE) is defined
    but we don't have a primary key
  */
  virtual void use_hidden_primary_key();
1878 1879 1880 1881 1882
  virtual uint alter_table_flags(uint flags)
  {
    if (ht->alter_table_flags)
      return ht->alter_table_flags(flags);
    return 0;
1883
  }
1884

1885 1886 1887 1888 1889
protected:
  /* Service methods for use by storage engines. */
  void ha_statistic_increment(ulong SSV::*offset) const;
  void **ha_data(THD *) const;
  THD *ha_thd(void) const;
1890

Marc Alff's avatar
Marc Alff committed
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
  /**
    Acquire the instrumented table information from a table share.
    @param share a table share
    @return an instrumented table share, or NULL.
  */
  PSI_table_share *ha_table_share_psi(const TABLE_SHARE *share) const;

  inline void psi_open()
  {
    DBUG_ASSERT(m_psi == NULL);
    DBUG_ASSERT(table_share != NULL);
#ifdef HAVE_PSI_INTERFACE
    if (PSI_server)
    {
      PSI_table_share *share_psi= ha_table_share_psi(table_share);
      if (share_psi)
        m_psi= PSI_server->open_table(share_psi, this);
    }
#endif
  }

  inline void psi_close()
  {
#ifdef HAVE_PSI_INTERFACE
    if (PSI_server && m_psi)
    {
      PSI_server->close_table(m_psi);
      m_psi= NULL; /* instrumentation handle, invalid after close_table() */
    }
#endif
    DBUG_ASSERT(m_psi == NULL);
  }

1924 1925 1926 1927 1928 1929 1930 1931
  /**
    Default rename_table() and delete_table() rename/delete files with a
    given name and extensions from bas_ext().

    These methods can be overridden, but their default implementation
    provide useful functionality.
  */
  virtual int rename_table(const char *from, const char *to);
1932 1933 1934 1935
  /**
    Delete a table in the engine. Called for base as well as temporary
    tables.
  */
1936
  virtual int delete_table(const char *name);
1937 1938 1939
private:
  /* Private helpers */
  inline void mark_trx_read_write();
1940 1941
private:
  /*
1942
    Low-level primitives for storage engines.  These should be
1943 1944 1945
    overridden by the storage engine class. To call these methods, use
    the corresponding 'ha_*' method above.
  */
1946

1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958
  virtual int open(const char *name, int mode, uint test_if_locked)=0;
  virtual int index_init(uint idx, bool sorted) { active_index= idx; return 0; }
  virtual int index_end() { active_index= MAX_KEY; return 0; }
  /**
    rnd_init() can be called two times without rnd_end() in between
    (it only makes sense if scan=1).
    then the second call should prepare for the new table scan (e.g
    if rnd_init allocates the cursor, second call should position it
    to the start of the table, no need to deallocate and allocate it again
  */
  virtual int rnd_init(bool scan)= 0;
  virtual int rnd_end() { return 0; }
1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
  virtual int write_row(uchar *buf __attribute__((unused)))
  {
    return HA_ERR_WRONG_COMMAND;
  }

  virtual int update_row(const uchar *old_data __attribute__((unused)),
                         uchar *new_data __attribute__((unused)))
  {
    return HA_ERR_WRONG_COMMAND;
  }

  virtual int delete_row(const uchar *buf __attribute__((unused)))
  {
    return HA_ERR_WRONG_COMMAND;
  }
1974 1975 1976 1977 1978 1979 1980
  /**
    Reset state of file to after 'open'.
    This function is called after every statement for all tables used
    by that statement.
  */
  virtual int reset() { return 0; }
  virtual Table_flags table_flags(void) const= 0;
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
  /**
    Is not invoked for non-transactional temporary tables.

    Tells the storage engine that we intend to read or write data
    from the table. This call is prefixed with a call to handler::store_lock()
    and is invoked only for those handler instances that stored the lock.

    Calls to rnd_init/index_init are prefixed with this call. When table
    IO is complete, we call external_lock(F_UNLCK).
    A storage engine writer should expect that each call to
    ::external_lock(F_[RD|WR]LOCK is followed by a call to
    ::external_lock(F_UNLCK). If it is not, it is a bug in MySQL.

    The name and signature originate from the first implementation
    in MyISAM, which would call fcntl to set/clear an advisory
    lock on the data file in this method.

    @param   lock_type    F_RDLCK, F_WRLCK, F_UNLCK

    @return  non-0 in case of failure, 0 in case of success.
    When lock_type is F_UNLCK, the return value is ignored.
  */
2003 2004 2005 2006 2007
  virtual int external_lock(THD *thd __attribute__((unused)),
                            int lock_type __attribute__((unused)))
  {
    return 0;
  }
2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
  virtual void release_auto_increment() { return; };
  /** admin commands - called from mysql_admin_table */
  virtual int check_for_upgrade(HA_CHECK_OPT *check_opt)
  { return 0; }
  virtual int check(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }

  /**
     In this method check_opt can be modified
     to specify CHECK option to use to call check()
     upon the table.
  */
  virtual int repair(THD* thd, HA_CHECK_OPT* check_opt)
2021 2022 2023 2024
  {
    DBUG_ASSERT(!(ha_table_flags() & HA_CAN_REPAIR));
    return HA_ADMIN_NOT_IMPLEMENTED;
  }
2025 2026 2027 2028 2029 2030 2031
  virtual void start_bulk_insert(ha_rows rows) {}
  virtual int end_bulk_insert() { return 0; }
  virtual int index_read(uchar * buf, const uchar * key, uint key_len,
                         enum ha_rkey_function find_flag)
   { return  HA_ERR_WRONG_COMMAND; }
  virtual int index_read_last(uchar * buf, const uchar * key, uint key_len)
   { return (my_errno= HA_ERR_WRONG_COMMAND); }
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054
  /**
    This method is similar to update_row, however the handler doesn't need
    to execute the updates at this point in time. The handler can be certain
    that another call to bulk_update_row will occur OR a call to
    exec_bulk_update before the set of updates in this query is concluded.

    @param    old_data       Old record
    @param    new_data       New record
    @param    dup_key_found  Number of duplicate keys found

    @retval  0   Bulk delete used by handler
    @retval  1   Bulk delete not used, normal operation used
  */
  virtual int bulk_update_row(const uchar *old_data, uchar *new_data,
                              uint *dup_key_found)
  {
    DBUG_ASSERT(FALSE);
    return HA_ERR_WRONG_COMMAND;
  }
  /**
    This is called to delete all rows in a table
    If the handler don't support this, then this function will
    return HA_ERR_WRONG_COMMAND and MySQL will delete the rows one
2055
    by one.
2056 2057 2058
  */
  virtual int delete_all_rows()
  { return (my_errno=HA_ERR_WRONG_COMMAND); }
2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078
  /**
    Quickly remove all rows from a table.

    @remark This method is responsible for implementing MySQL's TRUNCATE
            TABLE statement, which is a DDL operation. As such, a engine
            can bypass certain integrity checks and in some cases avoid
            fine-grained locking (e.g. row locks) which would normally be
            required for a DELETE statement.

    @remark Typically, truncate is not used if it can result in integrity
            violation. For example, truncate is not used when a foreign
            key references the table, but it might be used if foreign key
            checks are disabled.

    @remark Engine is responsible for resetting the auto-increment counter.

    @remark The table is locked in exclusive mode.
  */
  virtual int truncate()
  { return HA_ERR_WRONG_COMMAND; }
2079 2080
  /**
    Reset the auto-increment counter to the given value, i.e. the next row
2081 2082
    inserted will get the given value. HA_ERR_WRONG_COMMAND is returned by
    storage engines that don't support this operation.
2083 2084 2085 2086 2087 2088 2089
  */
  virtual int reset_auto_increment(ulonglong value)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int optimize(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
  virtual int analyze(THD* thd, HA_CHECK_OPT* check_opt)
  { return HA_ADMIN_NOT_IMPLEMENTED; }
unknown's avatar
unknown committed
2090
  virtual bool check_and_repair(THD *thd) { return TRUE; }
2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104
  virtual int disable_indexes(uint mode) { return HA_ERR_WRONG_COMMAND; }
  virtual int enable_indexes(uint mode) { return HA_ERR_WRONG_COMMAND; }
  virtual int discard_or_import_tablespace(my_bool discard)
  { return (my_errno=HA_ERR_WRONG_COMMAND); }
  virtual void prepare_for_alter() { return; }
  virtual void drop_table(const char *name);
  virtual int create(const char *name, TABLE *form, HA_CREATE_INFO *info)=0;

  virtual int create_handler_files(const char *name, const char *old_name,
                                   int action_flag, HA_CREATE_INFO *info)
  { return FALSE; }

  virtual int change_partitions(HA_CREATE_INFO *create_info,
                                const char *path,
2105 2106
                                ulonglong * const copied,
                                ulonglong * const deleted,
2107 2108 2109 2110 2111 2112 2113
                                const uchar *pack_frm_data,
                                size_t pack_frm_len)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int drop_partitions(const char *path)
  { return HA_ERR_WRONG_COMMAND; }
  virtual int rename_partitions(const char *path)
  { return HA_ERR_WRONG_COMMAND; }
unknown's avatar
unknown committed
2114 2115
};

2116

unknown's avatar
unknown committed
2117 2118 2119
	/* Some extern variables used with handlers */

extern const char *ha_row_type[];
2120 2121
extern MYSQL_PLUGIN_IMPORT const char *tx_isolation_names[];
extern MYSQL_PLUGIN_IMPORT const char *binlog_format_names[];
2122
extern TYPELIB tx_isolation_typelib;
2123
extern const char *myisam_stats_method_names[];
2124
extern ulong total_ha, total_ha_2pc;
unknown's avatar
unknown committed
2125

2126
/* lookups */
unknown's avatar
unknown committed
2127
handlerton *ha_default_handlerton(THD *thd);
unknown's avatar
unknown committed
2128
plugin_ref ha_resolve_by_name(THD *thd, const LEX_STRING *name);
2129
plugin_ref ha_lock_engine(THD *thd, const handlerton *hton);
unknown's avatar
unknown committed
2130
handlerton *ha_resolve_by_legacy_type(THD *thd, enum legacy_db_type db_type);
unknown's avatar
unknown committed
2131
handler *get_new_handler(TABLE_SHARE *share, MEM_ROOT *alloc,
unknown's avatar
unknown committed
2132 2133
                         handlerton *db_type);
handlerton *ha_checktype(THD *thd, enum legacy_db_type database_type,
2134
                          bool no_substitute, bool report_error);
unknown's avatar
unknown committed
2135 2136


unknown's avatar
unknown committed
2137
static inline enum legacy_db_type ha_legacy_type(const handlerton *db_type)
unknown's avatar
unknown committed
2138 2139 2140 2141
{
  return (db_type == NULL) ? DB_TYPE_UNKNOWN : db_type->db_type;
}

unknown's avatar
unknown committed
2142
static inline const char *ha_resolve_storage_engine_name(const handlerton *db_type)
unknown's avatar
unknown committed
2143
{
unknown's avatar
unknown committed
2144
  return db_type == NULL ? "UNKNOWN" : hton2plugin[db_type->slot]->name.str;
unknown's avatar
unknown committed
2145 2146
}

unknown's avatar
unknown committed
2147
static inline bool ha_check_storage_engine_flag(const handlerton *db_type, uint32 flag)
unknown's avatar
unknown committed
2148 2149 2150 2151
{
  return db_type == NULL ? FALSE : test(db_type->flags & flag);
}

unknown's avatar
unknown committed
2152
static inline bool ha_storage_engine_is_enabled(const handlerton *db_type)
unknown's avatar
unknown committed
2153
{
2154
  return (db_type && db_type->create) ?
unknown's avatar
unknown committed
2155 2156
         (db_type->state == SHOW_OPTION_YES) : FALSE;
}
2157 2158

/* basic stuff */
2159
int ha_init_errors(void);
unknown's avatar
unknown committed
2160
int ha_init(void);
2161
int ha_end(void);
unknown's avatar
unknown committed
2162 2163
int ha_initialize_handlerton(st_plugin_int *plugin);
int ha_finalize_handlerton(st_plugin_int *plugin);
unknown's avatar
unknown committed
2164

2165
TYPELIB *ha_known_exts(void);
unknown's avatar
unknown committed
2166
int ha_panic(enum ha_panic_function flag);
2167
void ha_close_connection(THD* thd);
unknown's avatar
unknown committed
2168
bool ha_flush_logs(handlerton *db_type);
2169
void ha_drop_database(char* path);
unknown's avatar
unknown committed
2170 2171 2172
int ha_create_table(THD *thd, const char *path,
                    const char *db, const char *table_name,
                    HA_CREATE_INFO *create_info,
unknown's avatar
unknown committed
2173
		    bool update_create_info);
unknown's avatar
unknown committed
2174
int ha_delete_table(THD *thd, handlerton *db_type, const char *path,
unknown's avatar
unknown committed
2175
                    const char *db, const char *alias, bool generate_warning);
2176

2177
/* statistics and info */
unknown's avatar
unknown committed
2178
bool ha_show_status(THD *thd, handlerton *db_type, enum ha_stat_type stat);
2179

2180
/* discovery */
2181
int ha_create_table_from_engine(THD* thd, const char *db, const char *name);
2182 2183
bool ha_check_if_table_exists(THD* thd, const char *db, const char *name,
                             bool *exists);
2184
int ha_discover(THD* thd, const char* dbname, const char* name,
2185
                uchar** frmblob, size_t* frmlen);
2186
int ha_find_files(THD *thd,const char *db,const char *path,
2187
                  const char *wild, bool dir, List<LEX_STRING>* files);
unknown's avatar
unknown committed
2188
int ha_table_exists_in_engine(THD* thd, const char* db, const char* name);
2189 2190

/* key cache */
2191
extern "C" int ha_init_key_cache(const char *name, KEY_CACHE *key_cache);
unknown's avatar
unknown committed
2192 2193
int ha_resize_key_cache(KEY_CACHE *key_cache);
int ha_change_key_cache_param(KEY_CACHE *key_cache);
2194 2195
int ha_change_key_cache(KEY_CACHE *old_key_cache, KEY_CACHE *new_key_cache);

unknown's avatar
unknown committed
2196
/* report to InnoDB that control passes to the client */
2197
int ha_release_temporary_latches(THD *thd);
2198 2199 2200

/* transactions: interface to handlerton functions */
int ha_start_consistent_snapshot(THD *thd);
unknown's avatar
unknown committed
2201
int ha_commit_or_rollback_by_xid(XID *xid, bool commit);
2202
int ha_commit_one_phase(THD *thd, bool all);
Konstantin Osipov's avatar
Konstantin Osipov committed
2203
int ha_commit_trans(THD *thd, bool all);
2204 2205 2206 2207 2208
int ha_rollback_trans(THD *thd, bool all);
int ha_prepare(THD *thd);
int ha_recover(HASH *commit_list);

/* transactions: these functions never call handlerton functions directly */
2209
int ha_enable_transaction(THD *thd, bool on);
2210 2211 2212 2213 2214 2215

/* savepoints */
int ha_rollback_to_savepoint(THD *thd, SAVEPOINT *sv);
int ha_savepoint(THD *thd, SAVEPOINT *sv);
int ha_release_savepoint(THD *thd, SAVEPOINT *sv);

unknown's avatar
unknown committed
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
/* these are called by storage engines */
void trans_register_ha(THD *thd, bool all, handlerton *ht);

/*
  Storage engine has to assume the transaction will end up with 2pc if
   - there is more than one 2pc-capable storage engine available
   - in the current transaction 2pc was not disabled yet
*/
#define trans_need_2pc(thd, all)                   ((total_ha_2pc > 1) && \
        !((all ? &thd->transaction.all : &thd->transaction.stmt)->no_2pc))

unknown's avatar
unknown committed
2227 2228 2229 2230
#ifdef HAVE_NDB_BINLOG
int ha_reset_logs(THD *thd);
int ha_binlog_index_purge_file(THD *thd, const char *file);
void ha_reset_slave(THD *thd);
2231
void ha_binlog_log_query(THD *thd, handlerton *db_type,
2232
                         enum_binlog_command binlog_command,
unknown's avatar
unknown committed
2233 2234 2235 2236 2237
                         const char *query, uint query_length,
                         const char *db, const char *table_name);
void ha_binlog_wait(THD *thd);
int ha_binlog_end(THD *thd);
#else
2238 2239 2240 2241 2242 2243
#define ha_reset_logs(a) do {} while (0)
#define ha_binlog_index_purge_file(a,b) do {} while (0)
#define ha_reset_slave(a) do {} while (0)
#define ha_binlog_log_query(a,b,c,d,e,f,g) do {} while (0)
#define ha_binlog_wait(a) do {} while (0)
#define ha_binlog_end(a)  do {} while (0)
unknown's avatar
unknown committed
2244
#endif
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255

const char *get_canonical_filename(handler *file, const char *path,
                                   char *tmp_path);
bool mysql_xa_recover(THD *thd);


inline const char *table_case_name(HA_CREATE_INFO *info, const char *name)
{
  return ((lower_case_table_names == 2 && info->alias) ? info->alias : name);
}

2256
#endif /* HANDLER_INCLUDED */