dict0dict.ic 17.4 KB
Newer Older
osku's avatar
osku committed
1 2 3 4 5 6 7 8 9 10 11
/**********************************************************************
Data dictionary system

(c) 1996 Innobase Oy

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

#include "dict0load.h"
#include "trx0undo.h"
#include "trx0sys.h"
12 13
#include "rem0types.h"
#include "data0type.h"
osku's avatar
osku committed
14 15 16 17

/*************************************************************************
Gets the column data type. */
UNIV_INLINE
18 19 20 21 22
void
dict_col_copy_type(
/*===============*/
	const dict_col_t*	col,	/* in: column */
	dtype_t*		type)	/* out: data type */
osku's avatar
osku committed
23
{
24
	ut_ad(col && type);
osku's avatar
osku committed
25

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
	type->mtype = col->mtype;
	type->prtype = col->prtype;
	type->len = col->len;
	type->mbminlen = col->mbminlen;
	type->mbmaxlen = col->mbmaxlen;
}

/***************************************************************************
Returns the minimum size of the column. */
UNIV_INLINE
ulint
dict_col_get_min_size(
/*==================*/
					/* out: minimum size */
	const dict_col_t*	col)	/* in: column */
{
	return(dtype_get_min_size_low(col->mtype, col->prtype, col->len,
				      col->mbminlen, col->mbmaxlen));
}
/***************************************************************************
Returns the maximum size of the column. */
UNIV_INLINE
ulint
dict_col_get_max_size(
/*==================*/
					/* out: maximum size */
	const dict_col_t*	col)	/* in: column */
{
	return(dtype_get_max_size_low(col->mtype, col->len));
}
/***************************************************************************
Returns the size of a fixed size column, 0 if not a fixed size column. */
UNIV_INLINE
ulint
dict_col_get_fixed_size(
/*====================*/
					/* out: fixed size, or 0 */
	const dict_col_t*	col)	/* in: column */
{
	return(dtype_get_fixed_size_low(col->mtype, col->prtype, col->len,
					col->mbminlen, col->mbmaxlen));
}
/***************************************************************************
Returns the ROW_FORMAT=REDUNDANT stored SQL NULL size of a column.
For fixed length types it is the fixed length of the type, otherwise 0. */
UNIV_INLINE
ulint
dict_col_get_sql_null_size(
/*=======================*/
					/* out: SQL null storage size
					in ROW_FORMAT=REDUNDANT */
	const dict_col_t*	col)	/* in: column */
{
	return(dict_col_get_fixed_size(col));
osku's avatar
osku committed
80 81 82 83 84 85 86 87
}

/*************************************************************************
Gets the column number. */
UNIV_INLINE
ulint
dict_col_get_no(
/*============*/
88
	const dict_col_t*	col)
osku's avatar
osku committed
89 90 91 92 93 94 95 96 97 98 99 100
{
	ut_ad(col);

	return(col->ind);
}

/*************************************************************************
Gets the column position in the clustered index. */
UNIV_INLINE
ulint
dict_col_get_clust_pos(
/*===================*/
101 102
	const dict_col_t*	col,		/* in: table column */
	const dict_index_t*	clust_index)	/* in: clustered index */
osku's avatar
osku committed
103
{
104 105
	ulint	i;

osku's avatar
osku committed
106
	ut_ad(col);
107
	ut_ad(clust_index && clust_index->type & DICT_CLUSTERED);
osku's avatar
osku committed
108

109 110 111 112 113 114 115 116 117
	for (i = 0; i < clust_index->n_def; i++) {
		const dict_field_t*	field = &clust_index->fields[i];

		if (!field->prefix_len && field->col == col) {
			return(i);
		}
	}

	return(ULINT_UNDEFINED);
osku's avatar
osku committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
}

/************************************************************************
Gets the first index on the table (the clustered index). */
UNIV_INLINE
dict_index_t*
dict_table_get_first_index(
/*=======================*/
				/* out: index, NULL if none exists */
	dict_table_t*	table)	/* in: table */
{
	ut_ad(table);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

	return(UT_LIST_GET_FIRST(table->indexes));
}

/************************************************************************
Gets the next index on the table. */
UNIV_INLINE
dict_index_t*
dict_table_get_next_index(
/*======================*/
				/* out: index, NULL if none left */
	dict_index_t*	index)	/* in: index */
{
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);

	return(UT_LIST_GET_NEXT(indexes, index));
}

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/************************************************************************
Check whether the index is the clustered index. */
UNIV_INLINE
ulint
dict_index_is_clust(
/*================*/
					/* out: nonzero for clustered index,
					zero for other indexes */
	const dict_index_t*	index)	/* in: index */
{
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);

	return(UNIV_UNLIKELY(index->type & DICT_CLUSTERED));
}

osku's avatar
osku committed
166 167 168 169 170 171 172 173 174 175 176 177 178
/************************************************************************
Gets the number of user-defined columns in a table in the dictionary
cache. */
UNIV_INLINE
ulint
dict_table_get_n_user_cols(
/*=======================*/
				/* out: number of user-defined (e.g., not
				ROW_ID) columns of a table */
	dict_table_t*	table)	/* in: table */
{
	ut_ad(table);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);
179

osku's avatar
osku committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
	return(table->n_cols - DATA_N_SYS_COLS);
}

/************************************************************************
Gets the number of system columns in a table in the dictionary cache. */
UNIV_INLINE
ulint
dict_table_get_n_sys_cols(
/*======================*/
				/* out: number of system (e.g.,
				ROW_ID) columns of a table */
	dict_table_t*	table __attribute__((unused)))	/* in: table */
{
	ut_ad(table);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);
	ut_ad(table->cached);

	return(DATA_N_SYS_COLS);
}

/************************************************************************
Gets the number of all columns (also system) in a table in the dictionary
cache. */
UNIV_INLINE
ulint
dict_table_get_n_cols(
/*==================*/
				/* out: number of columns of a table */
	dict_table_t*	table)	/* in: table */
{
	ut_ad(table);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);
212

osku's avatar
osku committed
213 214 215
	return(table->n_cols);
}

216
#ifdef UNIV_DEBUG
osku's avatar
osku committed
217 218 219
/************************************************************************
Gets the nth column of a table. */
UNIV_INLINE
220
dict_col_t*
osku's avatar
osku committed
221 222
dict_table_get_nth_col(
/*===================*/
223 224 225
					/* out: pointer to column object */
	const dict_table_t*	table,	/* in: table */
	ulint			pos)	/* in: position of column */
osku's avatar
osku committed
226 227 228 229 230
{
	ut_ad(table);
	ut_ad(pos < table->n_def);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

231
	return((dict_col_t*) (table->cols) + pos);
osku's avatar
osku committed
232 233 234 235 236
}

/************************************************************************
Gets the given system column of a table. */
UNIV_INLINE
237
dict_col_t*
osku's avatar
osku committed
238 239
dict_table_get_sys_col(
/*===================*/
240 241 242
					/* out: pointer to column object */
	const dict_table_t*	table,	/* in: table */
	ulint			sys)	/* in: DATA_ROW_ID, ... */
osku's avatar
osku committed
243
{
244
	dict_col_t*	col;
osku's avatar
osku committed
245 246 247 248 249

	ut_ad(table);
	ut_ad(sys < DATA_N_SYS_COLS);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

250
	col = dict_table_get_nth_col(table, table->n_cols
251
				     - DATA_N_SYS_COLS + sys);
252 253
	ut_ad(col->mtype == DATA_SYS);
	ut_ad(col->prtype == (sys | DATA_NOT_NULL));
osku's avatar
osku committed
254 255 256

	return(col);
}
257
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
258 259 260 261 262 263 264

/************************************************************************
Gets the given system column number of a table. */
UNIV_INLINE
ulint
dict_table_get_sys_col_no(
/*======================*/
265 266 267
					/* out: column number */
	const dict_table_t*	table,	/* in: table */
	ulint			sys)	/* in: DATA_ROW_ID, ... */
osku's avatar
osku committed
268 269 270 271 272 273 274 275
{
	ut_ad(table);
	ut_ad(sys < DATA_N_SYS_COLS);
	ut_ad(table->magic_n == DICT_TABLE_MAGIC_N);

	return(table->n_cols - DATA_N_SYS_COLS + sys);
}

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
/************************************************************************
Check whether the table uses the compact page format. */
UNIV_INLINE
ibool
dict_table_is_comp(
/*===============*/
					/* out: TRUE if table uses the
					compact page format */
	const dict_table_t*	table)	/* in: table */
{
	ut_ad(table);

#if DICT_TF_COMPACT != TRUE
#error
#endif

	return(UNIV_LIKELY(table->flags & DICT_TF_COMPACT));
}

295 296 297
/************************************************************************
Check whether the table uses the compressed compact page format. */
UNIV_INLINE
298 299 300 301 302
ulint
dict_table_zip_size(
/*================*/
					/* out: compressed page size,
					or 0 if not compressed */
303 304 305 306
	const dict_table_t*	table)	/* in: table */
{
	ut_ad(table);

307
	return(UNIV_UNLIKELY((table->flags & DICT_TF_COMPRESSED_MASK)
308
			     << (10 - DICT_TF_COMPRESSED_SHIFT)));
309 310
}

osku's avatar
osku committed
311 312 313 314 315 316 317
/************************************************************************
Gets the number of fields in the internal representation of an index,
including fields added by the dictionary system. */
UNIV_INLINE
ulint
dict_index_get_n_fields(
/*====================*/
318 319 320 321
					/* out: number of fields */
	const dict_index_t*	index)	/* in: an internal
					representation of index (in
					the dictionary cache) */
osku's avatar
osku committed
322 323 324
{
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
325

osku's avatar
osku committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
	return(index->n_fields);
}

/************************************************************************
Gets the number of fields in the internal representation of an index
that uniquely determine the position of an index entry in the index, if
we do not take multiversioning into account: in the B-tree use the value
returned by dict_index_get_n_unique_in_tree. */
UNIV_INLINE
ulint
dict_index_get_n_unique(
/*====================*/
				/* out: number of fields */
	dict_index_t*	index)	/* in: an internal representation of index
				(in the dictionary cache) */
{
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
	ut_ad(index->cached);
345

osku's avatar
osku committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
	return(index->n_uniq);
}

/************************************************************************
Gets the number of fields in the internal representation of an index
which uniquely determine the position of an index entry in the index, if
we also take multiversioning into account. */
UNIV_INLINE
ulint
dict_index_get_n_unique_in_tree(
/*============================*/
				/* out: number of fields */
	dict_index_t*	index)	/* in: an internal representation of index
				(in the dictionary cache) */
{
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
	ut_ad(index->cached);
364

365
	if (dict_index_is_clust(index)) {
osku's avatar
osku committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388

		return(dict_index_get_n_unique(index));
	}

	return(dict_index_get_n_fields(index));
}

/************************************************************************
Gets the number of user-defined ordering fields in the index. In the internal
representation of clustered indexes we add the row id to the ordering fields
to make a clustered index unique, but this function returns the number of
fields the user defined in the index as ordering fields. */
UNIV_INLINE
ulint
dict_index_get_n_ordering_defined_by_user(
/*======================================*/
				/* out: number of fields */
	dict_index_t*	index)	/* in: an internal representation of index
				(in the dictionary cache) */
{
	return(index->n_user_defined_cols);
}

389
#ifdef UNIV_DEBUG
osku's avatar
osku committed
390 391 392 393 394 395
/************************************************************************
Gets the nth field of an index. */
UNIV_INLINE
dict_field_t*
dict_index_get_nth_field(
/*=====================*/
396 397 398
					/* out: pointer to field object */
	const dict_index_t*	index,	/* in: index */
	ulint			pos)	/* in: position of field */
osku's avatar
osku committed
399 400 401 402 403
{
	ut_ad(index);
	ut_ad(pos < index->n_def);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);

404
	return((dict_field_t*) (index->fields) + pos);
osku's avatar
osku committed
405
}
406
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
407 408 409 410 411 412 413

/************************************************************************
Returns the position of a system column in an index. */
UNIV_INLINE
ulint
dict_index_get_sys_col_pos(
/*=======================*/
414 415 416 417
					/* out: position,
					ULINT_UNDEFINED if not contained */
	const dict_index_t*	index,	/* in: index */
	ulint			type)	/* in: DATA_ROW_ID, ... */
osku's avatar
osku committed
418 419 420 421 422
{
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
	ut_ad(!(index->type & DICT_UNIVERSAL));

423
	if (dict_index_is_clust(index)) {
osku's avatar
osku committed
424

425 426 427
		return(dict_col_get_clust_pos(
			       dict_table_get_sys_col(index->table, type),
			       index));
osku's avatar
osku committed
428 429
	}

430 431
	return(dict_index_get_nth_col_pos(
		       index, dict_table_get_sys_col_no(index->table, type)));
osku's avatar
osku committed
432 433 434 435 436
}

/*************************************************************************
Gets the field column. */
UNIV_INLINE
437
const dict_col_t*
osku's avatar
osku committed
438 439
dict_field_get_col(
/*===============*/
440
	const dict_field_t*	field)
osku's avatar
osku committed
441 442 443 444 445 446 447
{
	ut_ad(field);

	return(field->col);
}

/************************************************************************
448
Gets pointer to the nth column in an index. */
osku's avatar
osku committed
449
UNIV_INLINE
450 451 452 453 454 455
const dict_col_t*
dict_index_get_nth_col(
/*===================*/
					/* out: column */
	const dict_index_t*	index,	/* in: index */
	ulint			pos)	/* in: position of the field */
osku's avatar
osku committed
456
{
457
	return(dict_field_get_col(dict_index_get_nth_field(index, pos)));
osku's avatar
osku committed
458 459 460 461 462 463 464 465
}

/************************************************************************
Gets the column number the nth field in an index. */
UNIV_INLINE
ulint
dict_index_get_nth_col_no(
/*======================*/
466 467 468
					/* out: column number */
	const dict_index_t*	index,	/* in: index */
	ulint			pos)	/* in: position of the field */
osku's avatar
osku committed
469
{
470
	return(dict_col_get_no(dict_index_get_nth_col(index, pos)));
osku's avatar
osku committed
471 472 473 474 475 476
}

/*************************************************************************
Gets the space id of the root of the index tree. */
UNIV_INLINE
ulint
477 478
dict_index_get_space(
/*=================*/
osku's avatar
osku committed
479
				/* out: space id */
480
	dict_index_t*	index)	/* in: index */
osku's avatar
osku committed
481
{
482 483
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
osku's avatar
osku committed
484

485
	return(index->space);
osku's avatar
osku committed
486 487 488 489 490 491
}

/*************************************************************************
Sets the space id of the root of the index tree. */
UNIV_INLINE
void
492 493 494
dict_index_set_space(
/*=================*/
	dict_index_t*	index,	/* in: index */
osku's avatar
osku committed
495 496
	ulint		space)	/* in: space id */
{
497 498
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
osku's avatar
osku committed
499

500
	index->space = space;
osku's avatar
osku committed
501 502 503 504 505 506
}

/*************************************************************************
Gets the page number of the root of the index tree. */
UNIV_INLINE
ulint
507 508
dict_index_get_page(
/*================*/
osku's avatar
osku committed
509
				/* out: page number */
510
	dict_index_t*	index)	/* in: index */
osku's avatar
osku committed
511
{
512 513
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
osku's avatar
osku committed
514

515
	return(index->page);
osku's avatar
osku committed
516 517 518 519 520 521
}

/*************************************************************************
Sets the page number of the root of index tree. */
UNIV_INLINE
void
522 523 524
dict_index_set_page(
/*================*/
	dict_index_t*	index,	/* in: index */
osku's avatar
osku committed
525 526
	ulint		page)	/* in: page number */
{
527 528
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
osku's avatar
osku committed
529

530
	index->page = page;
osku's avatar
osku committed
531 532 533 534 535 536
}

/*************************************************************************
Gets the type of the index tree. */
UNIV_INLINE
ulint
537 538
dict_index_get_type(
/*================*/
osku's avatar
osku committed
539
				/* out: type */
540
	dict_index_t*	index)	/* in: index */
osku's avatar
osku committed
541
{
542 543
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
osku's avatar
osku committed
544

545
	return(index->type);
osku's avatar
osku committed
546 547 548 549 550 551
}

/*************************************************************************
Gets the read-write lock of the index tree. */
UNIV_INLINE
rw_lock_t*
552 553
dict_index_get_lock(
/*================*/
osku's avatar
osku committed
554
				/* out: read-write lock */
555
	dict_index_t*	index)	/* in: index */
osku's avatar
osku committed
556
{
557 558
	ut_ad(index);
	ut_ad(index->magic_n == DICT_INDEX_MAGIC_N);
osku's avatar
osku committed
559

560
	return(&(index->lock));
osku's avatar
osku committed
561 562 563 564 565 566 567 568
}

/************************************************************************
Returns free space reserved for future updates of records. This is
relevant only in the case of many consecutive inserts, as updates
which make the records bigger might fragment the index. */
UNIV_INLINE
ulint
569 570
dict_index_get_space_reserve(void)
/*==============================*/
osku's avatar
osku committed
571 572 573 574 575 576 577 578 579 580 581
				/* out: number of free bytes on page,
				reserved for updates */
{
	return(UNIV_PAGE_SIZE / 16);
}

/**************************************************************************
Checks if a table is in the dictionary cache. */
UNIV_INLINE
dict_table_t*
dict_table_check_if_in_cache_low(
582
/*=============================*/
osku's avatar
osku committed
583 584 585 586 587
					/* out: table, NULL if not found */
	const char*	table_name)	/* in: table name */
{
	dict_table_t*	table;
	ulint		table_fold;
588

osku's avatar
osku committed
589 590 591 592 593 594 595 596 597
	ut_ad(table_name);
#ifdef UNIV_SYNC_DEBUG
	ut_ad(mutex_own(&(dict_sys->mutex)));
#endif /* UNIV_SYNC_DEBUG */

	/* Look for the table name in the hash table */
	table_fold = ut_fold_string(table_name);

	HASH_SEARCH(name_hash, dict_sys->table_hash, table_fold, table,
598
		    ut_strcmp(table->name, table_name) == 0);
osku's avatar
osku committed
599 600 601 602 603 604 605 606 607 608 609 610 611 612
	return(table);
}

/**************************************************************************
Gets a table; loads it to the dictionary cache if necessary. A low-level
function. */
UNIV_INLINE
dict_table_t*
dict_table_get_low(
/*===============*/
					/* out: table, NULL if not found */
	const char*	table_name)	/* in: table name */
{
	dict_table_t*	table;
613

osku's avatar
osku committed
614 615 616 617 618 619
	ut_ad(table_name);
#ifdef UNIV_SYNC_DEBUG
	ut_ad(mutex_own(&(dict_sys->mutex)));
#endif /* UNIV_SYNC_DEBUG */

	table = dict_table_check_if_in_cache_low(table_name);
620

osku's avatar
osku committed
621 622 623 624 625 626 627 628
	if (table == NULL) {
		table = dict_load_table(table_name);
	}

	return(table);
}

/**************************************************************************
629
Returns a table object based on table id. */
osku's avatar
osku committed
630 631 632 633 634
UNIV_INLINE
dict_table_t*
dict_table_get_on_id_low(
/*=====================*/
				/* out: table, NULL if does not exist */
635
	dulint	table_id)	/* in: table id */
osku's avatar
osku committed
636 637 638 639 640 641 642
{
	dict_table_t*	table;
	ulint		fold;

#ifdef UNIV_SYNC_DEBUG
	ut_ad(mutex_own(&(dict_sys->mutex)));
#endif /* UNIV_SYNC_DEBUG */
643

osku's avatar
osku committed
644 645 646 647
	/* Look for the table name in the hash table */
	fold = ut_fold_dulint(table_id);

	HASH_SEARCH(id_hash, dict_sys->table_id_hash, fold, table,
648
		    ut_dulint_cmp(table->id, table_id) == 0);
osku's avatar
osku committed
649 650 651 652 653
	if (table == NULL) {
		table = dict_load_table_on_id(table_id);
	}

	/* TODO: should get the type information from MySQL */
654

osku's avatar
osku committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668
	return(table);
}

/**************************************************************************
Returns an index object. */
UNIV_INLINE
dict_index_t*
dict_table_get_index(
/*=================*/
				/* out: index, NULL if does not exist */
	dict_table_t*	table,	/* in: table */
	const char*	name)	/* in: index name */
{
	dict_index_t*	index	= NULL;
669

osku's avatar
osku committed
670 671 672 673 674 675 676 677 678
	index = dict_table_get_first_index(table);

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

			break;
		}

		index = dict_table_get_next_index(index);
679 680
	}

osku's avatar
osku committed
681 682
	return(index);
}