handler.cc 73.9 KB
Newer Older
unknown's avatar
unknown committed
1
/* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
unknown's avatar
unknown committed
2

unknown's avatar
unknown committed
3 4 5 6
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
unknown's avatar
unknown committed
7

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

unknown's avatar
unknown committed
13 14 15 16 17 18 19
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */


/* Handler-calling-functions */

20
#ifdef USE_PRAGMA_IMPLEMENTATION
unknown's avatar
unknown committed
21 22 23 24 25 26 27
#pragma implementation				// gcc: Class implementation
#endif

#include "mysql_priv.h"
#include "ha_heap.h"
#include "ha_myisam.h"
#include "ha_myisammrg.h"
28 29 30 31 32 33


/*
  We have dummy hanldertons in case the handler has not been compiled
  in. This will be removed in 5.1.
*/
unknown's avatar
unknown committed
34 35
#ifdef HAVE_BERKELEY_DB
#include "ha_berkeley.h"
36
extern handlerton berkeley_hton;
37 38 39 40 41
#else
handlerton berkeley_hton = { "BerkeleyDB", SHOW_OPTION_NO, 
  "Supports transactions and page-level locking", DB_TYPE_BERKELEY_DB, NULL, 
  0, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  NULL, NULL, HTON_NO_FLAGS };
unknown's avatar
unknown committed
42
#endif
43 44
#ifdef HAVE_BLACKHOLE_DB
#include "ha_blackhole.h"
45
extern handlerton blackhole_hton;
46 47 48 49 50 51
#else
handlerton blackhole_hton = { "BLACKHOLE", SHOW_OPTION_NO,
  "/dev/null storage engine (anything you write to it disappears)",
  DB_TYPE_BLACKHOLE_DB, NULL, 0, 0, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
52
#endif
53 54
#ifdef HAVE_EXAMPLE_DB
#include "examples/ha_example.h"
55
extern handlerton example_hton;
56 57 58 59 60 61
#else
handlerton example_hton = { "EXAMPLE", SHOW_OPTION_NO,
  "Example storage engine", 
  DB_TYPE_EXAMPLE_DB, NULL, 0, 0, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
62
#endif
63 64
#ifdef HAVE_PARTITION_DB
#include "ha_partition.h"
65 66 67 68 69 70 71
extern handlerton partition_hton;
#else
handlerton partition_hton = { "partition", SHOW_OPTION_NO,
  "Partition engine", 
  DB_TYPE_EXAMPLE_DB, NULL, 0, 0, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
72
#endif
73
#ifdef HAVE_ARCHIVE_DB
74
#include "ha_archive.h"
75
extern handlerton archive_hton;
76 77 78 79 80
#else
handlerton archive_hton = { "ARCHIVE", SHOW_OPTION_NO,
  "Archive storage engine", DB_TYPE_ARCHIVE_DB, NULL, 0, 0, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
81
#endif
82 83
#ifdef HAVE_CSV_DB
#include "examples/ha_tina.h"
84
extern handlerton tina_hton;
85 86 87 88 89
#else
handlerton tina_hton = { "CSV", SHOW_OPTION_NO, "CSV storage engine", 
  DB_TYPE_CSV_DB, NULL, 0, 0, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
90
#endif
91
#ifdef HAVE_INNOBASE_DB
92
#include "ha_innodb.h"
93
extern handlerton innobase_hton;
94 95 96 97 98 99
#else
handlerton innobase_hton = { "InnoDB", SHOW_OPTION_NO,
  "Supports transactions, row-level locking, and foreign keys", 
  DB_TYPE_INNODB, NULL, 0, 0, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
100
#endif
unknown's avatar
unknown committed
101 102
#ifdef HAVE_NDBCLUSTER_DB
#include "ha_ndbcluster.h"
103
extern handlerton ndbcluster_hton;
104 105 106 107 108 109
#else
handlerton ndbcluster_hton = { "ndbcluster", SHOW_OPTION_NO,
  "Clustered, fault-tolerant, memory-based tables", 
  DB_TYPE_NDBCLUSTER, NULL, 0, 0, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
unknown's avatar
unknown committed
110
#endif
111 112
#ifdef HAVE_FEDERATED_DB
#include "ha_federated.h"
113
extern handlerton federated_hton;
114 115 116 117 118
#else
handlerton federated_hton = { "FEDERATED", SHOW_OPTION_NO, 
  "Federated MySQL storage engine", DB_TYPE_FEDERATED_DB, NULL, 0, 0, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  HTON_NO_FLAGS };
119
#endif
unknown's avatar
unknown committed
120 121 122
#include <myisampack.h>
#include <errno.h>

123 124 125
extern handlerton myisam_hton;
extern handlerton myisammrg_hton;
extern handlerton heap_hton;
126
extern handlerton binlog_hton;
127

128 129 130 131 132 133
/*
  Obsolete
*/
handlerton isam_hton = { "ISAM", SHOW_OPTION_NO, "Obsolete storage engine", 
  DB_TYPE_ISAM, NULL, 0, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 
  NULL, NULL, NULL, NULL, NULL, NULL, HTON_NO_FLAGS };
unknown's avatar
unknown committed
134 135


136
/* static functions defined in this file */
unknown's avatar
unknown committed
137

138
static SHOW_COMP_OPTION have_yes= SHOW_OPTION_YES;
unknown's avatar
unknown committed
139 140 141 142 143 144 145

/* number of entries in handlertons[] */
ulong total_ha;
/* number of storage engines (from handlertons[]) that support 2pc */
ulong total_ha_2pc;
/* size of savepoint storage area (see ha_init) */
ulong savepoint_alloc_size;
146

147
/*
148
  This array is used for processing compiled in engines.
149
*/
150
handlerton *sys_table_types[]=
unknown's avatar
unknown committed
151
{
152 153 154 155 156 157 158 159 160 161 162
  &myisam_hton,
  &heap_hton,
  &innobase_hton,
  &berkeley_hton,
  &blackhole_hton,
  &example_hton,
  &archive_hton,
  &tina_hton,
  &ndbcluster_hton,
  &federated_hton,
  &myisammrg_hton,
163 164
  &binlog_hton,
  &isam_hton,
165
  &partition_hton,
166
  NULL
167 168 169 170
};

struct show_table_alias_st sys_table_aliases[]=
{
171 172 173 174 175 176
  {"INNOBASE",	"InnoDB"},
  {"NDB", "NDBCLUSTER"},
  {"BDB", "BERKELEYDB"},
  {"HEAP", "MEMORY"},
  {"MERGE", "MRG_MYISAM"},
  {NullS, NullS}
unknown's avatar
unknown committed
177
};
178

unknown's avatar
unknown committed
179
const char *ha_row_type[] = {
180
  "", "FIXED", "DYNAMIC", "COMPRESSED", "REDUNDANT", "COMPACT", "?","?","?"
unknown's avatar
unknown committed
181 182
};

unknown's avatar
unknown committed
183
const char *tx_isolation_names[] =
184 185 186
{ "READ-UNCOMMITTED", "READ-COMMITTED", "REPEATABLE-READ", "SERIALIZABLE",
  NullS};
TYPELIB tx_isolation_typelib= {array_elements(tx_isolation_names)-1,"",
187
			       tx_isolation_names, NULL};
unknown's avatar
unknown committed
188

189
static TYPELIB known_extensions= {0,"known_exts", NULL, NULL};
190
uint known_extensions_id= 0;
191

192 193
enum db_type ha_resolve_by_name(const char *name, uint namelen)
{
194
  THD *thd= current_thd;
195
  show_table_alias_st *table_alias;
196
  handlerton **types;
197

198
  if (thd && !my_strnncoll(&my_charset_latin1,
199 200
                           (const uchar *)name, namelen,
                           (const uchar *)"DEFAULT", 7))
201
    return (enum db_type) thd->variables.table_type;
unknown's avatar
unknown committed
202

203
retest:
204
  for (types= sys_table_types; *types; types++)
205
  {
206
    if (!my_strnncoll(&my_charset_latin1,
207 208
                      (const uchar *)name, namelen,
                      (const uchar *)(*types)->name, strlen((*types)->name)))
209
      return (enum db_type) (*types)->db_type;
210
  }
unknown's avatar
unknown committed
211

212
  /*
213
    We check for the historical aliases.
214 215
  */
  for (table_alias= sys_table_aliases; table_alias->type; table_alias++)
216
  {
217
    if (!my_strnncoll(&my_charset_latin1,
218 219 220
                      (const uchar *)name, namelen,
                      (const uchar *)table_alias->alias,
                      strlen(table_alias->alias)))
221
    {
222 223
      name= table_alias->type;
      namelen= strlen(name);
224 225
      goto retest;
    }
226
  }
227

228 229
  return DB_TYPE_UNKNOWN;
}
unknown's avatar
unknown committed
230 231


unknown's avatar
unknown committed
232
const char *ha_get_storage_engine(enum db_type db_type)
233
{
234 235
  handlerton **types;
  for (types= sys_table_types; *types; types++)
236
  {
237 238
    if (db_type == (*types)->db_type)
      return (*types)->name;
239
  }
unknown's avatar
unknown committed
240
  return "*NONE*";
241 242
}

unknown's avatar
unknown committed
243

244 245
bool ha_check_storage_engine_flag(enum db_type db_type, uint32 flag)
{
246 247
  handlerton **types;
  for (types= sys_table_types; *types; types++)
248
  {
249
    if (db_type == (*types)->db_type)
unknown's avatar
unknown committed
250
      return test((*types)->flags & flag);
251
  }
unknown's avatar
unknown committed
252
  return FALSE;                                 // No matching engine
253 254
}

unknown's avatar
unknown committed
255

256
my_bool ha_storage_engine_is_enabled(enum db_type database_type)
unknown's avatar
unknown committed
257
{
258 259
  handlerton **types;
  for (types= sys_table_types; *types; types++)
260
  {
261 262
    if ((database_type == (*types)->db_type) &&
	((*types)->state == SHOW_OPTION_YES))
263
      return TRUE;
264
  }
265 266 267 268
  return FALSE;
}


269
/* Use other database handler if databasehandler is not compiled in */
unknown's avatar
unknown committed
270

271 272
enum db_type ha_checktype(THD *thd, enum db_type database_type,
                          bool no_substitute, bool report_error)
unknown's avatar
unknown committed
273
{
274 275
  if (ha_storage_engine_is_enabled(database_type))
    return database_type;
276 277 278 279 280 281 282
#ifdef HAVE_PARTITION_DB
  /*
    Partition handler is not in the list of handlers shown since it is an internal handler
  */
  if (database_type == DB_TYPE_PARTITION_DB)
    return database_type;
#endif
283 284 285 286 287 288 289 290 291 292
  if (no_substitute)
  {
    if (report_error)
    {
      const char *engine_name= ha_get_storage_engine(database_type);
      my_error(ER_FEATURE_DISABLED,MYF(0),engine_name,engine_name);
    }
    return DB_TYPE_UNKNOWN;
  }

unknown's avatar
unknown committed
293 294 295
  switch (database_type) {
#ifndef NO_HASH
  case DB_TYPE_HASH:
296
    return (database_type);
297
#endif
298 299
  case DB_TYPE_MRG_ISAM:
    return (DB_TYPE_MRG_MYISAM);
unknown's avatar
unknown committed
300 301 302
  default:
    break;
  }
303
  
304 305
  return ((enum db_type) thd->variables.table_type != DB_TYPE_UNKNOWN ?
          (enum db_type) thd->variables.table_type :
306 307 308 309
          ((enum db_type) global_system_variables.table_type !=
           DB_TYPE_UNKNOWN ?
           (enum db_type) global_system_variables.table_type : DB_TYPE_MYISAM)
          );
unknown's avatar
unknown committed
310 311 312
} /* ha_checktype */


313
handler *get_new_handler(TABLE *table, MEM_ROOT *alloc, enum db_type db_type)
unknown's avatar
unknown committed
314
{
315
  handler *file;
unknown's avatar
unknown committed
316 317
  switch (db_type) {
#ifndef NO_HASH
318
  case DB_TYPE_HASH:
unknown's avatar
unknown committed
319
    file= new (alloc) ha_hash(table);
320
    break;
unknown's avatar
unknown committed
321
#endif
322
  case DB_TYPE_MRG_ISAM:
unknown's avatar
unknown committed
323
    file= new (alloc) ha_myisammrg(table);
324
    break;
unknown's avatar
unknown committed
325 326
#ifdef HAVE_BERKELEY_DB
  case DB_TYPE_BERKELEY_DB:
unknown's avatar
unknown committed
327
    file= new (alloc) ha_berkeley(table);
328
    break;
329 330
#endif
#ifdef HAVE_INNOBASE_DB
331
  case DB_TYPE_INNODB:
unknown's avatar
unknown committed
332
    file= new (alloc) ha_innobase(table);
333
    break;
334 335 336
#endif
#ifdef HAVE_EXAMPLE_DB
  case DB_TYPE_EXAMPLE_DB:
337 338
    file= new ha_example(table);
    break;
339
#endif
340 341 342
#ifdef HAVE_PARTITION_DB
  case DB_TYPE_PARTITION_DB:
  {
unknown's avatar
unknown committed
343
    file= new (alloc) ha_partition(table);
344 345 346
    break;
  }
#endif
347 348
#ifdef HAVE_ARCHIVE_DB
  case DB_TYPE_ARCHIVE_DB:
unknown's avatar
unknown committed
349
    file= new (alloc) ha_archive(table);
350
    break;
unknown's avatar
Merge  
unknown committed
351
#endif
352 353
#ifdef HAVE_BLACKHOLE_DB
  case DB_TYPE_BLACKHOLE_DB:
unknown's avatar
unknown committed
354
    file= new (alloc) ha_blackhole(table);
355
    break;
356
#endif
357 358
#ifdef HAVE_FEDERATED_DB
  case DB_TYPE_FEDERATED_DB:
unknown's avatar
unknown committed
359
    file= new (alloc) ha_federated(table);
360
    break;
361
#endif
362 363
#ifdef HAVE_CSV_DB
  case DB_TYPE_CSV_DB:
unknown's avatar
unknown committed
364
    file= new (alloc) ha_tina(table);
365
    break;
366
#endif
unknown's avatar
unknown committed
367 368
#ifdef HAVE_NDBCLUSTER_DB
  case DB_TYPE_NDBCLUSTER:
unknown's avatar
unknown committed
369
    file= new (alloc) ha_ndbcluster(table);
370
    break;
unknown's avatar
unknown committed
371 372
#endif
  case DB_TYPE_HEAP:
unknown's avatar
unknown committed
373
    file= new (alloc) ha_heap(table);
374
    break;
unknown's avatar
unknown committed
375
  default:					// should never happen
376 377 378 379
  {
    enum db_type def=(enum db_type) current_thd->variables.table_type;
    /* Try first with 'default table type' */
    if (db_type != def)
380
      return get_new_handler(table, alloc, def);
381 382 383
  }
  /* Fall back to MyISAM */
  case DB_TYPE_MYISAM:
unknown's avatar
unknown committed
384
    file= new (alloc) ha_myisam(table);
385
    break;
unknown's avatar
unknown committed
386
  case DB_TYPE_MRG_MYISAM:
unknown's avatar
unknown committed
387
    file= new (alloc) ha_myisammrg(table);
388
    break;
unknown's avatar
unknown committed
389
  }
390 391
  if (file)
  {
392
    if (file->ha_initialise())
393 394
    {
      delete file;
395
      file=0;
396
    }
397 398
  }
  return file;
unknown's avatar
unknown committed
399 400
}

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423

#ifdef HAVE_PARTITION_DB
handler *get_ha_partition(partition_info *part_info)
{
  ha_partition *partition;
  DBUG_ENTER("get_ha_partition");
  if ((partition= new ha_partition(part_info)))
  {
    if (partition->ha_initialise())
    {
      delete partition;
      partition= 0;
    }
  }
  else
  {
    my_error(ER_OUTOFMEMORY, MYF(0), sizeof(ha_partition));
  }
  DBUG_RETURN(((handler*) partition));
}
#endif


424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
/*
  Register handler error messages for use with my_error().

  SYNOPSIS
    ha_init_errors()

  RETURN
    0           OK
    != 0        Error
*/

static int ha_init_errors(void)
{
#define SETMSG(nr, msg) errmsgs[(nr) - HA_ERR_FIRST]= (msg)
  const char    **errmsgs;

  /* Allocate a pointer array for the error message strings. */
  /* Zerofill it to avoid uninitialized gaps. */
  if (! (errmsgs= (const char**) my_malloc(HA_ERR_ERRORS * sizeof(char*),
                                           MYF(MY_WME | MY_ZEROFILL))))
    return 1;

  /* Set the dedicated error messages. */
  SETMSG(HA_ERR_KEY_NOT_FOUND,          ER(ER_KEY_NOT_FOUND));
  SETMSG(HA_ERR_FOUND_DUPP_KEY,         ER(ER_DUP_KEY));
  SETMSG(HA_ERR_RECORD_CHANGED,         "Update wich is recoverable");
  SETMSG(HA_ERR_WRONG_INDEX,            "Wrong index given to function");
  SETMSG(HA_ERR_CRASHED,                ER(ER_NOT_KEYFILE));
  SETMSG(HA_ERR_WRONG_IN_RECORD,        ER(ER_CRASHED_ON_USAGE));
  SETMSG(HA_ERR_OUT_OF_MEM,             "Table handler out of memory");
  SETMSG(HA_ERR_NOT_A_TABLE,            "Incorrect file format '%.64s'");
  SETMSG(HA_ERR_WRONG_COMMAND,          "Command not supported");
  SETMSG(HA_ERR_OLD_FILE,               ER(ER_OLD_KEYFILE));
  SETMSG(HA_ERR_NO_ACTIVE_RECORD,       "No record read in update");
  SETMSG(HA_ERR_RECORD_DELETED,         "Intern record deleted");
  SETMSG(HA_ERR_RECORD_FILE_FULL,       ER(ER_RECORD_FILE_FULL));
  SETMSG(HA_ERR_INDEX_FILE_FULL,        "No more room in index file '%.64s'");
  SETMSG(HA_ERR_END_OF_FILE,            "End in next/prev/first/last");
  SETMSG(HA_ERR_UNSUPPORTED,            ER(ER_ILLEGAL_HA));
  SETMSG(HA_ERR_TO_BIG_ROW,             "Too big row");
  SETMSG(HA_WRONG_CREATE_OPTION,        "Wrong create option");
  SETMSG(HA_ERR_FOUND_DUPP_UNIQUE,      ER(ER_DUP_UNIQUE));
  SETMSG(HA_ERR_UNKNOWN_CHARSET,        "Can't open charset");
  SETMSG(HA_ERR_WRONG_MRG_TABLE_DEF,    ER(ER_WRONG_MRG_TABLE));
  SETMSG(HA_ERR_CRASHED_ON_REPAIR,      ER(ER_CRASHED_ON_REPAIR));
  SETMSG(HA_ERR_CRASHED_ON_USAGE,       ER(ER_CRASHED_ON_USAGE));
  SETMSG(HA_ERR_LOCK_WAIT_TIMEOUT,      ER(ER_LOCK_WAIT_TIMEOUT));
  SETMSG(HA_ERR_LOCK_TABLE_FULL,        ER(ER_LOCK_TABLE_FULL));
  SETMSG(HA_ERR_READ_ONLY_TRANSACTION,  ER(ER_READ_ONLY_TRANSACTION));
  SETMSG(HA_ERR_LOCK_DEADLOCK,          ER(ER_LOCK_DEADLOCK));
  SETMSG(HA_ERR_CANNOT_ADD_FOREIGN,     ER(ER_CANNOT_ADD_FOREIGN));
475 476
  SETMSG(HA_ERR_NO_REFERENCED_ROW,      ER(ER_NO_REFERENCED_ROW_2));
  SETMSG(HA_ERR_ROW_IS_REFERENCED,      ER(ER_ROW_IS_REFERENCED_2));
477 478 479 480 481
  SETMSG(HA_ERR_NO_SAVEPOINT,           "No savepoint with that name");
  SETMSG(HA_ERR_NON_UNIQUE_BLOCK_SIZE,  "Non unique key block size");
  SETMSG(HA_ERR_NO_SUCH_TABLE,          "No such table: '%.64s'");
  SETMSG(HA_ERR_TABLE_EXIST,            ER(ER_TABLE_EXISTS_ERROR));
  SETMSG(HA_ERR_NO_CONNECTION,          "Could not connect to storage engine");
482
  SETMSG(HA_ERR_TABLE_DEF_CHANGED,      ER(ER_TABLE_DEF_CHANGED));
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 508 509

  /* Register the error messages for use with my_error(). */
  return my_error_register(errmsgs, HA_ERR_FIRST, HA_ERR_LAST);
}


/*
  Unregister handler error messages.

  SYNOPSIS
    ha_finish_errors()

  RETURN
    0           OK
    != 0        Error
*/

static int ha_finish_errors(void)
{
  const char    **errmsgs;

  /* Allocate a pointer array for the error message strings. */
  if (! (errmsgs= my_error_unregister(HA_ERR_FIRST, HA_ERR_LAST)))
    return 1;
  my_free((gptr) errmsgs, MYF(0));
  return 0;
}
unknown's avatar
unknown committed
510

511

512 513 514 515 516 517 518 519 520
static inline void ha_was_inited_ok(handlerton **ht)
{
  uint tmp= (*ht)->savepoint_offset;
  (*ht)->savepoint_offset= savepoint_alloc_size;
  savepoint_alloc_size+= tmp;
  (*ht)->slot= total_ha++;
  if ((*ht)->prepare)
    total_ha_2pc++;
}
521

unknown's avatar
unknown committed
522 523
int ha_init()
{
524
  int error= 0;
525
  handlerton **types;
526
  show_table_alias_st *table_alias;
527 528
  total_ha= savepoint_alloc_size= 0;

529 530
  if (ha_init_errors())
    return 1;
unknown's avatar
unknown committed
531

532
  /*
533
    We now initialize everything here.
534
  */
535
  for (types= sys_table_types; *types; types++)
536
  {
537 538
    if (!(*types)->init || !(*types)->init())
      ha_was_inited_ok(types); 
unknown's avatar
unknown committed
539
    else
540
      (*types)->state= SHOW_OPTION_DISABLED;
541
  }
542

543
  DBUG_ASSERT(total_ha < MAX_HA);
544 545 546 547 548 549
  /*
    Check if there is a transaction-capable storage engine besides the
    binary log (which is considered a transaction-capable storage engine in
    counting total_ha)
  */
  opt_using_transactions= total_ha>(ulong)opt_bin_log;
550
  savepoint_alloc_size+= sizeof(SAVEPOINT);
551
  return error;
unknown's avatar
unknown committed
552 553 554 555 556 557 558 559 560 561 562
}

	/* close, flush or restart databases */
	/* Ignore this for other databases than ours */

int ha_panic(enum ha_panic_function flag)
{
  int error=0;
#ifndef NO_HASH
  error|=h_panic(flag);			/* fix hash */
#endif
563 564
#ifdef HAVE_ISAM
  error|=mrg_panic(flag);
unknown's avatar
unknown committed
565
  error|=nisam_panic(flag);
566 567
#endif
  error|=heap_panic(flag);
unknown's avatar
unknown committed
568 569 570
  error|=mi_panic(flag);
  error|=myrg_panic(flag);
#ifdef HAVE_BERKELEY_DB
571
  if (have_berkeley_db == SHOW_OPTION_YES)
unknown's avatar
unknown committed
572
    error|=berkeley_end();
573 574
#endif
#ifdef HAVE_INNOBASE_DB
575
  if (have_innodb == SHOW_OPTION_YES)
576
    error|=innobase_end();
unknown's avatar
unknown committed
577 578 579 580
#endif
#ifdef HAVE_NDBCLUSTER_DB
  if (have_ndbcluster == SHOW_OPTION_YES)
    error|=ndbcluster_end();
581
#endif
unknown's avatar
unknown committed
582 583 584 585
#ifdef HAVE_FEDERATED_DB
  if (have_federated_db == SHOW_OPTION_YES)
    error|= federated_db_end();
#endif
586 587 588
#ifdef HAVE_ARCHIVE_DB
  if (have_archive_db == SHOW_OPTION_YES)
    error|= archive_db_end();
unknown's avatar
unknown committed
589 590 591 592
#endif
#ifdef HAVE_CSV_DB
  if (have_csv_db == SHOW_OPTION_YES)
    error|= tina_end();
unknown's avatar
unknown committed
593
#endif
594 595
  if (ha_finish_errors())
    error= 1;
unknown's avatar
unknown committed
596 597 598
  return error;
} /* ha_panic */

599 600 601
void ha_drop_database(char* path)
{
#ifdef HAVE_INNOBASE_DB
602
  if (have_innodb == SHOW_OPTION_YES)
603 604
    innobase_drop_database(path);
#endif
unknown's avatar
unknown committed
605 606 607 608
#ifdef HAVE_NDBCLUSTER_DB
  if (have_ndbcluster == SHOW_OPTION_YES)
    ndbcluster_drop_database(path);
#endif
609
}
unknown's avatar
unknown committed
610

611
/* don't bother to rollback here, it's done already */
612 613
void ha_close_connection(THD* thd)
{
614 615 616 617
  handlerton **types;
  for (types= sys_table_types; *types; types++)
    if (thd->ha_data[(*types)->slot])
      (*types)->close_connection(thd);
618 619 620 621 622
}

/* ========================================================================
 ======================= TRANSACTIONS ===================================*/

unknown's avatar
unknown committed
623 624 625 626 627 628 629 630 631
/*
  Register a storage engine for a transaction

  DESCRIPTION
    Every storage engine MUST call this function when it starts
    a transaction or a statement (that is it must be called both for the
    "beginning of transaction" and "beginning of statement").
    Only storage engines registered for the transaction/statement
    will know when to commit/rollback it.
632 633 634 635 636

  NOTE
    trans_register_ha is idempotent - storage engine may register many
    times per transaction.

unknown's avatar
unknown committed
637
*/
638 639 640
void trans_register_ha(THD *thd, bool all, handlerton *ht_arg)
{
  THD_TRANS *trans;
641
  handlerton **ht;
unknown's avatar
unknown committed
642 643 644
  DBUG_ENTER("trans_register_ha");
  DBUG_PRINT("enter",("%s", all ? "all" : "stmt"));

645 646 647 648 649 650 651 652
  if (all)
  {
    trans= &thd->transaction.all;
    thd->server_status|= SERVER_STATUS_IN_TRANS;
  }
  else
    trans= &thd->transaction.stmt;

653
  for (ht=trans->ht; *ht; ht++)
unknown's avatar
unknown committed
654 655 656
    if (*ht == ht_arg)
      DBUG_VOID_RETURN;  /* already registered, return */

657
  trans->ht[trans->nht++]=ht_arg;
658
  DBUG_ASSERT(*ht == ht_arg);
659
  trans->no_2pc|=(ht_arg->prepare==0);
660 661
  if (thd->transaction.xid_state.xid.is_null())
    thd->transaction.xid_state.xid.set(thd->query_id);
unknown's avatar
unknown committed
662
  DBUG_VOID_RETURN;
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
}

/*
  RETURN
      0  - ok
      1  - error, transaction was rolled back
*/
int ha_prepare(THD *thd)
{
  int error=0, all=1;
  THD_TRANS *trans=all ? &thd->transaction.all : &thd->transaction.stmt;
  handlerton **ht=trans->ht;
  DBUG_ENTER("ha_prepare");
#ifdef USING_TRANSACTIONS
  if (trans->nht)
  {
    for (; *ht; ht++)
    {
      int err;
      statistic_increment(thd->status_var.ha_prepare_count,&LOCK_status);
683
      if ((*ht)->prepare)
684
      {
685 686 687 688 689 690 691 692 693 694 695 696
        if ((err= (*(*ht)->prepare)(thd, all)))
        {
          my_error(ER_ERROR_DURING_COMMIT, MYF(0), err);
          ha_rollback_trans(thd, all);
          error=1;
          break;
        }
      }
      else
      {
        push_warning_printf(thd, MYSQL_ERROR::WARN_LEVEL_WARN,
                            ER_ILLEGAL_HA, ER(ER_ILLEGAL_HA), (*ht)->name);
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
      }
    }
  }
#endif /* USING_TRANSACTIONS */
  DBUG_RETURN(error);
}

/*
  RETURN
      0  - ok
      1  - transaction was rolled back
      2  - error during commit, data may be inconsistent
*/
int ha_commit_trans(THD *thd, bool all)
{
  int error= 0, cookie= 0;
  THD_TRANS *trans= all ? &thd->transaction.all : &thd->transaction.stmt;
  bool is_real_trans= all || thd->transaction.all.nht == 0;
  handlerton **ht= trans->ht;
716
  my_xid xid= thd->transaction.xid_state.xid.get_my_xid();
717
  DBUG_ENTER("ha_commit_trans");
718

719
  if (thd->in_sub_stmt)
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
  {
    /*
      Since we don't support nested statement transactions in 5.0,
      we can't commit or rollback stmt transactions while we are inside
      stored functions or triggers. So we simply do nothing now.
      TODO: This should be fixed in later ( >= 5.1) releases.
    */
    if (!all)
      DBUG_RETURN(0);
    /*
      We assume that all statements which commit or rollback main transaction
      are prohibited inside of stored functions or triggers. So they should
      bail out with error even before ha_commit_trans() call. To be 100% safe
      let us throw error in non-debug builds.
    */
    DBUG_ASSERT(0);
    my_error(ER_COMMIT_NOT_ALLOWED_IN_SF_OR_TRG, MYF(0));
    DBUG_RETURN(2);
  }
739 740 741
#ifdef USING_TRANSACTIONS
  if (trans->nht)
  {
742 743 744 745 746
    if (is_real_trans && wait_if_global_read_lock(thd, 0, 0))
    {
      ha_rollback_trans(thd, all);
      DBUG_RETURN(1);
    }
747
    DBUG_EXECUTE_IF("crash_commit_before", abort(););
748 749 750 751 752

    /* Close all cursors that can not survive COMMIT */
    if (is_real_trans)                          /* not a statement commit */
      thd->stmt_map.close_transient_cursors();

753 754 755 756 757 758 759 760
    if (!trans->no_2pc && trans->nht > 1)
    {
      for (; *ht && !error; ht++)
      {
        int err;
        if ((err= (*(*ht)->prepare)(thd, all)))
        {
          my_error(ER_ERROR_DURING_COMMIT, MYF(0), err);
761
          error= 1;
762 763 764
        }
        statistic_increment(thd->status_var.ha_prepare_count,&LOCK_status);
      }
765
      DBUG_EXECUTE_IF("crash_commit_after_prepare", abort(););
unknown's avatar
unknown committed
766 767
      if (error || (is_real_trans && xid &&
                    (error= !(cookie= tc_log->log(thd, xid)))))
768 769
      {
        ha_rollback_trans(thd, all);
770 771
        error= 1;
        goto end;
772
      }
773
      DBUG_EXECUTE_IF("crash_commit_after_log", abort(););
774 775
    }
    error=ha_commit_one_phase(thd, all) ? cookie ? 2 : 1 : 0;
776
    DBUG_EXECUTE_IF("crash_commit_before_unlog", abort(););
777
    if (cookie)
unknown's avatar
unknown committed
778
      tc_log->unlog(cookie, xid);
779
    DBUG_EXECUTE_IF("crash_commit_after", abort(););
780 781 782
end:
    if (is_real_trans)
      start_waiting_global_read_lock(thd);
783 784 785 786 787
  }
#endif /* USING_TRANSACTIONS */
  DBUG_RETURN(error);
}

788 789 790 791
/*
  NOTE - this function does not care about global read lock.
  A caller should.
*/
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
int ha_commit_one_phase(THD *thd, bool all)
{
  int error=0;
  THD_TRANS *trans=all ? &thd->transaction.all : &thd->transaction.stmt;
  bool is_real_trans=all || thd->transaction.all.nht == 0;
  handlerton **ht=trans->ht;
  DBUG_ENTER("ha_commit_one_phase");
#ifdef USING_TRANSACTIONS
  if (trans->nht)
  {
    for (ht=trans->ht; *ht; ht++)
    {
      int err;
      if ((err= (*(*ht)->commit)(thd, all)))
      {
        my_error(ER_ERROR_DURING_COMMIT, MYF(0), err);
        error=1;
      }
      statistic_increment(thd->status_var.ha_commit_count,&LOCK_status);
      *ht= 0;
    }
    trans->nht=0;
    trans->no_2pc=0;
    if (is_real_trans)
816
      thd->transaction.xid_state.xid.null();
817 818 819 820 821
    if (all)
    {
#ifdef HAVE_QUERY_CACHE
      if (thd->transaction.changed_tables)
        query_cache.invalidate(thd->transaction.changed_tables);
unknown's avatar
unknown committed
822
#endif
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
      thd->variables.tx_isolation=thd->session_tx_isolation;
      thd->transaction.cleanup();
    }
  }
#endif /* USING_TRANSACTIONS */
  DBUG_RETURN(error);
}


int ha_rollback_trans(THD *thd, bool all)
{
  int error=0;
  THD_TRANS *trans=all ? &thd->transaction.all : &thd->transaction.stmt;
  bool is_real_trans=all || thd->transaction.all.nht == 0;
  DBUG_ENTER("ha_rollback_trans");
838
  if (thd->in_sub_stmt)
839 840 841 842 843 844 845 846 847 848 849 850
  {
    /*
      If we are inside stored function or trigger we should not commit or
      rollback current statement transaction. See comment in ha_commit_trans()
      call for more information.
    */
    if (!all)
      DBUG_RETURN(0);
    DBUG_ASSERT(0);
    my_error(ER_COMMIT_NOT_ALLOWED_IN_SF_OR_TRG, MYF(0));
    DBUG_RETURN(1);
  }
851 852 853
#ifdef USING_TRANSACTIONS
  if (trans->nht)
  {
854 855 856 857
    /* Close all cursors that can not survive ROLLBACK */
    if (is_real_trans)                          /* not a statement commit */
      thd->stmt_map.close_transient_cursors();

858 859 860 861 862 863 864 865 866 867 868 869 870 871
    for (handlerton **ht=trans->ht; *ht; ht++)
    {
      int err;
      if ((err= (*(*ht)->rollback)(thd, all)))
      { // cannot happen
        my_error(ER_ERROR_DURING_ROLLBACK, MYF(0), err);
        error=1;
      }
      statistic_increment(thd->status_var.ha_rollback_count,&LOCK_status);
      *ht= 0;
    }
    trans->nht=0;
    trans->no_2pc=0;
    if (is_real_trans)
872
      thd->transaction.xid_state.xid.null();
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
    if (all)
    {
      thd->variables.tx_isolation=thd->session_tx_isolation;
      thd->transaction.cleanup();
    }
  }
#endif /* USING_TRANSACTIONS */
  /*
    If a non-transactional table was updated, warn; don't warn if this is a
    slave thread (because when a slave thread executes a ROLLBACK, it has
    been read from the binary log, so it's 100% sure and normal to produce
    error ER_WARNING_NOT_COMPLETE_ROLLBACK. If we sent the warning to the
    slave SQL thread, it would not stop the thread but just be printed in
    the error log; but we don't want users to wonder why they have this
    message in the error log, so we don't send it.
  */
  if (is_real_trans && (thd->options & OPTION_STATUS_NO_TRANS_UPDATE) &&
      !thd->slave_thread)
    push_warning(thd, MYSQL_ERROR::WARN_LEVEL_WARN,
                 ER_WARNING_NOT_COMPLETE_ROLLBACK,
                 ER(ER_WARNING_NOT_COMPLETE_ROLLBACK));
  DBUG_RETURN(error);
895 896
}

897
/*
unknown's avatar
unknown committed
898
  This is used to commit or rollback a single statement depending on the value
unknown's avatar
unknown committed
899 900 901 902 903
  of error. Note that if the autocommit is on, then the following call inside
  InnoDB will commit or rollback the whole transaction (= the statement). The
  autocommit mechanism built into InnoDB is based on counting locks, but if
  the user has used LOCK TABLES then that mechanism does not know to do the
  commit.
904 905
*/

unknown's avatar
unknown committed
906 907 908
int ha_autocommit_or_rollback(THD *thd, int error)
{
  DBUG_ENTER("ha_autocommit_or_rollback");
909
#ifdef USING_TRANSACTIONS
910
  if (thd->transaction.stmt.nht)
unknown's avatar
unknown committed
911
  {
912 913 914 915 916 917 918
    if (!error)
    {
      if (ha_commit_stmt(thd))
	error=1;
    }
    else
      (void) ha_rollback_stmt(thd);
unknown's avatar
unknown committed
919

unknown's avatar
unknown committed
920
    thd->variables.tx_isolation=thd->session_tx_isolation;
unknown's avatar
unknown committed
921 922 923 924 925
  }
#endif
  DBUG_RETURN(error);
}

unknown's avatar
unknown committed
926

unknown's avatar
unknown committed
927
int ha_commit_or_rollback_by_xid(XID *xid, bool commit)
928
{
929
  handlerton **types;
930 931
  int res= 1;

932
  for (types= sys_table_types; *types; types++)
unknown's avatar
unknown committed
933
  {
934
    if ((*types)->state == SHOW_OPTION_YES && (*types)->recover)
unknown's avatar
unknown committed
935 936 937 938 939 940
    {
      if ((*(commit ? (*types)->commit_by_xid :
             (*types)->rollback_by_xid))(xid));
      res= 0;
    }
  }
941 942
  return res;
}
unknown's avatar
unknown committed
943

unknown's avatar
unknown committed
944

unknown's avatar
unknown committed
945 946 947 948 949 950 951 952 953 954
#ifndef DBUG_OFF
/* this does not need to be multi-byte safe or anything */
static char* xid_to_str(char *buf, XID *xid)
{
  int i;
  char *s=buf;
  *s++='\'';
  for (i=0; i < xid->gtrid_length+xid->bqual_length; i++)
  {
    uchar c=(uchar)xid->data[i];
unknown's avatar
unknown committed
955 956
    /* is_next_dig is set if next character is a number */
    bool is_next_dig= FALSE;
unknown's avatar
unknown committed
957 958
    if (i < XIDDATASIZE)
    {
unknown's avatar
unknown committed
959 960
      char ch= xid->data[i+1];
      is_next_dig= (ch >= '0' && ch <='9');
unknown's avatar
unknown committed
961
    }
unknown's avatar
unknown committed
962 963 964 965 966 967 968 969 970 971 972 973
    if (i == xid->gtrid_length)
    {
      *s++='\'';
      if (xid->bqual_length)
      {
        *s++='.';
        *s++='\'';
      }
    }
    if (c < 32 || c > 126)
    {
      *s++='\\';
unknown's avatar
unknown committed
974 975 976 977 978
      /*
        If next character is a number, write current character with
        3 octal numbers to ensure that the next number is not seen
        as part of the octal number
      */
unknown's avatar
unknown committed
979 980 981 982 983
      if (c > 077 || is_next_dig)
        *s++=_dig_vec_lower[c >> 6];
      if (c > 007 || is_next_dig)
        *s++=_dig_vec_lower[(c >> 3) & 7];
      *s++=_dig_vec_lower[c & 7];
unknown's avatar
unknown committed
984 985 986 987 988 989 990 991 992 993 994 995 996 997
    }
    else
    {
      if (c == '\'' || c == '\\')
        *s++='\\';
      *s++=c;
    }
  }
  *s++='\'';
  *s=0;
  return buf;
}
#endif

998 999
/*
  recover() step of xa
unknown's avatar
unknown committed
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

  NOTE
   there are three modes of operation:

   - automatic recover after a crash
     in this case commit_list != 0, tc_heuristic_recover==0
     all xids from commit_list are committed, others are rolled back

   - manual (heuristic) recover
     in this case commit_list==0, tc_heuristic_recover != 0
     DBA has explicitly specified that all prepared transactions should
     be committed (or rolled back).

   - no recovery (MySQL did not detect a crash)
     in this case commit_list==0, tc_heuristic_recover == 0
     there should be no prepared transactions in this case.
unknown's avatar
unknown committed
1016
*/
1017
int ha_recover(HASH *commit_list)
1018
{
unknown's avatar
unknown committed
1019
  int len, got, found_foreign_xids=0, found_my_xids=0;
1020
  handlerton **types;
1021
  XID *list=0;
unknown's avatar
unknown committed
1022
  bool dry_run=(commit_list==0 && tc_heuristic_recover==0);
1023 1024
  DBUG_ENTER("ha_recover");

unknown's avatar
unknown committed
1025 1026 1027
  /* commit_list and tc_heuristic_recover cannot be set both */
  DBUG_ASSERT(commit_list==0 || tc_heuristic_recover==0);
  /* if either is set, total_ha_2pc must be set too */
1028
  DBUG_ASSERT(dry_run || total_ha_2pc>(ulong)opt_bin_log);
unknown's avatar
unknown committed
1029

1030
  if (total_ha_2pc <= (ulong)opt_bin_log)
unknown's avatar
unknown committed
1031 1032
    DBUG_RETURN(0);

unknown's avatar
unknown committed
1033 1034 1035
  if (commit_list)
    sql_print_information("Starting crash recovery...");

unknown's avatar
unknown committed
1036 1037 1038 1039 1040
#ifndef WILL_BE_DELETED_LATER
  /*
    for now, only InnoDB supports 2pc. It means we can always safely
    rollback all pending transactions, without risking inconsistent data
  */
unknown's avatar
unknown committed
1041
  DBUG_ASSERT(total_ha_2pc == (ulong) opt_bin_log+1); // only InnoDB and binlog
unknown's avatar
unknown committed
1042 1043 1044
  tc_heuristic_recover= TC_HEURISTIC_RECOVER_ROLLBACK; // forcing ROLLBACK
  dry_run=FALSE;
#endif
1045

1046
  for (len= MAX_XID_LIST_SIZE ; list==0 && len > MIN_XID_LIST_SIZE; len/=2)
1047
  {
1048 1049 1050 1051
    list=(XID *)my_malloc(len*sizeof(XID), MYF(0));
  }
  if (!list)
  {
unknown's avatar
unknown committed
1052
    sql_print_error(ER(ER_OUTOFMEMORY), len*sizeof(XID));
1053 1054 1055
    DBUG_RETURN(1);
  }

1056
  for (types= sys_table_types; *types; types++)
1057
  {
1058
    if ((*types)->state != SHOW_OPTION_YES || !(*types)->recover)
1059
      continue;
1060
    while ((got=(*(*types)->recover)(list, len)) > 0 )
1061
    {
unknown's avatar
unknown committed
1062
      sql_print_information("Found %d prepared transaction(s) in %s",
1063
                            got, (*types)->name);
1064 1065 1066 1067
      for (int i=0; i < got; i ++)
      {
        my_xid x=list[i].get_my_xid();
        if (!x) // not "mine" - that is generated by external TM
unknown's avatar
unknown committed
1068
        {
unknown's avatar
unknown committed
1069 1070 1071 1072
#ifndef DBUG_OFF
          char buf[XIDDATASIZE*4+6]; // see xid_to_str
          sql_print_information("ignore xid %s", xid_to_str(buf, list+i));
#endif
1073
          xid_cache_insert(list+i, XA_PREPARED);
unknown's avatar
unknown committed
1074 1075 1076 1077 1078 1079
          found_foreign_xids++;
          continue;
        }
        if (dry_run)
        {
          found_my_xids++;
1080
          continue;
unknown's avatar
unknown committed
1081 1082
        }
        // recovery mode
1083
        if (commit_list ?
unknown's avatar
unknown committed
1084
            hash_search(commit_list, (byte *)&x, sizeof(x)) != 0 :
1085
            tc_heuristic_recover == TC_HEURISTIC_RECOVER_COMMIT)
unknown's avatar
unknown committed
1086 1087 1088 1089 1090
        {
#ifndef DBUG_OFF
          char buf[XIDDATASIZE*4+6]; // see xid_to_str
          sql_print_information("commit xid %s", xid_to_str(buf, list+i));
#endif
1091
          (*(*types)->commit_by_xid)(list+i);
unknown's avatar
unknown committed
1092
        }
1093
        else
unknown's avatar
unknown committed
1094 1095 1096 1097 1098
        {
#ifndef DBUG_OFF
          char buf[XIDDATASIZE*4+6]; // see xid_to_str
          sql_print_information("rollback xid %s", xid_to_str(buf, list+i));
#endif
1099
          (*(*types)->rollback_by_xid)(list+i);
unknown's avatar
unknown committed
1100
        }
1101 1102 1103
      }
      if (got < len)
        break;
1104 1105
    }
  }
1106
  my_free((gptr)list, MYF(0));
unknown's avatar
unknown committed
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
  if (found_foreign_xids)
    sql_print_warning("Found %d prepared XA transactions", found_foreign_xids);
  if (dry_run && found_my_xids)
  {
    sql_print_error("Found %d prepared transactions! It means that mysqld was "
                    "not shut down properly last time and critical recovery "
                    "information (last binlog or %s file) was manually deleted "
                    "after a crash. You have to start mysqld with "
                    "--tc-heuristic-recover switch to commit or rollback "
                    "pending transactions.",
                    found_my_xids, opt_tc_log_file);
    DBUG_RETURN(1);
  }
unknown's avatar
unknown committed
1120 1121
  if (commit_list)
    sql_print_information("Crash recovery finished.");
1122
  DBUG_RETURN(0);
1123
}
1124

unknown's avatar
unknown committed
1125
/*
1126
  return the list of XID's to a client, the same way SHOW commands do
unknown's avatar
unknown committed
1127

1128 1129 1130 1131
  NOTE
    I didn't find in XA specs that an RM cannot return the same XID twice,
    so mysql_xa_recover does not filter XID's to ensure uniqueness.
    It can be easily fixed later, if necessary.
unknown's avatar
unknown committed
1132
*/
1133
bool mysql_xa_recover(THD *thd)
unknown's avatar
unknown committed
1134
{
1135 1136
  List<Item> field_list;
  Protocol *protocol= thd->protocol;
1137 1138
  int i=0;
  XID_STATE *xs;
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
  DBUG_ENTER("mysql_xa_recover");

  field_list.push_back(new Item_int("formatID",0,11));
  field_list.push_back(new Item_int("gtrid_length",0,11));
  field_list.push_back(new Item_int("bqual_length",0,11));
  field_list.push_back(new Item_empty_string("data",XIDDATASIZE));

  if (protocol->send_fields(&field_list,
                            Protocol::SEND_NUM_ROWS | Protocol::SEND_EOF))
    DBUG_RETURN(1);
unknown's avatar
unknown committed
1149

1150
  pthread_mutex_lock(&LOCK_xid_cache);
unknown's avatar
unknown committed
1151
  while ((xs= (XID_STATE*)hash_element(&xid_cache, i++)))
1152
  {
1153
    if (xs->xa_state==XA_PREPARED)
1154
    {
1155 1156 1157 1158 1159 1160 1161
      protocol->prepare_for_resend();
      protocol->store_longlong((longlong)xs->xid.formatID, FALSE);
      protocol->store_longlong((longlong)xs->xid.gtrid_length, FALSE);
      protocol->store_longlong((longlong)xs->xid.bqual_length, FALSE);
      protocol->store(xs->xid.data, xs->xid.gtrid_length+xs->xid.bqual_length,
                      &my_charset_bin);
      if (protocol->write())
1162
      {
1163 1164
        pthread_mutex_unlock(&LOCK_xid_cache);
        DBUG_RETURN(1);
1165 1166
      }
    }
unknown's avatar
unknown committed
1167
  }
1168

1169
  pthread_mutex_unlock(&LOCK_xid_cache);
1170
  send_eof(thd);
1171
  DBUG_RETURN(0);
unknown's avatar
unknown committed
1172
}
1173

1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
/*
  This function should be called when MySQL sends rows of a SELECT result set
  or the EOF mark to the client. It releases a possible adaptive hash index
  S-latch held by thd in InnoDB and also releases a possible InnoDB query
  FIFO ticket to enter InnoDB. To save CPU time, InnoDB allows a thd to
  keep them over several calls of the InnoDB handler interface when a join
  is executed. But when we let the control to pass to the client they have
  to be released because if the application program uses mysql_use_result(),
  it may deadlock on the S-latch if the application on another connection
  performs another SQL query. In MySQL-4.1 this is even more important because
  there a connection can have several SELECT queries open at the same time.

  arguments:
  thd:           the thread handle of the current connection
  return value:  always 0
*/

int ha_release_temporary_latches(THD *thd)
{
#ifdef HAVE_INNOBASE_DB
1194 1195
  if (opt_innodb)
    innobase_release_temporary_latches(thd);
1196 1197 1198 1199
#endif
  return 0;
}

1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214

/* 
  Export statistics for different engines. Currently we use it only for
  InnoDB.
*/

int ha_update_statistics()
{
#ifdef HAVE_INNOBASE_DB
  if (opt_innodb)
    innodb_export_status();
#endif
  return 0;
}

1215
int ha_rollback_to_savepoint(THD *thd, SAVEPOINT *sv)
unknown's avatar
unknown committed
1216 1217
{
  int error=0;
1218 1219 1220 1221
  THD_TRANS *trans=&thd->transaction.all;
  handlerton **ht=trans->ht, **end_ht;
  DBUG_ENTER("ha_rollback_to_savepoint");
  DBUG_ASSERT(thd->transaction.stmt.ht[0] == 0);
1222

1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
  trans->nht=sv->nht;
  trans->no_2pc=0;
  end_ht=ht+sv->nht;
  /*
    rolling back to savepoint in all storage engines that were part of the
    transaction when the savepoint was set
  */
  for (; ht < end_ht; ht++)
  {
    int err;
1233
    DBUG_ASSERT((*ht)->savepoint_set != 0);
1234 1235 1236 1237
    if ((err= (*(*ht)->savepoint_rollback)(thd, (byte *)(sv+1)+(*ht)->savepoint_offset)))
    { // cannot happen
      my_error(ER_ERROR_DURING_ROLLBACK, MYF(0), err);
      error=1;
1238
    }
1239 1240
    statistic_increment(thd->status_var.ha_savepoint_rollback_count,&LOCK_status);
    trans->no_2pc|=(*ht)->prepare == 0;
1241
  }
1242 1243 1244 1245 1246
  /*
    rolling back the transaction in all storage engines that were not part of
    the transaction when the savepoint was set
  */
  for (; *ht ; ht++)
unknown's avatar
unknown committed
1247
  {
1248 1249 1250 1251 1252
    int err;
    if ((err= (*(*ht)->rollback)(thd, 1)))
    { // cannot happen
      my_error(ER_ERROR_DURING_ROLLBACK, MYF(0), err);
      error=1;
unknown's avatar
unknown committed
1253
    }
1254 1255
    statistic_increment(thd->status_var.ha_rollback_count,&LOCK_status);
    *ht=0; // keep it conveniently zero-filled
1256
  }
unknown's avatar
unknown committed
1257 1258 1259
  DBUG_RETURN(error);
}

unknown's avatar
unknown committed
1260
/*
1261 1262 1263
  note, that according to the sql standard (ISO/IEC 9075-2:2003)
  section "4.33.4 SQL-statements and transaction states",
  SAVEPOINT is *not* transaction-initiating SQL-statement
unknown's avatar
unknown committed
1264 1265
*/

1266
int ha_savepoint(THD *thd, SAVEPOINT *sv)
unknown's avatar
unknown committed
1267 1268
{
  int error=0;
1269 1270 1271 1272
  THD_TRANS *trans=&thd->transaction.all;
  handlerton **ht=trans->ht;
  DBUG_ENTER("ha_savepoint");
  DBUG_ASSERT(thd->transaction.stmt.ht[0] == 0);
unknown's avatar
unknown committed
1273
#ifdef USING_TRANSACTIONS
1274
  for (; *ht; ht++)
unknown's avatar
unknown committed
1275
  {
1276 1277
    int err;
    if (! (*ht)->savepoint_set)
unknown's avatar
unknown committed
1278
    {
1279
      my_error(ER_CHECK_NOT_IMPLEMENTED, MYF(0), "SAVEPOINT");
unknown's avatar
unknown committed
1280
      error=1;
1281
      break;
unknown's avatar
unknown committed
1282
    }
1283 1284 1285
    if ((err= (*(*ht)->savepoint_set)(thd, (byte *)(sv+1)+(*ht)->savepoint_offset)))
    { // cannot happen
      my_error(ER_GET_ERRNO, MYF(0), err);
unknown's avatar
unknown committed
1286 1287
      error=1;
    }
1288
    statistic_increment(thd->status_var.ha_savepoint_count,&LOCK_status);
unknown's avatar
unknown committed
1289
  }
1290
  sv->nht=trans->nht;
unknown's avatar
unknown committed
1291 1292 1293 1294
#endif /* USING_TRANSACTIONS */
  DBUG_RETURN(error);
}

1295
int ha_release_savepoint(THD *thd, SAVEPOINT *sv)
unknown's avatar
unknown committed
1296 1297
{
  int error=0;
1298 1299 1300 1301 1302 1303
  handlerton **ht=thd->transaction.all.ht, **end_ht;
  DBUG_ENTER("ha_release_savepoint");
  DBUG_ASSERT(thd->transaction.stmt.ht[0] == 0);

  end_ht=ht+sv->nht;
  for (; ht < end_ht; ht++)
unknown's avatar
unknown committed
1304
  {
1305 1306 1307 1308 1309 1310 1311
    int err;
    if (!(*ht)->savepoint_release)
      continue;
    if ((err= (*(*ht)->savepoint_release)(thd, (byte *)(sv+1)+(*ht)->savepoint_offset)))
    { // cannot happen
      my_error(ER_GET_ERRNO, MYF(0), err);
      error=1;
unknown's avatar
unknown committed
1312
    }
unknown's avatar
unknown committed
1313 1314 1315 1316
  }
  DBUG_RETURN(error);
}

1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328

int ha_start_consistent_snapshot(THD *thd)
{
#ifdef HAVE_INNOBASE_DB
  if ((have_innodb == SHOW_OPTION_YES) &&
      !innobase_start_trx_and_assign_read_view(thd))
    return 0;
#endif
  /*
    Same idea as when one wants to CREATE TABLE in one engine which does not
    exist:
  */
1329 1330 1331
  push_warning(thd, MYSQL_ERROR::WARN_LEVEL_WARN, ER_UNKNOWN_ERROR,
               "This MySQL server does not support any "
               "consistent-read capable storage engine");
1332 1333 1334 1335
  return 0;
}


unknown's avatar
unknown committed
1336 1337 1338 1339
bool ha_flush_logs()
{
  bool result=0;
#ifdef HAVE_BERKELEY_DB
1340
  if ((have_berkeley_db == SHOW_OPTION_YES) &&
1341
      berkeley_flush_logs())
unknown's avatar
unknown committed
1342
    result=1;
1343 1344
#endif
#ifdef HAVE_INNOBASE_DB
1345
  if ((have_innodb == SHOW_OPTION_YES) &&
1346
      innobase_flush_logs())
1347
    result=1;
unknown's avatar
unknown committed
1348 1349 1350 1351
#endif
  return result;
}

unknown's avatar
unknown committed
1352 1353 1354 1355
/*
  This should return ENOENT if the file doesn't exists.
  The .frm file will be deleted only if we return 0 or ENOENT
*/
unknown's avatar
unknown committed
1356

1357 1358
int ha_delete_table(THD *thd, enum db_type table_type, const char *path,
                    const char *alias, bool generate_warning)
unknown's avatar
unknown committed
1359
{
1360
  handler *file;
unknown's avatar
unknown committed
1361
  char tmp_path[FN_REFLEN];
1362 1363 1364 1365 1366 1367 1368 1369
  int error;
  TABLE dummy_table;
  TABLE_SHARE dummy_share;
  DBUG_ENTER("ha_delete_table");

  bzero((char*) &dummy_table, sizeof(dummy_table));
  bzero((char*) &dummy_share, sizeof(dummy_share));
  dummy_table.s= &dummy_share;
1370 1371 1372

  /* DB_TYPE_UNKNOWN is used in ALTER TABLE when renaming only .frm files */
  if (table_type == DB_TYPE_UNKNOWN ||
1373
      ! (file=get_new_handler(&dummy_table, thd->mem_root, table_type)))
1374
    DBUG_RETURN(ENOENT);
1375

unknown's avatar
unknown committed
1376 1377 1378 1379
  if (lower_case_table_names == 2 && !(file->table_flags() & HA_FILE_BASED))
  {
    /* Ensure that table handler get path in lower case */
    strmov(tmp_path, path);
1380
    my_casedn_str(files_charset_info, tmp_path);
unknown's avatar
unknown committed
1381 1382
    path= tmp_path;
  }
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
  if ((error= file->delete_table(path)) && generate_warning)
  {
    /*
      Because file->print_error() use my_error() to generate the error message
      we must store the error state in thd, reset it and restore it to
      be able to get hold of the error message.
      (We should in the future either rewrite handler::print_error() or make
      a nice method of this.
    */
    bool query_error= thd->query_error;
    sp_rcontext *spcont= thd->spcont;
    SELECT_LEX *current_select= thd->lex->current_select;
    char buff[sizeof(thd->net.last_error)];
    char new_error[sizeof(thd->net.last_error)];
    int last_errno= thd->net.last_errno;

    strmake(buff, thd->net.last_error, sizeof(buff)-1);
    thd->query_error= 0;
    thd->spcont= 0;
    thd->lex->current_select= 0;
    thd->net.last_error[0]= 0;

    /* Fill up strucutures that print_error may need */
    dummy_table.s->path= path;
    dummy_table.alias= alias;

    file->print_error(error, 0);
    strmake(new_error, thd->net.last_error, sizeof(buff)-1);

    /* restore thd */
    thd->query_error= query_error;
    thd->spcont= spcont;
    thd->lex->current_select= current_select;
    thd->net.last_errno= last_errno;
    strmake(thd->net.last_error, buff, sizeof(buff)-1);
    push_warning(thd, MYSQL_ERROR::WARN_LEVEL_ERROR, error, new_error);
  }
unknown's avatar
unknown committed
1420
  delete file;
1421
  DBUG_RETURN(error);
unknown's avatar
unknown committed
1422
}
unknown's avatar
unknown committed
1423

unknown's avatar
unknown committed
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
/****************************************************************************
** General handler functions
****************************************************************************/

	/* Open database-handler. Try O_RDONLY if can't open as O_RDWR */
	/* Don't wait for locks if not HA_OPEN_WAIT_IF_LOCKED is set */

int handler::ha_open(const char *name, int mode, int test_if_locked)
{
  int error;
1434
  DBUG_ENTER("handler::ha_open");
1435
  DBUG_PRINT("enter",("name: %s  db_type: %d  db_stat: %d  mode: %d  lock_test: %d",
unknown's avatar
unknown committed
1436 1437
                      name, table->s->db_type, table->db_stat, mode,
                      test_if_locked));
unknown's avatar
unknown committed
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454

  if ((error=open(name,mode,test_if_locked)))
  {
    if ((error == EACCES || error == EROFS) && mode == O_RDWR &&
	(table->db_stat & HA_TRY_READ_ONLY))
    {
      table->db_stat|=HA_READ_ONLY;
      error=open(name,O_RDONLY,test_if_locked);
    }
  }
  if (error)
  {
    my_errno=error;			/* Safeguard */
    DBUG_PRINT("error",("error: %d  errno: %d",error,errno));
  }
  else
  {
1455
    if (table->s->db_options_in_use & HA_OPTION_READ_ONLY_DATA)
unknown's avatar
unknown committed
1456
      table->db_stat|=HA_READ_ONLY;
1457 1458
    (void) extra(HA_EXTRA_NO_READCHECK);	// Not needed in SQL

1459 1460 1461
    DBUG_ASSERT(alloc_root_inited(&table->mem_root));

    if (!(ref= (byte*) alloc_root(&table->mem_root, ALIGN_SIZE(ref_length)*2)))
unknown's avatar
unknown committed
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
    {
      close();
      error=HA_ERR_OUT_OF_MEM;
    }
    else
      dupp_ref=ref+ALIGN_SIZE(ref_length);
  }
  DBUG_RETURN(error);
}

1472 1473
int handler::ha_initialise()
{
unknown's avatar
unknown committed
1474
  DBUG_ENTER("ha_initialise");
1475 1476 1477
  if (table && table->s->fields &&
      ha_allocate_read_write_set(table->s->fields))
  {
unknown's avatar
unknown committed
1478
    DBUG_RETURN(TRUE);
1479
  }
unknown's avatar
unknown committed
1480
  DBUG_RETURN(FALSE);
1481 1482
}

1483 1484
int handler::ha_allocate_read_write_set(ulong no_fields)
{
unknown's avatar
unknown committed
1485
  uint bitmap_size= 4*(((no_fields+1)+31)/32);
1486 1487 1488 1489
  uint32 *read_buf, *write_buf;
#ifndef DEBUG_OFF
  my_bool r;
#endif
1490
  DBUG_ENTER("ha_allocate_read_write_set");
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
  DBUG_PRINT("enter", ("no_fields = %d", no_fields));

  if (table)
  {
    if (table->read_set == NULL)
    {
      read_set= (MY_BITMAP*)sql_alloc(sizeof(MY_BITMAP));
      write_set= (MY_BITMAP*)sql_alloc(sizeof(MY_BITMAP));
      read_buf= (uint32*)sql_alloc(bitmap_size);
      write_buf= (uint32*)sql_alloc(bitmap_size);
      if (!read_set || !write_set || !read_buf || !write_buf)
      {
        ha_deallocate_read_write_set();
        DBUG_RETURN(TRUE);
      }
1506
#ifndef DEBUG_OFF
1507
      r =
1508
#endif
1509 1510
        bitmap_init(read_set, read_buf, no_fields+1, FALSE);
      DBUG_ASSERT(!r /*bitmap_init(read_set...)*/);
1511
#ifndef DEBUG_OFF
1512
      r =
1513
#endif
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
        bitmap_init(write_set, write_buf, no_fields+1, FALSE);
      DBUG_ASSERT(!r /*bitmap_init(write_set...)*/);
      table->read_set= read_set;
      table->write_set= write_set;
      ha_clear_all_set();
    }
    else
    {
      read_set= table->read_set;
      write_set= table->write_set;
    }
  }
1526 1527 1528 1529 1530
  DBUG_RETURN(FALSE);
}

void handler::ha_deallocate_read_write_set()
{
unknown's avatar
unknown committed
1531
  DBUG_ENTER("ha_deallocate_read_write_set");
1532
  read_set=write_set=0;
unknown's avatar
unknown committed
1533
  DBUG_VOID_RETURN;
1534 1535 1536 1537 1538
}

void handler::ha_clear_all_set()
{
  DBUG_ENTER("ha_clear_all_set");
unknown's avatar
unknown committed
1539 1540 1541 1542
  bitmap_clear_all(read_set);
  bitmap_clear_all(write_set);
  bitmap_set_bit(read_set, 0);
  bitmap_set_bit(write_set, 0);
unknown's avatar
unknown committed
1543
  DBUG_VOID_RETURN;
1544 1545 1546 1547
}

int handler::ha_retrieve_all_cols()
{
unknown's avatar
unknown committed
1548
  DBUG_ENTER("handler::ha_retrieve_all_cols");
unknown's avatar
unknown committed
1549
  bitmap_set_all(read_set);
unknown's avatar
unknown committed
1550
  DBUG_RETURN(0);
1551 1552 1553 1554
}

int handler::ha_retrieve_all_pk()
{
unknown's avatar
unknown committed
1555
  DBUG_ENTER("ha_retrieve_all_pk");
1556
  ha_set_primary_key_in_read_set();
unknown's avatar
unknown committed
1557
  DBUG_RETURN(0);
1558 1559 1560 1561 1562
}

void handler::ha_set_primary_key_in_read_set()
{
  ulong prim_key= table->s->primary_key;
1563 1564
  DBUG_ENTER("handler::ha_set_primary_key_in_read_set");
  DBUG_PRINT("info", ("Primary key = %d", prim_key));
1565 1566 1567 1568 1569 1570 1571 1572
  if (prim_key != MAX_KEY)
  {
    KEY_PART_INFO *key_part= table->key_info[prim_key].key_part;
    KEY_PART_INFO *key_part_end= key_part +
              table->key_info[prim_key].key_parts;
    for (;key_part != key_part_end; ++key_part)
      ha_set_bit_in_read_set(key_part->fieldnr);
  }
1573
  DBUG_VOID_RETURN;
1574
}
1575 1576


1577 1578 1579 1580 1581
/*
  Read first row (only) from a table
  This is never called for InnoDB or BDB tables, as these table types
  has the HA_NOT_EXACT_COUNT set.
*/
unknown's avatar
unknown committed
1582

1583
int handler::read_first_row(byte * buf, uint primary_key)
unknown's avatar
unknown committed
1584 1585
{
  register int error;
1586
  DBUG_ENTER("handler::read_first_row");
unknown's avatar
unknown committed
1587

1588
  statistic_increment(current_thd->status_var.ha_read_first_count,&LOCK_status);
1589 1590 1591 1592

  /*
    If there is very few deleted rows in the table, find the first row by
    scanning the table.
1593
    TODO remove the test for HA_READ_ORDER
1594
  */
1595 1596
  if (deleted < 10 || primary_key >= MAX_KEY ||
      !(index_flags(primary_key, 0, 0) & HA_READ_ORDER))
1597
  {
unknown's avatar
unknown committed
1598
    (void) ha_rnd_init(1);
1599
    while ((error= rnd_next(buf)) == HA_ERR_RECORD_DELETED) ;
unknown's avatar
unknown committed
1600
    (void) ha_rnd_end();
1601 1602 1603 1604
  }
  else
  {
    /* Find the first row through the primary key */
1605
    (void) ha_index_init(primary_key, 0);
1606
    error=index_first(buf);
unknown's avatar
unknown committed
1607
    (void) ha_index_end();
1608
  }
unknown's avatar
unknown committed
1609 1610 1611
  DBUG_RETURN(error);
}

1612
/*
1613
  Generate the next auto-increment number based on increment and offset
unknown's avatar
unknown committed
1614

1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
  In most cases increment= offset= 1, in which case we get:
  1,2,3,4,5,...
  If increment=10 and offset=5 and previous number is 1, we get:
  1,5,15,25,35,...
*/

inline ulonglong
next_insert_id(ulonglong nr,struct system_variables *variables)
{
  nr= (((nr+ variables->auto_increment_increment -
         variables->auto_increment_offset)) /
       (ulonglong) variables->auto_increment_increment);
  return (nr* (ulonglong) variables->auto_increment_increment +
          variables->auto_increment_offset);
}


/*
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
  Update the auto_increment field if necessary

  SYNOPSIS
     update_auto_increment()

  RETURN
    0	ok
    1 	get_auto_increment() was called and returned ~(ulonglong) 0
    

  IMPLEMENTATION

    Updates columns with type NEXT_NUMBER if:
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681

  - If column value is set to NULL (in which case
    auto_increment_field_not_null is 0)
  - If column is set to 0 and (sql_mode & MODE_NO_AUTO_VALUE_ON_ZERO) is not
    set. In the future we will only set NEXT_NUMBER fields if one sets them
    to NULL (or they are not included in the insert list).


  There are two different cases when the above is true:

  - thd->next_insert_id == 0  (This is the normal case)
    In this case we set the set the column for the first row to the value
    next_insert_id(get_auto_increment(column))) which is normally
    max-used-column-value +1.

    We call get_auto_increment() only for the first row in a multi-row
    statement. For the following rows we generate new numbers based on the
    last used number.

  - thd->next_insert_id != 0.  This happens when we have read a statement
    from the binary log or when one has used SET LAST_INSERT_ID=#.

    In this case we will set the column to the value of next_insert_id.
    The next row will be given the id
    next_insert_id(next_insert_id)

    The idea is that generated auto_increment values are predictable and
    independent of the column values in the table.  This is needed to be
    able to replicate into a table that already has rows with a higher
    auto-increment value than the one that is inserted.

    After we have already generated an auto-increment number and the user
    inserts a column with a higher value than the last used one, we will
    start counting from the inserted value.

    thd->next_insert_id is cleared after it's been used for a statement.
1682
*/
unknown's avatar
unknown committed
1683

1684
bool handler::update_auto_increment()
unknown's avatar
unknown committed
1685
{
1686 1687 1688
  ulonglong nr;
  THD *thd= table->in_use;
  struct system_variables *variables= &thd->variables;
unknown's avatar
unknown committed
1689
  bool auto_increment_field_not_null;
1690
  bool result= 0;
1691
  DBUG_ENTER("handler::update_auto_increment");
1692 1693 1694 1695 1696 1697

  /*
    We must save the previous value to be able to restore it if the
    row was not inserted
  */
  thd->prev_insert_id= thd->next_insert_id;
unknown's avatar
unknown committed
1698 1699
  auto_increment_field_not_null= table->auto_increment_field_not_null;
  table->auto_increment_field_not_null= FALSE;
1700 1701

  if ((nr= table->next_number_field->val_int()) != 0 ||
unknown's avatar
unknown committed
1702
      auto_increment_field_not_null &&
1703
      thd->variables.sql_mode & MODE_NO_AUTO_VALUE_ON_ZERO)
1704
  {
1705 1706
    /* Clear flag for next row */
    /* Mark that we didn't generate a new value **/
1707
    auto_increment_column_changed=0;
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718

    /* Update next_insert_id if we have already generated a value */
    if (thd->clear_next_insert_id && nr >= thd->next_insert_id)
    {
      if (variables->auto_increment_increment != 1)
        nr= next_insert_id(nr, variables);
      else
        nr++;
      thd->next_insert_id= nr;
      DBUG_PRINT("info",("next_insert_id: %lu", (ulong) nr));
    }
1719
    DBUG_RETURN(0);
1720
  }
1721 1722
  if (!(nr= thd->next_insert_id))
  {
1723 1724 1725
    if ((nr= get_auto_increment()) == ~(ulonglong) 0)
      result= 1;                                // Mark failure

1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
    if (variables->auto_increment_increment != 1)
      nr= next_insert_id(nr-1, variables);
    /*
      Update next row based on the found value. This way we don't have to
      call the handler for every generated auto-increment value on a
      multi-row statement
    */
    thd->next_insert_id= nr;
  }

  DBUG_PRINT("info",("auto_increment: %lu", (ulong) nr));

  /* Mark that we should clear next_insert_id before next stmt */
  thd->clear_next_insert_id= 1;

1741
  if (!table->next_number_field->store((longlong) nr, TRUE))
1742
    thd->insert_id((ulonglong) nr);
1743 1744
  else
    thd->insert_id(table->next_number_field->val_int());
1745 1746 1747 1748 1749 1750

  /*
    We can't set next_insert_id if the auto-increment key is not the
    first key part, as there is no guarantee that the first parts will be in
    sequence
  */
1751
  if (!table->s->next_number_key_offset)
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
  {
    /*
      Set next insert id to point to next auto-increment value to be able to
      handle multi-row statements
      This works even if auto_increment_increment > 1
    */
    thd->next_insert_id= next_insert_id(nr, variables);
  }
  else
    thd->next_insert_id= 0;

  /* Mark that we generated a new value */
1764
  auto_increment_column_changed=1;
1765
  DBUG_RETURN(result);
unknown's avatar
unknown committed
1766 1767
}

1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
/*
  restore_auto_increment

  In case of error on write, we restore the last used next_insert_id value
  because the previous value was not used.
*/

void handler::restore_auto_increment()
{
  THD *thd= table->in_use;
  if (thd->next_insert_id)
    thd->next_insert_id= thd->prev_insert_id;
}

unknown's avatar
unknown committed
1782

1783
ulonglong handler::get_auto_increment()
unknown's avatar
unknown committed
1784
{
1785
  ulonglong nr;
unknown's avatar
unknown committed
1786
  int error;
unknown's avatar
unknown committed
1787

unknown's avatar
unknown committed
1788
  (void) extra(HA_EXTRA_KEYREAD);
1789
  index_init(table->s->next_number_index, 1);
1790
  if (!table->s->next_number_key_offset)
unknown's avatar
unknown committed
1791 1792 1793 1794 1795 1796
  {						// Autoincrement at key-start
    error=index_last(table->record[1]);
  }
  else
  {
    byte key[MAX_KEY_LENGTH];
1797
    key_copy(key, table->record[0],
1798 1799 1800 1801
             table->key_info + table->s->next_number_index,
             table->s->next_number_key_offset);
    error= index_read(table->record[1], key, table->s->next_number_key_offset,
                      HA_READ_PREFIX_LAST);
unknown's avatar
unknown committed
1802 1803
  }

unknown's avatar
unknown committed
1804 1805 1806
  if (error)
    nr=1;
  else
1807 1808
    nr= ((ulonglong) table->next_number_field->
         val_int_offset(table->s->rec_buff_length)+1);
unknown's avatar
unknown committed
1809
  index_end();
unknown's avatar
unknown committed
1810
  (void) extra(HA_EXTRA_NO_KEYREAD);
unknown's avatar
unknown committed
1811 1812 1813
  return nr;
}

1814 1815 1816 1817

/*
  Print error that we got from handler function

unknown's avatar
unknown committed
1818
  NOTE
1819 1820 1821 1822 1823
   In case of delete table it's only safe to use the following parts of
   the 'table' structure:
     table->s->path
     table->alias
*/
unknown's avatar
unknown committed
1824 1825 1826

void handler::print_error(int error, myf errflag)
{
1827
  DBUG_ENTER("handler::print_error");
unknown's avatar
unknown committed
1828 1829 1830 1831
  DBUG_PRINT("enter",("error: %d",error));

  int textno=ER_GET_ERRNO;
  switch (error) {
1832 1833 1834
  case EACCES:
    textno=ER_OPEN_AS_READONLY;
    break;
unknown's avatar
unknown committed
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
  case EAGAIN:
    textno=ER_FILE_USED;
    break;
  case ENOENT:
    textno=ER_FILE_NOT_FOUND;
    break;
  case HA_ERR_KEY_NOT_FOUND:
  case HA_ERR_NO_ACTIVE_RECORD:
  case HA_ERR_END_OF_FILE:
    textno=ER_KEY_NOT_FOUND;
    break;
unknown's avatar
unknown committed
1846
  case HA_ERR_WRONG_MRG_TABLE_DEF:
unknown's avatar
unknown committed
1847 1848 1849 1850 1851 1852 1853 1854 1855
    textno=ER_WRONG_MRG_TABLE;
    break;
  case HA_ERR_FOUND_DUPP_KEY:
  {
    uint key_nr=get_dup_key(error);
    if ((int) key_nr >= 0)
    {
      /* Write the dupplicated key in the error message */
      char key[MAX_KEY_LENGTH];
1856
      String str(key,sizeof(key),system_charset_info);
unknown's avatar
unknown committed
1857
      key_unpack(&str,table,(uint) key_nr);
unknown's avatar
unknown committed
1858
      uint max_length=MYSQL_ERRMSG_SIZE-(uint) strlen(ER(ER_DUP_ENTRY));
unknown's avatar
unknown committed
1859 1860 1861 1862 1863
      if (str.length() >= max_length)
      {
	str.length(max_length-4);
	str.append("...");
      }
1864
      my_error(ER_DUP_ENTRY, MYF(0), str.c_ptr(), key_nr+1);
unknown's avatar
unknown committed
1865 1866 1867 1868 1869
      DBUG_VOID_RETURN;
    }
    textno=ER_DUP_KEY;
    break;
  }
1870 1871
  case HA_ERR_NULL_IN_SPATIAL:
    textno= ER_UNKNOWN_ERROR;
1872
    break;
unknown's avatar
unknown committed
1873 1874 1875 1876 1877 1878 1879 1880 1881
  case HA_ERR_FOUND_DUPP_UNIQUE:
    textno=ER_DUP_UNIQUE;
    break;
  case HA_ERR_RECORD_CHANGED:
    textno=ER_CHECKREAD;
    break;
  case HA_ERR_CRASHED:
    textno=ER_NOT_KEYFILE;
    break;
1882 1883 1884
  case HA_ERR_WRONG_IN_RECORD:
    textno= ER_CRASHED_ON_USAGE;
    break;
1885 1886 1887
  case HA_ERR_CRASHED_ON_USAGE:
    textno=ER_CRASHED_ON_USAGE;
    break;
1888 1889 1890
  case HA_ERR_NOT_A_TABLE:
    textno= error;
    break;
1891 1892 1893
  case HA_ERR_CRASHED_ON_REPAIR:
    textno=ER_CRASHED_ON_REPAIR;
    break;
unknown's avatar
unknown committed
1894
  case HA_ERR_OUT_OF_MEM:
1895 1896
    textno=ER_OUT_OF_RESOURCES;
    break;
unknown's avatar
unknown committed
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
  case HA_ERR_WRONG_COMMAND:
    textno=ER_ILLEGAL_HA;
    break;
  case HA_ERR_OLD_FILE:
    textno=ER_OLD_KEYFILE;
    break;
  case HA_ERR_UNSUPPORTED:
    textno=ER_UNSUPPORTED_EXTENSION;
    break;
  case HA_ERR_RECORD_FILE_FULL:
1907
  case HA_ERR_INDEX_FILE_FULL:
1908
    textno=ER_RECORD_FILE_FULL;
1909
    break;
1910 1911 1912 1913 1914 1915
  case HA_ERR_LOCK_WAIT_TIMEOUT:
    textno=ER_LOCK_WAIT_TIMEOUT;
    break;
  case HA_ERR_LOCK_TABLE_FULL:
    textno=ER_LOCK_TABLE_FULL;
    break;
1916 1917 1918
  case HA_ERR_LOCK_DEADLOCK:
    textno=ER_LOCK_DEADLOCK;
    break;
1919 1920 1921
  case HA_ERR_READ_ONLY_TRANSACTION:
    textno=ER_READ_ONLY_TRANSACTION;
    break;
unknown's avatar
Merge  
unknown committed
1922 1923 1924 1925
  case HA_ERR_CANNOT_ADD_FOREIGN:
    textno=ER_CANNOT_ADD_FOREIGN;
    break;
  case HA_ERR_ROW_IS_REFERENCED:
1926 1927 1928 1929 1930 1931
  {
    String str;
    get_error_message(error, &str);
    my_error(ER_ROW_IS_REFERENCED_2, MYF(0), str.c_ptr_safe());
    DBUG_VOID_RETURN;
  }
unknown's avatar
Merge  
unknown committed
1932
  case HA_ERR_NO_REFERENCED_ROW:
1933 1934 1935 1936 1937 1938
  {
    String str;
    get_error_message(error, &str);
    my_error(ER_NO_REFERENCED_ROW_2, MYF(0), str.c_ptr_safe());
    DBUG_VOID_RETURN;
  }
1939 1940 1941
  case HA_ERR_TABLE_DEF_CHANGED:
    textno=ER_TABLE_DEF_CHANGED;
    break;
1942 1943
  case HA_ERR_NO_SUCH_TABLE:
  {
unknown's avatar
unknown committed
1944 1945 1946 1947 1948
    /*
      We have to use path to find database name instead of using
      table->table_cache_key because if the table didn't exist, then
      table_cache_key was not set up
    */
1949 1950
    char *db;
    char buff[FN_REFLEN];
1951
    uint length= dirname_part(buff,table->s->path);
1952 1953
    buff[length-1]=0;
    db=buff+dirname_length(buff);
1954
    my_error(ER_NO_SUCH_TABLE, MYF(0), db, table->alias);
1955 1956
    break;
  }
unknown's avatar
unknown committed
1957 1958
  default:
    {
1959 1960 1961
      /* The error was "unknown" to this function.
	 Ask handler if it has got a message for this error */
      bool temporary= FALSE;
1962 1963 1964
      String str;
      temporary= get_error_message(error, &str);
      if (!str.is_empty())
1965
      {
1966
	const char* engine= table_type();
1967
	if (temporary)
1968
	  my_error(ER_GET_TEMPORARY_ERRMSG, MYF(0), error, str.ptr(), engine);
1969
	else
1970
	  my_error(ER_GET_ERRMSG, MYF(0), error, str.ptr(), engine);
1971
      }
1972
      else
1973
	my_error(ER_GET_ERRNO,errflag,error);
unknown's avatar
unknown committed
1974 1975 1976
      DBUG_VOID_RETURN;
    }
  }
1977
  my_error(textno, errflag, table->alias, error);
unknown's avatar
unknown committed
1978 1979 1980
  DBUG_VOID_RETURN;
}

unknown's avatar
unknown committed
1981

1982
/*
1983
   Return an error message specific to this handler
1984

1985
   SYNOPSIS
1986 1987
   error        error code previously returned by handler
   buf          Pointer to String where to add error message
unknown's avatar
unknown committed
1988

1989
   Returns true if this is a temporary error
1990 1991
 */

1992
bool handler::get_error_message(int error, String* buf)
1993
{
unknown's avatar
unknown committed
1994
  return FALSE;
1995 1996 1997
}


unknown's avatar
unknown committed
1998
/* Return key if error because of duplicated keys */
unknown's avatar
unknown committed
1999 2000 2001

uint handler::get_dup_key(int error)
{
2002
  DBUG_ENTER("handler::get_dup_key");
unknown's avatar
unknown committed
2003
  table->file->errkey  = (uint) -1;
2004 2005
  if (error == HA_ERR_FOUND_DUPP_KEY || error == HA_ERR_FOUND_DUPP_UNIQUE ||
      error == HA_ERR_NULL_IN_SPATIAL)
unknown's avatar
unknown committed
2006 2007 2008 2009
    info(HA_STATUS_ERRKEY | HA_STATUS_NO_LOCK);
  DBUG_RETURN(table->file->errkey);
}

unknown's avatar
unknown committed
2010

2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
/*
  Delete all files with extension from bas_ext()

  SYNOPSIS
    delete_table()
    name		Base name of table

  NOTES
    We assume that the handler may return more extensions than
    was actually used for the file.

  RETURN
    0   If we successfully deleted at least one file from base_ext and
unknown's avatar
unknown committed
2024
	didn't get any other errors than ENOENT
2025
    #   Error
2026 2027
*/

unknown's avatar
unknown committed
2028 2029
int handler::delete_table(const char *name)
{
2030 2031
  int error= 0;
  int enoent_or_zero= ENOENT;                   // Error if no file was deleted
2032
  char buff[FN_REFLEN];
2033

unknown's avatar
unknown committed
2034 2035
  for (const char **ext=bas_ext(); *ext ; ext++)
  {
2036 2037
    fn_format(buff, name, "", *ext, 2 | 4);
    if (my_delete_with_symlink(buff, MYF(0)))
unknown's avatar
unknown committed
2038
    {
2039
      if ((error= my_errno) != ENOENT)
unknown's avatar
unknown committed
2040 2041
	break;
    }
2042
    else
2043
      enoent_or_zero= 0;                        // No error for ENOENT
2044
    error= enoent_or_zero;
unknown's avatar
unknown committed
2045
  }
unknown's avatar
unknown committed
2046
  return error;
unknown's avatar
unknown committed
2047 2048 2049 2050 2051
}


int handler::rename_table(const char * from, const char * to)
{
unknown's avatar
unknown committed
2052 2053
  int error= 0;
  for (const char **ext= bas_ext(); *ext ; ext++)
unknown's avatar
unknown committed
2054
  {
unknown's avatar
unknown committed
2055 2056 2057 2058 2059 2060
    if (rename_file_ext(from, to, *ext))
    {
      if ((error=my_errno) != ENOENT)
	break;
      error= 0;
    }
unknown's avatar
unknown committed
2061
  }
unknown's avatar
unknown committed
2062
  return error;
unknown's avatar
unknown committed
2063 2064
}

unknown's avatar
unknown committed
2065 2066 2067 2068 2069 2070 2071 2072

void handler::drop_table(const char *name)
{
  close();
  delete_table(name);
}


unknown's avatar
unknown committed
2073
/*
2074 2075 2076 2077 2078 2079
  Tell the storage engine that it is allowed to "disable transaction" in the
  handler. It is a hint that ACID is not required - it is used in NDB for
  ALTER TABLE, for example, when data are copied to temporary table.
  A storage engine may treat this hint any way it likes. NDB for example
  starts to commit every now and then automatically.
  This hint can be safely ignored.
2080
*/
unknown's avatar
unknown committed
2081

2082
int ha_enable_transaction(THD *thd, bool on)
2083 2084 2085
{
  int error=0;

2086 2087
  DBUG_ENTER("ha_enable_transaction");
  thd->transaction.on= on;
unknown's avatar
unknown committed
2088
  if (on)
2089 2090 2091 2092 2093 2094 2095 2096 2097
  {
    /*
      Now all storage engines should have transaction handling enabled.
      But some may have it enabled all the time - "disabling" transactions
      is an optimization hint that storage engine is free to ignore.
      So, let's commit an open transaction (if any) now.
    */
    error= end_trans(thd, COMMIT);
  }
2098 2099 2100
  DBUG_RETURN(error);
}

unknown's avatar
unknown committed
2101 2102 2103 2104 2105
int handler::index_next_same(byte *buf, const byte *key, uint keylen)
{
  int error;
  if (!(error=index_next(buf)))
  {
unknown's avatar
unknown committed
2106
    if (key_cmp_if_same(table, key, active_index, keylen))
unknown's avatar
unknown committed
2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119
    {
      table->status=STATUS_NOT_FOUND;
      error=HA_ERR_END_OF_FILE;
    }
  }
  return error;
}


/****************************************************************************
** Some general functions that isn't in the handler class
****************************************************************************/

unknown's avatar
unknown committed
2120 2121 2122 2123
/*
  Initiates table-file and calls apropriate database-creator
  Returns 1 if something got wrong
*/
unknown's avatar
unknown committed
2124 2125 2126 2127 2128 2129

int ha_create_table(const char *name, HA_CREATE_INFO *create_info,
		    bool update_create_info)
{
  int error;
  TABLE table;
unknown's avatar
unknown committed
2130
  char name_buff[FN_REFLEN];
unknown's avatar
unknown committed
2131 2132
  DBUG_ENTER("ha_create_table");

2133
  if (openfrm(current_thd, name,"",0,(uint) READ_ALL, 0, &table))
unknown's avatar
unknown committed
2134 2135 2136 2137 2138
    DBUG_RETURN(1);
  if (update_create_info)
  {
    update_create_info_from_table(create_info, &table);
  }
unknown's avatar
unknown committed
2139 2140 2141 2142 2143
  if (lower_case_table_names == 2 &&
      !(table.file->table_flags() & HA_FILE_BASED))
  {
    /* Ensure that handler gets name in lower case */
    strmov(name_buff, name);
2144
    my_casedn_str(files_charset_info, name_buff);
unknown's avatar
unknown committed
2145 2146 2147
    name= name_buff;
  }

unknown's avatar
unknown committed
2148 2149
  error=table.file->create(name,&table,create_info);
  VOID(closefrm(&table));
unknown's avatar
unknown committed
2150
  if (error)
2151
    my_error(ER_CANT_CREATE_TABLE, MYF(ME_BELL+ME_WAITTANG), name,error);
unknown's avatar
unknown committed
2152 2153 2154
  DBUG_RETURN(error != 0);
}

2155
/*
2156
  Try to discover table from engine and
2157
  if found, write the frm file to disk.
2158

2159
  RETURN VALUES:
2160
  -1 : Table did not exists
2161
   0 : Table created ok
2162
   > 0 : Error, table existed but could not be created
2163 2164 2165

*/

2166 2167 2168
int ha_create_table_from_engine(THD* thd,
				const char *db,
				const char *name)
2169
{
unknown's avatar
unknown committed
2170 2171 2172
  int error;
  const void *frmblob;
  uint frmlen;
2173 2174 2175 2176
  char path[FN_REFLEN];
  HA_CREATE_INFO create_info;
  TABLE table;
  DBUG_ENTER("ha_create_table_from_engine");
unknown's avatar
unknown committed
2177
  DBUG_PRINT("enter", ("name '%s'.'%s'", db, name));
2178 2179 2180

  bzero((char*) &create_info,sizeof(create_info));
  if ((error= ha_discover(thd, db, name, &frmblob, &frmlen)))
2181
  {
unknown's avatar
unknown committed
2182
    /* Table could not be discovered and thus not created */
2183
    DBUG_RETURN(error);
2184 2185
  }

unknown's avatar
unknown committed
2186
  /*
2187 2188
    Table exists in handler and could be discovered
    frmblob and frmlen are set, write the frm to disk
unknown's avatar
unknown committed
2189
  */
2190

2191 2192
  (void)strxnmov(path,FN_REFLEN,mysql_data_home,"/",db,"/",name,NullS);
  // Save the frm file
unknown's avatar
unknown committed
2193 2194 2195
  error= writefrm(path, frmblob, frmlen);
  my_free((char*) frmblob, MYF(0));
  if (error)
2196
    DBUG_RETURN(2);
2197

unknown's avatar
unknown committed
2198
  if (openfrm(thd, path,"",0,(uint) READ_ALL, 0, &table))
2199
    DBUG_RETURN(3);
2200

2201
  update_create_info_from_table(&create_info, &table);
2202
  create_info.table_options|= HA_OPTION_CREATE_FROM_ENGINE;
2203

2204 2205 2206 2207 2208
  if (lower_case_table_names == 2 &&
      !(table.file->table_flags() & HA_FILE_BASED))
  {
    /* Ensure that handler gets name in lower case */
    my_casedn_str(files_charset_info, path);
2209
  }
2210 2211
  error=table.file->create(path,&table,&create_info);
  VOID(closefrm(&table));
2212

2213
  DBUG_RETURN(error != 0);
2214 2215
}

2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
void st_ha_check_opt::init()
{
  flags= sql_flags= 0;
  sort_buffer_size = current_thd->variables.myisam_sort_buff_size;
}


/*****************************************************************************
  Key cache handling.

  This code is only relevant for ISAM/MyISAM tables

  key_cache->cache may be 0 only in the case where a key cache is not
  initialized or when we where not able to init the key cache in a previous
  call to ha_init_key_cache() (probably out of memory)
*****************************************************************************/

/* Init a key cache if it has not been initied before */
unknown's avatar
unknown committed
2234

2235

unknown's avatar
unknown committed
2236
int ha_init_key_cache(const char *name, KEY_CACHE *key_cache)
unknown's avatar
unknown committed
2237
{
2238 2239
  DBUG_ENTER("ha_init_key_cache");

unknown's avatar
unknown committed
2240
  if (!key_cache->key_cache_inited)
2241 2242
  {
    pthread_mutex_lock(&LOCK_global_system_variables);
unknown's avatar
unknown committed
2243 2244 2245 2246
    long tmp_buff_size= (long) key_cache->param_buff_size;
    long tmp_block_size= (long) key_cache->param_block_size;
    uint division_limit= key_cache->param_division_limit;
    uint age_threshold=  key_cache->param_age_threshold;
2247
    pthread_mutex_unlock(&LOCK_global_system_variables);
unknown's avatar
unknown committed
2248
    DBUG_RETURN(!init_key_cache(key_cache,
2249 2250
				tmp_block_size,
				tmp_buff_size,
unknown's avatar
unknown committed
2251
				division_limit, age_threshold));
2252
  }
2253
  DBUG_RETURN(0);
unknown's avatar
unknown committed
2254 2255
}

2256 2257 2258

/* Resize key cache */

unknown's avatar
unknown committed
2259
int ha_resize_key_cache(KEY_CACHE *key_cache)
unknown's avatar
unknown committed
2260
{
2261 2262
  DBUG_ENTER("ha_resize_key_cache");

unknown's avatar
unknown committed
2263
  if (key_cache->key_cache_inited)
2264 2265
  {
    pthread_mutex_lock(&LOCK_global_system_variables);
unknown's avatar
unknown committed
2266 2267 2268 2269
    long tmp_buff_size= (long) key_cache->param_buff_size;
    long tmp_block_size= (long) key_cache->param_block_size;
    uint division_limit= key_cache->param_division_limit;
    uint age_threshold=  key_cache->param_age_threshold;
2270
    pthread_mutex_unlock(&LOCK_global_system_variables);
unknown's avatar
unknown committed
2271 2272 2273
    DBUG_RETURN(!resize_key_cache(key_cache, tmp_block_size,
				  tmp_buff_size,
				  division_limit, age_threshold));
2274
  }
2275
  DBUG_RETURN(0);
2276 2277
}

2278 2279 2280

/* Change parameters for key cache (like size) */

unknown's avatar
unknown committed
2281
int ha_change_key_cache_param(KEY_CACHE *key_cache)
2282
{
unknown's avatar
unknown committed
2283 2284 2285 2286 2287 2288 2289 2290
  if (key_cache->key_cache_inited)
  {
    pthread_mutex_lock(&LOCK_global_system_variables);
    uint division_limit= key_cache->param_division_limit;
    uint age_threshold=  key_cache->param_age_threshold;
    pthread_mutex_unlock(&LOCK_global_system_variables);
    change_key_cache_param(key_cache, division_limit, age_threshold);
  }
2291 2292
  return 0;
}
unknown's avatar
unknown committed
2293

2294 2295
/* Free memory allocated by a key cache */

unknown's avatar
unknown committed
2296
int ha_end_key_cache(KEY_CACHE *key_cache)
unknown's avatar
unknown committed
2297
{
unknown's avatar
unknown committed
2298
  end_key_cache(key_cache, 1);		// Can never fail
2299
  return 0;
unknown's avatar
unknown committed
2300
}
unknown's avatar
unknown committed
2301

2302
/* Move all tables from one key cache to another one */
unknown's avatar
unknown committed
2303

unknown's avatar
unknown committed
2304 2305
int ha_change_key_cache(KEY_CACHE *old_key_cache,
			KEY_CACHE *new_key_cache)
unknown's avatar
unknown committed
2306
{
2307 2308
  mi_change_key_cache(old_key_cache, new_key_cache);
  return 0;
unknown's avatar
unknown committed
2309
}
2310 2311


unknown's avatar
unknown committed
2312 2313
/*
  Try to discover one table from handler(s)
unknown's avatar
unknown committed
2314 2315

  RETURN
2316 2317 2318
   -1  : Table did not exists
    0  : OK. In this case *frmblob and *frmlen are set
    >0 : error.  frmblob and frmlen may not be set
unknown's avatar
unknown committed
2319 2320
*/

unknown's avatar
unknown committed
2321 2322
int ha_discover(THD *thd, const char *db, const char *name,
		const void **frmblob, uint *frmlen)
unknown's avatar
unknown committed
2323
{
2324
  int error= -1; // Table does not exist in any handler
unknown's avatar
unknown committed
2325
  DBUG_ENTER("ha_discover");
2326
  DBUG_PRINT("enter", ("db: %s, name: %s", db, name));
2327 2328
  if (is_prefix(name,tmp_file_prefix)) /* skip temporary tables */
    DBUG_RETURN(error);
unknown's avatar
unknown committed
2329 2330
#ifdef HAVE_NDBCLUSTER_DB
  if (have_ndbcluster == SHOW_OPTION_YES)
2331
    error= ndbcluster_discover(thd, db, name, frmblob, frmlen);
unknown's avatar
unknown committed
2332 2333
#endif
  if (!error)
2334
    statistic_increment(thd->status_var.ha_discover_count,&LOCK_status);
unknown's avatar
unknown committed
2335 2336 2337 2338
  DBUG_RETURN(error);
}


2339
/*
2340 2341 2342
  Call this function in order to give the handler the possiblity 
  to ask engine if there are any new tables that should be written to disk 
  or any dropped tables that need to be removed from disk
2343 2344
*/

2345 2346
int
ha_find_files(THD *thd,const char *db,const char *path,
unknown's avatar
unknown committed
2347
	      const char *wild, bool dir, List<char> *files)
2348 2349
{
  int error= 0;
2350 2351 2352
  DBUG_ENTER("ha_find_files");
  DBUG_PRINT("enter", ("db: %s, path: %s, wild: %s, dir: %d", 
		       db, path, wild, dir));
2353 2354
#ifdef HAVE_NDBCLUSTER_DB
  if (have_ndbcluster == SHOW_OPTION_YES)
unknown's avatar
unknown committed
2355
    error= ndbcluster_find_files(thd, db, path, wild, dir, files);
2356 2357 2358 2359
#endif
  DBUG_RETURN(error);
}

unknown's avatar
unknown committed
2360

2361 2362 2363 2364 2365 2366 2367 2368 2369
/*
  Ask handler if the table exists in engine

  RETURN
    0                   Table does not exist
    1                   Table exists
    #                   Error code

 */
2370
int ha_table_exists_in_engine(THD* thd, const char* db, const char* name)
2371
{
2372 2373
  int error= 0;
  DBUG_ENTER("ha_table_exists_in_engine");
2374 2375 2376
  DBUG_PRINT("enter", ("db: %s, name: %s", db, name));
#ifdef HAVE_NDBCLUSTER_DB
  if (have_ndbcluster == SHOW_OPTION_YES)
2377
    error= ndbcluster_table_exists_in_engine(thd, db, name);
2378
#endif
2379
  DBUG_PRINT("exit", ("error: %d", error));
2380 2381 2382 2383
  DBUG_RETURN(error);
}


unknown's avatar
unknown committed
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508
/*
  Read the first row of a multi-range set.

  SYNOPSIS
    read_multi_range_first()
    found_range_p       Returns a pointer to the element in 'ranges' that
                        corresponds to the returned row.
    ranges              An array of KEY_MULTI_RANGE range descriptions.
    range_count         Number of ranges in 'ranges'.
    sorted		If result should be sorted per key.
    buffer              A HANDLER_BUFFER for internal handler usage.

  NOTES
    Record is read into table->record[0].
    *found_range_p returns a valid value only if read_multi_range_first()
    returns 0.
    Sorting is done within each range. If you want an overall sort, enter
    'ranges' with sorted ranges.

  RETURN
    0			OK, found a row
    HA_ERR_END_OF_FILE	No rows in range
    #			Error code
*/

int handler::read_multi_range_first(KEY_MULTI_RANGE **found_range_p,
                                    KEY_MULTI_RANGE *ranges, uint range_count,
                                    bool sorted, HANDLER_BUFFER *buffer)
{
  int result= HA_ERR_END_OF_FILE;
  DBUG_ENTER("handler::read_multi_range_first");
  multi_range_sorted= sorted;
  multi_range_buffer= buffer;

  for (multi_range_curr= ranges, multi_range_end= ranges + range_count;
       multi_range_curr < multi_range_end;
       multi_range_curr++)
  {
    result= read_range_first(multi_range_curr->start_key.length ?
                             &multi_range_curr->start_key : 0,
                             multi_range_curr->end_key.length ?
                             &multi_range_curr->end_key : 0,
                             test(multi_range_curr->range_flag & EQ_RANGE),
                             multi_range_sorted);
    if (result != HA_ERR_END_OF_FILE)
      break;
  }

  *found_range_p= multi_range_curr;
  DBUG_PRINT("exit",("result %d", result));
  DBUG_RETURN(result);
}


/*
  Read the next row of a multi-range set.

  SYNOPSIS
    read_multi_range_next()
    found_range_p       Returns a pointer to the element in 'ranges' that
                        corresponds to the returned row.

  NOTES
    Record is read into table->record[0].
    *found_range_p returns a valid value only if read_multi_range_next()
    returns 0.

  RETURN
    0			OK, found a row
    HA_ERR_END_OF_FILE	No (more) rows in range
    #			Error code
*/

int handler::read_multi_range_next(KEY_MULTI_RANGE **found_range_p)
{
  int result;
  DBUG_ENTER("handler::read_multi_range_next");

  /* We should not be called after the last call returned EOF. */
  DBUG_ASSERT(multi_range_curr < multi_range_end);

  do
  {
    /* Save a call if there can be only one row in range. */
    if (multi_range_curr->range_flag != (UNIQUE_RANGE | EQ_RANGE))
    {
      result= read_range_next();

      /* On success or non-EOF errors jump to the end. */
      if (result != HA_ERR_END_OF_FILE)
        break;
    }
    else
    {
      /*
        We need to set this for the last range only, but checking this
        condition is more expensive than just setting the result code.
      */
      result= HA_ERR_END_OF_FILE;
    }

    /* Try the next range(s) until one matches a record. */
    for (multi_range_curr++;
         multi_range_curr < multi_range_end;
         multi_range_curr++)
    {
      result= read_range_first(multi_range_curr->start_key.length ?
                               &multi_range_curr->start_key : 0,
                               multi_range_curr->end_key.length ?
                               &multi_range_curr->end_key : 0,
                               test(multi_range_curr->range_flag & EQ_RANGE),
                               multi_range_sorted);
      if (result != HA_ERR_END_OF_FILE)
        break;
    }
  }
  while ((result == HA_ERR_END_OF_FILE) &&
         (multi_range_curr < multi_range_end));

  *found_range_p= multi_range_curr;
  DBUG_PRINT("exit",("handler::read_multi_range_next: result %d", result));
  DBUG_RETURN(result);
}


2509 2510 2511 2512 2513 2514 2515 2516
/*
  Read first row between two ranges.
  Store ranges for future calls to read_range_next

  SYNOPSIS
    read_range_first()
    start_key		Start key. Is 0 if no min range
    end_key		End key.  Is 0 if no max range
unknown's avatar
unknown committed
2517
    eq_range_arg	Set to 1 if start_key == end_key		
2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530
    sorted		Set to 1 if result should be sorted per key

  NOTES
    Record is read into table->record[0]

  RETURN
    0			Found row
    HA_ERR_END_OF_FILE	No rows in range
    #			Error code
*/

int handler::read_range_first(const key_range *start_key,
			      const key_range *end_key,
unknown's avatar
unknown committed
2531
			      bool eq_range_arg, bool sorted)
2532 2533 2534 2535
{
  int result;
  DBUG_ENTER("handler::read_range_first");

unknown's avatar
unknown committed
2536
  eq_range= eq_range_arg;
2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
  end_range= 0;
  if (end_key)
  {
    end_range= &save_end_range;
    save_end_range= *end_key;
    key_compare_result_on_equal= ((end_key->flag == HA_READ_BEFORE_KEY) ? 1 :
				  (end_key->flag == HA_READ_AFTER_KEY) ? -1 : 0);
  }
  range_key_part= table->key_info[active_index].key_part;

  if (!start_key)			// Read first record
    result= index_first(table->record[0]);
  else
    result= index_read(table->record[0],
		       start_key->key,
		       start_key->length,
		       start_key->flag);
  if (result)
unknown's avatar
unknown committed
2555 2556 2557
    DBUG_RETURN((result == HA_ERR_KEY_NOT_FOUND) 
		? HA_ERR_END_OF_FILE
		: result);
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577

  DBUG_RETURN (compare_key(end_range) <= 0 ? 0 : HA_ERR_END_OF_FILE);
}


/*
  Read next row between two ranges.

  SYNOPSIS
    read_range_next()

  NOTES
    Record is read into table->record[0]

  RETURN
    0			Found row
    HA_ERR_END_OF_FILE	No rows in range
    #			Error code
*/

unknown's avatar
unknown committed
2578
int handler::read_range_next()
2579 2580 2581 2582 2583
{
  int result;
  DBUG_ENTER("handler::read_range_next");

  if (eq_range)
unknown's avatar
unknown committed
2584 2585 2586 2587 2588 2589 2590
  {
    /* We trust that index_next_same always gives a row in range */
    DBUG_RETURN(index_next_same(table->record[0],
                                end_range->key,
                                end_range->length));
  }
  result= index_next(table->record[0]);
2591 2592 2593 2594 2595 2596 2597
  if (result)
    DBUG_RETURN(result);
  DBUG_RETURN(compare_key(end_range) <= 0 ? 0 : HA_ERR_END_OF_FILE);
}


/*
unknown's avatar
unknown committed
2598
  Compare if found key (in row) is over max-value
2599 2600 2601

  SYNOPSIS
    compare_key
unknown's avatar
unknown committed
2602
    range		range to compare to row. May be 0 for no range
2603 2604
 
  NOTES
unknown's avatar
unknown committed
2605
    See key.cc::key_cmp() for details
2606 2607

  RETURN
unknown's avatar
unknown committed
2608 2609
    The return value is SIGN(key_in_row - range_key):

2610 2611 2612 2613 2614 2615 2616
    0			Key is equal to range or 'range' == 0 (no range)
   -1			Key is less than range
    1			Key is larger than range
*/

int handler::compare_key(key_range *range)
{
unknown's avatar
unknown committed
2617
  int cmp;
2618 2619
  if (!range)
    return 0;					// No max range
unknown's avatar
unknown committed
2620 2621 2622 2623
  cmp= key_cmp(range_key_part, range->key, range->length);
  if (!cmp)
    cmp= key_compare_result_on_equal;
  return cmp;
2624
}
unknown's avatar
unknown committed
2625 2626 2627 2628

int handler::index_read_idx(byte * buf, uint index, const byte * key,
			     uint key_len, enum ha_rkey_function find_flag)
{
2629
  int error= ha_index_init(index, 0);
unknown's avatar
unknown committed
2630 2631 2632 2633 2634 2635 2636
  if (!error)
    error= index_read(buf, key, key_len, find_flag);
  if (!error)
    error= ha_index_end();
  return error;
}

2637

2638 2639 2640 2641 2642 2643 2644 2645
/*
  Returns a list of all known extensions.

  SYNOPSIS
    ha_known_exts()
 
  NOTES
    No mutexes, worst case race is a minor surplus memory allocation
2646 2647
    We have to recreate the extension map if mysqld is restarted (for example
    within libmysqld)
2648 2649 2650 2651

  RETURN VALUE
    pointer		pointer to TYPELIB structure
*/
2652

2653 2654
TYPELIB *ha_known_exts(void)
{
2655
  MEM_ROOT *mem_root= current_thd->mem_root;
2656
  if (!known_extensions.type_names || mysys_usage_id != known_extensions_id)
2657
  {
2658
    handlerton **types;
2659 2660
    List<char> found_exts;
    List_iterator_fast<char> it(found_exts);
2661 2662 2663
    const char **ext, *old_ext;

    known_extensions_id= mysys_usage_id;
2664
    found_exts.push_back((char*) triggers_file_ext);
2665
    found_exts.push_back((char*) trigname_file_ext);
2666
    for (types= sys_table_types; *types; types++)
unknown's avatar
unknown committed
2667
    {
2668
      if ((*types)->state == SHOW_OPTION_YES)
2669
      {
2670 2671
	handler *file= get_new_handler(0, mem_root,
                                       (enum db_type) (*types)->db_type);
2672 2673
	for (ext= file->bas_ext(); *ext; ext++)
	{
2674 2675 2676
	  while ((old_ext= it++))
          {
	    if (!strcmp(old_ext, *ext))
2677
	      break;
2678 2679 2680
          }
	  if (!old_ext)
	    found_exts.push_back((char *) *ext);
2681 2682 2683 2684 2685 2686

	  it.rewind();
	}
	delete file;
      }
    }
2687 2688 2689
    ext= (const char **) my_once_alloc(sizeof(char *)*
                                       (found_exts.elements+1),
                                       MYF(MY_WME | MY_FAE));
2690
    
2691
    DBUG_ASSERT(ext != 0);
2692 2693
    known_extensions.count= found_exts.elements;
    known_extensions.type_names= ext;
2694 2695 2696 2697

    while ((old_ext= it++))
      *ext++= old_ext;
    *ext= 0;
2698 2699 2700
  }
  return &known_extensions;
}
unknown's avatar
unknown committed
2701

unknown's avatar
unknown committed
2702

unknown's avatar
unknown committed
2703
#ifdef HAVE_REPLICATION
unknown's avatar
unknown committed
2704 2705 2706 2707 2708 2709
/*
  Reports to table handlers up to which position we have sent the binlog
  to a slave in replication

  SYNOPSIS
    ha_repl_report_sent_binlog()
unknown's avatar
unknown committed
2710 2711 2712 2713
    thd             thread doing the binlog communication to the slave
    log_file_name   binlog file name
    end_offse t     the offset in the binlog file up to which we sent the
		    contents to the slave
unknown's avatar
unknown committed
2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731

  NOTES
    Only works for InnoDB at the moment

  RETURN VALUE
    Always 0 (= success)  
*/

int ha_repl_report_sent_binlog(THD *thd, char *log_file_name,
                               my_off_t end_offset)
{
#ifdef HAVE_INNOBASE_DB
  return innobase_repl_report_sent_binlog(thd,log_file_name,end_offset);
#else
  return 0;
#endif
}

unknown's avatar
unknown committed
2732

unknown's avatar
unknown committed
2733 2734 2735 2736 2737
/*
  Reports to table handlers that we stop replication to a specific slave

  SYNOPSIS
    ha_repl_report_replication_stop()
unknown's avatar
unknown committed
2738
    thd              thread doing the binlog communication to the slave
unknown's avatar
unknown committed
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752

  NOTES
    Does nothing at the moment

  RETURN VALUE
    Always 0 (= success)  

  PARAMETERS
*/

int ha_repl_report_replication_stop(THD *thd)
{
  return 0;
}
unknown's avatar
unknown committed
2753
#endif /* HAVE_REPLICATION */