dict0dict.c 121 KB
Newer Older
vasil's avatar
vasil committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*****************************************************************************

Copyright (c) 1996, 2009, Innobase Oy. All Rights Reserved.

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

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.

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

*****************************************************************************/

osku's avatar
osku committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
/**********************************************************************
Data dictionary system

Created 1/8/1996 Heikki Tuuri
***********************************************************************/

#include "dict0dict.h"

#ifdef UNIV_NONINL
#include "dict0dict.ic"
#endif

#include "buf0buf.h"
#include "data0type.h"
#include "mach0data.h"
#include "dict0boot.h"
#include "dict0mem.h"
#include "dict0crea.h"
#include "trx0undo.h"
#include "btr0btr.h"
#include "btr0cur.h"
#include "btr0sea.h"
41 42
#include "page0zip.h"
#include "page0page.h"
osku's avatar
osku committed
43 44 45 46
#include "pars0pars.h"
#include "pars0sym.h"
#include "que0que.h"
#include "rem0cmp.h"
47
#include "row0merge.h"
48 49
#ifndef UNIV_HOTBACKUP
# include "m_ctype.h" /* my_isspace() */
50
# include "ha_prototypes.h" /* innobase_strcasecmp() */
51
#endif /* !UNIV_HOTBACKUP */
osku's avatar
osku committed
52

53 54
#include <ctype.h>

55 56 57 58 59 60 61 62 63 64
/* the dictionary system */
UNIV_INTERN dict_sys_t*	dict_sys	= NULL;

/* table create, drop, etc. reserve this in X-mode; implicit or
backround operations purge, rollback, foreign key checks reserve this
in S-mode; we cannot trust that MySQL protects implicit or background
operations a table drop since MySQL does not know of them; therefore
we need this; NOTE: a transaction which reserves this must keep book
on the mode in trx->dict_operation_lock_mode */
UNIV_INTERN rw_lock_t	dict_operation_lock;
osku's avatar
osku committed
65 66 67 68 69 70 71 72 73 74 75 76

#define	DICT_HEAP_SIZE		100	/* initial memory heap size when
					creating a table or index object */
#define DICT_POOL_PER_TABLE_HASH 512	/* buffer pool max size per table
					hash table fixed size in bytes */
#define DICT_POOL_PER_VARYING	4	/* buffer pool max size per data
					dictionary varying size in bytes */

/* Identifies generated InnoDB foreign key names */
static char	dict_ibfk[] = "_ibfk_";

/***********************************************************************
77 78
Tries to find column names for the index and sets the col field of the
index. */
osku's avatar
osku committed
79
static
80
void
osku's avatar
osku committed
81 82 83
dict_index_find_cols(
/*=================*/
	dict_table_t*	table,	/* in: table */
84
	dict_index_t*	index);	/* in: index */
osku's avatar
osku committed
85 86 87 88 89 90 91
/***********************************************************************
Builds the internal dictionary cache representation for a clustered
index, containing also system fields not defined by the user. */
static
dict_index_t*
dict_index_build_internal_clust(
/*============================*/
92 93 94 95 96 97
					/* out, own: the internal
					representation of the clustered
					index */
	const dict_table_t*	table,	/* in: table */
	dict_index_t*		index);	/* in: user representation of
					a clustered index */
osku's avatar
osku committed
98 99 100 101 102 103 104
/***********************************************************************
Builds the internal dictionary cache representation for a non-clustered
index, containing also system fields not defined by the user. */
static
dict_index_t*
dict_index_build_internal_non_clust(
/*================================*/
105 106 107 108 109 110
					/* out, own: the internal
					representation of the non-clustered
					index */
	const dict_table_t*	table,	/* in: table */
	dict_index_t*		index);	/* in: user representation of
					a non-clustered index */
osku's avatar
osku committed
111 112 113 114 115 116 117 118 119 120 121 122 123
/**************************************************************************
Removes a foreign constraint struct from the dictionary cache. */
static
void
dict_foreign_remove_from_cache(
/*===========================*/
	dict_foreign_t*	foreign);	/* in, own: foreign constraint */
/**************************************************************************
Prints a column data. */
static
void
dict_col_print_low(
/*===============*/
124 125
	const dict_table_t*	table,	/* in: table */
	const dict_col_t*	col);	/* in: column */
osku's avatar
osku committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
/**************************************************************************
Prints an index data. */
static
void
dict_index_print_low(
/*=================*/
	dict_index_t*	index);	/* in: index */
/**************************************************************************
Prints a field data. */
static
void
dict_field_print_low(
/*=================*/
	dict_field_t*	field);	/* in: field */
/*************************************************************************
Frees a foreign key struct. */
static
void
dict_foreign_free(
/*==============*/
	dict_foreign_t*	foreign);	/* in, own: foreign key struct */

/* Stream for storing detailed information about the latest foreign key
and unique key errors */
150 151 152
UNIV_INTERN FILE*	dict_foreign_err_file		= NULL;
/* mutex protecting the foreign and unique error buffers */
UNIV_INTERN mutex_t	dict_foreign_err_mutex;
153 154

#ifndef UNIV_HOTBACKUP
osku's avatar
osku committed
155 156
/**********************************************************************
Makes all characters in a NUL-terminated UTF-8 string lower case. */
157
UNIV_INTERN
osku's avatar
osku committed
158 159 160 161 162 163 164
void
dict_casedn_str(
/*============*/
	char*	a)	/* in/out: string to put in lower case */
{
	innobase_casedn_str(a);
}
165
#endif /* !UNIV_HOTBACKUP */
osku's avatar
osku committed
166 167 168

/************************************************************************
Checks if the database name in two table names is the same. */
169
UNIV_INTERN
osku's avatar
osku committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
ibool
dict_tables_have_same_db(
/*=====================*/
				/* out: TRUE if same db name */
	const char*	name1,	/* in: table name in the form
				dbname '/' tablename */
	const char*	name2)	/* in: table name in the form
				dbname '/' tablename */
{
	for (; *name1 == *name2; name1++, name2++) {
		if (*name1 == '/') {
			return(TRUE);
		}
		ut_a(*name1); /* the names must contain '/' */
	}
	return(FALSE);
}

/************************************************************************
Return the end of table name where we have removed dbname and '/'. */
190
UNIV_INTERN
osku's avatar
osku committed
191 192 193 194 195 196 197
const char*
dict_remove_db_name(
/*================*/
				/* out: table name */
	const char*	name)	/* in: table name in the form
				dbname '/' tablename */
{
198
	const char*	s = strchr(name, '/');
osku's avatar
osku committed
199
	ut_a(s);
200 201

	return(s + 1);
osku's avatar
osku committed
202 203 204 205
}

/************************************************************************
Get the database name length in a table name. */
206
UNIV_INTERN
osku's avatar
osku committed
207 208 209 210 211 212 213 214 215 216 217 218
ulint
dict_get_db_name_len(
/*=================*/
				/* out: database name length */
	const char*	name)	/* in: table name in the form
				dbname '/' tablename */
{
	const char*	s;
	s = strchr(name, '/');
	ut_a(s);
	return(s - name);
}
219

osku's avatar
osku committed
220 221
/************************************************************************
Reserves the dictionary system mutex for MySQL. */
222
UNIV_INTERN
osku's avatar
osku committed
223 224 225 226 227 228
void
dict_mutex_enter_for_mysql(void)
/*============================*/
{
	mutex_enter(&(dict_sys->mutex));
}
229

osku's avatar
osku committed
230 231
/************************************************************************
Releases the dictionary system mutex for MySQL. */
232
UNIV_INTERN
osku's avatar
osku committed
233 234 235 236 237 238
void
dict_mutex_exit_for_mysql(void)
/*===========================*/
{
	mutex_exit(&(dict_sys->mutex));
}
239

osku's avatar
osku committed
240 241
/************************************************************************
Decrements the count of open MySQL handles to a table. */
242
UNIV_INTERN
osku's avatar
osku committed
243 244 245
void
dict_table_decrement_handle_count(
/*==============================*/
246
	dict_table_t*	table,		/* in/out: table */
247
	ibool		dict_locked)	/* in: TRUE=data dictionary locked */
osku's avatar
osku committed
248
{
249 250 251
	if (!dict_locked) {
		mutex_enter(&dict_sys->mutex);
	}
osku's avatar
osku committed
252

253
	ut_ad(mutex_own(&dict_sys->mutex));
osku's avatar
osku committed
254 255 256
	ut_a(table->n_mysql_handles_opened > 0);

	table->n_mysql_handles_opened--;
257

258 259 260
	if (!dict_locked) {
		mutex_exit(&dict_sys->mutex);
	}
osku's avatar
osku committed
261 262
}

263 264
/**************************************************************************
Returns a column's name. */
265
UNIV_INTERN
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
const char*
dict_table_get_col_name(
/*====================*/
					/* out: column name. NOTE: not
					guaranteed to stay valid if table is
					modified in any way (columns added,
					etc.). */
	const dict_table_t*	table,	/* in: table */
	ulint			col_nr)	/* in: column number */
{
	ulint		i;
	const char*	s;

	ut_ad(table);
	ut_ad(col_nr < table->n_def);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

	s = table->col_names;
284 285 286 287
	if (s) {
		for (i = 0; i < col_nr; i++) {
			s += strlen(s) + 1;
		}
288 289 290 291 292
	}

	return(s);
}

293 294 295

/************************************************************************
Acquire the autoinc lock.*/
296
UNIV_INTERN
297 298 299
void
dict_table_autoinc_lock(
/*====================*/
300
	dict_table_t*	table)	/* in/out: table */
301 302 303 304
{
	mutex_enter(&table->autoinc_mutex);
}

osku's avatar
osku committed
305
/************************************************************************
306
Unconditionally set the autoinc counter. */
307
UNIV_INTERN
osku's avatar
osku committed
308 309 310
void
dict_table_autoinc_initialize(
/*==========================*/
311
	dict_table_t*	table,	/* in/out: table */
312
	ib_uint64_t	value)	/* in: next value to assign to a row */
osku's avatar
osku committed
313
{
314 315
	ut_ad(mutex_own(&table->autoinc_mutex));

osku's avatar
osku committed
316 317 318 319 320 321
	table->autoinc = value;
}

/************************************************************************
Reads the next autoinc value (== autoinc counter value), 0 if not yet
initialized. */
322
UNIV_INTERN
323
ib_uint64_t
osku's avatar
osku committed
324 325
dict_table_autoinc_read(
/*====================*/
326 327
					/* out: value for a new row, or 0 */
	const dict_table_t*	table)	/* in: table */
osku's avatar
osku committed
328
{
329 330
	ut_ad(mutex_own(&table->autoinc_mutex));

331
	return(table->autoinc);
osku's avatar
osku committed
332 333 334
}

/************************************************************************
335
Updates the autoinc counter if the value supplied is greater than the
sunny's avatar
sunny committed
336
current value. */
337
UNIV_INTERN
osku's avatar
osku committed
338
void
339 340
dict_table_autoinc_update_if_greater(
/*=================================*/
osku's avatar
osku committed
341

342
	dict_table_t*	table,	/* in/out: table */
343
	ib_uint64_t	value)	/* in: value which was assigned to a row */
osku's avatar
osku committed
344
{
345
	ut_ad(mutex_own(&table->autoinc_mutex));
osku's avatar
osku committed
346

347
	if (value > table->autoinc) {
sunny's avatar
sunny committed
348

349
		table->autoinc = value;
350
	}
351 352 353 354
}

/************************************************************************
Release the autoinc lock.*/
355
UNIV_INTERN
356 357 358
void
dict_table_autoinc_unlock(
/*======================*/
359
	dict_table_t*	table)	/* in/out: table */
360 361
{
	mutex_exit(&table->autoinc_mutex);
osku's avatar
osku committed
362 363
}

364 365 366
/**************************************************************************
Looks for an index with the given table and index id.
NOTE that we do not reserve the dictionary mutex. */
367
UNIV_INTERN
368 369 370
dict_index_t*
dict_index_get_on_id_low(
/*=====================*/
371 372
				/* out: index or NULL if not found
				from cache */
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
	dict_table_t*	table,	/* in: table */
	dulint		id)	/* in: index id */
{
	dict_index_t*	index;

	index = dict_table_get_first_index(table);

	while (index) {
		if (0 == ut_dulint_cmp(id, index->id)) {
			/* Found */

			return(index);
		}

		index = dict_table_get_next_index(index);
	}

	return(NULL);
}

osku's avatar
osku committed
393 394
/************************************************************************
Looks for column n in an index. */
395
UNIV_INTERN
osku's avatar
osku committed
396 397 398
ulint
dict_index_get_nth_col_pos(
/*=======================*/
399 400 401 402 403 404
					/* out: position in internal
					representation of the index;
					if not contained, returns
					ULINT_UNDEFINED */
	const dict_index_t*	index,	/* in: index */
	ulint			n)	/* in: column number */
osku's avatar
osku committed
405
{
406 407 408 409
	const dict_field_t*	field;
	const dict_col_t*	col;
	ulint			pos;
	ulint			n_fields;
410

osku's avatar
osku committed
411 412 413 414 415
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);

	col = dict_table_get_nth_col(index->table, n);

416
	if (dict_index_is_clust(index)) {
osku's avatar
osku committed
417

418
		return(dict_col_get_clust_pos(col, index));
osku's avatar
osku committed
419 420 421
	}

	n_fields = dict_index_get_n_fields(index);
422

osku's avatar
osku committed
423 424 425 426 427 428 429 430 431 432 433 434 435 436
	for (pos = 0; pos < n_fields; pos++) {
		field = dict_index_get_nth_field(index, pos);

		if (col == field->col && field->prefix_len == 0) {

			return(pos);
		}
	}

	return(ULINT_UNDEFINED);
}

/************************************************************************
Returns TRUE if the index contains a column or a prefix of that column. */
437
UNIV_INTERN
osku's avatar
osku committed
438 439 440
ibool
dict_index_contains_col_or_prefix(
/*==============================*/
441 442 443 444
					/* out: TRUE if contains the column
					or its prefix */
	const dict_index_t*	index,	/* in: index */
	ulint			n)	/* in: column number */
osku's avatar
osku committed
445
{
446 447 448 449
	const dict_field_t*	field;
	const dict_col_t*	col;
	ulint			pos;
	ulint			n_fields;
450

osku's avatar
osku committed
451 452 453
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);

454
	if (dict_index_is_clust(index)) {
osku's avatar
osku committed
455 456 457 458 459 460 461

		return(TRUE);
	}

	col = dict_table_get_nth_col(index->table, n);

	n_fields = dict_index_get_n_fields(index);
462

osku's avatar
osku committed
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
	for (pos = 0; pos < n_fields; pos++) {
		field = dict_index_get_nth_field(index, pos);

		if (col == field->col) {

			return(TRUE);
		}
	}

	return(FALSE);
}

/************************************************************************
Looks for a matching field in an index. The column has to be the same. The
column in index must be complete, or must contain a prefix longer than the
column in index2. That is, we must be able to construct the prefix in index2
from the prefix in index. */
480
UNIV_INTERN
osku's avatar
osku committed
481 482 483
ulint
dict_index_get_nth_field_pos(
/*=========================*/
484 485 486 487 488 489 490
					/* out: position in internal
					representation of the index;
					if not contained, returns
					ULINT_UNDEFINED */
	const dict_index_t*	index,	/* in: index from which to search */
	const dict_index_t*	index2,	/* in: index */
	ulint			n)	/* in: field number in index2 */
osku's avatar
osku committed
491
{
492 493 494 495
	const dict_field_t*	field;
	const dict_field_t*	field2;
	ulint			n_fields;
	ulint			pos;
496

osku's avatar
osku committed
497 498 499 500 501 502
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);

	field2 = dict_index_get_nth_field(index2, n);

	n_fields = dict_index_get_n_fields(index);
503

osku's avatar
osku committed
504 505 506 507
	for (pos = 0; pos < n_fields; pos++) {
		field = dict_index_get_nth_field(index, pos);

		if (field->col == field2->col
508
		    && (field->prefix_len == 0
osku's avatar
osku committed
509
			|| (field->prefix_len >= field2->prefix_len
510
			    && field2->prefix_len != 0))) {
osku's avatar
osku committed
511 512 513 514 515 516 517 518 519

			return(pos);
		}
	}

	return(ULINT_UNDEFINED);
}

/**************************************************************************
520
Returns a table object based on table id. */
521
UNIV_INTERN
osku's avatar
osku committed
522 523 524 525 526 527 528 529
dict_table_t*
dict_table_get_on_id(
/*=================*/
				/* out: table, NULL if does not exist */
	dulint	table_id,	/* in: table id */
	trx_t*	trx)		/* in: transaction handle */
{
	dict_table_t*	table;
530

osku's avatar
osku committed
531
	if (ut_dulint_cmp(table_id, DICT_FIELDS_ID) <= 0
532
	    || trx->dict_operation_lock_mode == RW_X_LATCH) {
osku's avatar
osku committed
533 534 535 536 537
		/* It is a system table which will always exist in the table
		cache: we avoid acquiring the dictionary mutex, because
		if we are doing a rollback to handle an error in TABLE
		CREATE, for example, we already have the mutex! */

538 539
		ut_ad(mutex_own(&(dict_sys->mutex))
		      || trx->dict_operation_lock_mode == RW_X_LATCH);
osku's avatar
osku committed
540

541
		return(dict_table_get_on_id_low(table_id));
osku's avatar
osku committed
542 543 544 545
	}

	mutex_enter(&(dict_sys->mutex));

546
	table = dict_table_get_on_id_low(table_id);
547

osku's avatar
osku committed
548 549 550 551 552 553 554
	mutex_exit(&(dict_sys->mutex));

	return(table);
}

/************************************************************************
Looks for column n position in the clustered index. */
555
UNIV_INTERN
osku's avatar
osku committed
556 557 558
ulint
dict_table_get_nth_col_pos(
/*=======================*/
559 560 561 562 563
					/* out: position in internal
					representation of
					the clustered index */
	const dict_table_t*	table,	/* in: table */
	ulint			n)	/* in: column number */
osku's avatar
osku committed
564 565
{
	return(dict_index_get_nth_col_pos(dict_table_get_first_index(table),
566
					  n));
osku's avatar
osku committed
567 568 569 570 571
}

/************************************************************************
Checks if a column is in the ordering columns of the clustered index of a
table. Column prefixes are treated like whole columns. */
572
UNIV_INTERN
osku's avatar
osku committed
573 574 575
ibool
dict_table_col_in_clustered_key(
/*============================*/
576 577 578 579
					/* out: TRUE if the column, or its
					prefix, is in the clustered key */
	const dict_table_t*	table,	/* in: table */
	ulint			n)	/* in: column number */
osku's avatar
osku committed
580
{
581
	const dict_index_t*	index;
582 583 584 585
	const dict_field_t*	field;
	const dict_col_t*	col;
	ulint			pos;
	ulint			n_fields;
586

osku's avatar
osku committed
587 588 589 590 591 592 593
	ut_ad(table);

	col = dict_table_get_nth_col(table, n);

	index = dict_table_get_first_index(table);

	n_fields = dict_index_get_n_unique(index);
594

osku's avatar
osku committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608
	for (pos = 0; pos < n_fields; pos++) {
		field = dict_index_get_nth_field(index, pos);

		if (col == field->col) {

			return(TRUE);
		}
	}

	return(FALSE);
}

/**************************************************************************
Inits the data dictionary module. */
609
UNIV_INTERN
osku's avatar
osku committed
610 611 612 613 614 615
void
dict_init(void)
/*===========*/
{
	dict_sys = mem_alloc(sizeof(dict_sys_t));

616
	mutex_create(&dict_sys->mutex, SYNC_DICT);
osku's avatar
osku committed
617

618
	dict_sys->table_hash = hash_create(buf_pool_get_curr_size()
619 620
					   / (DICT_POOL_PER_TABLE_HASH
					      * UNIV_WORD_SIZE));
621
	dict_sys->table_id_hash = hash_create(buf_pool_get_curr_size()
622 623
					      / (DICT_POOL_PER_TABLE_HASH
						 * UNIV_WORD_SIZE));
osku's avatar
osku committed
624 625 626 627
	dict_sys->size = 0;

	UT_LIST_INIT(dict_sys->table_LRU);

628
	rw_lock_create(&dict_operation_lock, SYNC_DICT_OPERATION);
osku's avatar
osku committed
629 630 631

	dict_foreign_err_file = os_file_create_tmpfile();
	ut_a(dict_foreign_err_file);
632 633

	mutex_create(&dict_foreign_err_mutex, SYNC_ANY_LATCH);
osku's avatar
osku committed
634 635 636
}

/**************************************************************************
637 638 639 640
Returns a table object and optionally increment its MySQL open handle count.
NOTE! This is a high-level function to be used mainly from outside the
'dict' directory. Inside this directory dict_table_get_low is usually the
appropriate function. */
641
UNIV_INTERN
osku's avatar
osku committed
642 643 644 645 646
dict_table_t*
dict_table_get(
/*===========*/
					/* out: table, NULL if
					does not exist */
647 648
	const char*	table_name,	/* in: table name */
	ibool		inc_mysql_count)
649
					/* in: whether to increment the open
650
					handle count on the table */
osku's avatar
osku committed
651 652 653 654
{
	dict_table_t*	table;

	mutex_enter(&(dict_sys->mutex));
655

osku's avatar
osku committed
656 657
	table = dict_table_get_low(table_name);

658
	if (inc_mysql_count && table) {
659
		table->n_mysql_handles_opened++;
osku's avatar
osku committed
660 661 662 663 664
	}

	mutex_exit(&(dict_sys->mutex));

	if (table != NULL) {
665 666 667 668
		if (!table->stat_initialized) {
			/* If table->ibd_file_missing == TRUE, this will
			print an error message and return without doing
			anything. */
osku's avatar
osku committed
669 670 671
			dict_update_statistics(table);
		}
	}
672

osku's avatar
osku committed
673 674 675 676
	return(table);
}

/**************************************************************************
677
Adds system columns to a table object. */
678
UNIV_INTERN
osku's avatar
osku committed
679
void
680 681
dict_table_add_system_columns(
/*==========================*/
682 683
	dict_table_t*	table,	/* in/out: table */
	mem_heap_t*	heap)	/* in: temporary heap */
osku's avatar
osku committed
684 685 686 687
{
	ut_ad(table);
	ut_ad(table->n_def == table->n_cols - DATA_N_SYS_COLS);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);
688
	ut_ad(!table->cached);
689

osku's avatar
osku committed
690 691 692 693 694 695
	/* NOTE: the system columns MUST be added in the following order
	(so that they can be indexed by the numerical value of DATA_ROW_ID,
	etc.) and as the last columns of the table memory object.
	The clustered index will not always physically contain all
	system columns. */

696
	dict_mem_table_add_col(table, heap, "DB_ROW_ID", DATA_SYS,
697
			       DATA_ROW_ID | DATA_NOT_NULL,
698
			       DATA_ROW_ID_LEN);
osku's avatar
osku committed
699 700 701
#if DATA_ROW_ID != 0
#error "DATA_ROW_ID != 0"
#endif
702
	dict_mem_table_add_col(table, heap, "DB_TRX_ID", DATA_SYS,
703
			       DATA_TRX_ID | DATA_NOT_NULL,
704
			       DATA_TRX_ID_LEN);
osku's avatar
osku committed
705 706 707
#if DATA_TRX_ID != 1
#error "DATA_TRX_ID != 1"
#endif
708
	dict_mem_table_add_col(table, heap, "DB_ROLL_PTR", DATA_SYS,
709
			       DATA_ROLL_PTR | DATA_NOT_NULL,
710
			       DATA_ROLL_PTR_LEN);
osku's avatar
osku committed
711 712 713 714 715
#if DATA_ROLL_PTR != 2
#error "DATA_ROLL_PTR != 2"
#endif

	/* This check reminds that if a new system column is added to
716
	the program, it should be dealt with here */
717 718
#if DATA_N_SYS_COLS != 3
#error "DATA_N_SYS_COLS != 3"
osku's avatar
osku committed
719
#endif
720 721 722 723
}

/**************************************************************************
Adds a table object to the dictionary cache. */
724
UNIV_INTERN
725 726 727
void
dict_table_add_to_cache(
/*====================*/
728 729
	dict_table_t*	table,	/* in: table */
	mem_heap_t*	heap)	/* in: temporary heap */
730 731 732 733
{
	ulint	fold;
	ulint	id_fold;
	ulint	i;
734
	ulint	row_len;
735

736 737 738
	/* The lower limit for what we consider a "big" row */
#define BIG_ROW_SIZE 1024

739
	ut_ad(mutex_own(&(dict_sys->mutex)));
740

741
	dict_table_add_system_columns(table, heap);
742 743 744 745 746

	table->cached = TRUE;

	fold = ut_fold_string(table->name);
	id_fold = ut_fold_dulint(table->id);
osku's avatar
osku committed
747

748 749
	row_len = 0;
	for (i = 0; i < table->n_def; i++) {
750 751 752 753
		ulint	col_len = dict_col_get_max_size(
			dict_table_get_nth_col(table, i));

		row_len += col_len;
754 755

		/* If we have a single unbounded field, or several gigantic
756 757 758
		fields, mark the maximum row size as BIG_ROW_SIZE. */
		if (row_len >= BIG_ROW_SIZE || col_len >= BIG_ROW_SIZE) {
			row_len = BIG_ROW_SIZE;
759 760 761 762 763

			break;
		}
	}

764
	table->big_rows = row_len >= BIG_ROW_SIZE;
765

osku's avatar
osku committed
766 767 768
	/* Look for a table with the same name: error if such exists */
	{
		dict_table_t*	table2;
769
		HASH_SEARCH(name_hash, dict_sys->table_hash, fold,
770 771
			    dict_table_t*, table2, ut_ad(table2->cached),
			    ut_strcmp(table2->name, table->name) == 0);
osku's avatar
osku committed
772
		ut_a(table2 == NULL);
773 774 775 776 777 778 779 780

#ifdef UNIV_DEBUG
		/* Look for the same table pointer with a different name */
		HASH_SEARCH_ALL(name_hash, dict_sys->table_hash,
				dict_table_t*, table2, ut_ad(table2->cached),
				table2 == table);
		ut_ad(table2 == NULL);
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
781 782 783 784 785
	}

	/* Look for a table with the same id: error if such exists */
	{
		dict_table_t*	table2;
786
		HASH_SEARCH(id_hash, dict_sys->table_id_hash, id_fold,
787 788
			    dict_table_t*, table2, ut_ad(table2->cached),
			    ut_dulint_cmp(table2->id, table->id) == 0);
osku's avatar
osku committed
789
		ut_a(table2 == NULL);
790 791 792 793 794 795 796 797

#ifdef UNIV_DEBUG
		/* Look for the same table pointer with a different id */
		HASH_SEARCH_ALL(id_hash, dict_sys->table_id_hash,
				dict_table_t*, table2, ut_ad(table2->cached),
				table2 == table);
		ut_ad(table2 == NULL);
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
798 799 800 801
	}

	/* Add table to hash table of tables */
	HASH_INSERT(dict_table_t, name_hash, dict_sys->table_hash, fold,
802
		    table);
osku's avatar
osku committed
803 804 805

	/* Add table to hash table of tables based on table id */
	HASH_INSERT(dict_table_t, id_hash, dict_sys->table_id_hash, id_fold,
806
		    table);
osku's avatar
osku committed
807 808 809 810 811 812 813 814 815 816
	/* Add table to LRU list of tables */
	UT_LIST_ADD_FIRST(table_LRU, dict_sys->table_LRU, table);

	dict_sys->size += mem_heap_get_size(table->heap);
}

/**************************************************************************
Looks for an index with the given id. NOTE that we do not reserve
the dictionary mutex: this function is for emergency purposes like
printing info of a corrupt database page! */
817
UNIV_INTERN
osku's avatar
osku committed
818 819 820 821 822 823 824 825
dict_index_t*
dict_index_find_on_id_low(
/*======================*/
			/* out: index or NULL if not found from cache */
	dulint	id)	/* in: index id */
{
	dict_table_t*	table;
	dict_index_t*	index;
826

osku's avatar
osku committed
827 828 829 830 831 832
	table = UT_LIST_GET_FIRST(dict_sys->table_LRU);

	while (table) {
		index = dict_table_get_first_index(table);

		while (index) {
833
			if (0 == ut_dulint_cmp(id, index->id)) {
osku's avatar
osku committed
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
				/* Found */

				return(index);
			}

			index = dict_table_get_next_index(index);
		}

		table = UT_LIST_GET_NEXT(table_LRU, table);
	}

	return(NULL);
}

/**************************************************************************
Renames a table object. */
850
UNIV_INTERN
osku's avatar
osku committed
851 852 853 854
ibool
dict_table_rename_in_cache(
/*=======================*/
					/* out: TRUE if success */
855
	dict_table_t*	table,		/* in/out: table */
osku's avatar
osku committed
856 857 858 859 860 861 862 863 864
	const char*	new_name,	/* in: new name */
	ibool		rename_also_foreigns)/* in: in ALTER TABLE we want
					to preserve the original table name
					in constraints which reference it */
{
	dict_foreign_t*	foreign;
	dict_index_t*	index;
	ulint		fold;
	ulint		old_size;
865
	const char*	old_name;
866

osku's avatar
osku committed
867 868 869 870
	ut_ad(table);
	ut_ad(mutex_own(&(dict_sys->mutex)));

	old_size = mem_heap_get_size(table->heap);
871
	old_name = table->name;
872

osku's avatar
osku committed
873
	fold = ut_fold_string(new_name);
874

osku's avatar
osku committed
875 876 877
	/* Look for a table with the same name: error if such exists */
	{
		dict_table_t*	table2;
878
		HASH_SEARCH(name_hash, dict_sys->table_hash, fold,
879
			    dict_table_t*, table2, ut_ad(table2->cached),
880
			    (ut_strcmp(table2->name, new_name) == 0));
881 882 883 884 885 886 887 888 889
		if (UNIV_LIKELY_NULL(table2)) {
			ut_print_timestamp(stderr);
			fputs("  InnoDB: Error: dictionary cache"
			      " already contains a table ", stderr);
			ut_print_name(stderr, NULL, TRUE, new_name);
			fputs("\n"
			      "InnoDB: cannot rename table ", stderr);
			ut_print_name(stderr, NULL, TRUE, old_name);
			putc('\n', stderr);
osku's avatar
osku committed
890 891 892 893 894 895 896 897 898
			return(FALSE);
		}
	}

	/* If the table is stored in a single-table tablespace, rename the
	.ibd file */

	if (table->space != 0) {
		if (table->dir_path_of_temp_table != NULL) {
899 900 901 902 903 904 905 906 907 908 909
			ut_print_timestamp(stderr);
			fputs("  InnoDB: Error: trying to rename a"
			      " TEMPORARY TABLE ", stderr);
			ut_print_name(stderr, NULL, TRUE, old_name);
			fputs(" (", stderr);
			ut_print_filename(stderr,
					  table->dir_path_of_temp_table);
			fputs(" )\n", stderr);
			return(FALSE);
		} else if (!fil_rename_tablespace(old_name, table->space,
						  new_name)) {
osku's avatar
osku committed
910 911 912 913 914 915
			return(FALSE);
		}
	}

	/* Remove table from the hash tables of tables */
	HASH_DELETE(dict_table_t, name_hash, dict_sys->table_hash,
916
		    ut_fold_string(old_name), table);
osku's avatar
osku committed
917 918 919 920
	table->name = mem_heap_strdup(table->heap, new_name);

	/* Add table to hash table of tables */
	HASH_INSERT(dict_table_t, name_hash, dict_sys->table_hash, fold,
921
		    table);
osku's avatar
osku committed
922 923 924 925 926 927 928
	dict_sys->size += (mem_heap_get_size(table->heap) - old_size);

	/* Update the table_name field in indexes */
	index = dict_table_get_first_index(table);

	while (index != NULL) {
		index->table_name = table->name;
929

osku's avatar
osku committed
930 931 932 933 934 935 936 937 938 939 940
		index = dict_table_get_next_index(index);
	}

	if (!rename_also_foreigns) {
		/* In ALTER TABLE we think of the rename table operation
		in the direction table -> temporary table (#sql...)
		as dropping the table with the old name and creating
		a new with the new name. Thus we kind of drop the
		constraints from the dictionary cache here. The foreign key
		constraints will be inherited to the new table from the
		system tables through a call of dict_load_foreigns. */
941

osku's avatar
osku committed
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
		/* Remove the foreign constraints from the cache */
		foreign = UT_LIST_GET_LAST(table->foreign_list);

		while (foreign != NULL) {
			dict_foreign_remove_from_cache(foreign);
			foreign = UT_LIST_GET_LAST(table->foreign_list);
		}

		/* Reset table field in referencing constraints */

		foreign = UT_LIST_GET_FIRST(table->referenced_list);

		while (foreign != NULL) {
			foreign->referenced_table = NULL;
			foreign->referenced_index = NULL;
957

osku's avatar
osku committed
958 959 960 961 962 963
			foreign = UT_LIST_GET_NEXT(referenced_list, foreign);
		}

		/* Make the list of referencing constraints empty */

		UT_LIST_INIT(table->referenced_list);
964

osku's avatar
osku committed
965 966 967 968 969 970 971 972 973 974
		return(TRUE);
	}

	/* Update the table name fields in foreign constraints, and update also
	the constraint id of new format >= 4.0.18 constraints. Note that at
	this point we have already changed table->name to the new name. */

	foreign = UT_LIST_GET_FIRST(table->foreign_list);

	while (foreign != NULL) {
975 976
		if (ut_strlen(foreign->foreign_table_name)
		    < ut_strlen(table->name)) {
osku's avatar
osku committed
977 978 979
			/* Allocate a longer name buffer;
			TODO: store buf len to save memory */

980 981 982
			foreign->foreign_table_name
				= mem_heap_alloc(foreign->heap,
						 ut_strlen(table->name) + 1);
osku's avatar
osku committed
983 984 985 986 987 988 989 990 991 992 993 994 995
		}

		strcpy(foreign->foreign_table_name, table->name);

		if (strchr(foreign->id, '/')) {
			ulint	db_len;
			char*	old_id;

			/* This is a >= 4.0.18 format id */

			old_id = mem_strdup(foreign->id);

			if (ut_strlen(foreign->id) > ut_strlen(old_name)
996 997 998 999 1000
			    + ((sizeof dict_ibfk) - 1)
			    && !memcmp(foreign->id, old_name,
				       ut_strlen(old_name))
			    && !memcmp(foreign->id + ut_strlen(old_name),
				       dict_ibfk, (sizeof dict_ibfk) - 1)) {
osku's avatar
osku committed
1001 1002 1003

				/* This is a generated >= 4.0.18 format id */

1004
				if (strlen(table->name) > strlen(old_name)) {
1005 1006 1007 1008
					foreign->id = mem_heap_alloc(
						foreign->heap,
						strlen(table->name)
						+ strlen(old_id) + 1);
osku's avatar
osku committed
1009
				}
1010

osku's avatar
osku committed
1011 1012 1013 1014
				/* Replace the prefix 'databasename/tablename'
				with the new names */
				strcpy(foreign->id, table->name);
				strcat(foreign->id,
1015
				       old_id + ut_strlen(old_name));
osku's avatar
osku committed
1016 1017 1018 1019 1020 1021
			} else {
				/* This is a >= 4.0.18 format id where the user
				gave the id name */
				db_len = dict_get_db_name_len(table->name) + 1;

				if (dict_get_db_name_len(table->name)
1022
				    > dict_get_db_name_len(foreign->id)) {
osku's avatar
osku committed
1023

1024 1025 1026
					foreign->id = mem_heap_alloc(
						foreign->heap,
						db_len + strlen(old_id) + 1);
osku's avatar
osku committed
1027 1028 1029 1030
				}

				/* Replace the database prefix in id with the
				one from table->name */
1031

osku's avatar
osku committed
1032 1033 1034
				ut_memcpy(foreign->id, table->name, db_len);

				strcpy(foreign->id + db_len,
1035
				       dict_remove_db_name(old_id));
osku's avatar
osku committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
			}

			mem_free(old_id);
		}

		foreign = UT_LIST_GET_NEXT(foreign_list, foreign);
	}

	foreign = UT_LIST_GET_FIRST(table->referenced_list);

	while (foreign != NULL) {
1047 1048
		if (ut_strlen(foreign->referenced_table_name)
		    < ut_strlen(table->name)) {
osku's avatar
osku committed
1049 1050 1051
			/* Allocate a longer name buffer;
			TODO: store buf len to save memory */

1052 1053
			foreign->referenced_table_name = mem_heap_alloc(
				foreign->heap, strlen(table->name) + 1);
osku's avatar
osku committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
		}

		strcpy(foreign->referenced_table_name, table->name);

		foreign = UT_LIST_GET_NEXT(referenced_list, foreign);
	}

	return(TRUE);
}

/**************************************************************************
Change the id of a table object in the dictionary cache. This is used in
DISCARD TABLESPACE. */
1067
UNIV_INTERN
osku's avatar
osku committed
1068 1069 1070
void
dict_table_change_id_in_cache(
/*==========================*/
1071
	dict_table_t*	table,	/* in/out: table object already in cache */
osku's avatar
osku committed
1072 1073 1074 1075 1076 1077 1078 1079 1080
	dulint		new_id)	/* in: new id to set */
{
	ut_ad(table);
	ut_ad(mutex_own(&(dict_sys->mutex)));
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

	/* Remove the table from the hash table of id's */

	HASH_DELETE(dict_table_t, id_hash, dict_sys->table_id_hash,
1081
		    ut_fold_dulint(table->id), table);
osku's avatar
osku committed
1082 1083 1084 1085
	table->id = new_id;

	/* Add the table back to the hash table */
	HASH_INSERT(dict_table_t, id_hash, dict_sys->table_id_hash,
1086
		    ut_fold_dulint(table->id), table);
osku's avatar
osku committed
1087 1088 1089 1090
}

/**************************************************************************
Removes a table object from the dictionary cache. */
1091
UNIV_INTERN
osku's avatar
osku committed
1092 1093 1094 1095 1096 1097 1098 1099
void
dict_table_remove_from_cache(
/*=========================*/
	dict_table_t*	table)	/* in, own: table */
{
	dict_foreign_t*	foreign;
	dict_index_t*	index;
	ulint		size;
1100

osku's avatar
osku committed
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
	ut_ad(table);
	ut_ad(mutex_own(&(dict_sys->mutex)));
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

#if 0
	fputs("Removing table ", stderr);
	ut_print_name(stderr, table->name, ULINT_UNDEFINED);
	fputs(" from dictionary cache\n", stderr);
#endif

	/* Remove the foreign constraints from the cache */
	foreign = UT_LIST_GET_LAST(table->foreign_list);

	while (foreign != NULL) {
		dict_foreign_remove_from_cache(foreign);
		foreign = UT_LIST_GET_LAST(table->foreign_list);
	}

	/* Reset table field in referencing constraints */

	foreign = UT_LIST_GET_FIRST(table->referenced_list);

	while (foreign != NULL) {
		foreign->referenced_table = NULL;
		foreign->referenced_index = NULL;
1126

osku's avatar
osku committed
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
		foreign = UT_LIST_GET_NEXT(referenced_list, foreign);
	}

	/* Remove the indexes from the cache */
	index = UT_LIST_GET_LAST(table->indexes);

	while (index != NULL) {
		dict_index_remove_from_cache(table, index);
		index = UT_LIST_GET_LAST(table->indexes);
	}

	/* Remove table from the hash tables of tables */
	HASH_DELETE(dict_table_t, name_hash, dict_sys->table_hash,
1140
		    ut_fold_string(table->name), table);
osku's avatar
osku committed
1141
	HASH_DELETE(dict_table_t, id_hash, dict_sys->table_id_hash,
1142
		    ut_fold_dulint(table->id), table);
osku's avatar
osku committed
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152

	/* Remove table from LRU list of tables */
	UT_LIST_REMOVE(table_LRU, dict_sys->table_LRU, table);

	size = mem_heap_get_size(table->heap);

	ut_ad(dict_sys->size >= size);

	dict_sys->size -= size;

1153
	dict_mem_table_free(table);
osku's avatar
osku committed
1154 1155
}

1156 1157 1158
/********************************************************************
If the given column name is reserved for InnoDB system columns, return
TRUE. */
1159
UNIV_INTERN
1160 1161 1162 1163 1164 1165 1166 1167
ibool
dict_col_name_is_reserved(
/*======================*/
				/* out: TRUE if name is reserved */
	const char*	name)	/* in: column name */
{
	/* This check reminds that if a new system column is added to
	the program, it should be dealt with here. */
1168 1169
#if DATA_N_SYS_COLS != 3
#error "DATA_N_SYS_COLS != 3"
1170 1171 1172
#endif

	static const char*	reserved_names[] = {
1173
		"DB_ROW_ID", "DB_TRX_ID", "DB_ROLL_PTR"
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
	};

	ulint			i;

	for (i = 0; i < UT_ARR_SIZE(reserved_names); i++) {
		if (strcmp(name, reserved_names[i]) == 0) {

			return(TRUE);
		}
	}

	return(FALSE);
}

1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
/********************************************************************
If an undo log record for this table might not fit on a single page,
return TRUE. */
static
ibool
dict_index_too_big_for_undo(
/*========================*/
						/* out: TRUE if the undo log
						record could become too big */
	const dict_table_t*	table,		/* in: table */
	const dict_index_t*	new_index)	/* in: index */
{
	/* Make sure that all column prefixes will fit in the undo log record
	in trx_undo_page_report_modify() right after trx_undo_page_init(). */

	ulint			i;
	const dict_index_t*	clust_index
		= dict_table_get_first_index(table);
	ulint			undo_page_len
		= TRX_UNDO_PAGE_HDR - TRX_UNDO_PAGE_HDR_SIZE
		+ 2 /* next record pointer */
		+ 1 /* type_cmpl */
		+ 11 /* trx->undo_no */ - 11 /* table->id */
		+ 1 /* rec_get_info_bits() */
		+ 11 /* DB_TRX_ID */
		+ 11 /* DB_ROLL_PTR */
		+ 10 + FIL_PAGE_DATA_END /* trx_undo_left() */
		+ 2/* pointer to previous undo log record */;

	if (UNIV_UNLIKELY(!clust_index)) {
		ut_a(dict_index_is_clust(new_index));
		clust_index = new_index;
	}

	/* Add the size of the ordering columns in the
	clustered index. */
	for (i = 0; i < clust_index->n_uniq; i++) {
		const dict_col_t*	col
			= dict_index_get_nth_col(clust_index, i);

		/* Use the maximum output size of
		mach_write_compressed(), although the encoded
		length should always fit in 2 bytes. */
		undo_page_len += 5 + dict_col_get_max_size(col);
	}

	/* Add the old values of the columns to be updated.
	First, the amount and the numbers of the columns.
	These are written by mach_write_compressed() whose
	maximum output length is 5 bytes.  However, given that
	the quantities are below REC_MAX_N_FIELDS (10 bits),
	the maximum length is 2 bytes per item. */
	undo_page_len += 2 * (dict_table_get_n_cols(table) + 1);

	for (i = 0; i < clust_index->n_def; i++) {
		const dict_col_t*	col
			= dict_index_get_nth_col(clust_index, i);
		ulint			max_size
			= dict_col_get_max_size(col);
		ulint			fixed_size
			= dict_col_get_fixed_size(col);

		if (fixed_size) {
			/* Fixed-size columns are stored locally. */
			max_size = fixed_size;
		} else if (max_size <= BTR_EXTERN_FIELD_REF_SIZE * 2) {
			/* Short columns are stored locally. */
		} else if (!col->ord_part) {
			/* See if col->ord_part would be set
			because of new_index. */
			ulint	j;

			for (j = 0; j < new_index->n_uniq; j++) {
				if (dict_index_get_nth_col(
					    new_index, j) == col) {

					goto is_ord_part;
				}
			}

			/* This is not an ordering column in any index.
			Thus, it can be stored completely externally. */
			max_size = BTR_EXTERN_FIELD_REF_SIZE;
		} else {
is_ord_part:
			/* This is an ordering column in some index.
			A long enough prefix must be written to the
			undo log.  See trx_undo_page_fetch_ext(). */

			if (max_size > REC_MAX_INDEX_COL_LEN) {
				max_size = REC_MAX_INDEX_COL_LEN;
			}

			max_size += BTR_EXTERN_FIELD_REF_SIZE;
		}

		undo_page_len += 5 + max_size;
	}

	return(undo_page_len >= UNIV_PAGE_SIZE);
}

1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 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 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
/********************************************************************
If a record of this index might not fit on a single B-tree page,
return TRUE. */
static
ibool
dict_index_too_big_for_tree(
/*========================*/
						/* out: TRUE if the index
						record could become too big */
	const dict_table_t*	table,		/* in: table */
	const dict_index_t*	new_index)	/* in: index */
{
	ulint	zip_size;
	ulint	comp;
	ulint	i;
	/* maximum possible storage size of a record */
	ulint	rec_max_size;
	/* maximum allowed size of a record on a leaf page */
	ulint	page_rec_max;
	/* maximum allowed size of a node pointer record */
	ulint	page_ptr_max;

	comp = dict_table_is_comp(table);
	zip_size = dict_table_zip_size(table);

	if (zip_size && zip_size < UNIV_PAGE_SIZE) {
		/* On a compressed page, two records must fit in the
		uncompressed page modification log.  On compressed
		pages with zip_size == UNIV_PAGE_SIZE, this limit will
		never be reached. */
		ut_ad(comp);
		/* The maximum allowed record size is the size of
		an empty page, minus a byte for recoding the heap
		number in the page modification log.  The maximum
		allowed node pointer size is half that. */
		page_rec_max = page_zip_empty_size(new_index->n_fields,
						   zip_size) - 1;
		page_ptr_max = page_rec_max / 2;
		/* On a compressed page, there is a two-byte entry in
		the dense page directory for every record.  But there
		is no record header. */
		rec_max_size = 2;
	} else {
		/* The maximum allowed record size is half a B-tree
		page.  No additional sparse page directory entry will
		be generated for the first few user records. */
		page_rec_max = page_get_free_space_of_empty(comp) / 2;
		page_ptr_max = page_rec_max;
		/* Each record has a header. */
		rec_max_size = comp
			? REC_N_NEW_EXTRA_BYTES
			: REC_N_OLD_EXTRA_BYTES;
	}

	if (comp) {
		/* Include the "null" flags in the
		maximum possible record size. */
		rec_max_size += UT_BITS_IN_BYTES(new_index->n_nullable);
	} else {
		/* For each column, include a 2-byte offset and a
		"null" flag.  The 1-byte format is only used in short
		records that do not contain externally stored columns.
		Such records could never exceed the page limit, even
		when using the 2-byte format. */
		rec_max_size += 2 * new_index->n_fields;
	}

	/* Compute the maximum possible record size. */
	for (i = 0; i < new_index->n_fields; i++) {
		const dict_field_t*	field
			= dict_index_get_nth_field(new_index, i);
		const dict_col_t*	col
			= dict_field_get_col(field);
		ulint			field_max_size;
		ulint			field_ext_max_size;

		/* In dtuple_convert_big_rec(), variable-length columns
		that are longer than BTR_EXTERN_FIELD_REF_SIZE * 2
		may be chosen for external storage.

		Fixed-length columns, and all columns of secondary
		index records are always stored inline. */

		/* Determine the maximum length of the index field.
		The field_ext_max_size should be computed as the worst
		case in rec_get_converted_size_comp() for
		REC_STATUS_ORDINARY records. */

		field_max_size = dict_col_get_fixed_size(col);
		if (field_max_size) {
			/* dict_index_add_col() should guarantee this */
			ut_ad(!field->prefix_len
			      || field->fixed_len == field->prefix_len);
			/* Fixed lengths are not encoded
			in ROW_FORMAT=COMPACT. */
			field_ext_max_size = 0;
			goto add_field_size;
		}

		field_max_size = dict_col_get_max_size(col);
		field_ext_max_size = field_max_size < 256 ? 1 : 2;

		if (field->prefix_len) {
			if (field->prefix_len < field_max_size) {
				field_max_size = field->prefix_len;
			}
		} else if (field_max_size > BTR_EXTERN_FIELD_REF_SIZE * 2
			   && dict_index_is_clust(new_index)) {

			/* In the worst case, we have a locally stored
			column of BTR_EXTERN_FIELD_REF_SIZE * 2 bytes.
			The length can be stored in one byte.  If the
			column were stored externally, the lengths in
			the clustered index page would be
			BTR_EXTERN_FIELD_REF_SIZE and 2. */
			field_max_size = BTR_EXTERN_FIELD_REF_SIZE * 2;
			field_ext_max_size = 1;
		}

		if (comp) {
			/* Add the extra size for ROW_FORMAT=COMPACT.
			For ROW_FORMAT=REDUNDANT, these bytes were
			added to rec_max_size before this loop. */
			rec_max_size += field_ext_max_size;
		}
add_field_size:
		rec_max_size += field_max_size;

		/* Check the size limit on leaf pages. */
		if (UNIV_UNLIKELY(rec_max_size >= page_rec_max)) {

			return(TRUE);
		}

		/* Check the size limit on non-leaf pages.  Records
		stored in non-leaf B-tree pages consist of the unique
		columns of the record (the key columns of the B-tree)
		and a node pointer field.  When we have processed the
		unique columns, rec_max_size equals the size of the
		node pointer record minus the node pointer column. */
		if (i + 1 == dict_index_get_n_unique_in_tree(new_index)
		    && rec_max_size + REC_NODE_PTR_SIZE >= page_ptr_max) {

			return(TRUE);
		}
	}

	return(FALSE);
}

osku's avatar
osku committed
1440 1441
/**************************************************************************
Adds an index to the dictionary cache. */
1442
UNIV_INTERN
1443
ulint
osku's avatar
osku committed
1444 1445
dict_index_add_to_cache(
/*====================*/
1446
				/* out: DB_SUCCESS or DB_TOO_BIG_RECORD */
osku's avatar
osku committed
1447 1448 1449
	dict_table_t*	table,	/* in: table on which the index is */
	dict_index_t*	index,	/* in, own: index; NOTE! The index memory
				object is freed in this function! */
1450 1451 1452 1453
	ulint		page_no,/* in: root page number of the index */
	ibool		strict)	/* in: TRUE=refuse to create the index
				if records could be too big to fit in
				an B-tree page */
osku's avatar
osku committed
1454 1455 1456 1457
{
	dict_index_t*	new_index;
	ulint		n_ord;
	ulint		i;
1458

osku's avatar
osku committed
1459 1460 1461 1462
	ut_ad(index);
	ut_ad(mutex_own(&(dict_sys->mutex)));
	ut_ad(index->n_def == index->n_fields);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
1463

osku's avatar
osku committed
1464
	ut_ad(mem_heap_validate(index->heap));
1465
	ut_a(!dict_index_is_clust(index)
1466
	     || UT_LIST_GET_LEN(table->indexes) == 0);
osku's avatar
osku committed
1467

1468
	dict_index_find_cols(table, index);
1469

osku's avatar
osku committed
1470 1471 1472
	/* Build the cache internal representation of the index,
	containing also the added system fields */

1473
	if (dict_index_is_clust(index)) {
osku's avatar
osku committed
1474 1475 1476 1477 1478 1479 1480 1481 1482
		new_index = dict_index_build_internal_clust(table, index);
	} else {
		new_index = dict_index_build_internal_non_clust(table, index);
	}

	/* Set the n_fields value in new_index to the actual defined
	number of fields in the cache internal representation */

	new_index->n_fields = new_index->n_def;
1483

1484 1485 1486 1487 1488 1489 1490
	if (strict && dict_index_too_big_for_tree(table, new_index)) {
too_big:
		dict_mem_index_free(new_index);
		dict_mem_index_free(index);
		return(DB_TOO_BIG_RECORD);
	}

osku's avatar
osku committed
1491 1492 1493
	if (UNIV_UNLIKELY(index->type & DICT_UNIVERSAL)) {
		n_ord = new_index->n_fields;
	} else {
1494
		n_ord = new_index->n_uniq;
osku's avatar
osku committed
1495 1496
	}

1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
	switch (dict_table_get_format(table)) {
	case DICT_TF_FORMAT_51:
		/* ROW_FORMAT=REDUNDANT and ROW_FORMAT=COMPACT store
		prefixes of externally stored columns locally within
		the record.  There are no special considerations for
		the undo log record size. */
		goto undo_size_ok;

	case DICT_TF_FORMAT_ZIP:
		/* In ROW_FORMAT=DYNAMIC and ROW_FORMAT=COMPRESSED,
		column prefix indexes require that prefixes of
		externally stored columns are written to the undo log.
		This may make the undo log record bigger than the
		record on the B-tree page.  The maximum size of an
		undo log record is the page size.  That must be
		checked for below. */
		break;

#if DICT_TF_FORMAT_ZIP != DICT_TF_FORMAT_MAX
# error "DICT_TF_FORMAT_ZIP != DICT_TF_FORMAT_MAX"
#endif
	}

1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
	for (i = 0; i < n_ord; i++) {
		const dict_field_t*	field
			= dict_index_get_nth_field(new_index, i);
		const dict_col_t*	col
			= dict_field_get_col(field);

		/* In dtuple_convert_big_rec(), variable-length columns
		that are longer than BTR_EXTERN_FIELD_REF_SIZE * 2
		may be chosen for external storage.  If the column appears
		in an ordering column of an index, a longer prefix of
		REC_MAX_INDEX_COL_LEN will be copied to the undo log
		by trx_undo_page_report_modify() and
		trx_undo_page_fetch_ext().  It suffices to check the
		capacity of the undo log whenever new_index includes
		a column prefix on a column that may be stored externally. */

		if (field->prefix_len /* prefix index */
		    && !col->ord_part /* not yet ordering column */
		    && !dict_col_get_fixed_size(col) /* variable-length */
		    && dict_col_get_max_size(col)
		    > BTR_EXTERN_FIELD_REF_SIZE * 2 /* long enough */) {

			if (dict_index_too_big_for_undo(table, new_index)) {
				/* An undo log record might not fit in
				a single page.  Refuse to create this index. */
1545 1546

				goto too_big;
1547 1548 1549 1550 1551 1552
			}

			break;
		}
	}

1553
undo_size_ok:
1554 1555
	/* Flag the ordering columns */

osku's avatar
osku committed
1556 1557
	for (i = 0; i < n_ord; i++) {

1558
		dict_index_get_nth_field(new_index, i)->col->ord_part = 1;
osku's avatar
osku committed
1559 1560
	}

1561 1562 1563 1564 1565 1566 1567 1568
	/* Add the new index as the last index for the table */

	UT_LIST_ADD_LAST(indexes, table->indexes, new_index);
	new_index->table = table;
	new_index->table_name = table->name;

	new_index->search_info = btr_search_info_create(new_index->heap);

1569 1570 1571 1572
	new_index->stat_index_size = 1;
	new_index->stat_n_leaf_pages = 1;

	new_index->page = page_no;
1573
	rw_lock_create(&new_index->lock, SYNC_INDEX_TREE);
osku's avatar
osku committed
1574 1575 1576

	if (!UNIV_UNLIKELY(new_index->type & DICT_UNIVERSAL)) {

1577 1578 1579
		new_index->stat_n_diff_key_vals = mem_heap_alloc(
			new_index->heap,
			(1 + dict_index_get_n_unique(new_index))
1580
			* sizeof(ib_int64_t));
osku's avatar
osku committed
1581 1582 1583 1584 1585 1586 1587 1588
		/* Give some sensible values to stat_n_... in case we do
		not calculate statistics quickly enough */

		for (i = 0; i <= dict_index_get_n_unique(new_index); i++) {

			new_index->stat_n_diff_key_vals[i] = 100;
		}
	}
1589

osku's avatar
osku committed
1590 1591 1592
	dict_sys->size += mem_heap_get_size(new_index->heap);

	dict_mem_index_free(index);
1593 1594

	return(DB_SUCCESS);
osku's avatar
osku committed
1595 1596 1597 1598
}

/**************************************************************************
Removes an index from the dictionary cache. */
1599
UNIV_INTERN
osku's avatar
osku committed
1600 1601 1602
void
dict_index_remove_from_cache(
/*=========================*/
1603
	dict_table_t*	table,	/* in/out: table */
osku's avatar
osku committed
1604 1605 1606
	dict_index_t*	index)	/* in, own: index */
{
	ulint		size;
1607 1608
	ulint		retries = 0;
	btr_search_t*	info;
osku's avatar
osku committed
1609 1610 1611 1612 1613 1614

	ut_ad(table && index);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
	ut_ad(mutex_own(&(dict_sys->mutex)));

1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
	/* We always create search info whether or not adaptive
	hash index is enabled or not. */
	info = index->search_info;
	ut_ad(info);

	/* We are not allowed to free the in-memory index struct
 	dict_index_t until all entries in the adaptive hash index
	that point to any of the page belonging to his b-tree index
	are dropped. This is so because dropping of these entries
	require access to dict_index_t struct. To avoid such scenario
	We keep a count of number of such pages in the search_info and
	only free the dict_index_t struct when this count drops to
	zero. */

	for (;;) {
		ulint ref_count = btr_search_info_get_ref_count(info);
		if (ref_count == 0) {
			break;
		}

		/* Sleep for 10ms before trying again. */
		os_thread_sleep(10000);
		++retries;

		if (retries % 500 == 0) {
			/* No luck after 5 seconds of wait. */
			fprintf(stderr, "InnoDB: Error: Waited for"
					" %lu secs for hash index"
					" ref_count (%lu) to drop"
					" to 0.\n"
					"index: \"%s\""
					" table: \"%s\"\n",
					retries/100,
					ref_count,
					index->name,
					table->name);
		}

		/* To avoid a hang here we commit suicide if the
		ref_count doesn't drop to zero in 600 seconds. */
		if (retries >= 60000) {
			ut_error;
		}
	}

1660
	rw_lock_free(&index->lock);
osku's avatar
osku committed
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670

	/* Remove the index from the list of indexes of the table */
	UT_LIST_REMOVE(indexes, table->indexes, index);

	size = mem_heap_get_size(index->heap);

	ut_ad(dict_sys->size >= size);

	dict_sys->size -= size;

1671
	dict_mem_index_free(index);
osku's avatar
osku committed
1672 1673 1674
}

/***********************************************************************
1675 1676
Tries to find column names for the index and sets the col field of the
index. */
osku's avatar
osku committed
1677
static
1678
void
osku's avatar
osku committed
1679 1680 1681
dict_index_find_cols(
/*=================*/
	dict_table_t*	table,	/* in: table */
1682
	dict_index_t*	index)	/* in: index */
osku's avatar
osku committed
1683 1684
{
	ulint		i;
1685

osku's avatar
osku committed
1686 1687 1688 1689 1690
	ut_ad(table && index);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);
	ut_ad(mutex_own(&(dict_sys->mutex)));

	for (i = 0; i < index->n_fields; i++) {
1691 1692
		ulint		j;
		dict_field_t*	field = dict_index_get_nth_field(index, i);
osku's avatar
osku committed
1693

1694 1695 1696
		for (j = 0; j < table->n_cols; j++) {
			if (!strcmp(dict_table_get_col_name(table, j),
				    field->name)) {
1697
				field->col = dict_table_get_nth_col(table, j);
1698

1699 1700
				goto found;
			}
osku's avatar
osku committed
1701 1702
		}

1703 1704 1705
		/* It is an error not to find a matching column. */
		ut_error;

1706
found:
1707 1708
		;
	}
osku's avatar
osku committed
1709
}
1710

osku's avatar
osku committed
1711 1712
/***********************************************************************
Adds a column to index. */
1713
UNIV_INTERN
osku's avatar
osku committed
1714 1715 1716
void
dict_index_add_col(
/*===============*/
1717 1718 1719 1720
	dict_index_t*		index,		/* in/out: index */
	const dict_table_t*	table,		/* in: table */
	dict_col_t*		col,		/* in: column */
	ulint			prefix_len)	/* in: column prefix length */
osku's avatar
osku committed
1721 1722
{
	dict_field_t*	field;
1723
	const char*	col_name;
osku's avatar
osku committed
1724

1725 1726 1727
	col_name = dict_table_get_col_name(table, dict_col_get_no(col));

	dict_mem_index_add_field(index, col_name, prefix_len);
osku's avatar
osku committed
1728 1729 1730 1731

	field = dict_index_get_nth_field(index, index->n_def - 1);

	field->col = col;
1732
	field->fixed_len = (unsigned int) dict_col_get_fixed_size(col);
osku's avatar
osku committed
1733 1734

	if (prefix_len && field->fixed_len > prefix_len) {
1735
		field->fixed_len = (unsigned int) prefix_len;
osku's avatar
osku committed
1736 1737 1738 1739 1740 1741 1742 1743 1744
	}

	/* Long fixed-length fields that need external storage are treated as
	variable-length fields, so that the extern flag can be embedded in
	the length word. */

	if (field->fixed_len > DICT_MAX_INDEX_COL_LEN) {
		field->fixed_len = 0;
	}
1745 1746 1747 1748 1749 1750
#if DICT_MAX_INDEX_COL_LEN != 768
	/* The comparison limit above must be constant.  If it were
	changed, the disk format of some fixed-length columns would
	change, which would be a disaster. */
# error "DICT_MAX_INDEX_COL_LEN != 768"
#endif
osku's avatar
osku committed
1751

1752
	if (!(col->prtype & DATA_NOT_NULL)) {
osku's avatar
osku committed
1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
		index->n_nullable++;
	}
}

/***********************************************************************
Copies fields contained in index2 to index1. */
static
void
dict_index_copy(
/*============*/
1763 1764 1765 1766 1767
	dict_index_t*		index1,	/* in: index to copy to */
	dict_index_t*		index2,	/* in: index to copy from */
	const dict_table_t*	table,	/* in: table */
	ulint			start,	/* in: first position to copy */
	ulint			end)	/* in: last position to copy */
osku's avatar
osku committed
1768 1769 1770
{
	dict_field_t*	field;
	ulint		i;
1771

osku's avatar
osku committed
1772 1773 1774 1775 1776
	/* Copy fields contained in index2 */

	for (i = start; i < end; i++) {

		field = dict_index_get_nth_field(index2, i);
1777 1778
		dict_index_add_col(index1, table, field->col,
				   field->prefix_len);
osku's avatar
osku committed
1779 1780 1781 1782 1783
	}
}

/***********************************************************************
Copies types of fields contained in index to tuple. */
1784
UNIV_INTERN
osku's avatar
osku committed
1785 1786 1787
void
dict_index_copy_types(
/*==================*/
1788 1789 1790 1791
	dtuple_t*		tuple,		/* in/out: data tuple */
	const dict_index_t*	index,		/* in: index */
	ulint			n_fields)	/* in: number of
						field types to copy */
osku's avatar
osku committed
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
{
	ulint		i;

	if (UNIV_UNLIKELY(index->type & DICT_UNIVERSAL)) {
		dtuple_set_types_binary(tuple, n_fields);

		return;
	}

	for (i = 0; i < n_fields; i++) {
1802 1803
		const dict_field_t*	ifield;
		dtype_t*		dfield_type;
1804 1805

		ifield = dict_index_get_nth_field(index, i);
1806
		dfield_type = dfield_get_type(dtuple_get_nth_field(tuple, i));
1807
		dict_col_copy_type(dict_field_get_col(ifield), dfield_type);
osku's avatar
osku committed
1808 1809 1810 1811
	}
}

/***********************************************************************
1812 1813 1814
Copies types of columns contained in table to tuple and sets all
fields of the tuple to the SQL NULL value.  This function should
be called right after dtuple_create(). */
1815
UNIV_INTERN
osku's avatar
osku committed
1816 1817 1818
void
dict_table_copy_types(
/*==================*/
1819 1820
	dtuple_t*		tuple,	/* in/out: data tuple */
	const dict_table_t*	table)	/* in: table */
osku's avatar
osku committed
1821 1822 1823 1824 1825
{
	ulint		i;

	for (i = 0; i < dtuple_get_n_fields(tuple); i++) {

1826 1827 1828 1829 1830
		dfield_t*	dfield	= dtuple_get_nth_field(tuple, i);
		dtype_t*	dtype	= dfield_get_type(dfield);

		dfield_set_null(dfield);
		dict_col_copy_type(dict_table_get_nth_col(table, i), dtype);
osku's avatar
osku committed
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
	}
}

/***********************************************************************
Builds the internal dictionary cache representation for a clustered
index, containing also system fields not defined by the user. */
static
dict_index_t*
dict_index_build_internal_clust(
/*============================*/
1841 1842 1843 1844 1845 1846
					/* out, own: the internal
					representation of the clustered
					index */
	const dict_table_t*	table,	/* in: table */
	dict_index_t*		index)	/* in: user representation of
					a clustered index */
osku's avatar
osku committed
1847 1848 1849 1850 1851 1852
{
	dict_index_t*	new_index;
	dict_field_t*	field;
	ulint		fixed_size;
	ulint		trx_id_pos;
	ulint		i;
1853
	ibool*		indexed;
osku's avatar
osku committed
1854 1855

	ut_ad(table && index);
1856
	ut_ad(dict_index_is_clust(index));
osku's avatar
osku committed
1857 1858 1859 1860 1861
	ut_ad(mutex_own(&(dict_sys->mutex)));
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

	/* Create a new index object with certainly enough fields */
	new_index = dict_mem_index_create(table->name,
1862 1863 1864
					  index->name, table->space,
					  index->type,
					  index->n_fields + table->n_cols);
osku's avatar
osku committed
1865 1866 1867 1868 1869

	/* Copy other relevant data from the old index struct to the new
	struct: it inherits the values */

	new_index->n_user_defined_cols = index->n_fields;
1870

osku's avatar
osku committed
1871 1872
	new_index->id = index->id;

1873
	/* Copy the fields of index */
1874
	dict_index_copy(new_index, index, table, 0, index->n_fields);
osku's avatar
osku committed
1875 1876 1877 1878

	if (UNIV_UNLIKELY(index->type & DICT_UNIVERSAL)) {
		/* No fixed number of fields determines an entry uniquely */

1879
		new_index->n_uniq = REC_MAX_N_FIELDS;
1880

1881
	} else if (dict_index_is_unique(index)) {
osku's avatar
osku committed
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
		/* Only the fields defined so far are needed to identify
		the index entry uniquely */

		new_index->n_uniq = new_index->n_def;
	} else {
		/* Also the row id is needed to identify the entry */
		new_index->n_uniq = 1 + new_index->n_def;
	}

	new_index->trx_id_offset = 0;

1893
	if (!dict_index_is_ibuf(index)) {
osku's avatar
osku committed
1894 1895 1896 1897
		/* Add system columns, trx id first */

		trx_id_pos = new_index->n_def;

1898 1899 1900 1901 1902 1903 1904 1905 1906
#if DATA_ROW_ID != 0
# error "DATA_ROW_ID != 0"
#endif
#if DATA_TRX_ID != 1
# error "DATA_TRX_ID != 1"
#endif
#if DATA_ROLL_PTR != 2
# error "DATA_ROLL_PTR != 2"
#endif
osku's avatar
osku committed
1907

1908
		if (!dict_index_is_unique(index)) {
1909
			dict_index_add_col(new_index, table,
1910 1911 1912
					   dict_table_get_sys_col(
						   table, DATA_ROW_ID),
					   0);
osku's avatar
osku committed
1913 1914 1915
			trx_id_pos++;
		}

1916
		dict_index_add_col(new_index, table,
1917 1918
				   dict_table_get_sys_col(table, DATA_TRX_ID),
				   0);
1919

1920
		dict_index_add_col(new_index, table,
1921 1922 1923
				   dict_table_get_sys_col(table,
							  DATA_ROLL_PTR),
				   0);
osku's avatar
osku committed
1924 1925 1926

		for (i = 0; i < trx_id_pos; i++) {

1927 1928
			fixed_size = dict_col_get_fixed_size(
				dict_index_get_nth_col(new_index, i));
osku's avatar
osku committed
1929 1930 1931 1932 1933 1934 1935 1936

			if (fixed_size == 0) {
				new_index->trx_id_offset = 0;

				break;
			}

			if (dict_index_get_nth_field(new_index, i)->prefix_len
1937
			    > 0) {
osku's avatar
osku committed
1938 1939 1940 1941 1942
				new_index->trx_id_offset = 0;

				break;
			}

1943
			new_index->trx_id_offset += (unsigned int) fixed_size;
osku's avatar
osku committed
1944 1945 1946 1947
		}

	}

1948
	/* Remember the table columns already contained in new_index */
1949
	indexed = mem_zalloc(table->n_cols * sizeof *indexed);
osku's avatar
osku committed
1950

1951
	/* Mark the table columns already contained in new_index */
osku's avatar
osku committed
1952 1953 1954 1955 1956 1957 1958 1959 1960
	for (i = 0; i < new_index->n_def; i++) {

		field = dict_index_get_nth_field(new_index, i);

		/* If there is only a prefix of the column in the index
		field, do not mark the column as contained in the index */

		if (field->prefix_len == 0) {

1961
			indexed[field->col->ind] = TRUE;
osku's avatar
osku committed
1962 1963
		}
	}
1964

osku's avatar
osku committed
1965 1966
	/* Add to new_index non-system columns of table not yet included
	there */
1967
	for (i = 0; i + DATA_N_SYS_COLS < (ulint) table->n_cols; i++) {
osku's avatar
osku committed
1968

1969
		dict_col_t*	col = dict_table_get_nth_col(table, i);
1970
		ut_ad(col->mtype != DATA_SYS);
osku's avatar
osku committed
1971

1972
		if (!indexed[col->ind]) {
1973
			dict_index_add_col(new_index, table, col, 0);
osku's avatar
osku committed
1974 1975 1976
		}
	}

1977 1978
	mem_free(indexed);

1979
	ut_ad(dict_index_is_ibuf(index)
1980
	      || (UT_LIST_GET_LEN(table->indexes) == 0));
osku's avatar
osku committed
1981 1982 1983 1984

	new_index->cached = TRUE;

	return(new_index);
1985
}
osku's avatar
osku committed
1986 1987 1988 1989 1990 1991 1992 1993

/***********************************************************************
Builds the internal dictionary cache representation for a non-clustered
index, containing also system fields not defined by the user. */
static
dict_index_t*
dict_index_build_internal_non_clust(
/*================================*/
1994 1995 1996 1997 1998 1999
					/* out, own: the internal
					representation of the non-clustered
					index */
	const dict_table_t*	table,	/* in: table */
	dict_index_t*		index)	/* in: user representation of
					a non-clustered index */
osku's avatar
osku committed
2000 2001 2002 2003 2004
{
	dict_field_t*	field;
	dict_index_t*	new_index;
	dict_index_t*	clust_index;
	ulint		i;
2005
	ibool*		indexed;
osku's avatar
osku committed
2006 2007

	ut_ad(table && index);
2008
	ut_ad(!dict_index_is_clust(index));
osku's avatar
osku committed
2009 2010 2011 2012 2013
	ut_ad(mutex_own(&(dict_sys->mutex)));
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

	/* The clustered index should be the first in the list of indexes */
	clust_index = UT_LIST_GET_FIRST(table->indexes);
2014

osku's avatar
osku committed
2015
	ut_ad(clust_index);
2016
	ut_ad(dict_index_is_clust(clust_index));
osku's avatar
osku committed
2017 2018 2019
	ut_ad(!(clust_index->type & DICT_UNIVERSAL));

	/* Create a new index */
2020 2021 2022
	new_index = dict_mem_index_create(
		table->name, index->name, index->space, index->type,
		index->n_fields + 1 + clust_index->n_uniq);
osku's avatar
osku committed
2023 2024 2025 2026 2027

	/* Copy other relevant data from the old index
	struct to the new struct: it inherits the values */

	new_index->n_user_defined_cols = index->n_fields;
2028

osku's avatar
osku committed
2029 2030 2031
	new_index->id = index->id;

	/* Copy fields from index to new_index */
2032
	dict_index_copy(new_index, index, table, 0, index->n_fields);
osku's avatar
osku committed
2033

2034
	/* Remember the table columns already contained in new_index */
2035
	indexed = mem_zalloc(table->n_cols * sizeof *indexed);
osku's avatar
osku committed
2036

2037
	/* Mark the table columns already contained in new_index */
osku's avatar
osku committed
2038 2039 2040 2041 2042 2043 2044 2045 2046
	for (i = 0; i < new_index->n_def; i++) {

		field = dict_index_get_nth_field(new_index, i);

		/* If there is only a prefix of the column in the index
		field, do not mark the column as contained in the index */

		if (field->prefix_len == 0) {

2047
			indexed[field->col->ind] = TRUE;
osku's avatar
osku committed
2048 2049 2050 2051 2052 2053 2054 2055 2056 2057
		}
	}

	/* Add to new_index the columns necessary to determine the clustered
	index entry uniquely */

	for (i = 0; i < clust_index->n_uniq; i++) {

		field = dict_index_get_nth_field(clust_index, i);

2058
		if (!indexed[field->col->ind]) {
2059
			dict_index_add_col(new_index, table, field->col,
2060
					   field->prefix_len);
osku's avatar
osku committed
2061 2062 2063
		}
	}

2064 2065
	mem_free(indexed);

2066
	if (dict_index_is_unique(index)) {
osku's avatar
osku committed
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
		new_index->n_uniq = index->n_fields;
	} else {
		new_index->n_uniq = new_index->n_def;
	}

	/* Set the n_fields value in new_index to the actual defined
	number of fields */

	new_index->n_fields = new_index->n_def;

	new_index->cached = TRUE;

	return(new_index);
2080
}
osku's avatar
osku committed
2081 2082 2083 2084 2085

/*====================== FOREIGN KEY PROCESSING ========================*/

/*************************************************************************
Checks if a table is referenced by foreign keys. */
2086
UNIV_INTERN
osku's avatar
osku committed
2087
ibool
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099
dict_table_is_referenced_by_foreign_key(
/*====================================*/
					/* out: TRUE if table is referenced
					by a foreign key */
	const dict_table_t*	table)	/* in: InnoDB table */
{
	return(UT_LIST_GET_LEN(table->referenced_list) > 0);
}

/*************************************************************************
Check if the index is referenced by a foreign key, if TRUE return foreign
else return NULL */
2100
UNIV_INTERN
2101 2102
dict_foreign_t*
dict_table_get_referenced_constraint(
osku's avatar
osku committed
2103
/*=================================*/
2104 2105 2106 2107
				/* out: pointer to foreign key struct if index
				is defined for foreign key, otherwise NULL */
	dict_table_t*	table,	/* in: InnoDB table */
	dict_index_t*	index)	/* in: InnoDB index */
osku's avatar
osku committed
2108
{
marko's avatar
marko committed
2109
	dict_foreign_t*	foreign;
2110

inaam's avatar
inaam committed
2111
	ut_ad(index != NULL);
marko's avatar
marko committed
2112
	ut_ad(table != NULL);
osku's avatar
osku committed
2113

marko's avatar
marko committed
2114 2115 2116
	for (foreign = UT_LIST_GET_FIRST(table->referenced_list);
	     foreign;
	     foreign = UT_LIST_GET_NEXT(referenced_list, foreign)) {
2117

marko's avatar
marko committed
2118
		if (foreign->referenced_index == index) {
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130

			return(foreign);
		}
	}

	return(NULL);
}

/*************************************************************************
Checks if a index is defined for a foreign key constraint. Index is a part
of a foreign key constraint if the index is referenced by foreign key
or index is a foreign key index. */
2131
UNIV_INTERN
2132 2133 2134 2135 2136 2137 2138 2139
dict_foreign_t*
dict_table_get_foreign_constraint(
/*==============================*/
				/* out: pointer to foreign key struct if index
				is defined for foreign key, otherwise NULL */
	dict_table_t*	table,	/* in: InnoDB table */
	dict_index_t*	index)	/* in: InnoDB index */
{
marko's avatar
marko committed
2140
	dict_foreign_t*	foreign;
2141

marko's avatar
marko committed
2142 2143
	ut_ad(index != NULL);
	ut_ad(table != NULL);
2144

marko's avatar
marko committed
2145 2146 2147
	for (foreign = UT_LIST_GET_FIRST(table->foreign_list);
	     foreign;
	     foreign = UT_LIST_GET_NEXT(foreign_list, foreign)) {
2148 2149 2150 2151 2152 2153 2154 2155 2156

		if (foreign->foreign_index == index
		    || foreign->referenced_index == index) {

			return(foreign);
		}
	}

	return(NULL);
osku's avatar
osku committed
2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
}

/*************************************************************************
Frees a foreign key struct. */
static
void
dict_foreign_free(
/*==============*/
	dict_foreign_t*	foreign)	/* in, own: foreign key struct */
{
	mem_heap_free(foreign->heap);
}

/**************************************************************************
Removes a foreign constraint struct from the dictionary cache. */
static
void
dict_foreign_remove_from_cache(
/*===========================*/
	dict_foreign_t*	foreign)	/* in, own: foreign constraint */
{
	ut_ad(mutex_own(&(dict_sys->mutex)));
	ut_a(foreign);
2180

osku's avatar
osku committed
2181 2182
	if (foreign->referenced_table) {
		UT_LIST_REMOVE(referenced_list,
2183 2184
			       foreign->referenced_table->referenced_list,
			       foreign);
osku's avatar
osku committed
2185 2186 2187 2188
	}

	if (foreign->foreign_table) {
		UT_LIST_REMOVE(foreign_list,
2189 2190
			       foreign->foreign_table->foreign_list,
			       foreign);
osku's avatar
osku committed
2191 2192 2193 2194 2195
	}

	dict_foreign_free(foreign);
}

2196
#ifndef UNIV_HOTBACKUP
osku's avatar
osku committed
2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221
/**************************************************************************
Looks for the foreign constraint from the foreign and referenced lists
of a table. */
static
dict_foreign_t*
dict_foreign_find(
/*==============*/
				/* out: foreign constraint */
	dict_table_t*	table,	/* in: table object */
	const char*	id)	/* in: foreign constraint id */
{
	dict_foreign_t*	foreign;

	ut_ad(mutex_own(&(dict_sys->mutex)));

	foreign = UT_LIST_GET_FIRST(table->foreign_list);

	while (foreign) {
		if (ut_strcmp(id, foreign->id) == 0) {

			return(foreign);
		}

		foreign = UT_LIST_GET_NEXT(foreign_list, foreign);
	}
2222

osku's avatar
osku committed
2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
	foreign = UT_LIST_GET_FIRST(table->referenced_list);

	while (foreign) {
		if (ut_strcmp(id, foreign->id) == 0) {

			return(foreign);
		}

		foreign = UT_LIST_GET_NEXT(referenced_list, foreign);
	}

	return(NULL);
2235
}
osku's avatar
osku committed
2236 2237 2238

/*************************************************************************
Tries to find an index whose first fields are the columns in the array,
2239 2240
in the same order and is not marked for deletion and is not the same
as types_idx. */
osku's avatar
osku committed
2241 2242 2243 2244 2245 2246 2247 2248
static
dict_index_t*
dict_foreign_find_index(
/*====================*/
				/* out: matching index, NULL if not found */
	dict_table_t*	table,	/* in: table */
	const char**	columns,/* in: array of column names */
	ulint		n_cols,	/* in: number of columns */
2249
	dict_index_t*	types_idx, /* in: NULL or an index to whose types the
2250
				   column types must match */
2251
	ibool		check_charsets,
2252 2253
				/* in: whether to check charsets.
				only has an effect if types_idx != NULL */
2254 2255 2256
	ulint		check_null)
				/* in: nonzero if none of the columns must
				be declared NOT NULL */
osku's avatar
osku committed
2257 2258
{
	dict_index_t*	index;
2259

osku's avatar
osku committed
2260 2261 2262
	index = dict_table_get_first_index(table);

	while (index != NULL) {
2263 2264 2265 2266 2267 2268 2269 2270
		/* Ignore matches that refer to the same instance
		or the index is to be dropped */
		if (index->to_be_dropped || types_idx == index) {

			goto next_rec;

		} else if (dict_index_get_n_fields(index) >= n_cols) {
			ulint		i;
osku's avatar
osku committed
2271 2272

			for (i = 0; i < n_cols; i++) {
2273 2274 2275
				dict_field_t*	field;
				const char*	col_name;

2276 2277 2278 2279 2280 2281
				field = dict_index_get_nth_field(index, i);

				col_name = dict_table_get_col_name(
					table, dict_col_get_no(field->col));

				if (field->prefix_len != 0) {
osku's avatar
osku committed
2282 2283
					/* We do not accept column prefix
					indexes here */
2284

osku's avatar
osku committed
2285 2286 2287 2288
					break;
				}

				if (0 != innobase_strcasecmp(columns[i],
2289
							     col_name)) {
2290
					break;
osku's avatar
osku committed
2291 2292
				}

2293 2294 2295 2296 2297 2298
				if (check_null
				    && (field->col->prtype & DATA_NOT_NULL)) {

					return(NULL);
				}

2299 2300 2301 2302 2303
				if (types_idx && !cmp_cols_are_equal(
					    dict_index_get_nth_col(index, i),
					    dict_index_get_nth_col(types_idx,
								   i),
					    check_charsets)) {
osku's avatar
osku committed
2304

2305 2306
					break;
				}
osku's avatar
osku committed
2307 2308 2309 2310 2311 2312 2313 2314 2315
			}

			if (i == n_cols) {
				/* We found a matching index */

				return(index);
			}
		}

2316
next_rec:
osku's avatar
osku committed
2317 2318 2319 2320 2321 2322
		index = dict_table_get_next_index(index);
	}

	return(NULL);
}

2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346
/**************************************************************************
Find an index that is equivalent to the one passed in and is not marked
for deletion. */
UNIV_INTERN
dict_index_t*
dict_foreign_find_equiv_index(
/*==========================*/
				/* out: index equivalent to
				foreign->foreign_index, or NULL */
	dict_foreign_t*	foreign)/* in: foreign key */
{
	ut_a(foreign != NULL);

	/* Try to find an index which contains the columns as the
	first fields and in the right order, and the types are the
	same as in foreign->foreign_index */

	return(dict_foreign_find_index(
		       foreign->foreign_table,
		       foreign->foreign_col_names, foreign->n_fields,
		       foreign->foreign_index, TRUE, /* check types */
		       FALSE/* allow columns to be NULL */));
}

marko's avatar
marko committed
2347 2348 2349
/**************************************************************************
Returns an index object by matching on the name and column names and
if more than one index matches return the index with the max id */
2350
UNIV_INTERN
2351
dict_index_t*
marko's avatar
marko committed
2352 2353
dict_table_get_index_by_max_id(
/*===========================*/
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
				/* out: matching index, NULL if not found */
	dict_table_t*	table,	/* in: table */
	const char*	name,	/* in: the index name to find */
	const char**	columns,/* in: array of column names */
	ulint		n_cols)	/* in: number of columns */
{
	dict_index_t*	index;
	dict_index_t*	found;

	found = NULL;
	index = dict_table_get_first_index(table);

	while (index != NULL) {
		if (ut_strcmp(index->name, name) == 0
		    && dict_index_get_n_ordering_defined_by_user(index)
		    == n_cols) {

			ulint		i;

			for (i = 0; i < n_cols; i++) {
				dict_field_t*	field;
				const char*	col_name;

				field = dict_index_get_nth_field(index, i);

				col_name = dict_table_get_col_name(
					table, dict_col_get_no(field->col));

				if (0 != innobase_strcasecmp(
					    columns[i], col_name)) {

					break;
				}
			}

			if (i == n_cols) {
				/* We found a matching index, select
				the index with the higher id*/

				if (!found
				    || ut_dulint_cmp(index->id, found->id) > 0) {

					found = index;
				}
			}
		}

		index = dict_table_get_next_index(index);
	}

	return(found);
}

osku's avatar
osku committed
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
/**************************************************************************
Report an error in a foreign key definition. */
static
void
dict_foreign_error_report_low(
/*==========================*/
	FILE*		file,	/* in: output stream */
	const char*	name)	/* in: table name */
{
	rewind(file);
	ut_print_timestamp(file);
	fprintf(file, " Error in foreign key constraint of table %s:\n",
		name);
}

/**************************************************************************
Report an error in a foreign key definition. */
static
void
dict_foreign_error_report(
/*======================*/
	FILE*		file,	/* in: output stream */
	dict_foreign_t*	fk,	/* in: foreign key constraint */
	const char*	msg)	/* in: the error message */
{
	mutex_enter(&dict_foreign_err_mutex);
	dict_foreign_error_report_low(file, fk->foreign_table_name);
	fputs(msg, file);
	fputs(" Constraint:\n", file);
	dict_print_info_on_foreign_key_in_create_format(file, NULL, fk, TRUE);
2437
	putc('\n', file);
osku's avatar
osku committed
2438
	if (fk->foreign_index) {
2439
		fputs("The index in the foreign key in table is ", file);
2440
		ut_print_name(file, NULL, FALSE, fk->foreign_index->name);
2441
		fputs("\n"
2442 2443 2444 2445
		      "See http://dev.mysql.com/doc/refman/5.1/en/"
		      "innodb-foreign-key-constraints.html\n"
		      "for correct foreign key definition.\n",
		      file);
osku's avatar
osku committed
2446 2447 2448 2449 2450 2451 2452 2453 2454
	}
	mutex_exit(&dict_foreign_err_mutex);
}

/**************************************************************************
Adds a foreign key constraint object to the dictionary cache. May free
the object if there already is an object with the same identifier in.
At least one of the foreign table and the referenced table must already
be in the dictionary cache! */
2455
UNIV_INTERN
osku's avatar
osku committed
2456 2457 2458 2459 2460
ulint
dict_foreign_add_to_cache(
/*======================*/
					/* out: DB_SUCCESS or error code */
	dict_foreign_t*	foreign,	/* in, own: foreign key constraint */
2461 2462
	ibool		check_charsets)	/* in: TRUE=check charset
					compatibility */
osku's avatar
osku committed
2463 2464 2465 2466 2467 2468
{
	dict_table_t*	for_table;
	dict_table_t*	ref_table;
	dict_foreign_t*	for_in_cache		= NULL;
	dict_index_t*	index;
	ibool		added_to_referenced_list= FALSE;
2469
	FILE*		ef			= dict_foreign_err_file;
osku's avatar
osku committed
2470 2471 2472

	ut_ad(mutex_own(&(dict_sys->mutex)));

2473 2474
	for_table = dict_table_check_if_in_cache_low(
		foreign->foreign_table_name);
2475

2476 2477
	ref_table = dict_table_check_if_in_cache_low(
		foreign->referenced_table_name);
osku's avatar
osku committed
2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
	ut_a(for_table || ref_table);

	if (for_table) {
		for_in_cache = dict_foreign_find(for_table, foreign->id);
	}

	if (!for_in_cache && ref_table) {
		for_in_cache = dict_foreign_find(ref_table, foreign->id);
	}

	if (for_in_cache) {
		/* Free the foreign object */
		mem_heap_free(foreign->heap);
	} else {
		for_in_cache = foreign;
	}

	if (for_in_cache->referenced_table == NULL && ref_table) {
2496 2497
		index = dict_foreign_find_index(
			ref_table,
2498
			for_in_cache->referenced_col_names,
2499
			for_in_cache->n_fields, for_in_cache->foreign_index,
2500
			check_charsets, FALSE);
osku's avatar
osku committed
2501 2502

		if (index == NULL) {
2503 2504 2505 2506 2507 2508 2509 2510
			dict_foreign_error_report(
				ef, for_in_cache,
				"there is no index in referenced table"
				" which would contain\n"
				"the columns as the first columns,"
				" or the data types in the\n"
				"referenced table do not match"
				" the ones in table.");
osku's avatar
osku committed
2511 2512 2513 2514 2515

			if (for_in_cache == foreign) {
				mem_heap_free(foreign->heap);
			}

2516
			return(DB_CANNOT_ADD_CONSTRAINT);
osku's avatar
osku committed
2517 2518 2519 2520 2521
		}

		for_in_cache->referenced_table = ref_table;
		for_in_cache->referenced_index = index;
		UT_LIST_ADD_LAST(referenced_list,
2522 2523
				 ref_table->referenced_list,
				 for_in_cache);
osku's avatar
osku committed
2524 2525 2526 2527
		added_to_referenced_list = TRUE;
	}

	if (for_in_cache->foreign_table == NULL && for_table) {
2528 2529
		index = dict_foreign_find_index(
			for_table,
2530
			for_in_cache->foreign_col_names,
2531
			for_in_cache->n_fields,
2532 2533 2534 2535
			for_in_cache->referenced_index, check_charsets,
			for_in_cache->type
			& (DICT_FOREIGN_ON_DELETE_SET_NULL
			   | DICT_FOREIGN_ON_UPDATE_SET_NULL));
osku's avatar
osku committed
2536 2537

		if (index == NULL) {
2538 2539 2540 2541 2542 2543 2544
			dict_foreign_error_report(
				ef, for_in_cache,
				"there is no index in the table"
				" which would contain\n"
				"the columns as the first columns,"
				" or the data types in the\n"
				"table do not match"
2545 2546 2547
				" the ones in the referenced table\n"
				"or one of the ON ... SET NULL columns"
				" is declared NOT NULL.");
osku's avatar
osku committed
2548 2549 2550

			if (for_in_cache == foreign) {
				if (added_to_referenced_list) {
2551 2552 2553 2554
					UT_LIST_REMOVE(
						referenced_list,
						ref_table->referenced_list,
						for_in_cache);
osku's avatar
osku committed
2555
				}
2556

osku's avatar
osku committed
2557 2558 2559
				mem_heap_free(foreign->heap);
			}

2560
			return(DB_CANNOT_ADD_CONSTRAINT);
osku's avatar
osku committed
2561 2562 2563 2564 2565
		}

		for_in_cache->foreign_table = for_table;
		for_in_cache->foreign_index = index;
		UT_LIST_ADD_LAST(foreign_list,
2566 2567
				 for_table->foreign_list,
				 for_in_cache);
osku's avatar
osku committed
2568 2569 2570 2571 2572 2573 2574 2575 2576
	}

	return(DB_SUCCESS);
}

/*************************************************************************
Scans from pointer onwards. Stops if is at the start of a copy of
'string' where characters are compared without case sensitivity, and
only outside `` or "" quotes. Stops also at '\0'. */
2577
static
osku's avatar
osku committed
2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601
const char*
dict_scan_to(
/*=========*/
				/* out: scanned up to this */
	const char*	ptr,	/* in: scan from */
	const char*	string)	/* in: look for this */
{
	char	quote	= '\0';

	for (; *ptr; ptr++) {
		if (*ptr == quote) {
			/* Closing quote character: do not look for
			starting quote or the keyword. */
			quote = '\0';
		} else if (quote) {
			/* Within quotes: do nothing. */
		} else if (*ptr == '`' || *ptr == '"') {
			/* Starting quote: remember the quote character. */
			quote = *ptr;
		} else {
			/* Outside quotes: look for the keyword. */
			ulint	i;
			for (i = 0; string[i]; i++) {
				if (toupper((int)(unsigned char)(ptr[i]))
2602 2603
				    != toupper((int)(unsigned char)
					       (string[i]))) {
osku's avatar
osku committed
2604 2605 2606 2607
					goto nomatch;
				}
			}
			break;
2608
nomatch:
osku's avatar
osku committed
2609 2610 2611 2612 2613 2614 2615 2616 2617
			;
		}
	}

	return(ptr);
}

/*************************************************************************
Accepts a specified string. Comparisons are case-insensitive. */
2618
static
osku's avatar
osku committed
2619 2620 2621 2622 2623
const char*
dict_accept(
/*========*/
				/* out: if string was accepted, the pointer
				is moved after that, else ptr is returned */
2624
	struct charset_info_st*	cs,/* in: the character set of ptr */
osku's avatar
osku committed
2625 2626 2627 2628 2629 2630 2631 2632 2633
	const char*	ptr,	/* in: scan from this */
	const char*	string,	/* in: accept only this string as the next
				non-whitespace string */
	ibool*		success)/* out: TRUE if accepted */
{
	const char*	old_ptr = ptr;
	const char*	old_ptr2;

	*success = FALSE;
2634

2635
	while (my_isspace(cs, *ptr)) {
osku's avatar
osku committed
2636 2637 2638 2639
		ptr++;
	}

	old_ptr2 = ptr;
2640

osku's avatar
osku committed
2641
	ptr = dict_scan_to(ptr, string);
2642

osku's avatar
osku committed
2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
	if (*ptr == '\0' || old_ptr2 != ptr) {
		return(old_ptr);
	}

	*success = TRUE;

	return(ptr + ut_strlen(string));
}

/*************************************************************************
Scans an id. For the lexical definition of an 'id', see the code below.
Strips backquotes or double quotes from around the id. */
static
const char*
dict_scan_id(
/*=========*/
				/* out: scanned to */
2660
	struct charset_info_st*	cs,/* in: the character set of ptr */
osku's avatar
osku committed
2661 2662 2663 2664 2665 2666
	const char*	ptr,	/* in: scanned to */
	mem_heap_t*	heap,	/* in: heap where to allocate the id
				(NULL=id will not be allocated, but it
				will point to string near ptr) */
	const char**	id,	/* out,own: the id; NULL if no id was
				scannable */
2667 2668
	ibool		table_id,/* in: TRUE=convert the allocated id
				as a table name; FALSE=convert to UTF-8 */
osku's avatar
osku committed
2669 2670 2671 2672 2673 2674 2675 2676
	ibool		accept_also_dot)
				/* in: TRUE if also a dot can appear in a
				non-quoted id; in a quoted id it can appear
				always */
{
	char		quote	= '\0';
	ulint		len	= 0;
	const char*	s;
2677 2678
	char*		str;
	char*		dst;
osku's avatar
osku committed
2679 2680 2681

	*id = NULL;

2682
	while (my_isspace(cs, *ptr)) {
osku's avatar
osku committed
2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
		ptr++;
	}

	if (*ptr == '\0') {

		return(ptr);
	}

	if (*ptr == '`' || *ptr == '"') {
		quote = *ptr++;
	}

	s = ptr;

	if (quote) {
		for (;;) {
			if (!*ptr) {
				/* Syntax error */
				return(ptr);
			}
			if (*ptr == quote) {
				ptr++;
				if (*ptr != quote) {
					break;
				}
			}
			ptr++;
			len++;
		}
	} else {
2713
		while (!my_isspace(cs, *ptr) && *ptr != '(' && *ptr != ')'
2714 2715
		       && (accept_also_dot || *ptr != '.')
		       && *ptr != ',' && *ptr != '\0') {
osku's avatar
osku committed
2716 2717 2718 2719 2720 2721 2722

			ptr++;
		}

		len = ptr - s;
	}

2723 2724 2725 2726 2727 2728 2729 2730 2731
	if (UNIV_UNLIKELY(!heap)) {
		/* no heap given: id will point to source string */
		*id = s;
		return(ptr);
	}

	if (quote) {
		char*	d;
		str = d = mem_heap_alloc(heap, len + 1);
osku's avatar
osku committed
2732 2733 2734 2735 2736 2737
		while (len--) {
			if ((*d++ = *s++) == quote) {
				s++;
			}
		}
		*d++ = 0;
2738 2739 2740
		len = d - str;
		ut_ad(*s == quote);
		ut_ad(s + 1 == ptr);
osku's avatar
osku committed
2741
	} else {
2742 2743 2744 2745 2746 2747 2748 2749 2750 2751
		str = mem_heap_strdupl(heap, s, len);
	}

	if (!table_id) {
convert_id:
		/* Convert the identifier from connection character set
		to UTF-8. */
		len = 3 * len + 1;
		*id = dst = mem_heap_alloc(heap, len);

2752
		innobase_convert_from_id(cs, dst, str, len);
2753
	} else if (!strncmp(str, srv_mysql50_table_name_prefix,
2754
			    sizeof srv_mysql50_table_name_prefix)) {
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764
		/* This is a pre-5.1 table name
		containing chars other than [A-Za-z0-9].
		Discard the prefix and use raw UTF-8 encoding. */
		str += sizeof srv_mysql50_table_name_prefix;
		len -= sizeof srv_mysql50_table_name_prefix;
		goto convert_id;
	} else {
		/* Encode using filename-safe characters. */
		len = 5 * len + 1;
		*id = dst = mem_heap_alloc(heap, len);
osku's avatar
osku committed
2765

2766
		innobase_convert_from_table_id(cs, dst, str, len);
osku's avatar
osku committed
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777
	}

	return(ptr);
}

/*************************************************************************
Tries to scan a column name. */
static
const char*
dict_scan_col(
/*==========*/
2778 2779 2780 2781 2782 2783 2784 2785 2786
					/* out: scanned to */
	struct charset_info_st*	cs,	/* in: the character set of ptr */
	const char*		ptr,	/* in: scanned to */
	ibool*			success,/* out: TRUE if success */
	dict_table_t*		table,	/* in: table in which the column is */
	const dict_col_t**	column,	/* out: pointer to column if success */
	mem_heap_t*		heap,	/* in: heap where to allocate */
	const char**		name)	/* out,own: the column name;
					NULL if no name was scannable */
osku's avatar
osku committed
2787 2788 2789 2790 2791
{
	ulint		i;

	*success = FALSE;

2792
	ptr = dict_scan_id(cs, ptr, heap, name, FALSE, TRUE);
osku's avatar
osku committed
2793 2794 2795 2796 2797 2798 2799 2800 2801 2802

	if (*name == NULL) {

		return(ptr);	/* Syntax error */
	}

	if (table == NULL) {
		*success = TRUE;
		*column = NULL;
	} else {
2803
		for (i = 0; i < dict_table_get_n_cols(table); i++) {
osku's avatar
osku committed
2804

2805 2806
			const char*	col_name = dict_table_get_col_name(
				table, i);
osku's avatar
osku committed
2807

2808
			if (0 == innobase_strcasecmp(col_name, *name)) {
2809
				/* Found */
osku's avatar
osku committed
2810

2811
				*success = TRUE;
2812 2813
				*column = dict_table_get_nth_col(table, i);
				strcpy((char*) *name, col_name);
osku's avatar
osku committed
2814

2815
				break;
osku's avatar
osku committed
2816 2817 2818
			}
		}
	}
2819

osku's avatar
osku committed
2820 2821 2822 2823 2824 2825 2826 2827 2828 2829
	return(ptr);
}

/*************************************************************************
Scans a table name from an SQL string. */
static
const char*
dict_scan_table_name(
/*=================*/
				/* out: scanned to */
2830
	struct charset_info_st*	cs,/* in: the character set of ptr */
osku's avatar
osku committed
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
	const char*	ptr,	/* in: scanned to */
	dict_table_t**	table,	/* out: table object or NULL */
	const char*	name,	/* in: foreign key table name */
	ibool*		success,/* out: TRUE if ok name found */
	mem_heap_t*	heap,	/* in: heap where to allocate the id */
	const char**	ref_name)/* out,own: the table name;
				NULL if no name was scannable */
{
	const char*	database_name	= NULL;
	ulint		database_name_len = 0;
	const char*	table_name	= NULL;
	ulint		table_name_len;
	const char*	scan_name;
	char*		ref;

	*success = FALSE;
	*table = NULL;
2848

2849
	ptr = dict_scan_id(cs, ptr, heap, &scan_name, TRUE, FALSE);
osku's avatar
osku committed
2850 2851

	if (scan_name == NULL) {
2852

osku's avatar
osku committed
2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
		return(ptr);	/* Syntax error */
	}

	if (*ptr == '.') {
		/* We scanned the database name; scan also the table name */

		ptr++;

		database_name = scan_name;
		database_name_len = strlen(database_name);

2864
		ptr = dict_scan_id(cs, ptr, heap, &table_name, TRUE, FALSE);
osku's avatar
osku committed
2865 2866 2867 2868 2869 2870 2871 2872 2873 2874

		if (table_name == NULL) {

			return(ptr);	/* Syntax error */
		}
	} else {
		/* To be able to read table dumps made with InnoDB-4.0.17 or
		earlier, we must allow the dot separator between the database
		name and the table name also to appear within a quoted
		identifier! InnoDB used to print a constraint as:
2875
		... REFERENCES `databasename.tablename` ...
osku's avatar
osku committed
2876
		starting from 4.0.18 it is
2877
		... REFERENCES `databasename`.`tablename` ... */
osku's avatar
osku committed
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928
		const char* s;

		for (s = scan_name; *s; s++) {
			if (*s == '.') {
				database_name = scan_name;
				database_name_len = s - scan_name;
				scan_name = ++s;
				break;/* to do: multiple dots? */
			}
		}

		table_name = scan_name;
	}

	if (database_name == NULL) {
		/* Use the database name of the foreign key table */

		database_name = name;
		database_name_len = dict_get_db_name_len(name);
	}

	table_name_len = strlen(table_name);

	/* Copy database_name, '/', table_name, '\0' */
	ref = mem_heap_alloc(heap, database_name_len + table_name_len + 2);
	memcpy(ref, database_name, database_name_len);
	ref[database_name_len] = '/';
	memcpy(ref + database_name_len + 1, table_name, table_name_len + 1);
#ifndef __WIN__
	if (srv_lower_case_table_names) {
#endif /* !__WIN__ */
		/* The table name is always put to lower case on Windows. */
		innobase_casedn_str(ref);
#ifndef __WIN__
	}
#endif /* !__WIN__ */

	*success = TRUE;
	*ref_name = ref;
	*table = dict_table_get_low(ref);

	return(ptr);
}

/*************************************************************************
Skips one id. The id is allowed to contain also '.'. */
static
const char*
dict_skip_word(
/*===========*/
				/* out: scanned to */
2929
	struct charset_info_st*	cs,/* in: the character set of ptr */
osku's avatar
osku committed
2930 2931 2932 2933 2934
	const char*	ptr,	/* in: scanned to */
	ibool*		success)/* out: TRUE if success, FALSE if just spaces
				left in string or a syntax error */
{
	const char*	start;
2935

osku's avatar
osku committed
2936 2937
	*success = FALSE;

2938
	ptr = dict_scan_id(cs, ptr, NULL, &start, FALSE, TRUE);
osku's avatar
osku committed
2939 2940 2941 2942

	if (start) {
		*success = TRUE;
	}
2943

osku's avatar
osku committed
2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964
	return(ptr);
}

/*************************************************************************
Removes MySQL comments from an SQL string. A comment is either
(a) '#' to the end of the line,
(b) '--<space>' to the end of the line, or
(c) '<slash><asterisk>' till the next '<asterisk><slash>' (like the familiar
C comment syntax). */
static
char*
dict_strip_comments(
/*================*/
					/* out, own: SQL string stripped from
					comments; the caller must free this
					with mem_free()! */
	const char*	sql_string)	/* in: SQL string */
{
	char*		str;
	const char*	sptr;
	char*		ptr;
2965 2966
	/* unclosed quote character (0 if none) */
	char		quote	= 0;
osku's avatar
osku committed
2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993

	str = mem_alloc(strlen(sql_string) + 1);

	sptr = sql_string;
	ptr = str;

	for (;;) {
scan_more:
		if (*sptr == '\0') {
			*ptr = '\0';

			ut_a(ptr <= str + strlen(sql_string));

			return(str);
		}

		if (*sptr == quote) {
			/* Closing quote character: do not look for
			starting quote or comments. */
			quote = 0;
		} else if (quote) {
			/* Within quotes: do not look for
			starting quotes or comments. */
		} else if (*sptr == '"' || *sptr == '`') {
			/* Starting quote: remember the quote character. */
			quote = *sptr;
		} else if (*sptr == '#'
2994 2995
			   || (sptr[0] == '-' && sptr[1] == '-'
			       && sptr[2] == ' ')) {
osku's avatar
osku committed
2996 2997 2998 2999 3000
			for (;;) {
				/* In Unix a newline is 0x0A while in Windows
				it is 0x0D followed by 0x0A */

				if (*sptr == (char)0x0A
3001 3002
				    || *sptr == (char)0x0D
				    || *sptr == '\0') {
osku's avatar
osku committed
3003 3004 3005 3006 3007 3008 3009 3010 3011 3012

					goto scan_more;
				}

				sptr++;
			}
		} else if (!quote && *sptr == '/' && *(sptr + 1) == '*') {
			for (;;) {
				if (*sptr == '*' && *(sptr + 1) == '/') {

3013
					sptr += 2;
osku's avatar
osku committed
3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058

					goto scan_more;
				}

				if (*sptr == '\0') {

					goto scan_more;
				}

				sptr++;
			}
		}

		*ptr = *sptr;

		ptr++;
		sptr++;
	}
}

/*************************************************************************
Finds the highest <number> for foreign key constraints of the table. Looks
only at the >= 4.0.18-format id's, which are of the form
databasename/tablename_ibfk_<number>. */
static
ulint
dict_table_get_highest_foreign_id(
/*==============================*/
				/* out: highest number, 0 if table has no new
				format foreign key constraints */
	dict_table_t*	table)	/* in: table in the dictionary memory cache */
{
	dict_foreign_t*	foreign;
	char*		endp;
	ulint		biggest_id	= 0;
	ulint		id;
	ulint		len;

	ut_a(table);

	len = ut_strlen(table->name);
	foreign = UT_LIST_GET_FIRST(table->foreign_list);

	while (foreign) {
		if (ut_strlen(foreign->id) > ((sizeof dict_ibfk) - 1) + len
3059 3060 3061 3062
		    && 0 == ut_memcmp(foreign->id, table->name, len)
		    && 0 == ut_memcmp(foreign->id + len,
				      dict_ibfk, (sizeof dict_ibfk) - 1)
		    && foreign->id[len + ((sizeof dict_ibfk) - 1)] != '0') {
osku's avatar
osku committed
3063 3064
			/* It is of the >= 4.0.18 format */

3065 3066 3067
			id = strtoul(foreign->id + len
				     + ((sizeof dict_ibfk) - 1),
				     &endp, 10);
osku's avatar
osku committed
3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094
			if (*endp == '\0') {
				ut_a(id != biggest_id);

				if (id > biggest_id) {
					biggest_id = id;
				}
			}
		}

		foreign = UT_LIST_GET_NEXT(foreign_list, foreign);
	}

	return(biggest_id);
}

/*************************************************************************
Reports a simple foreign key create clause syntax error. */
static
void
dict_foreign_report_syntax_err(
/*===========================*/
	const char*	name,		/* in: table name */
	const char*	start_of_latest_foreign,
					/* in: start of the foreign key clause
					in the SQL string */
	const char*	ptr)		/* in: place of the syntax error */
{
3095
	FILE*	ef = dict_foreign_err_file;
osku's avatar
osku committed
3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116

	mutex_enter(&dict_foreign_err_mutex);
	dict_foreign_error_report_low(ef, name);
	fprintf(ef, "%s:\nSyntax error close to:\n%s\n",
		start_of_latest_foreign, ptr);
	mutex_exit(&dict_foreign_err_mutex);
}

/*************************************************************************
Scans a table create SQL string and adds to the data dictionary the foreign
key constraints declared in the string. This function should be called after
the indexes for a table have been created. Each foreign key constraint must
be accompanied with indexes in both participating tables. The indexes are
allowed to contain more fields than mentioned in the constraint. */
static
ulint
dict_create_foreign_constraints_low(
/*================================*/
				/* out: error code or DB_SUCCESS */
	trx_t*		trx,	/* in: transaction */
	mem_heap_t*	heap,	/* in: memory heap */
3117
	struct charset_info_st*	cs,/* in: the character set of sql_string */
osku's avatar
osku committed
3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137
	const char*	sql_string,
				/* in: CREATE TABLE or ALTER TABLE statement
				where foreign keys are declared like:
				FOREIGN KEY (a, b) REFERENCES table2(c, d),
				table2 can be written also with the database
				name before it: test.table2; the default
				database is the database of parameter name */
	const char*	name,	/* in: table full name in the normalized form
				database_name/table_name */
	ibool		reject_fks)
				/* in: if TRUE, fail with error code
				DB_CANNOT_ADD_CONSTRAINT if any foreign
				keys are found. */
{
	dict_table_t*	table;
	dict_table_t*	referenced_table;
	dict_table_t*	table_to_alter;
	ulint		highest_id_so_far	= 0;
	dict_index_t*	index;
	dict_foreign_t*	foreign;
3138
	const char*	ptr			= sql_string;
osku's avatar
osku committed
3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150
	const char*	start_of_latest_foreign	= sql_string;
	FILE*		ef			= dict_foreign_err_file;
	const char*	constraint_name;
	ibool		success;
	ulint		error;
	const char*	ptr1;
	const char*	ptr2;
	ulint		i;
	ulint		j;
	ibool		is_on_delete;
	ulint		n_on_deletes;
	ulint		n_on_updates;
3151
	const dict_col_t*columns[500];
osku's avatar
osku committed
3152 3153
	const char*	column_names[500];
	const char*	referenced_table_name;
3154

osku's avatar
osku committed
3155 3156 3157 3158 3159 3160 3161 3162
	ut_ad(mutex_own(&(dict_sys->mutex)));

	table = dict_table_get_low(name);

	if (table == NULL) {
		mutex_enter(&dict_foreign_err_mutex);
		dict_foreign_error_report_low(ef, name);
		fprintf(ef,
3163 3164 3165
			"Cannot find the table in the internal"
			" data dictionary of InnoDB.\n"
			"Create table statement:\n%s\n", sql_string);
osku's avatar
osku committed
3166 3167 3168 3169 3170 3171 3172 3173
		mutex_exit(&dict_foreign_err_mutex);

		return(DB_ERROR);
	}

	/* First check if we are actually doing an ALTER TABLE, and in that
	case look for the table being altered */

3174
	ptr = dict_accept(cs, ptr, "ALTER", &success);
osku's avatar
osku committed
3175 3176 3177 3178 3179 3180

	if (!success) {

		goto loop;
	}

3181
	ptr = dict_accept(cs, ptr, "TABLE", &success);
osku's avatar
osku committed
3182 3183 3184 3185 3186 3187 3188 3189

	if (!success) {

		goto loop;
	}

	/* We are doing an ALTER TABLE: scan the table name we are altering */

3190
	ptr = dict_scan_table_name(cs, ptr, &table_to_alter, name,
3191
				   &success, heap, &referenced_table_name);
osku's avatar
osku committed
3192 3193
	if (!success) {
		fprintf(stderr,
3194 3195 3196
			"InnoDB: Error: could not find"
			" the table being ALTERED in:\n%s\n",
			sql_string);
osku's avatar
osku committed
3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212

		return(DB_ERROR);
	}

	/* Starting from 4.0.18 and 4.1.2, we generate foreign key id's in the
	format databasename/tablename_ibfk_<number>, where <number> is local
	to the table; look for the highest <number> for table_to_alter, so
	that we can assign to new constraints higher numbers. */

	/* If we are altering a temporary table, the table name after ALTER
	TABLE does not correspond to the internal table name, and
	table_to_alter is NULL. TODO: should we fix this somehow? */

	if (table_to_alter == NULL) {
		highest_id_so_far = 0;
	} else {
3213 3214
		highest_id_so_far = dict_table_get_highest_foreign_id(
			table_to_alter);
osku's avatar
osku committed
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231
	}

	/* Scan for foreign key declarations in a loop */
loop:
	/* Scan either to "CONSTRAINT" or "FOREIGN", whichever is closer */

	ptr1 = dict_scan_to(ptr, "CONSTRAINT");
	ptr2 = dict_scan_to(ptr, "FOREIGN");

	constraint_name = NULL;

	if (ptr1 < ptr2) {
		/* The user may have specified a constraint name. Pick it so
		that we can store 'databasename/constraintname' as the id of
		of the constraint to system tables. */
		ptr = ptr1;

3232
		ptr = dict_accept(cs, ptr, "CONSTRAINT", &success);
osku's avatar
osku committed
3233 3234 3235

		ut_a(success);

3236
		if (!my_isspace(cs, *ptr) && *ptr != '"' && *ptr != '`') {
3237
			goto loop;
osku's avatar
osku committed
3238 3239
		}

3240
		while (my_isspace(cs, *ptr)) {
osku's avatar
osku committed
3241 3242 3243 3244 3245
			ptr++;
		}

		/* read constraint name unless got "CONSTRAINT FOREIGN" */
		if (ptr != ptr2) {
3246
			ptr = dict_scan_id(cs, ptr, heap,
3247
					   &constraint_name, FALSE, FALSE);
osku's avatar
osku committed
3248 3249 3250 3251 3252 3253 3254
		}
	} else {
		ptr = ptr2;
	}

	if (*ptr == '\0') {
		/* The proper way to reject foreign keys for temporary
3255 3256 3257 3258 3259 3260
		tables would be to split the lexing and syntactical
		analysis of foreign key clauses from the actual adding
		of them, so that ha_innodb.cc could first parse the SQL
		command, determine if there are any foreign keys, and
		if so, immediately reject the command if the table is a
		temporary one. For now, this kludge will work. */
3261
		if (reject_fks && (UT_LIST_GET_LEN(table->foreign_list) > 0)) {
3262 3263

			return(DB_CANNOT_ADD_CONSTRAINT);
osku's avatar
osku committed
3264
		}
3265

osku's avatar
osku committed
3266 3267 3268
		/**********************************************************/
		/* The following call adds the foreign key constraints
		to the data dictionary system tables on disk */
3269

3270 3271
		error = dict_create_add_foreigns_to_dictionary(
			highest_id_so_far, table, trx);
osku's avatar
osku committed
3272 3273 3274 3275 3276
		return(error);
	}

	start_of_latest_foreign = ptr;

3277
	ptr = dict_accept(cs, ptr, "FOREIGN", &success);
3278

osku's avatar
osku committed
3279 3280 3281 3282
	if (!success) {
		goto loop;
	}

3283
	if (!my_isspace(cs, *ptr)) {
3284
		goto loop;
osku's avatar
osku committed
3285 3286
	}

3287
	ptr = dict_accept(cs, ptr, "KEY", &success);
osku's avatar
osku committed
3288 3289 3290 3291 3292

	if (!success) {
		goto loop;
	}

3293
	ptr = dict_accept(cs, ptr, "(", &success);
osku's avatar
osku committed
3294 3295 3296 3297

	if (!success) {
		/* MySQL allows also an index id before the '('; we
		skip it */
3298
		ptr = dict_skip_word(cs, ptr, &success);
osku's avatar
osku committed
3299 3300

		if (!success) {
3301 3302
			dict_foreign_report_syntax_err(
				name, start_of_latest_foreign, ptr);
osku's avatar
osku committed
3303 3304 3305 3306

			return(DB_CANNOT_ADD_CONSTRAINT);
		}

3307
		ptr = dict_accept(cs, ptr, "(", &success);
osku's avatar
osku committed
3308 3309 3310 3311 3312

		if (!success) {
			/* We do not flag a syntax error here because in an
			ALTER TABLE we may also have DROP FOREIGN KEY abc */

3313
			goto loop;
osku's avatar
osku committed
3314 3315 3316 3317 3318 3319 3320 3321
		}
	}

	i = 0;

	/* Scan the columns in the first list */
col_loop1:
	ut_a(i < (sizeof column_names) / sizeof *column_names);
3322
	ptr = dict_scan_col(cs, ptr, &success, table, columns + i,
3323
			    heap, column_names + i);
osku's avatar
osku committed
3324 3325 3326 3327
	if (!success) {
		mutex_enter(&dict_foreign_err_mutex);
		dict_foreign_error_report_low(ef, name);
		fprintf(ef, "%s:\nCannot resolve column name close to:\n%s\n",
3328
			start_of_latest_foreign, ptr);
osku's avatar
osku committed
3329 3330 3331 3332 3333 3334
		mutex_exit(&dict_foreign_err_mutex);

		return(DB_CANNOT_ADD_CONSTRAINT);
	}

	i++;
3335

3336
	ptr = dict_accept(cs, ptr, ",", &success);
osku's avatar
osku committed
3337 3338 3339 3340

	if (success) {
		goto col_loop1;
	}
3341

3342
	ptr = dict_accept(cs, ptr, ")", &success);
osku's avatar
osku committed
3343 3344

	if (!success) {
3345 3346
		dict_foreign_report_syntax_err(
			name, start_of_latest_foreign, ptr);
osku's avatar
osku committed
3347 3348 3349 3350 3351 3352
		return(DB_CANNOT_ADD_CONSTRAINT);
	}

	/* Try to find an index which contains the columns
	as the first fields and in the right order */

3353 3354
	index = dict_foreign_find_index(table, column_names, i,
					NULL, TRUE, FALSE);
osku's avatar
osku committed
3355 3356 3357 3358 3359

	if (!index) {
		mutex_enter(&dict_foreign_err_mutex);
		dict_foreign_error_report_low(ef, name);
		fputs("There is no index in table ", ef);
3360
		ut_print_name(ef, NULL, TRUE, name);
osku's avatar
osku committed
3361
		fprintf(ef, " where the columns appear\n"
3362 3363 3364 3365
			"as the first columns. Constraint:\n%s\n"
			"See http://dev.mysql.com/doc/refman/5.1/en/"
			"innodb-foreign-key-constraints.html\n"
			"for correct foreign key definition.\n",
osku's avatar
osku committed
3366 3367 3368 3369 3370
			start_of_latest_foreign);
		mutex_exit(&dict_foreign_err_mutex);

		return(DB_CANNOT_ADD_CONSTRAINT);
	}
3371
	ptr = dict_accept(cs, ptr, "REFERENCES", &success);
osku's avatar
osku committed
3372

3373
	if (!success || !my_isspace(cs, *ptr)) {
3374 3375
		dict_foreign_report_syntax_err(
			name, start_of_latest_foreign, ptr);
osku's avatar
osku committed
3376 3377 3378 3379 3380 3381 3382 3383
		return(DB_CANNOT_ADD_CONSTRAINT);
	}

	/* Let us create a constraint struct */

	foreign = dict_mem_foreign_create();

	if (constraint_name) {
3384
		ulint	db_len;
osku's avatar
osku committed
3385 3386 3387 3388 3389 3390 3391 3392

		/* Catenate 'databasename/' to the constraint name specified
		by the user: we conceive the constraint as belonging to the
		same MySQL 'database' as the table itself. We store the name
		to foreign->id. */

		db_len = dict_get_db_name_len(table->name);

3393 3394
		foreign->id = mem_heap_alloc(
			foreign->heap, db_len + strlen(constraint_name) + 2);
osku's avatar
osku committed
3395 3396 3397 3398 3399 3400 3401 3402

		ut_memcpy(foreign->id, table->name, db_len);
		foreign->id[db_len] = '/';
		strcpy(foreign->id + db_len + 1, constraint_name);
	}

	foreign->foreign_table = table;
	foreign->foreign_table_name = mem_heap_strdup(foreign->heap,
3403
						      table->name);
osku's avatar
osku committed
3404
	foreign->foreign_index = index;
3405
	foreign->n_fields = (unsigned int) i;
osku's avatar
osku committed
3406
	foreign->foreign_col_names = mem_heap_alloc(foreign->heap,
3407
						    i * sizeof(void*));
osku's avatar
osku committed
3408
	for (i = 0; i < foreign->n_fields; i++) {
3409 3410 3411 3412
		foreign->foreign_col_names[i] = mem_heap_strdup(
			foreign->heap,
			dict_table_get_col_name(table,
						dict_col_get_no(columns[i])));
osku's avatar
osku committed
3413
	}
3414

3415
	ptr = dict_scan_table_name(cs, ptr, &referenced_table, name,
3416
				   &success, heap, &referenced_table_name);
osku's avatar
osku committed
3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432

	/* Note that referenced_table can be NULL if the user has suppressed
	checking of foreign key constraints! */

	if (!success || (!referenced_table && trx->check_foreigns)) {
		dict_foreign_free(foreign);

		mutex_enter(&dict_foreign_err_mutex);
		dict_foreign_error_report_low(ef, name);
		fprintf(ef, "%s:\nCannot resolve table name close to:\n"
			"%s\n",
			start_of_latest_foreign, ptr);
		mutex_exit(&dict_foreign_err_mutex);

		return(DB_CANNOT_ADD_CONSTRAINT);
	}
3433

3434
	ptr = dict_accept(cs, ptr, "(", &success);
osku's avatar
osku committed
3435 3436 3437 3438

	if (!success) {
		dict_foreign_free(foreign);
		dict_foreign_report_syntax_err(name, start_of_latest_foreign,
3439
					       ptr);
osku's avatar
osku committed
3440 3441 3442 3443 3444 3445 3446
		return(DB_CANNOT_ADD_CONSTRAINT);
	}

	/* Scan the columns in the second list */
	i = 0;

col_loop2:
3447
	ptr = dict_scan_col(cs, ptr, &success, referenced_table, columns + i,
3448
			    heap, column_names + i);
osku's avatar
osku committed
3449
	i++;
3450

osku's avatar
osku committed
3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463
	if (!success) {
		dict_foreign_free(foreign);

		mutex_enter(&dict_foreign_err_mutex);
		dict_foreign_error_report_low(ef, name);
		fprintf(ef, "%s:\nCannot resolve column name close to:\n"
			"%s\n",
			start_of_latest_foreign, ptr);
		mutex_exit(&dict_foreign_err_mutex);

		return(DB_CANNOT_ADD_CONSTRAINT);
	}

3464
	ptr = dict_accept(cs, ptr, ",", &success);
osku's avatar
osku committed
3465 3466 3467 3468

	if (success) {
		goto col_loop2;
	}
3469

3470
	ptr = dict_accept(cs, ptr, ")", &success);
osku's avatar
osku committed
3471 3472 3473

	if (!success || foreign->n_fields != i) {
		dict_foreign_free(foreign);
3474

osku's avatar
osku committed
3475
		dict_foreign_report_syntax_err(name, start_of_latest_foreign,
3476
					       ptr);
osku's avatar
osku committed
3477 3478 3479 3480 3481
		return(DB_CANNOT_ADD_CONSTRAINT);
	}

	n_on_deletes = 0;
	n_on_updates = 0;
3482

osku's avatar
osku committed
3483 3484 3485
scan_on_conditions:
	/* Loop here as long as we can find ON ... conditions */

3486
	ptr = dict_accept(cs, ptr, "ON", &success);
osku's avatar
osku committed
3487 3488 3489 3490 3491 3492

	if (!success) {

		goto try_find_index;
	}

3493
	ptr = dict_accept(cs, ptr, "DELETE", &success);
osku's avatar
osku committed
3494 3495

	if (!success) {
3496
		ptr = dict_accept(cs, ptr, "UPDATE", &success);
osku's avatar
osku committed
3497 3498 3499

		if (!success) {
			dict_foreign_free(foreign);
3500

3501 3502
			dict_foreign_report_syntax_err(
				name, start_of_latest_foreign, ptr);
osku's avatar
osku committed
3503 3504 3505 3506 3507 3508 3509 3510 3511 3512
			return(DB_CANNOT_ADD_CONSTRAINT);
		}

		is_on_delete = FALSE;
		n_on_updates++;
	} else {
		is_on_delete = TRUE;
		n_on_deletes++;
	}

3513
	ptr = dict_accept(cs, ptr, "RESTRICT", &success);
osku's avatar
osku committed
3514 3515 3516 3517 3518

	if (success) {
		goto scan_on_conditions;
	}

3519
	ptr = dict_accept(cs, ptr, "CASCADE", &success);
osku's avatar
osku committed
3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530

	if (success) {
		if (is_on_delete) {
			foreign->type |= DICT_FOREIGN_ON_DELETE_CASCADE;
		} else {
			foreign->type |= DICT_FOREIGN_ON_UPDATE_CASCADE;
		}

		goto scan_on_conditions;
	}

3531
	ptr = dict_accept(cs, ptr, "NO", &success);
osku's avatar
osku committed
3532 3533

	if (success) {
3534
		ptr = dict_accept(cs, ptr, "ACTION", &success);
osku's avatar
osku committed
3535 3536 3537

		if (!success) {
			dict_foreign_free(foreign);
3538 3539
			dict_foreign_report_syntax_err(
				name, start_of_latest_foreign, ptr);
3540

osku's avatar
osku committed
3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552
			return(DB_CANNOT_ADD_CONSTRAINT);
		}

		if (is_on_delete) {
			foreign->type |= DICT_FOREIGN_ON_DELETE_NO_ACTION;
		} else {
			foreign->type |= DICT_FOREIGN_ON_UPDATE_NO_ACTION;
		}

		goto scan_on_conditions;
	}

3553
	ptr = dict_accept(cs, ptr, "SET", &success);
osku's avatar
osku committed
3554 3555 3556 3557

	if (!success) {
		dict_foreign_free(foreign);
		dict_foreign_report_syntax_err(name, start_of_latest_foreign,
3558
					       ptr);
osku's avatar
osku committed
3559 3560 3561
		return(DB_CANNOT_ADD_CONSTRAINT);
	}

3562
	ptr = dict_accept(cs, ptr, "NULL", &success);
osku's avatar
osku committed
3563 3564 3565 3566

	if (!success) {
		dict_foreign_free(foreign);
		dict_foreign_report_syntax_err(name, start_of_latest_foreign,
3567
					       ptr);
osku's avatar
osku committed
3568 3569 3570 3571
		return(DB_CANNOT_ADD_CONSTRAINT);
	}

	for (j = 0; j < foreign->n_fields; j++) {
3572
		if ((dict_index_get_nth_col(foreign->foreign_index, j)->prtype)
3573
		    & DATA_NOT_NULL) {
osku's avatar
osku committed
3574 3575 3576 3577 3578 3579 3580 3581 3582

			/* It is not sensible to define SET NULL
			if the column is not allowed to be NULL! */

			dict_foreign_free(foreign);

			mutex_enter(&dict_foreign_err_mutex);
			dict_foreign_error_report_low(ef, name);
			fprintf(ef, "%s:\n"
3583 3584 3585 3586
				"You have defined a SET NULL condition"
				" though some of the\n"
				"columns are defined as NOT NULL.\n",
				start_of_latest_foreign);
osku's avatar
osku committed
3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597
			mutex_exit(&dict_foreign_err_mutex);

			return(DB_CANNOT_ADD_CONSTRAINT);
		}
	}

	if (is_on_delete) {
		foreign->type |= DICT_FOREIGN_ON_DELETE_SET_NULL;
	} else {
		foreign->type |= DICT_FOREIGN_ON_UPDATE_SET_NULL;
	}
3598

osku's avatar
osku committed
3599 3600 3601 3602 3603
	goto scan_on_conditions;

try_find_index:
	if (n_on_deletes > 1 || n_on_updates > 1) {
		/* It is an error to define more than 1 action */
3604

osku's avatar
osku committed
3605 3606 3607 3608 3609
		dict_foreign_free(foreign);

		mutex_enter(&dict_foreign_err_mutex);
		dict_foreign_error_report_low(ef, name);
		fprintf(ef, "%s:\n"
3610 3611
			"You have twice an ON DELETE clause"
			" or twice an ON UPDATE clause.\n",
osku's avatar
osku committed
3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623
			start_of_latest_foreign);
		mutex_exit(&dict_foreign_err_mutex);

		return(DB_CANNOT_ADD_CONSTRAINT);
	}

	/* Try to find an index which contains the columns as the first fields
	and in the right order, and the types are the same as in
	foreign->foreign_index */

	if (referenced_table) {
		index = dict_foreign_find_index(referenced_table,
3624
						column_names, i,
3625 3626
						foreign->foreign_index,
						TRUE, FALSE);
osku's avatar
osku committed
3627 3628 3629 3630 3631
		if (!index) {
			dict_foreign_free(foreign);
			mutex_enter(&dict_foreign_err_mutex);
			dict_foreign_error_report_low(ef, name);
			fprintf(ef, "%s:\n"
3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646
				"Cannot find an index in the"
				" referenced table where the\n"
				"referenced columns appear as the"
				" first columns, or column types\n"
				"in the table and the referenced table"
				" do not match for constraint.\n"
				"Note that the internal storage type of"
				" ENUM and SET changed in\n"
				"tables created with >= InnoDB-4.1.12,"
				" and such columns in old tables\n"
				"cannot be referenced by such columns"
				" in new tables.\n"
				"See http://dev.mysql.com/doc/refman/5.1/en/"
				"innodb-foreign-key-constraints.html\n"
				"for correct foreign key definition.\n",
osku's avatar
osku committed
3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659
				start_of_latest_foreign);
			mutex_exit(&dict_foreign_err_mutex);

			return(DB_CANNOT_ADD_CONSTRAINT);
		}
	} else {
		ut_a(trx->check_foreigns == FALSE);
		index = NULL;
	}

	foreign->referenced_index = index;
	foreign->referenced_table = referenced_table;

3660 3661
	foreign->referenced_table_name
		= mem_heap_strdup(foreign->heap, referenced_table_name);
3662

osku's avatar
osku committed
3663
	foreign->referenced_col_names = mem_heap_alloc(foreign->heap,
3664
						       i * sizeof(void*));
osku's avatar
osku committed
3665 3666 3667 3668 3669 3670
	for (i = 0; i < foreign->n_fields; i++) {
		foreign->referenced_col_names[i]
			= mem_heap_strdup(foreign->heap, column_names[i]);
	}

	/* We found an ok constraint definition: add to the lists */
3671

osku's avatar
osku committed
3672 3673 3674 3675
	UT_LIST_ADD_LAST(foreign_list, table->foreign_list, foreign);

	if (referenced_table) {
		UT_LIST_ADD_LAST(referenced_list,
3676 3677
				 referenced_table->referenced_list,
				 foreign);
osku's avatar
osku committed
3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688
	}

	goto loop;
}

/*************************************************************************
Scans a table create SQL string and adds to the data dictionary the foreign
key constraints declared in the string. This function should be called after
the indexes for a table have been created. Each foreign key constraint must
be accompanied with indexes in both participating tables. The indexes are
allowed to contain more fields than mentioned in the constraint. */
3689
UNIV_INTERN
osku's avatar
osku committed
3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709
ulint
dict_create_foreign_constraints(
/*============================*/
					/* out: error code or DB_SUCCESS */
	trx_t*		trx,		/* in: transaction */
	const char*	sql_string,	/* in: table create statement where
					foreign keys are declared like:
					FOREIGN KEY (a, b) REFERENCES
					table2(c, d), table2 can be written
					also with the database
					name before it: test.table2; the
					default database id the database of
					parameter name */
	const char*	name,		/* in: table full name in the
					normalized form
					database_name/table_name */
	ibool		reject_fks)	/* in: if TRUE, fail with error
					code DB_CANNOT_ADD_CONSTRAINT if
					any foreign keys are found. */
{
3710 3711 3712 3713
	char*			str;
	ulint			err;
	mem_heap_t*		heap;

3714 3715
	ut_a(trx);
	ut_a(trx->mysql_thd);
osku's avatar
osku committed
3716 3717 3718 3719

	str = dict_strip_comments(sql_string);
	heap = mem_heap_create(10000);

3720 3721 3722
	err = dict_create_foreign_constraints_low(
		trx, heap, innobase_get_charset(trx->mysql_thd), str, name,
		reject_fks);
osku's avatar
osku committed
3723 3724 3725 3726

	mem_heap_free(heap);
	mem_free(str);

3727
	return(err);
osku's avatar
osku committed
3728 3729 3730 3731
}

/**************************************************************************
Parses the CONSTRAINT id's to be dropped in an ALTER TABLE statement. */
3732
UNIV_INTERN
osku's avatar
osku committed
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748
ulint
dict_foreign_parse_drop_constraints(
/*================================*/
						/* out: DB_SUCCESS or
						DB_CANNOT_DROP_CONSTRAINT if
						syntax error or the constraint
						id does not match */
	mem_heap_t*	heap,			/* in: heap from which we can
						allocate memory */
	trx_t*		trx,			/* in: transaction */
	dict_table_t*	table,			/* in: table */
	ulint*		n,			/* out: number of constraints
						to drop */
	const char***	constraints_to_drop)	/* out: id's of the
						constraints to drop */
{
3749 3750 3751 3752 3753 3754 3755 3756
	dict_foreign_t*		foreign;
	ibool			success;
	char*			str;
	const char*		ptr;
	const char*		id;
	FILE*			ef	= dict_foreign_err_file;
	struct charset_info_st*	cs;

3757 3758
	ut_a(trx);
	ut_a(trx->mysql_thd);
3759 3760

	cs = innobase_get_charset(trx->mysql_thd);
3761

osku's avatar
osku committed
3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774
	*n = 0;

	*constraints_to_drop = mem_heap_alloc(heap, 1000 * sizeof(char*));

	str = dict_strip_comments(*(trx->mysql_query_str));
	ptr = str;

	ut_ad(mutex_own(&(dict_sys->mutex)));
loop:
	ptr = dict_scan_to(ptr, "DROP");

	if (*ptr == '\0') {
		mem_free(str);
3775

osku's avatar
osku committed
3776 3777 3778
		return(DB_SUCCESS);
	}

3779
	ptr = dict_accept(cs, ptr, "DROP", &success);
osku's avatar
osku committed
3780

3781
	if (!my_isspace(cs, *ptr)) {
osku's avatar
osku committed
3782

3783
		goto loop;
osku's avatar
osku committed
3784 3785
	}

3786
	ptr = dict_accept(cs, ptr, "FOREIGN", &success);
3787

3788
	if (!success || !my_isspace(cs, *ptr)) {
osku's avatar
osku committed
3789

3790
		goto loop;
osku's avatar
osku committed
3791 3792
	}

3793
	ptr = dict_accept(cs, ptr, "KEY", &success);
osku's avatar
osku committed
3794 3795 3796 3797 3798 3799

	if (!success) {

		goto syntax_error;
	}

3800
	ptr = dict_scan_id(cs, ptr, heap, &id, FALSE, TRUE);
osku's avatar
osku committed
3801 3802 3803 3804 3805 3806 3807 3808 3809

	if (id == NULL) {

		goto syntax_error;
	}

	ut_a(*n < 1000);
	(*constraints_to_drop)[*n] = id;
	(*n)++;
3810

osku's avatar
osku committed
3811 3812 3813 3814 3815 3816
	/* Look for the given constraint id */

	foreign = UT_LIST_GET_FIRST(table->foreign_list);

	while (foreign != NULL) {
		if (0 == strcmp(foreign->id, id)
3817 3818 3819
		    || (strchr(foreign->id, '/')
			&& 0 == strcmp(id,
				       dict_remove_db_name(foreign->id)))) {
osku's avatar
osku committed
3820 3821 3822
			/* Found */
			break;
		}
3823

osku's avatar
osku committed
3824 3825 3826 3827 3828 3829 3830
		foreign = UT_LIST_GET_NEXT(foreign_list, foreign);
	}

	if (foreign == NULL) {
		mutex_enter(&dict_foreign_err_mutex);
		rewind(ef);
		ut_print_timestamp(ef);
3831 3832
		fputs(" Error in dropping of a foreign key constraint"
		      " of table ", ef);
3833
		ut_print_name(ef, NULL, TRUE, table->name);
osku's avatar
osku committed
3834
		fputs(",\n"
3835
		      "in SQL command\n", ef);
osku's avatar
osku committed
3836 3837
		fputs(str, ef);
		fputs("\nCannot find a constraint with the given id ", ef);
3838
		ut_print_name(ef, NULL, FALSE, id);
osku's avatar
osku committed
3839 3840 3841 3842 3843 3844 3845 3846
		fputs(".\n", ef);
		mutex_exit(&dict_foreign_err_mutex);

		mem_free(str);

		return(DB_CANNOT_DROP_CONSTRAINT);
	}

3847
	goto loop;
osku's avatar
osku committed
3848 3849 3850 3851 3852

syntax_error:
	mutex_enter(&dict_foreign_err_mutex);
	rewind(ef);
	ut_print_timestamp(ef);
3853 3854
	fputs(" Syntax error in dropping of a"
	      " foreign key constraint of table ", ef);
3855
	ut_print_name(ef, NULL, TRUE, table->name);
osku's avatar
osku committed
3856 3857 3858 3859 3860 3861 3862 3863
	fprintf(ef, ",\n"
		"close to:\n%s\n in SQL command\n%s\n", ptr, str);
	mutex_exit(&dict_foreign_err_mutex);

	mem_free(str);

	return(DB_CANNOT_DROP_CONSTRAINT);
}
3864
#endif /* UNIV_HOTBACKUP */
osku's avatar
osku committed
3865 3866 3867 3868

/*==================== END OF FOREIGN KEY PROCESSING ====================*/

/**************************************************************************
3869 3870
Returns an index object if it is found in the dictionary cache.
Assumes that dict_sys->mutex is already being held. */
3871
UNIV_INTERN
osku's avatar
osku committed
3872
dict_index_t*
3873 3874
dict_index_get_if_in_cache_low(
/*===========================*/
osku's avatar
osku committed
3875 3876 3877
				/* out: index, NULL if not found */
	dulint	index_id)	/* in: index id */
{
3878
	ut_ad(mutex_own(&(dict_sys->mutex)));
osku's avatar
osku committed
3879

3880 3881 3882
	return(dict_index_find_on_id_low(index_id));
}

3883
#if defined UNIV_DEBUG || defined UNIV_BUF_DEBUG
3884 3885
/**************************************************************************
Returns an index object if it is found in the dictionary cache. */
3886
UNIV_INTERN
3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901
dict_index_t*
dict_index_get_if_in_cache(
/*=======================*/
				/* out: index, NULL if not found */
	dulint	index_id)	/* in: index id */
{
	dict_index_t*	index;

	if (dict_sys == NULL) {
		return(NULL);
	}

	mutex_enter(&(dict_sys->mutex));

	index = dict_index_get_if_in_cache_low(index_id);
3902

osku's avatar
osku committed
3903 3904 3905 3906
	mutex_exit(&(dict_sys->mutex));

	return(index);
}
3907
#endif /* UNIV_DEBUG || UNIV_BUF_DEBUG */
osku's avatar
osku committed
3908

3909
#ifdef UNIV_DEBUG
osku's avatar
osku committed
3910 3911 3912
/**************************************************************************
Checks that a tuple has n_fields_cmp value in a sensible range, so that
no comparison can occur with the page number field in a node pointer. */
3913
UNIV_INTERN
osku's avatar
osku committed
3914
ibool
3915 3916
dict_index_check_search_tuple(
/*==========================*/
3917 3918 3919
					/* out: TRUE if ok */
	const dict_index_t*	index,	/* in: index tree */
	const dtuple_t*		tuple)	/* in: tuple used in a search */
osku's avatar
osku committed
3920
{
3921
	ut_a(index);
osku's avatar
osku committed
3922
	ut_a(dtuple_get_n_fields_cmp(tuple)
3923
	     <= dict_index_get_n_unique_in_tree(index));
osku's avatar
osku committed
3924 3925
	return(TRUE);
}
3926
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
3927 3928 3929

/**************************************************************************
Builds a node pointer out of a physical record and a page number. */
3930
UNIV_INTERN
osku's avatar
osku committed
3931
dtuple_t*
3932 3933
dict_index_build_node_ptr(
/*======================*/
3934 3935 3936 3937 3938 3939 3940 3941 3942 3943
					/* out, own: node pointer */
	const dict_index_t*	index,	/* in: index */
	const rec_t*		rec,	/* in: record for which to build node
					pointer */
	ulint			page_no,/* in: page number to put in node
					pointer */
	mem_heap_t*		heap,	/* in: memory heap where pointer
					created */
	ulint			level)	/* in: level of rec in tree:
					0 means leaf level */
osku's avatar
osku committed
3944 3945 3946 3947 3948 3949
{
	dtuple_t*	tuple;
	dfield_t*	field;
	byte*		buf;
	ulint		n_unique;

3950
	if (UNIV_UNLIKELY(index->type & DICT_UNIVERSAL)) {
osku's avatar
osku committed
3951
		/* In a universal index tree, we take the whole record as
3952
		the node pointer if the record is on the leaf level,
osku's avatar
osku committed
3953 3954 3955
		on non-leaf levels we remove the last field, which
		contains the page number of the child page */

3956
		ut_a(!dict_table_is_comp(index->table));
osku's avatar
osku committed
3957 3958 3959
		n_unique = rec_get_n_fields_old(rec);

		if (level > 0) {
3960 3961
			ut_a(n_unique > 1);
			n_unique--;
osku's avatar
osku committed
3962
		}
3963
	} else {
3964
		n_unique = dict_index_get_n_unique_in_tree(index);
osku's avatar
osku committed
3965 3966 3967 3968 3969 3970 3971 3972 3973
	}

	tuple = dtuple_create(heap, n_unique + 1);

	/* When searching in the tree for the node pointer, we must not do
	comparison on the last field, the page number field, as on upper
	levels in the tree there may be identical node pointers with a
	different page number; therefore, we set the n_fields_cmp to one
	less: */
3974

osku's avatar
osku committed
3975 3976
	dtuple_set_n_fields_cmp(tuple, n_unique);

3977
	dict_index_copy_types(tuple, index, n_unique);
3978

osku's avatar
osku committed
3979 3980 3981
	buf = mem_heap_alloc(heap, 4);

	mach_write_to_4(buf, page_no);
3982

3983
	field = dtuple_get_nth_field(tuple, n_unique);
osku's avatar
osku committed
3984 3985
	dfield_set_data(field, buf, 4);

3986
	dtype_set(dfield_get_type(field), DATA_SYS_CHILD, DATA_NOT_NULL, 4);
osku's avatar
osku committed
3987

3988
	rec_copy_prefix_to_dtuple(tuple, rec, index, n_unique, heap);
3989 3990
	dtuple_set_info_bits(tuple, dtuple_get_info_bits(tuple)
			     | REC_STATUS_NODE_PTR);
osku's avatar
osku committed
3991 3992 3993 3994

	ut_ad(dtuple_check_typed(tuple));

	return(tuple);
3995 3996
}

osku's avatar
osku committed
3997 3998 3999
/**************************************************************************
Copies an initial segment of a physical record, long enough to specify an
index entry uniquely. */
4000
UNIV_INTERN
osku's avatar
osku committed
4001
rec_t*
4002 4003
dict_index_copy_rec_order_prefix(
/*=============================*/
4004 4005 4006 4007 4008 4009 4010 4011
					/* out: pointer to the prefix record */
	const dict_index_t*	index,	/* in: index */
	const rec_t*		rec,	/* in: record for which to
					copy prefix */
	ulint*			n_fields,/* out: number of fields copied */
	byte**			buf,	/* in/out: memory buffer for the
					copied prefix, or NULL */
	ulint*			buf_size)/* in/out: buffer size */
osku's avatar
osku committed
4012 4013 4014 4015 4016
{
	ulint		n;

	UNIV_PREFETCH_R(rec);

4017
	if (UNIV_UNLIKELY(index->type & DICT_UNIVERSAL)) {
4018
		ut_a(!dict_table_is_comp(index->table));
osku's avatar
osku committed
4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029
		n = rec_get_n_fields_old(rec);
	} else {
		n = dict_index_get_n_unique_in_tree(index);
	}

	*n_fields = n;
	return(rec_copy_prefix_to_buf(rec, index, n, buf, buf_size));
}

/**************************************************************************
Builds a typed data tuple out of a physical record. */
4030
UNIV_INTERN
osku's avatar
osku committed
4031
dtuple_t*
4032 4033
dict_index_build_data_tuple(
/*========================*/
osku's avatar
osku committed
4034
				/* out, own: data tuple */
4035
	dict_index_t*	index,	/* in: index tree */
osku's avatar
osku committed
4036 4037 4038 4039 4040 4041
	rec_t*		rec,	/* in: record for which to build data tuple */
	ulint		n_fields,/* in: number of data fields */
	mem_heap_t*	heap)	/* in: memory heap where tuple created */
{
	dtuple_t*	tuple;

4042
	ut_ad(dict_table_is_comp(index->table)
4043
	      || n_fields <= rec_get_n_fields_old(rec));
4044 4045

	tuple = dtuple_create(heap, n_fields);
osku's avatar
osku committed
4046

4047
	dict_index_copy_types(tuple, index, n_fields);
osku's avatar
osku committed
4048

4049
	rec_copy_prefix_to_dtuple(tuple, rec, index, n_fields, heap);
osku's avatar
osku committed
4050 4051 4052 4053

	ut_ad(dtuple_check_typed(tuple));

	return(tuple);
4054 4055
}

osku's avatar
osku committed
4056 4057
/*************************************************************************
Calculates the minimum record length in an index. */
4058
UNIV_INTERN
osku's avatar
osku committed
4059 4060 4061
ulint
dict_index_calc_min_rec_len(
/*========================*/
4062
	const dict_index_t*	index)	/* in: index */
osku's avatar
osku committed
4063 4064 4065 4066
{
	ulint	sum	= 0;
	ulint	i;

4067
	if (dict_table_is_comp(index->table)) {
osku's avatar
osku committed
4068 4069 4070
		ulint nullable = 0;
		sum = REC_N_NEW_EXTRA_BYTES;
		for (i = 0; i < dict_index_get_n_fields(index); i++) {
4071 4072 4073
			const dict_col_t*	col
				= dict_index_get_nth_col(index, i);
			ulint	size = dict_col_get_fixed_size(col);
osku's avatar
osku committed
4074 4075
			sum += size;
			if (!size) {
4076
				size = col->len;
osku's avatar
osku committed
4077 4078
				sum += size < 128 ? 1 : 2;
			}
4079
			if (!(col->prtype & DATA_NOT_NULL)) {
osku's avatar
osku committed
4080
				nullable++;
4081
			}
osku's avatar
osku committed
4082 4083 4084
		}

		/* round the NULL flags up to full bytes */
4085
		sum += UT_BITS_IN_BYTES(nullable);
osku's avatar
osku committed
4086 4087 4088 4089 4090

		return(sum);
	}

	for (i = 0; i < dict_index_get_n_fields(index); i++) {
4091 4092
		sum += dict_col_get_fixed_size(
			dict_index_get_nth_col(index, i));
osku's avatar
osku committed
4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108
	}

	if (sum > 127) {
		sum += 2 * dict_index_get_n_fields(index);
	} else {
		sum += dict_index_get_n_fields(index);
	}

	sum += REC_N_OLD_EXTRA_BYTES;

	return(sum);
}

/*************************************************************************
Calculates new estimates for table and index statistics. The statistics
are used in query optimization. */
4109
UNIV_INTERN
osku's avatar
osku committed
4110 4111 4112
void
dict_update_statistics_low(
/*=======================*/
4113
	dict_table_t*	table,		/* in/out: table */
osku's avatar
osku committed
4114
	ibool		has_dict_mutex __attribute__((unused)))
4115 4116
					/* in: TRUE if the caller has the
					dictionary mutex */
osku's avatar
osku committed
4117 4118 4119 4120 4121 4122 4123 4124 4125
{
	dict_index_t*	index;
	ulint		size;
	ulint		sum_of_index_sizes	= 0;

	if (table->ibd_file_missing) {
		ut_print_timestamp(stderr);
		fprintf(stderr,
			"  InnoDB: cannot calculate statistics for table %s\n"
4126 4127 4128 4129
			"InnoDB: because the .ibd file is missing.  For help,"
			" please refer to\n"
			"InnoDB: http://dev.mysql.com/doc/refman/5.1/en/"
			"innodb-troubleshooting.html\n",
osku's avatar
osku committed
4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145
			table->name);

		return;
	}

	/* If we have set a high innodb_force_recovery level, do not calculate
	statistics, as a badly corrupted index can cause a crash in it. */

	if (srv_force_recovery >= SRV_FORCE_NO_IBUF_MERGE) {

		return;
	}

	/* Find out the sizes of the indexes and how many different values
	for the key they approximately have */

4146
	index = dict_table_get_first_index(table);
osku's avatar
osku committed
4147 4148 4149

	if (index == NULL) {
		/* Table definition is corrupt */
4150

osku's avatar
osku committed
4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168
		return;
	}

	while (index) {
		size = btr_get_size(index, BTR_TOTAL_SIZE);

		index->stat_index_size = size;

		sum_of_index_sizes += size;

		size = btr_get_size(index, BTR_N_LEAF_PAGES);

		if (size == 0) {
			/* The root node of the tree is a leaf */
			size = 1;
		}

		index->stat_n_leaf_pages = size;
4169

osku's avatar
osku committed
4170 4171 4172 4173 4174 4175 4176
		btr_estimate_number_of_different_key_vals(index);

		index = dict_table_get_next_index(index);
	}

	index = dict_table_get_first_index(table);

4177 4178
	table->stat_n_rows = index->stat_n_diff_key_vals[
		dict_index_get_n_unique(index)];
osku's avatar
osku committed
4179 4180 4181 4182

	table->stat_clustered_index_size = index->stat_index_size;

	table->stat_sum_of_other_index_sizes = sum_of_index_sizes
4183
		- index->stat_index_size;
osku's avatar
osku committed
4184 4185 4186

	table->stat_initialized = TRUE;

4187
	table->stat_modified_counter = 0;
osku's avatar
osku committed
4188 4189 4190 4191 4192
}

/*************************************************************************
Calculates new estimates for table and index statistics. The statistics
are used in query optimization. */
4193
UNIV_INTERN
osku's avatar
osku committed
4194 4195 4196
void
dict_update_statistics(
/*===================*/
4197
	dict_table_t*	table)	/* in/out: table */
osku's avatar
osku committed
4198 4199 4200 4201
{
	dict_update_statistics_low(table, FALSE);
}

4202
/**************************************************************************
osku's avatar
osku committed
4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221
Prints info of a foreign key constraint. */
static
void
dict_foreign_print_low(
/*===================*/
	dict_foreign_t*	foreign)	/* in: foreign key constraint */
{
	ulint	i;

	ut_ad(mutex_own(&(dict_sys->mutex)));

	fprintf(stderr, "  FOREIGN KEY CONSTRAINT %s: %s (",
		foreign->id, foreign->foreign_table_name);

	for (i = 0; i < foreign->n_fields; i++) {
		fprintf(stderr, " %s", foreign->foreign_col_names[i]);
	}

	fprintf(stderr, " )\n"
4222
		"             REFERENCES %s (",
osku's avatar
osku committed
4223
		foreign->referenced_table_name);
4224

osku's avatar
osku committed
4225 4226 4227 4228 4229 4230 4231 4232 4233
	for (i = 0; i < foreign->n_fields; i++) {
		fprintf(stderr, " %s", foreign->referenced_col_names[i]);
	}

	fputs(" )\n", stderr);
}

/**************************************************************************
Prints a table data. */
4234
UNIV_INTERN
osku's avatar
osku committed
4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246
void
dict_table_print(
/*=============*/
	dict_table_t*	table)	/* in: table */
{
	mutex_enter(&(dict_sys->mutex));
	dict_table_print_low(table);
	mutex_exit(&(dict_sys->mutex));
}

/**************************************************************************
Prints a table data when we know the table name. */
4247
UNIV_INTERN
osku's avatar
osku committed
4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259
void
dict_table_print_by_name(
/*=====================*/
	const char*	name)
{
	dict_table_t*	table;

	mutex_enter(&(dict_sys->mutex));

	table = dict_table_get_low(name);

	ut_a(table);
4260

osku's avatar
osku committed
4261 4262 4263 4264 4265 4266
	dict_table_print_low(table);
	mutex_exit(&(dict_sys->mutex));
}

/**************************************************************************
Prints a table data. */
4267
UNIV_INTERN
osku's avatar
osku committed
4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279
void
dict_table_print_low(
/*=================*/
	dict_table_t*	table)	/* in: table */
{
	dict_index_t*	index;
	dict_foreign_t*	foreign;
	ulint		i;

	ut_ad(mutex_own(&(dict_sys->mutex)));

	dict_update_statistics_low(table, TRUE);
4280

osku's avatar
osku committed
4281
	fprintf(stderr,
4282
		"--------------------------------------\n"
4283 4284
		"TABLE: name %s, id %lu %lu, flags %lx, columns %lu,"
		" indexes %lu, appr.rows %lu\n"
4285 4286 4287 4288
		"  COLUMNS: ",
		table->name,
		(ulong) ut_dulint_get_high(table->id),
		(ulong) ut_dulint_get_low(table->id),
4289
		(ulong) table->flags,
4290 4291 4292
		(ulong) table->n_cols,
		(ulong) UT_LIST_GET_LEN(table->indexes),
		(ulong) table->stat_n_rows);
osku's avatar
osku committed
4293

4294 4295
	for (i = 0; i + 1 < (ulint) table->n_cols; i++) {
		dict_col_print_low(table, dict_table_get_nth_col(table, i));
osku's avatar
osku committed
4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328
		fputs("; ", stderr);
	}

	putc('\n', stderr);

	index = UT_LIST_GET_FIRST(table->indexes);

	while (index != NULL) {
		dict_index_print_low(index);
		index = UT_LIST_GET_NEXT(indexes, index);
	}

	foreign = UT_LIST_GET_FIRST(table->foreign_list);

	while (foreign != NULL) {
		dict_foreign_print_low(foreign);
		foreign = UT_LIST_GET_NEXT(foreign_list, foreign);
	}

	foreign = UT_LIST_GET_FIRST(table->referenced_list);

	while (foreign != NULL) {
		dict_foreign_print_low(foreign);
		foreign = UT_LIST_GET_NEXT(referenced_list, foreign);
	}
}

/**************************************************************************
Prints a column data. */
static
void
dict_col_print_low(
/*===============*/
4329 4330
	const dict_table_t*	table,	/* in: table */
	const dict_col_t*	col)	/* in: column */
osku's avatar
osku committed
4331
{
4332
	dtype_t	type;
osku's avatar
osku committed
4333 4334 4335

	ut_ad(mutex_own(&(dict_sys->mutex)));

4336 4337 4338
	dict_col_copy_type(col, &type);
	fprintf(stderr, "%s: ", dict_table_get_col_name(table,
							dict_col_get_no(col)));
osku's avatar
osku committed
4339

4340
	dtype_print(&type);
osku's avatar
osku committed
4341 4342 4343 4344 4345 4346 4347 4348 4349 4350
}

/**************************************************************************
Prints an index data. */
static
void
dict_index_print_low(
/*=================*/
	dict_index_t*	index)	/* in: index */
{
4351
	ib_int64_t	n_vals;
osku's avatar
osku committed
4352
	ulint		i;
4353
	const char*	type_string;
osku's avatar
osku committed
4354 4355 4356 4357

	ut_ad(mutex_own(&(dict_sys->mutex)));

	if (index->n_user_defined_cols > 0) {
4358 4359
		n_vals = index->stat_n_diff_key_vals[
			index->n_user_defined_cols];
osku's avatar
osku committed
4360 4361 4362 4363
	} else {
		n_vals = index->stat_n_diff_key_vals[1];
	}

4364
	if (dict_index_is_clust(index)) {
4365
		type_string = "clustered index";
4366
	} else if (dict_index_is_unique(index)) {
4367 4368 4369 4370 4371
		type_string = "unique index";
	} else {
		type_string = "secondary index";
	}

osku's avatar
osku committed
4372
	fprintf(stderr,
4373 4374
		"  INDEX: name %s, id %lu %lu, fields %lu/%lu,"
		" uniq %lu, type %lu\n"
osku's avatar
osku committed
4375 4376 4377 4378
		"   root page %lu, appr.key vals %lu,"
		" leaf pages %lu, size pages %lu\n"
		"   FIELDS: ",
		index->name,
4379 4380
		(ulong) ut_dulint_get_high(index->id),
		(ulong) ut_dulint_get_low(index->id),
osku's avatar
osku committed
4381
		(ulong) index->n_user_defined_cols,
4382 4383 4384
		(ulong) index->n_fields,
		(ulong) index->n_uniq,
		(ulong) index->type,
4385
		(ulong) index->page,
osku's avatar
osku committed
4386 4387 4388
		(ulong) n_vals,
		(ulong) index->stat_n_leaf_pages,
		(ulong) index->stat_index_size);
4389

osku's avatar
osku committed
4390 4391 4392 4393 4394 4395 4396
	for (i = 0; i < index->n_fields; i++) {
		dict_field_print_low(dict_index_get_nth_field(index, i));
	}

	putc('\n', stderr);

#ifdef UNIV_BTR_PRINT
4397
	btr_print_size(index);
osku's avatar
osku committed
4398

4399
	btr_print_index(index, 7);
osku's avatar
osku committed
4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411
#endif /* UNIV_BTR_PRINT */
}

/**************************************************************************
Prints a field data. */
static
void
dict_field_print_low(
/*=================*/
	dict_field_t*	field)	/* in: field */
{
	ut_ad(mutex_own(&(dict_sys->mutex)));
4412

osku's avatar
osku committed
4413 4414 4415 4416 4417 4418 4419 4420 4421 4422
	fprintf(stderr, " %s", field->name);

	if (field->prefix_len != 0) {
		fprintf(stderr, "(%lu)", (ulong) field->prefix_len);
	}
}

/**************************************************************************
Outputs info on a foreign key of a table in a format suitable for
CREATE TABLE. */
4423
UNIV_INTERN
osku's avatar
osku committed
4424 4425 4426 4427 4428 4429 4430 4431 4432 4433
void
dict_print_info_on_foreign_key_in_create_format(
/*============================================*/
	FILE*		file,		/* in: file where to print */
	trx_t*		trx,		/* in: transaction */
	dict_foreign_t*	foreign,	/* in: foreign key constraint */
	ibool		add_newline)	/* in: whether to add a newline */
{
	const char*	stripped_id;
	ulint	i;
4434

osku's avatar
osku committed
4435 4436 4437
	if (strchr(foreign->id, '/')) {
		/* Strip the preceding database name from the constraint id */
		stripped_id = foreign->id + 1
4438
			+ dict_get_db_name_len(foreign->id);
osku's avatar
osku committed
4439 4440 4441 4442 4443
	} else {
		stripped_id = foreign->id;
	}

	putc(',', file);
4444

osku's avatar
osku committed
4445 4446 4447 4448 4449 4450
	if (add_newline) {
		/* SHOW CREATE TABLE wants constraints each printed nicely
		on its own line, while error messages want no newlines
		inserted. */
		fputs("\n ", file);
	}
4451

osku's avatar
osku committed
4452
	fputs(" CONSTRAINT ", file);
4453
	ut_print_name(file, trx, FALSE, stripped_id);
osku's avatar
osku committed
4454 4455 4456
	fputs(" FOREIGN KEY (", file);

	for (i = 0;;) {
4457
		ut_print_name(file, trx, FALSE, foreign->foreign_col_names[i]);
osku's avatar
osku committed
4458 4459
		if (++i < foreign->n_fields) {
			fputs(", ", file);
4460
		} else {
osku's avatar
osku committed
4461 4462 4463 4464 4465 4466 4467
			break;
		}
	}

	fputs(") REFERENCES ", file);

	if (dict_tables_have_same_db(foreign->foreign_table_name,
4468
				     foreign->referenced_table_name)) {
osku's avatar
osku committed
4469
		/* Do not print the database name of the referenced table */
4470 4471 4472
		ut_print_name(file, trx, TRUE,
			      dict_remove_db_name(
				      foreign->referenced_table_name));
osku's avatar
osku committed
4473
	} else {
4474
		ut_print_name(file, trx, TRUE,
4475
			      foreign->referenced_table_name);
osku's avatar
osku committed
4476 4477 4478 4479 4480 4481
	}

	putc(' ', file);
	putc('(', file);

	for (i = 0;;) {
4482
		ut_print_name(file, trx, FALSE,
4483
			      foreign->referenced_col_names[i]);
osku's avatar
osku committed
4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495
		if (++i < foreign->n_fields) {
			fputs(", ", file);
		} else {
			break;
		}
	}

	putc(')', file);

	if (foreign->type & DICT_FOREIGN_ON_DELETE_CASCADE) {
		fputs(" ON DELETE CASCADE", file);
	}
4496

osku's avatar
osku committed
4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507
	if (foreign->type & DICT_FOREIGN_ON_DELETE_SET_NULL) {
		fputs(" ON DELETE SET NULL", file);
	}

	if (foreign->type & DICT_FOREIGN_ON_DELETE_NO_ACTION) {
		fputs(" ON DELETE NO ACTION", file);
	}

	if (foreign->type & DICT_FOREIGN_ON_UPDATE_CASCADE) {
		fputs(" ON UPDATE CASCADE", file);
	}
4508

osku's avatar
osku committed
4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519
	if (foreign->type & DICT_FOREIGN_ON_UPDATE_SET_NULL) {
		fputs(" ON UPDATE SET NULL", file);
	}

	if (foreign->type & DICT_FOREIGN_ON_UPDATE_NO_ACTION) {
		fputs(" ON UPDATE NO ACTION", file);
	}
}

/**************************************************************************
Outputs info on foreign keys of a table. */
4520
UNIV_INTERN
osku's avatar
osku committed
4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545
void
dict_print_info_on_foreign_keys(
/*============================*/
	ibool		create_table_format, /* in: if TRUE then print in
				a format suitable to be inserted into
				a CREATE TABLE, otherwise in the format
				of SHOW TABLE STATUS */
	FILE*		file,	/* in: file where to print */
	trx_t*		trx,	/* in: transaction */
	dict_table_t*	table)	/* in: table */
{
	dict_foreign_t*	foreign;

	mutex_enter(&(dict_sys->mutex));

	foreign = UT_LIST_GET_FIRST(table->foreign_list);

	if (foreign == NULL) {
		mutex_exit(&(dict_sys->mutex));

		return;
	}

	while (foreign != NULL) {
		if (create_table_format) {
4546 4547
			dict_print_info_on_foreign_key_in_create_format(
				file, trx, foreign, TRUE);
osku's avatar
osku committed
4548 4549 4550 4551 4552 4553 4554 4555 4556
		} else {
			ulint	i;
			fputs("; (", file);

			for (i = 0; i < foreign->n_fields; i++) {
				if (i) {
					putc(' ', file);
				}

4557
				ut_print_name(file, trx, FALSE,
4558
					      foreign->foreign_col_names[i]);
osku's avatar
osku committed
4559 4560 4561
			}

			fputs(") REFER ", file);
4562
			ut_print_name(file, trx, TRUE,
4563
				      foreign->referenced_table_name);
osku's avatar
osku committed
4564 4565 4566 4567 4568 4569
			putc('(', file);

			for (i = 0; i < foreign->n_fields; i++) {
				if (i) {
					putc(' ', file);
				}
4570 4571 4572
				ut_print_name(
					file, trx, FALSE,
					foreign->referenced_col_names[i]);
osku's avatar
osku committed
4573 4574 4575 4576 4577 4578 4579
			}

			putc(')', file);

			if (foreign->type == DICT_FOREIGN_ON_DELETE_CASCADE) {
				fputs(" ON DELETE CASCADE", file);
			}
4580

osku's avatar
osku committed
4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591
			if (foreign->type == DICT_FOREIGN_ON_DELETE_SET_NULL) {
				fputs(" ON DELETE SET NULL", file);
			}

			if (foreign->type & DICT_FOREIGN_ON_DELETE_NO_ACTION) {
				fputs(" ON DELETE NO ACTION", file);
			}

			if (foreign->type & DICT_FOREIGN_ON_UPDATE_CASCADE) {
				fputs(" ON UPDATE CASCADE", file);
			}
4592

osku's avatar
osku committed
4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609
			if (foreign->type & DICT_FOREIGN_ON_UPDATE_SET_NULL) {
				fputs(" ON UPDATE SET NULL", file);
			}

			if (foreign->type & DICT_FOREIGN_ON_UPDATE_NO_ACTION) {
				fputs(" ON UPDATE NO ACTION", file);
			}
		}

		foreign = UT_LIST_GET_NEXT(foreign_list, foreign);
	}

	mutex_exit(&(dict_sys->mutex));
}

/************************************************************************
Displays the names of the index and the table. */
4610
UNIV_INTERN
osku's avatar
osku committed
4611 4612 4613 4614 4615 4616 4617 4618
void
dict_index_name_print(
/*==================*/
	FILE*			file,	/* in: output stream */
	trx_t*			trx,	/* in: transaction */
	const dict_index_t*	index)	/* in: index to print */
{
	fputs("index ", file);
4619
	ut_print_name(file, trx, FALSE, index->name);
osku's avatar
osku committed
4620
	fputs(" of table ", file);
4621
	ut_print_name(file, trx, TRUE, index->table_name);
osku's avatar
osku committed
4622
}
4623 4624 4625

/**************************************************************************
Get index by name */
4626
UNIV_INTERN
4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653
dict_index_t*
dict_table_get_index_on_name(
/*=========================*/
				/* out: index, NULL if does not exist */
	dict_table_t*	table,	/* in: table */
	const char*	name)	/* in: name of the index to find */
{
	dict_index_t*	index;

	index = dict_table_get_first_index(table);

	while (index != NULL) {
		if (ut_strcmp(index->name, name) == 0) {

			return(index);
		}

		index = dict_table_get_next_index(index);
	}

	return(NULL);

}

/**************************************************************************
Replace the index passed in with another equivalent index in the tables
foreign key list. */
4654
UNIV_INTERN
4655 4656 4657 4658 4659 4660
void
dict_table_replace_index_in_foreign_list(
/*=====================================*/
	dict_table_t*	table,  /* in/out: table */
	dict_index_t*	index)	/* in: index to be replaced */
{
4661
	dict_foreign_t*	foreign;
4662

4663 4664 4665
	for (foreign = UT_LIST_GET_FIRST(table->foreign_list);
	     foreign;
	     foreign = UT_LIST_GET_NEXT(foreign_list, foreign)) {
4666

4667 4668 4669 4670
		if (foreign->foreign_index == index) {
			dict_index_t*	new_index
				= dict_foreign_find_equiv_index(foreign);
			ut_a(new_index);
4671

4672
			foreign->foreign_index = new_index;
4673 4674 4675 4676 4677 4678 4679
		}
	}
}

/**************************************************************************
In case there is more than one index with the same name return the index
with the min(id). */
4680
UNIV_INTERN
4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709
dict_index_t*
dict_table_get_index_on_name_and_min_id(
/*=====================================*/
				/* out: index, NULL if does not exist */
	dict_table_t*	table,	/* in: table */
	const char*	name)	/* in: name of the index to find */
{
	dict_index_t*	index;
	dict_index_t*	min_index; /* Index with matching name and min(id) */

	min_index = NULL;
	index = dict_table_get_first_index(table);

	while (index != NULL) {
		if (ut_strcmp(index->name, name) == 0) {
			if (!min_index
			    || ut_dulint_cmp(index->id, min_index->id) < 0) {

				min_index = index;
			}
		}

		index = dict_table_get_next_index(index);
	}

	return(min_index);

}

4710
#ifdef UNIV_DEBUG
4711 4712
/**************************************************************************
Check for duplicate index entries in a table [using the index name] */
4713
UNIV_INTERN
4714 4715 4716
void
dict_table_check_for_dup_indexes(
/*=============================*/
4717 4718
	const dict_table_t*	table)	/* in: Check for dup indexes
					in this table */
4719 4720 4721 4722
{
	/* Check for duplicates, ignoring indexes that are marked
	as to be dropped */

4723 4724
	const dict_index_t*	index1;
	const dict_index_t*	index2;
4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747

	/* The primary index _must_ exist */
	ut_a(UT_LIST_GET_LEN(table->indexes) > 0);

	index1 = UT_LIST_GET_FIRST(table->indexes);
	index2 = UT_LIST_GET_NEXT(indexes, index1);

	while (index1 && index2) {

		while (index2) {

			if (!index2->to_be_dropped) {
				ut_ad(ut_strcmp(index1->name, index2->name));
			}

			index2 = UT_LIST_GET_NEXT(indexes, index2);
		}

		index1 = UT_LIST_GET_NEXT(indexes, index1);
		index2 = UT_LIST_GET_NEXT(indexes, index1);
	}
}
#endif /* UNIV_DEBUG */