btr0sea.c 43.3 KB
Newer Older
osku's avatar
osku committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/************************************************************************
The index tree adaptive search

(c) 1996 Innobase Oy

Created 2/17/1996 Heikki Tuuri
*************************************************************************/

#include "btr0sea.h"
#ifdef UNIV_NONINL
#include "btr0sea.ic"
#endif

#include "buf0buf.h"
#include "page0page.h"
#include "page0cur.h"
#include "btr0cur.h"
#include "btr0pcur.h"
#include "btr0btr.h"
#include "ha0ha.h"

ulint	btr_search_this_is_zero = 0;	/* A dummy variable to fool the
					compiler */

#ifdef UNIV_SEARCH_PERF_STAT
ulint	btr_search_n_succ	= 0;
ulint	btr_search_n_hash_fail	= 0;
28
#endif /* UNIV_SEARCH_PERF_STAT */
osku's avatar
osku committed
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

byte	btr_sea_pad1[64];	/* padding to prevent other memory update
				hotspots from residing on the same memory
				cache line as btr_search_latch */

/* The latch protecting the adaptive search system: this latch protects the
(1) positions of records on those pages where a hash index has been built.
NOTE: It does not protect values of non-ordering fields within a record from
being updated in-place! We can use fact (1) to perform unique searches to
indexes. */

rw_lock_t*	btr_search_latch_temp; /* We will allocate the latch from
					dynamic memory to get it to the
					same DRAM page as other hotspot
					semaphores */

byte	btr_sea_pad2[64];	/* padding to prevent other memory update
				hotspots from residing on the same memory
				cache line */

btr_search_sys_t*	btr_search_sys;

/* If the number of records on the page divided by this parameter
would have been successfully accessed using a hash index, the index
is then built on the page, assuming the global limit has been reached */

#define BTR_SEARCH_PAGE_BUILD_LIMIT	16

/* The global limit for consecutive potentially successful hash searches,
before hash index building is started */

#define BTR_SEARCH_BUILD_LIMIT		100

/************************************************************************
Builds a hash index on a page with the given parameters. If the page already
has a hash index with different parameters, the old hash index is removed.
If index is non-NULL, this function checks if n_fields and n_bytes are
sensible values, and does not build a hash index if not. */
static
void
btr_search_build_page_hash_index(
/*=============================*/
	dict_index_t*	index,	/* in: index for which to build, or NULL if
				not known */
	page_t*		page,	/* in: index page, s- or x-latched */
	ulint		n_fields,/* in: hash this many full fields */
	ulint		n_bytes,/* in: hash this many bytes from the next
				field */
77
	ibool		left_side);/* in: hash for searches from left side? */
osku's avatar
osku committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

/*********************************************************************
This function should be called before reserving any btr search mutex, if
the intended operation might add nodes to the search system hash table.
Because of the latching order, once we have reserved the btr search system
latch, we cannot allocate a free frame from the buffer pool. Checks that
there is a free buffer frame allocated for hash table heap in the btr search
system. If not, allocates a free frames for the heap. This check makes it
probable that, when have reserved the btr search system latch and we need to
allocate a new node to the hash table, it will succeed. However, the check
will not guarantee success. */
static
void
btr_search_check_free_space_in_heap(void)
/*=====================================*/
{
	buf_frame_t*	frame;
	hash_table_t*	table;
	mem_heap_t*	heap;

#ifdef UNIV_SYNC_DEBUG
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_SHARED));
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */

	table = btr_search_sys->hash_index;

	heap = table->heap;
106

osku's avatar
osku committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
	/* Note that we peek the value of heap->free_block without reserving
	the latch: this is ok, because we will not guarantee that there will
	be enough free space in the hash table. */

	if (heap->free_block == NULL) {
		frame = buf_frame_alloc();

		rw_lock_x_lock(&btr_search_latch);

		if (heap->free_block == NULL) {
			heap->free_block = frame;
		} else {
			buf_frame_free(frame);
		}

		rw_lock_x_unlock(&btr_search_latch);
	}
}

/*********************************************************************
Creates and initializes the adaptive search system at a database start. */

void
btr_search_sys_create(
/*==================*/
	ulint	hash_size)	/* in: hash index hash table size */
{
	/* We allocate the search latch from dynamic memory:
	see above at the global variable definition */
136

osku's avatar
osku committed
137
	btr_search_latch_temp = mem_alloc(sizeof(rw_lock_t));
138

139
	rw_lock_create(&btr_search_latch, SYNC_SEARCH_SYS);
osku's avatar
osku committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

	btr_search_sys = mem_alloc(sizeof(btr_search_sys_t));

	btr_search_sys->hash_index = ha_create(TRUE, hash_size, 0, 0);

}

/*********************************************************************
Creates and initializes a search info struct. */

btr_search_t*
btr_search_info_create(
/*===================*/
				/* out, own: search info struct */
	mem_heap_t*	heap)	/* in: heap where created */
{
	btr_search_t*	info;

	info = mem_heap_alloc(heap, sizeof(btr_search_t));

160
#ifdef UNIV_DEBUG
osku's avatar
osku committed
161
	info->magic_n = BTR_SEARCH_MAGIC_N;
162
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
163

inaam's avatar
inaam committed
164
	info->ref_count = 0;
osku's avatar
osku committed
165 166 167 168 169 170 171
	info->root_guess = NULL;

	info->hash_analysis = 0;
	info->n_hash_potential = 0;

	info->last_hash_succ = FALSE;

172
#ifdef UNIV_SEARCH_PERF_STAT
173 174 175 176
	info->n_hash_succ = 0;
	info->n_hash_fail = 0;
	info->n_patt_succ = 0;
	info->n_searches = 0;
177
#endif /* UNIV_SEARCH_PERF_STAT */
osku's avatar
osku committed
178 179 180 181 182

	/* Set some sensible values */
	info->n_fields = 1;
	info->n_bytes = 0;

183
	info->left_side = TRUE;
osku's avatar
osku committed
184 185 186 187

	return(info);
}

inaam's avatar
inaam committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/*********************************************************************
Returns the value of ref_count. The value is protected by
btr_search_latch. */
UNIV_INLINE
ulint
btr_search_info_get_ref_count(
/*==========================*/
				/* out: ref_count value. */
	btr_search_t*   info)	/* in: search info. */
{
	ulint ret;

	ut_ad(info);

#ifdef UNIV_SYNC_DEBUG
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_SHARED));
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */

	rw_lock_s_lock(&btr_search_latch);
	ret = info->ref_count;
	rw_lock_s_unlock(&btr_search_latch);

	return(ret);
}

osku's avatar
osku committed
214 215 216 217 218 219 220 221
/*************************************************************************
Updates the search info of an index about hash successes. NOTE that info
is NOT protected by any semaphore, to save CPU time! Do not assume its fields
are consistent. */
static
void
btr_search_info_update_hash(
/*========================*/
222
	btr_search_t*	info,	/* in/out: search info */
osku's avatar
osku committed
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
	btr_cur_t*	cursor)	/* in: cursor which was just positioned */
{
	dict_index_t*	index;
	ulint		n_unique;
	int		cmp;

#ifdef UNIV_SYNC_DEBUG
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_SHARED));
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */

	index = cursor->index;

	if (index->type & DICT_IBUF) {
		/* So many deletes are performed on an insert buffer tree
		that we do not consider a hash index useful on it: */

		return;
	}

	n_unique = dict_index_get_n_unique_in_tree(index);

	if (info->n_hash_potential == 0) {

		goto set_new_recomm;
	}

	/* Test if the search would have succeeded using the recommended
	hash prefix */

	if (info->n_fields >= n_unique && cursor->up_match >= n_unique) {
254
increment_potential:
osku's avatar
osku committed
255 256 257 258 259 260
		info->n_hash_potential++;

		return;
	}

	cmp = ut_pair_cmp(info->n_fields, info->n_bytes,
261
			  cursor->low_match, cursor->low_bytes);
osku's avatar
osku committed
262

263
	if (info->left_side ? cmp <= 0 : cmp > 0) {
osku's avatar
osku committed
264 265 266 267 268

		goto set_new_recomm;
	}

	cmp = ut_pair_cmp(info->n_fields, info->n_bytes,
269
			  cursor->up_match, cursor->up_bytes);
osku's avatar
osku committed
270

271
	if (info->left_side ? cmp <= 0 : cmp > 0) {
osku's avatar
osku committed
272

273
		goto increment_potential;
osku's avatar
osku committed
274 275 276 277 278 279
	}

set_new_recomm:
	/* We have to set a new recommendation; skip the hash analysis
	for a while to avoid unnecessary CPU time usage when there is no
	chance for success */
280

osku's avatar
osku committed
281
	info->hash_analysis = 0;
282

osku's avatar
osku committed
283
	cmp = ut_pair_cmp(cursor->up_match, cursor->up_bytes,
284
			  cursor->low_match, cursor->low_bytes);
osku's avatar
osku committed
285 286 287 288 289 290 291 292
	if (cmp == 0) {
		info->n_hash_potential = 0;

		/* For extra safety, we set some sensible values here */

		info->n_fields = 1;
		info->n_bytes = 0;

293
		info->left_side = TRUE;
osku's avatar
osku committed
294 295 296 297 298 299 300 301 302 303 304 305 306

	} else if (cmp > 0) {
		info->n_hash_potential = 1;

		if (cursor->up_match >= n_unique) {

			info->n_fields = n_unique;
			info->n_bytes = 0;

		} else if (cursor->low_match < cursor->up_match) {

			info->n_fields = cursor->low_match + 1;
			info->n_bytes = 0;
307
		} else {
osku's avatar
osku committed
308 309 310 311
			info->n_fields = cursor->low_match;
			info->n_bytes = cursor->low_bytes + 1;
		}

312
		info->left_side = TRUE;
osku's avatar
osku committed
313 314 315 316 317 318 319 320 321 322 323 324
	} else {
		info->n_hash_potential = 1;

		if (cursor->low_match >= n_unique) {

			info->n_fields = n_unique;
			info->n_bytes = 0;

		} else if (cursor->low_match > cursor->up_match) {

			info->n_fields = cursor->up_match + 1;
			info->n_bytes = 0;
325
		} else {
osku's avatar
osku committed
326 327 328 329
			info->n_fields = cursor->up_match;
			info->n_bytes = cursor->up_bytes + 1;
		}

330
		info->left_side = FALSE;
osku's avatar
osku committed
331 332
	}
}
333

osku's avatar
osku committed
334 335 336 337 338 339 340 341 342 343 344 345
/*************************************************************************
Updates the block search info on hash successes. NOTE that info and
block->n_hash_helps, n_fields, n_bytes, side are NOT protected by any
semaphore, to save CPU time! Do not assume the fields are consistent. */
static
ibool
btr_search_update_block_hash_info(
/*==============================*/
				/* out: TRUE if building a (new) hash index on
				the block is recommended */
	btr_search_t*	info,	/* in: search info */
	buf_block_t*	block,	/* in: buffer block */
346 347
	btr_cur_t*	cursor __attribute__((unused)))
				/* in: cursor */
osku's avatar
osku committed
348 349 350 351 352
{
#ifdef UNIV_SYNC_DEBUG
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_SHARED));
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_EX));
	ut_ad(rw_lock_own(&((buf_block_t*) block)->lock, RW_LOCK_SHARED)
353
	      || rw_lock_own(&((buf_block_t*) block)->lock, RW_LOCK_EX));
osku's avatar
osku committed
354 355 356 357 358 359
#endif /* UNIV_SYNC_DEBUG */
	ut_ad(cursor);

	info->last_hash_succ = FALSE;

	ut_a(block->magic_n == BUF_BLOCK_MAGIC_N);
360
	ut_ad(info->magic_n == BTR_SEARCH_MAGIC_N);
osku's avatar
osku committed
361 362

	if ((block->n_hash_helps > 0)
363 364 365
	    && (info->n_hash_potential > 0)
	    && (block->n_fields == info->n_fields)
	    && (block->n_bytes == info->n_bytes)
366
	    && (block->left_side == info->left_side)) {
367

osku's avatar
osku committed
368
		if ((block->is_hashed)
369 370
		    && (block->curr_n_fields == info->n_fields)
		    && (block->curr_n_bytes == info->n_bytes)
371
		    && (block->curr_left_side == info->left_side)) {
osku's avatar
osku committed
372 373 374

			/* The search would presumably have succeeded using
			the hash index */
375

osku's avatar
osku committed
376 377 378 379 380 381 382 383
			info->last_hash_succ = TRUE;
		}

		block->n_hash_helps++;
	} else {
		block->n_hash_helps = 1;
		block->n_fields = info->n_fields;
		block->n_bytes = info->n_bytes;
384
		block->left_side = info->left_side;
osku's avatar
osku committed
385 386
	}

387
#ifdef UNIV_DEBUG
osku's avatar
osku committed
388 389 390
	if (cursor->index->table->does_not_fit_in_memory) {
		block->n_hash_helps = 0;
	}
391
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
392 393

	if ((block->n_hash_helps > page_get_n_recs(block->frame)
394 395
	     / BTR_SEARCH_PAGE_BUILD_LIMIT)
	    && (info->n_hash_potential >= BTR_SEARCH_BUILD_LIMIT)) {
osku's avatar
osku committed
396

397
		if ((!block->is_hashed)
398 399 400 401
		    || (block->n_hash_helps
			> 2 * page_get_n_recs(block->frame))
		    || (block->n_fields != block->curr_n_fields)
		    || (block->n_bytes != block->curr_n_bytes)
402
		    || (block->left_side != block->curr_left_side)) {
osku's avatar
osku committed
403

404
			/* Build a new hash index on the page */
osku's avatar
osku committed
405

406
			return(TRUE);
osku's avatar
osku committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
		}
	}

	return(FALSE);
}

/*************************************************************************
Updates a hash node reference when it has been unsuccessfully used in a
search which could have succeeded with the used hash parameters. This can
happen because when building a hash index for a page, we do not check
what happens at page boundaries, and therefore there can be misleading
hash nodes. Also, collisions in the fold value can lead to misleading
references. This function lazily fixes these imperfections in the hash
index. */
static
void
btr_search_update_hash_ref(
/*=======================*/
	btr_search_t*	info,	/* in: search info */
	buf_block_t*	block,	/* in: buffer block where cursor positioned */
	btr_cur_t*	cursor)	/* in: cursor */
{
	ulint	fold;
	rec_t*	rec;
431
	dulint	index_id;
osku's avatar
osku committed
432 433 434 435 436

	ut_ad(cursor->flag == BTR_CUR_HASH_FAIL);
#ifdef UNIV_SYNC_DEBUG
	ut_ad(rw_lock_own(&btr_search_latch, RW_LOCK_EX));
	ut_ad(rw_lock_own(&(block->lock), RW_LOCK_SHARED)
437
	      || rw_lock_own(&(block->lock), RW_LOCK_EX));
osku's avatar
osku committed
438 439 440 441 442
#endif /* UNIV_SYNC_DEBUG */
	ut_ad(buf_block_align(btr_cur_get_rec(cursor)) == block);
	ut_a(!block->is_hashed || block->index == cursor->index);

	if (block->is_hashed
443 444 445
	    && (info->n_hash_potential > 0)
	    && (block->curr_n_fields == info->n_fields)
	    && (block->curr_n_bytes == info->n_bytes)
446
	    && (block->curr_left_side == info->left_side)) {
osku's avatar
osku committed
447 448 449 450
		mem_heap_t*	heap		= NULL;
		ulint		offsets_[REC_OFFS_NORMAL_SIZE];
		*offsets_ = (sizeof offsets_) / sizeof *offsets_;

451 452 453
		rec = btr_cur_get_rec(cursor);

		if (!page_rec_is_user_rec(rec)) {
osku's avatar
osku committed
454

455 456
			return;
		}
osku's avatar
osku committed
457

458
		index_id = cursor->index->id;
459 460 461
		fold = rec_fold(rec,
				rec_get_offsets(rec, cursor->index, offsets_,
						ULINT_UNDEFINED, &heap),
osku's avatar
osku committed
462
				block->curr_n_fields,
463
				block->curr_n_bytes, index_id);
osku's avatar
osku committed
464 465 466 467 468 469 470 471 472
		if (UNIV_LIKELY_NULL(heap)) {
			mem_heap_free(heap);
		}
#ifdef UNIV_SYNC_DEBUG
		ut_ad(rw_lock_own(&btr_search_latch, RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */

		ha_insert_for_fold(btr_search_sys->hash_index, fold, rec);
	}
473 474
}

osku's avatar
osku committed
475 476 477 478 479 480
/*************************************************************************
Updates the search info. */

void
btr_search_info_update_slow(
/*========================*/
481
	btr_search_t*	info,	/* in/out: search info */
osku's avatar
osku committed
482 483 484 485 486 487
	btr_cur_t*	cursor)	/* in: cursor which was just positioned */
{
	buf_block_t*	block;
	ibool		build_index;
	ulint*		params;
	ulint*		params2;
488

osku's avatar
osku committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
#ifdef UNIV_SYNC_DEBUG
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_SHARED));
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */

	block = buf_block_align(btr_cur_get_rec(cursor));

	/* NOTE that the following two function calls do NOT protect
	info or block->n_fields etc. with any semaphore, to save CPU time!
	We cannot assume the fields are consistent when we return from
	those functions! */

	btr_search_info_update_hash(info, cursor);

	build_index = btr_search_update_block_hash_info(info, block, cursor);

	if (build_index || (cursor->flag == BTR_CUR_HASH_FAIL)) {

		btr_search_check_free_space_in_heap();
	}
509

osku's avatar
osku committed
510 511 512
	if (cursor->flag == BTR_CUR_HASH_FAIL) {
		/* Update the hash node reference, if appropriate */

513
#ifdef UNIV_SEARCH_PERF_STAT
osku's avatar
osku committed
514
		btr_search_n_hash_fail++;
515
#endif /* UNIV_SEARCH_PERF_STAT */
osku's avatar
osku committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535

		rw_lock_x_lock(&btr_search_latch);

		btr_search_update_hash_ref(info, block, cursor);

		rw_lock_x_unlock(&btr_search_latch);
	}

	if (build_index) {
		/* Note that since we did not protect block->n_fields etc.
		with any semaphore, the values can be inconsistent. We have
		to check inside the function call that they make sense. We
		also malloc an array and store the values there to make sure
		the compiler does not let the function call parameters change
		inside the called function. It might be that the compiler
		would optimize the call just to pass pointers to block. */

		params = mem_alloc(3 * sizeof(ulint));
		params[0] = block->n_fields;
		params[1] = block->n_bytes;
536
		params[2] = block->left_side;
osku's avatar
osku committed
537 538 539 540 541

		/* Make sure the compiler cannot deduce the values and do
		optimizations */

		params2 = params + btr_search_this_is_zero;
542

osku's avatar
osku committed
543
		btr_search_build_page_hash_index(cursor->index,
544 545 546 547
						 block->frame,
						 params2[0],
						 params2[1],
						 params2[2]);
osku's avatar
osku committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561
		mem_free(params);
	}
}

/**********************************************************************
Checks if a guessed position for a tree cursor is right. Note that if
mode is PAGE_CUR_LE, which is used in inserts, and the function returns
TRUE, then cursor->up_match and cursor->low_match both have sensible values. */
static
ibool
btr_search_check_guess(
/*===================*/
				/* out: TRUE if success */
	btr_cur_t*	cursor,	/* in: guessed cursor position */
562 563
	ibool		can_only_compare_to_cursor_rec,
				/* in: if we do not have a latch on the page
osku's avatar
osku committed
564
				of cursor, but only a latch on
565
				btr_search_latch, then ONLY the columns
osku's avatar
osku committed
566 567 568 569
				of the record UNDER the cursor are
				protected, not the next or previous record
				in the chain: we cannot look at the next or
				previous record to check our guess! */
570
	dtuple_t*	tuple,	/* in: data tuple */
osku's avatar
osku committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
	ulint		mode,	/* in: PAGE_CUR_L, PAGE_CUR_LE, PAGE_CUR_G,
				or PAGE_CUR_GE */
	mtr_t*		mtr)	/* in: mtr */
{
	rec_t*		rec;
	ulint		n_unique;
	ulint		match;
	ulint		bytes;
	int		cmp;
	mem_heap_t*	heap		= NULL;
	ulint		offsets_[REC_OFFS_NORMAL_SIZE];
	ulint*		offsets		= offsets_;
	ibool		success		= FALSE;
	*offsets_ = (sizeof offsets_) / sizeof *offsets_;

	n_unique = dict_index_get_n_unique_in_tree(cursor->index);
587

osku's avatar
osku committed
588 589 590 591 592 593 594 595
	rec = btr_cur_get_rec(cursor);

	ut_ad(page_rec_is_user_rec(rec));

	match = 0;
	bytes = 0;

	offsets = rec_get_offsets(rec, cursor->index, offsets,
596
				  n_unique, &heap);
osku's avatar
osku committed
597
	cmp = page_cmp_dtuple_rec_with_match(tuple, rec,
598
					     offsets, &match, &bytes);
osku's avatar
osku committed
599 600 601 602 603 604 605 606 607 608 609

	if (mode == PAGE_CUR_GE) {
		if (cmp == 1) {
			goto exit_func;
		}

		cursor->up_match = match;

		if (match >= n_unique) {
			success = TRUE;
			goto exit_func;
610
		}
osku's avatar
osku committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
	} else if (mode == PAGE_CUR_LE) {
		if (cmp == -1) {
			goto exit_func;
		}

		cursor->low_match = match;

	} else if (mode == PAGE_CUR_G) {
		if (cmp != -1) {
			goto exit_func;
		}
	} else if (mode == PAGE_CUR_L) {
		if (cmp != 1) {
			goto exit_func;
		}
	}

	if (can_only_compare_to_cursor_rec) {
629 630
		/* Since we could not determine if our guess is right just by
		looking at the record under the cursor, return FALSE */
osku's avatar
osku committed
631 632 633 634 635 636 637 638 639 640
		goto exit_func;
	}

	match = 0;
	bytes = 0;

	if ((mode == PAGE_CUR_G) || (mode == PAGE_CUR_GE)) {
		rec_t*	prev_rec;

		ut_ad(!page_rec_is_infimum(rec));
641

osku's avatar
osku committed
642 643 644
		prev_rec = page_rec_get_prev(rec);

		if (page_rec_is_infimum(prev_rec)) {
645 646
			success = btr_page_get_prev(
				buf_frame_align(prev_rec), mtr) == FIL_NULL;
osku's avatar
osku committed
647 648 649 650 651

			goto exit_func;
		}

		offsets = rec_get_offsets(prev_rec, cursor->index, offsets,
652
					  n_unique, &heap);
osku's avatar
osku committed
653
		cmp = page_cmp_dtuple_rec_with_match(tuple, prev_rec,
654
						     offsets, &match, &bytes);
osku's avatar
osku committed
655 656 657 658 659 660 661 662 663 664 665
		if (mode == PAGE_CUR_GE) {
			success = cmp == 1;
		} else {
			success = cmp != -1;
		}

		goto exit_func;
	} else {
		rec_t*	next_rec;

		ut_ad(!page_rec_is_supremum(rec));
666

osku's avatar
osku committed
667 668 669
		next_rec = page_rec_get_next(rec);

		if (page_rec_is_supremum(next_rec)) {
670 671 672
			if (btr_page_get_next(
				    buf_frame_align(next_rec), mtr)
			    == FIL_NULL) {
osku's avatar
osku committed
673 674 675 676 677 678 679 680 681

				cursor->up_match = 0;
				success = TRUE;
			}

			goto exit_func;
		}

		offsets = rec_get_offsets(next_rec, cursor->index, offsets,
682
					  n_unique, &heap);
osku's avatar
osku committed
683
		cmp = page_cmp_dtuple_rec_with_match(tuple, next_rec,
684
						     offsets, &match, &bytes);
osku's avatar
osku committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
		if (mode == PAGE_CUR_LE) {
			success = cmp == -1;
			cursor->up_match = match;
		} else {
			success = cmp != 1;
		}
	}
exit_func:
	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}
	return(success);
}

/**********************************************************************
Tries to guess the right search position based on the hash search info
of the index. Note that if mode is PAGE_CUR_LE, which is used in inserts,
and the function returns TRUE, then cursor->up_match and cursor->low_match
both have sensible values. */

ibool
btr_search_guess_on_hash(
/*=====================*/
708
					/* out: TRUE if succeeded */
osku's avatar
osku committed
709 710 711 712
	dict_index_t*	index,		/* in: index */
	btr_search_t*	info,		/* in: index search info */
	dtuple_t*	tuple,		/* in: logical record */
	ulint		mode,		/* in: PAGE_CUR_L, ... */
713
	ulint		latch_mode,	/* in: BTR_SEARCH_LEAF, ...;
osku's avatar
osku committed
714 715 716 717 718
					NOTE that only if has_search_latch
					is 0, we will have a latch set on
					the cursor page, otherwise we assume
					the caller uses his search latch
					to protect the record! */
719
	btr_cur_t*	cursor,		/* out: tree cursor */
osku's avatar
osku committed
720 721 722 723 724 725 726 727 728 729
	ulint		has_search_latch,/* in: latch mode the caller
					currently has on btr_search_latch:
					RW_S_LATCH, RW_X_LATCH, or 0 */
	mtr_t*		mtr)		/* in: mtr */
{
	buf_block_t*	block;
	rec_t*		rec;
	page_t*		page;
	ulint		fold;
	ulint		tuple_n_fields;
730
	dulint		index_id;
731
	ibool		can_only_compare_to_cursor_rec = TRUE;
osku's avatar
osku committed
732 733 734 735 736 737
#ifdef notdefined
	btr_cur_t	cursor2;
	btr_pcur_t	pcur;
#endif
	ut_ad(index && info && tuple && cursor && mtr);
	ut_ad((latch_mode == BTR_SEARCH_LEAF)
738
	      || (latch_mode == BTR_MODIFY_LEAF));
osku's avatar
osku committed
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758

	/* Note that, for efficiency, the struct info may not be protected by
	any latch here! */

	if (UNIV_UNLIKELY(info->n_hash_potential == 0)) {

		return(FALSE);
	}

	cursor->n_fields = info->n_fields;
	cursor->n_bytes = info->n_bytes;

	tuple_n_fields = dtuple_get_n_fields(tuple);

	if (UNIV_UNLIKELY(tuple_n_fields < cursor->n_fields)) {

		return(FALSE);
	}

	if (UNIV_UNLIKELY(tuple_n_fields == cursor->n_fields)
759
	    && (cursor->n_bytes > 0)) {
osku's avatar
osku committed
760

761
		return(FALSE);
osku's avatar
osku committed
762 763
	}

764
	index_id = index->id;
osku's avatar
osku committed
765 766 767 768

#ifdef UNIV_SEARCH_PERF_STAT
	info->n_hash_succ++;
#endif
769
	fold = dtuple_fold(tuple, cursor->n_fields, cursor->n_bytes, index_id);
osku's avatar
osku committed
770 771 772

	cursor->fold = fold;
	cursor->flag = BTR_CUR_HASH;
773

osku's avatar
osku committed
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
	if (UNIV_LIKELY(!has_search_latch)) {
		rw_lock_s_lock(&btr_search_latch);
	}

	ut_ad(btr_search_latch.writer != RW_LOCK_EX);
	ut_ad(btr_search_latch.reader_count > 0);

	rec = ha_search_and_get_data(btr_search_sys->hash_index, fold);

	if (UNIV_UNLIKELY(!rec)) {
		goto failure_unlock;
	}

	page = buf_frame_align(rec);

	if (UNIV_LIKELY(!has_search_latch)) {

791 792 793 794 795
		if (UNIV_UNLIKELY(
			    !buf_page_get_known_nowait(latch_mode, page,
						       BUF_MAKE_YOUNG,
						       __FILE__, __LINE__,
						       mtr))) {
osku's avatar
osku committed
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
			goto failure_unlock;
		}

		rw_lock_s_unlock(&btr_search_latch);
		can_only_compare_to_cursor_rec = FALSE;

#ifdef UNIV_SYNC_DEBUG
		buf_page_dbg_add_level(page, SYNC_TREE_NODE_FROM_HASH);
#endif /* UNIV_SYNC_DEBUG */
	}

	block = buf_block_align(page);

	if (UNIV_UNLIKELY(block->state == BUF_BLOCK_REMOVE_HASH)) {
		if (UNIV_LIKELY(!has_search_latch)) {
811

osku's avatar
osku committed
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
			btr_leaf_page_release(page, latch_mode, mtr);
		}

		goto failure;
	}

	ut_ad(block->state == BUF_BLOCK_FILE_PAGE);
	ut_ad(page_rec_is_user_rec(rec));

	btr_cur_position(index, rec, cursor);

	/* Check the validity of the guess within the page */

	/* If we only have the latch on btr_search_latch, not on the
	page, it only protects the columns of the record the cursor
	is positioned on. We cannot look at the next of the previous
	record to determine if our guess for the cursor position is
	right. */
830 831
	if (UNIV_EXPECT(
		    ut_dulint_cmp(index_id, btr_page_get_index_id(page)), 0)
832 833 834
	    || !btr_search_check_guess(cursor,
				       can_only_compare_to_cursor_rec,
				       tuple, mode, mtr)) {
osku's avatar
osku committed
835
		if (UNIV_LIKELY(!has_search_latch)) {
836
			btr_leaf_page_release(page, latch_mode, mtr);
osku's avatar
osku committed
837 838 839 840 841 842
		}

		goto failure;
	}

	if (UNIV_LIKELY(info->n_hash_potential < BTR_SEARCH_BUILD_LIMIT + 5)) {
843

osku's avatar
osku committed
844 845 846 847 848 849
		info->n_hash_potential++;
	}

#ifdef notdefined
	/* These lines of code can be used in a debug version to check
	the correctness of the searched cursor position: */
850

osku's avatar
osku committed
851 852 853 854
	info->last_hash_succ = FALSE;

	/* Currently, does not work if the following fails: */
	ut_ad(!has_search_latch);
855

osku's avatar
osku committed
856 857 858
	btr_leaf_page_release(page, latch_mode, mtr);

	btr_cur_search_to_nth_level(index, 0, tuple, mode, latch_mode,
859
				    &cursor2, 0, mtr);
osku's avatar
osku committed
860
	if (mode == PAGE_CUR_GE
861
	    && page_rec_is_supremum(btr_cur_get_rec(&cursor2))) {
osku's avatar
osku committed
862 863 864 865

		/* If mode is PAGE_CUR_GE, then the binary search
		in the index tree may actually take us to the supremum
		of the previous page */
866

osku's avatar
osku committed
867 868 869
		info->last_hash_succ = FALSE;

		btr_pcur_open_on_user_rec(index, tuple, mode, latch_mode,
870
					  &pcur, mtr);
osku's avatar
osku committed
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
		ut_ad(btr_pcur_get_rec(&pcur) == btr_cur_get_rec(cursor));
	} else {
		ut_ad(btr_cur_get_rec(&cursor2) == btr_cur_get_rec(cursor));
	}

	/* NOTE that it is theoretically possible that the above assertions
	fail if the page of the cursor gets removed from the buffer pool
	meanwhile! Thus it might not be a bug. */
#endif
	info->last_hash_succ = TRUE;

#ifdef UNIV_SEARCH_PERF_STAT
	btr_search_n_succ++;
#endif
	if (UNIV_LIKELY(!has_search_latch)
886
	    && buf_block_peek_if_too_old(block)) {
osku's avatar
osku committed
887 888

		buf_page_make_young(page);
889
	}
osku's avatar
osku committed
890 891 892 893 894 895

	/* Increment the page get statistics though we did not really
	fix the page: for user info only */

	buf_pool->n_page_gets++;

896
	return(TRUE);
osku's avatar
osku committed
897 898 899 900 901 902 903 904 905 906

	/*-------------------------------------------*/
failure_unlock:
	if (UNIV_LIKELY(!has_search_latch)) {
		rw_lock_s_unlock(&btr_search_latch);
	}
failure:
	cursor->flag = BTR_CUR_HASH_FAIL;

#ifdef UNIV_SEARCH_PERF_STAT
907 908
	info->n_hash_fail++;

osku's avatar
osku committed
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
	if (info->n_hash_succ > 0) {
		info->n_hash_succ--;
	}
#endif
	info->last_hash_succ = FALSE;

	return(FALSE);
}

/************************************************************************
Drops a page hash index. */

void
btr_search_drop_page_hash_index(
/*============================*/
marko's avatar
marko committed
924 925
	page_t*	page)	/* in: index page, s- or x-latched, or an index page
			for which we know that block->buf_fix_count == 0 */
osku's avatar
osku committed
926 927 928 929 930 931 932 933
{
	hash_table_t*	table;
	buf_block_t*	block;
	ulint		n_fields;
	ulint		n_bytes;
	rec_t*		rec;
	ulint		fold;
	ulint		prev_fold;
934
	dulint		index_id;
osku's avatar
osku committed
935 936 937 938 939
	ulint		n_cached;
	ulint		n_recs;
	ulint*		folds;
	ulint		i;
	mem_heap_t*	heap;
940
	dict_index_t*	index;
osku's avatar
osku committed
941 942 943 944 945 946
	ulint*		offsets;

#ifdef UNIV_SYNC_DEBUG
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_SHARED));
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */
947
retry:
osku's avatar
osku committed
948 949 950 951
	rw_lock_s_lock(&btr_search_latch);

	block = buf_block_align(page);

952
	if (UNIV_LIKELY(!block->is_hashed)) {
osku's avatar
osku committed
953 954 955 956 957 958 959 960 961 962

		rw_lock_s_unlock(&btr_search_latch);

		return;
	}

	table = btr_search_sys->hash_index;

#ifdef UNIV_SYNC_DEBUG
	ut_ad(rw_lock_own(&(block->lock), RW_LOCK_SHARED)
963 964
	      || rw_lock_own(&(block->lock), RW_LOCK_EX)
	      || (block->buf_fix_count == 0));
osku's avatar
osku committed
965 966 967 968
#endif /* UNIV_SYNC_DEBUG */

	n_fields = block->curr_n_fields;
	n_bytes = block->curr_n_bytes;
969
	index = block->index;
osku's avatar
osku committed
970

971 972 973
	/* NOTE: The fields of block must not be accessed after
	releasing btr_search_latch, as the index page might only
	be s-latched! */
osku's avatar
osku committed
974 975

	rw_lock_s_unlock(&btr_search_latch);
976

977 978
	ut_a(n_fields + n_bytes > 0);

osku's avatar
osku committed
979 980 981 982 983 984 985 986 987 988 989 990
	n_recs = page_get_n_recs(page);

	/* Calculate and cache fold values into an array for fast deletion
	from the hash index */

	folds = mem_alloc(n_recs * sizeof(ulint));

	n_cached = 0;

	rec = page_get_infimum_rec(page);
	rec = page_rec_get_next(rec);

991
	index_id = btr_page_get_index_id(page);
992

993
	ut_a(0 == ut_dulint_cmp(index_id, index->id));
994

osku's avatar
osku committed
995 996 997 998 999 1000
	prev_fold = 0;

	heap = NULL;
	offsets = NULL;

	while (!page_rec_is_supremum(rec)) {
1001
		offsets = rec_get_offsets(rec, index, offsets,
1002
					  n_fields + (n_bytes > 0), &heap);
1003
		ut_a(rec_offs_n_fields(offsets) == n_fields + (n_bytes > 0));
1004
		fold = rec_fold(rec, offsets, n_fields, n_bytes, index_id);
osku's avatar
osku committed
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

		if (fold == prev_fold && prev_fold != 0) {

			goto next_rec;
		}

		/* Remove all hash nodes pointing to this page from the
		hash chain */

		folds[n_cached] = fold;
		n_cached++;
next_rec:
		rec = page_rec_get_next(rec);
		prev_fold = fold;
	}

	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}

	rw_lock_x_lock(&btr_search_latch);

1027 1028 1029 1030 1031 1032 1033 1034 1035
	if (UNIV_UNLIKELY(!block->is_hashed)) {
		/* Someone else has meanwhile dropped the hash index */

		goto cleanup;
	}

	ut_a(block->index == index);

	if (UNIV_UNLIKELY(block->curr_n_fields != n_fields)
1036
	    || UNIV_UNLIKELY(block->curr_n_bytes != n_bytes)) {
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046

		/* Someone else has meanwhile built a new hash index on the
		page, with different parameters */

		rw_lock_x_unlock(&btr_search_latch);

		mem_free(folds);
		goto retry;
	}

osku's avatar
osku committed
1047 1048 1049 1050 1051
	for (i = 0; i < n_cached; i++) {

		ha_remove_all_nodes_to_page(table, folds[i], page);
	}

inaam's avatar
inaam committed
1052 1053 1054
	ut_a(index->search_info->ref_count > 0);
	index->search_info->ref_count--;

osku's avatar
osku committed
1055 1056
	block->is_hashed = FALSE;
	block->index = NULL;
inaam's avatar
inaam committed
1057
	
1058 1059 1060 1061 1062
cleanup:
	if (UNIV_UNLIKELY(block->n_pointers)) {
		/* Corruption */
		ut_print_timestamp(stderr);
		fprintf(stderr,
1063 1064 1065 1066
			"  InnoDB: Corruption of adaptive hash index."
			" After dropping\n"
			"InnoDB: the hash index to a page of %s,"
			" still %lu hash nodes remain.\n",
1067 1068
			index->name, (ulong) block->n_pointers);
		rw_lock_x_unlock(&btr_search_latch);
osku's avatar
osku committed
1069

1070 1071 1072 1073
		btr_search_validate();
	} else {
		rw_lock_x_unlock(&btr_search_latch);
	}
osku's avatar
osku committed
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097

	mem_free(folds);
}

/************************************************************************
Drops a page hash index when a page is freed from a fseg to the file system.
Drops possible hash index if the page happens to be in the buffer pool. */

void
btr_search_drop_page_hash_when_freed(
/*=================================*/
	ulint	space,		/* in: space id */
	ulint	page_no)	/* in: page number */
{
	ibool	is_hashed;
	page_t*	page;
	mtr_t	mtr;

	is_hashed = buf_page_peek_if_search_hashed(space, page_no);

	if (!is_hashed) {

		return;
	}
1098

osku's avatar
osku committed
1099 1100 1101 1102 1103 1104
	mtr_start(&mtr);

	/* We assume that if the caller has a latch on the page, then the
	caller has already dropped the hash index for the page, and we never
	get here. Therefore we can acquire the s-latch to the page without
	having to fear a deadlock. */
1105

osku's avatar
osku committed
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
	page = buf_page_get_gen(space, page_no, RW_S_LATCH, NULL,
				BUF_GET_IF_IN_POOL, __FILE__, __LINE__,
				&mtr);

#ifdef UNIV_SYNC_DEBUG
	buf_page_dbg_add_level(page, SYNC_TREE_NODE_FROM_HASH);
#endif /* UNIV_SYNC_DEBUG */

	btr_search_drop_page_hash_index(page);

	mtr_commit(&mtr);
}

/************************************************************************
Builds a hash index on a page with the given parameters. If the page already
has a hash index with different parameters, the old hash index is removed.
If index is non-NULL, this function checks if n_fields and n_bytes are
sensible values, and does not build a hash index if not. */
static
void
btr_search_build_page_hash_index(
/*=============================*/
	dict_index_t*	index,	/* in: index for which to build */
	page_t*		page,	/* in: index page, s- or x-latched */
	ulint		n_fields,/* in: hash this many full fields */
	ulint		n_bytes,/* in: hash this many bytes from the next
				field */
1133
	ibool		left_side)/* in: hash for searches from left side? */
osku's avatar
osku committed
1134 1135 1136 1137 1138 1139 1140
{
	hash_table_t*	table;
	buf_block_t*	block;
	rec_t*		rec;
	rec_t*		next_rec;
	ulint		fold;
	ulint		next_fold;
1141
	dulint		index_id;
osku's avatar
osku committed
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
	ulint		n_cached;
	ulint		n_recs;
	ulint*		folds;
	rec_t**		recs;
	ulint		i;
	mem_heap_t*	heap		= NULL;
	ulint		offsets_[REC_OFFS_NORMAL_SIZE];
	ulint*		offsets		= offsets_;
	*offsets_ = (sizeof offsets_) / sizeof *offsets_;

	ut_ad(index);

	block = buf_block_align(page);
	table = btr_search_sys->hash_index;

#ifdef UNIV_SYNC_DEBUG
	ut_ad(!rw_lock_own(&btr_search_latch, RW_LOCK_EX));
	ut_ad(rw_lock_own(&(block->lock), RW_LOCK_SHARED)
1160
	      || rw_lock_own(&(block->lock), RW_LOCK_EX));
osku's avatar
osku committed
1161 1162 1163
#endif /* UNIV_SYNC_DEBUG */

	rw_lock_s_lock(&btr_search_latch);
1164

osku's avatar
osku committed
1165
	if (block->is_hashed && ((block->curr_n_fields != n_fields)
1166
				 || (block->curr_n_bytes != n_bytes)
1167
				 || (block->curr_left_side != left_side))) {
osku's avatar
osku committed
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183

		rw_lock_s_unlock(&btr_search_latch);

		btr_search_drop_page_hash_index(page);
	} else {
		rw_lock_s_unlock(&btr_search_latch);
	}

	n_recs = page_get_n_recs(page);

	if (n_recs == 0) {

		return;
	}

	/* Check that the values for hash index build are sensible */
1184

osku's avatar
osku committed
1185 1186 1187 1188 1189 1190
	if (n_fields + n_bytes == 0) {

		return;
	}

	if (dict_index_get_n_unique_in_tree(index) < n_fields
1191 1192
	    || (dict_index_get_n_unique_in_tree(index) == n_fields
		&& n_bytes > 0)) {
osku's avatar
osku committed
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
		return;
	}

	/* Calculate and cache fold values and corresponding records into
	an array for fast insertion to the hash index */

	folds = mem_alloc(n_recs * sizeof(ulint));
	recs = mem_alloc(n_recs * sizeof(rec_t*));

	n_cached = 0;

1204
	index_id = btr_page_get_index_id(page);
osku's avatar
osku committed
1205 1206 1207 1208 1209

	rec = page_get_infimum_rec(page);
	rec = page_rec_get_next(rec);

	offsets = rec_get_offsets(rec, index, offsets,
1210
				  n_fields + (n_bytes > 0), &heap);
osku's avatar
osku committed
1211 1212 1213 1214 1215 1216 1217 1218 1219

	if (!page_rec_is_supremum(rec)) {
		ut_a(n_fields <= rec_offs_n_fields(offsets));

		if (n_bytes > 0) {
			ut_a(n_fields < rec_offs_n_fields(offsets));
		}
	}

1220
	fold = rec_fold(rec, offsets, n_fields, n_bytes, index_id);
osku's avatar
osku committed
1221

1222
	if (left_side) {
osku's avatar
osku committed
1223 1224 1225 1226 1227

		folds[n_cached] = fold;
		recs[n_cached] = rec;
		n_cached++;
	}
1228

osku's avatar
osku committed
1229 1230 1231 1232 1233
	for (;;) {
		next_rec = page_rec_get_next(rec);

		if (page_rec_is_supremum(next_rec)) {

1234
			if (!left_side) {
1235

osku's avatar
osku committed
1236 1237 1238 1239 1240
				folds[n_cached] = fold;
				recs[n_cached] = rec;
				n_cached++;
			}

1241
			break;
osku's avatar
osku committed
1242 1243 1244
		}

		offsets = rec_get_offsets(next_rec, index, offsets,
1245
					  n_fields + (n_bytes > 0), &heap);
osku's avatar
osku committed
1246
		next_fold = rec_fold(next_rec, offsets, n_fields,
1247
				     n_bytes, index_id);
osku's avatar
osku committed
1248 1249 1250 1251

		if (fold != next_fold) {
			/* Insert an entry into the hash index */

1252
			if (left_side) {
osku's avatar
osku committed
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272

				folds[n_cached] = next_fold;
				recs[n_cached] = next_rec;
				n_cached++;
			} else {
				folds[n_cached] = fold;
				recs[n_cached] = rec;
				n_cached++;
			}
		}

		rec = next_rec;
		fold = next_fold;
	}

	btr_search_check_free_space_in_heap();

	rw_lock_x_lock(&btr_search_latch);

	if (block->is_hashed && ((block->curr_n_fields != n_fields)
1273
				 || (block->curr_n_bytes != n_bytes)
1274
				 || (block->curr_left_side != left_side))) {
osku's avatar
osku committed
1275 1276
		goto exit_func;
	}
1277

inaam's avatar
inaam committed
1278 1279 1280 1281 1282 1283 1284 1285 1286
	/* This counter is decremented every time we drop page
	hash index entries and is incremented here. Since we can
	rebuild hash index for a page that is already hashed, we
	have to take care not to increment the counter in that
	case. */
	if (!block->is_hashed) {
		index->search_info->ref_count++;
	}

osku's avatar
osku committed
1287 1288
	block->is_hashed = TRUE;
	block->n_hash_helps = 0;
1289

osku's avatar
osku committed
1290 1291
	block->curr_n_fields = n_fields;
	block->curr_n_bytes = n_bytes;
1292
	block->curr_left_side = left_side;
osku's avatar
osku committed
1293 1294 1295
	block->index = index;

	for (i = 0; i < n_cached; i++) {
1296

osku's avatar
osku committed
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
		ha_insert_for_fold(table, folds[i], recs[i]);
	}

exit_func:
	rw_lock_x_unlock(&btr_search_latch);

	mem_free(folds);
	mem_free(recs);
	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}
}

/************************************************************************
Moves or deletes hash entries for moved records. If new_page is already hashed,
then the hash index for page, if any, is dropped. If new_page is not hashed,
and page is hashed, then a new hash index is built to new_page with the same
parameters as page (this often happens when a page is split). */

void
btr_search_move_or_delete_hash_entries(
/*===================================*/
	page_t*		new_page,	/* in: records are copied
					to this page */
	page_t*		page,		/* in: index page from which
					records were copied, and the
					copied records will be deleted
					from this page */
	dict_index_t*	index)		/* in: record descriptor */
{
	buf_block_t*	block;
	buf_block_t*	new_block;
	ulint		n_fields;
	ulint		n_bytes;
1331
	ibool		left_side;
osku's avatar
osku committed
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344

	block = buf_block_align(page);
	new_block = buf_block_align(new_page);
	ut_a(page_is_comp(page) == page_is_comp(new_page));

#ifdef UNIV_SYNC_DEBUG
	ut_ad(rw_lock_own(&(block->lock), RW_LOCK_EX));
	ut_ad(rw_lock_own(&(new_block->lock), RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */
	ut_a(!new_block->is_hashed || new_block->index == index);
	ut_a(!block->is_hashed || block->index == index);

	rw_lock_s_lock(&btr_search_latch);
1345

osku's avatar
osku committed
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
	if (new_block->is_hashed) {

		rw_lock_s_unlock(&btr_search_latch);

		btr_search_drop_page_hash_index(page);

		return;
	}

	if (block->is_hashed) {

		n_fields = block->curr_n_fields;
		n_bytes = block->curr_n_bytes;
1359
		left_side = block->curr_left_side;
osku's avatar
osku committed
1360 1361 1362

		new_block->n_fields = block->curr_n_fields;
		new_block->n_bytes = block->curr_n_bytes;
1363
		new_block->left_side = left_side;
osku's avatar
osku committed
1364 1365 1366 1367 1368 1369

		rw_lock_s_unlock(&btr_search_latch);

		ut_a(n_fields + n_bytes > 0);

		btr_search_build_page_hash_index(index, new_page, n_fields,
1370 1371
						 n_bytes, left_side);
#if 1 /* TODO: safe to remove? */
osku's avatar
osku committed
1372 1373
		ut_a(n_fields == block->curr_n_fields);
		ut_a(n_bytes == block->curr_n_bytes);
1374 1375
		ut_a(left_side == block->curr_left_side);
#endif
osku's avatar
osku committed
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
		return;
	}

	rw_lock_s_unlock(&btr_search_latch);
}

/************************************************************************
Updates the page hash index when a single record is deleted from a page. */

void
btr_search_update_hash_on_delete(
/*=============================*/
	btr_cur_t*	cursor)	/* in: cursor which was positioned on the
				record to delete using btr_cur_search_...,
				the record is not yet deleted */
{
	hash_table_t*	table;
	buf_block_t*	block;
	rec_t*		rec;
	ulint		fold;
1396
	dulint		index_id;
osku's avatar
osku committed
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
	ibool		found;
	ulint		offsets_[REC_OFFS_NORMAL_SIZE];
	mem_heap_t*	heap		= NULL;
	*offsets_ = (sizeof offsets_) / sizeof *offsets_;

	rec = btr_cur_get_rec(cursor);

	block = buf_block_align(rec);

#ifdef UNIV_SYNC_DEBUG
	ut_ad(rw_lock_own(&(block->lock), RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */

	if (!block->is_hashed) {

		return;
	}

	ut_a(block->index == cursor->index);
	ut_a(block->curr_n_fields + block->curr_n_bytes > 0);

	table = btr_search_sys->hash_index;

1420
	index_id = cursor->index->id;
osku's avatar
osku committed
1421
	fold = rec_fold(rec, rec_get_offsets(rec, cursor->index, offsets_,
1422
					     ULINT_UNDEFINED, &heap),
1423
			block->curr_n_fields, block->curr_n_bytes, index_id);
osku's avatar
osku committed
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}
	rw_lock_x_lock(&btr_search_latch);

	found = ha_search_and_delete_if_found(table, fold, rec);

	rw_lock_x_unlock(&btr_search_latch);
}

/************************************************************************
Updates the page hash index when a single record is inserted on a page. */

void
btr_search_update_hash_node_on_insert(
/*==================================*/
	btr_cur_t*	cursor)	/* in: cursor which was positioned to the
				place to insert using btr_cur_search_...,
				and the new record has been inserted next
				to the cursor */
{
	hash_table_t*	table;
	buf_block_t*	block;
	rec_t*		rec;

	rec = btr_cur_get_rec(cursor);

	block = buf_block_align(rec);

#ifdef UNIV_SYNC_DEBUG
	ut_ad(rw_lock_own(&(block->lock), RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */

	if (!block->is_hashed) {

		return;
	}

	ut_a(block->index == cursor->index);

	rw_lock_x_lock(&btr_search_latch);

	if ((cursor->flag == BTR_CUR_HASH)
1467 1468
	    && (cursor->n_fields == block->curr_n_fields)
	    && (cursor->n_bytes == block->curr_n_bytes)
1469
	    && !block->curr_left_side) {
1470 1471

		table = btr_search_sys->hash_index;
osku's avatar
osku committed
1472

1473
		ha_search_and_update_if_found(table, cursor->fold, rec,
1474
					      page_rec_get_next(rec));
osku's avatar
osku committed
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494

		rw_lock_x_unlock(&btr_search_latch);
	} else {
		rw_lock_x_unlock(&btr_search_latch);

		btr_search_update_hash_on_insert(cursor);
	}
}

/************************************************************************
Updates the page hash index when a single record is inserted on a page. */

void
btr_search_update_hash_on_insert(
/*=============================*/
	btr_cur_t*	cursor)	/* in: cursor which was positioned to the
				place to insert using btr_cur_search_...,
				and the new record has been inserted next
				to the cursor */
{
1495
	hash_table_t*	table;
osku's avatar
osku committed
1496 1497 1498 1499
	buf_block_t*	block;
	rec_t*		rec;
	rec_t*		ins_rec;
	rec_t*		next_rec;
1500
	dulint		index_id;
osku's avatar
osku committed
1501 1502 1503 1504 1505
	ulint		fold;
	ulint		ins_fold;
	ulint		next_fold = 0; /* remove warning (??? bug ???) */
	ulint		n_fields;
	ulint		n_bytes;
1506
	ibool		left_side;
osku's avatar
osku committed
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
	ibool		locked		= FALSE;
	mem_heap_t*	heap		= NULL;
	ulint		offsets_[REC_OFFS_NORMAL_SIZE];
	ulint*		offsets		= offsets_;
	*offsets_ = (sizeof offsets_) / sizeof *offsets_;

	table = btr_search_sys->hash_index;

	btr_search_check_free_space_in_heap();

	rec = btr_cur_get_rec(cursor);

	block = buf_block_align(rec);

#ifdef UNIV_SYNC_DEBUG
	ut_ad(rw_lock_own(&(block->lock), RW_LOCK_EX));
#endif /* UNIV_SYNC_DEBUG */
1524

osku's avatar
osku committed
1525 1526 1527 1528 1529 1530 1531
	if (!block->is_hashed) {

		return;
	}

	ut_a(block->index == cursor->index);

1532
	index_id = cursor->index->id;
osku's avatar
osku committed
1533 1534 1535

	n_fields = block->curr_n_fields;
	n_bytes = block->curr_n_bytes;
1536
	left_side = block->curr_left_side;
osku's avatar
osku committed
1537 1538 1539 1540 1541

	ins_rec = page_rec_get_next(rec);
	next_rec = page_rec_get_next(ins_rec);

	offsets = rec_get_offsets(ins_rec, cursor->index, offsets,
1542
				  ULINT_UNDEFINED, &heap);
1543
	ins_fold = rec_fold(ins_rec, offsets, n_fields, n_bytes, index_id);
osku's avatar
osku committed
1544 1545 1546

	if (!page_rec_is_supremum(next_rec)) {
		offsets = rec_get_offsets(next_rec, cursor->index, offsets,
1547
					  n_fields + (n_bytes > 0), &heap);
osku's avatar
osku committed
1548
		next_fold = rec_fold(next_rec, offsets, n_fields,
1549
				     n_bytes, index_id);
osku's avatar
osku committed
1550 1551 1552 1553
	}

	if (!page_rec_is_infimum(rec)) {
		offsets = rec_get_offsets(rec, cursor->index, offsets,
1554
					  n_fields + (n_bytes > 0), &heap);
1555
		fold = rec_fold(rec, offsets, n_fields, n_bytes, index_id);
osku's avatar
osku committed
1556
	} else {
1557
		if (left_side) {
osku's avatar
osku committed
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568

			rw_lock_x_lock(&btr_search_latch);

			locked = TRUE;

			ha_insert_for_fold(table, ins_fold, ins_rec);
		}

		goto check_next_rec;
	}

1569 1570 1571
	if (fold != ins_fold) {

		if (!locked) {
osku's avatar
osku committed
1572 1573 1574 1575 1576 1577

			rw_lock_x_lock(&btr_search_latch);

			locked = TRUE;
		}

1578
		if (!left_side) {
osku's avatar
osku committed
1579 1580 1581 1582 1583 1584 1585 1586 1587
			ha_insert_for_fold(table, fold, rec);
		} else {
			ha_insert_for_fold(table, ins_fold, ins_rec);
		}
	}

check_next_rec:
	if (page_rec_is_supremum(next_rec)) {

1588
		if (!left_side) {
osku's avatar
osku committed
1589

1590
			if (!locked) {
osku's avatar
osku committed
1591 1592 1593 1594
				rw_lock_x_lock(&btr_search_latch);

				locked = TRUE;
			}
1595

osku's avatar
osku committed
1596 1597 1598 1599 1600
			ha_insert_for_fold(table, ins_fold, ins_rec);
		}

		goto function_exit;
	}
1601

osku's avatar
osku committed
1602 1603
	if (ins_fold != next_fold) {

1604 1605
		if (!locked) {

osku's avatar
osku committed
1606 1607 1608 1609 1610
			rw_lock_x_lock(&btr_search_latch);

			locked = TRUE;
		}

1611
		if (!left_side) {
osku's avatar
osku committed
1612 1613

			ha_insert_for_fold(table, ins_fold, ins_rec);
1614
			/*
osku's avatar
osku committed
1615 1616 1617
			fputs("Hash insert for ", stderr);
			dict_index_name_print(stderr, cursor->index);
			fprintf(stderr, " fold %lu\n", ins_fold);
1618
			*/
osku's avatar
osku committed
1619 1620 1621
		} else {
			ha_insert_for_fold(table, next_fold, next_rec);
		}
1622 1623
	}

osku's avatar
osku committed
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
function_exit:
	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}
	if (locked) {
		rw_lock_x_unlock(&btr_search_latch);
	}
}

/************************************************************************
Validates the search system. */

ibool
btr_search_validate(void)
/*=====================*/
				/* out: TRUE if ok */
{
	buf_block_t*	block;
	page_t*		page;
	ha_node_t*	node;
	ulint		n_page_dumps	= 0;
	ibool		ok		= TRUE;
	ulint		i;
osku's avatar
osku committed
1647
	ulint		cell_count;
osku's avatar
osku committed
1648 1649 1650
	mem_heap_t*	heap		= NULL;
	ulint		offsets_[REC_OFFS_NORMAL_SIZE];
	ulint*		offsets		= offsets_;
osku's avatar
osku committed
1651 1652 1653 1654

	/* How many cells to check before temporarily releasing
	btr_search_latch. */
	ulint		chunk_size = 10000;
1655

1656 1657
	*offsets_ = (sizeof offsets_) / sizeof *offsets_;

osku's avatar
osku committed
1658 1659
	rw_lock_x_lock(&btr_search_latch);

osku's avatar
osku committed
1660
	cell_count = hash_get_n_cells(btr_search_sys->hash_index);
1661

osku's avatar
osku committed
1662 1663 1664 1665 1666 1667 1668 1669
	for (i = 0; i < cell_count; i++) {
		/* We release btr_search_latch every once in a while to
		give other queries a chance to run. */
		if ((i != 0) && ((i % chunk_size) == 0)) {
			rw_lock_x_unlock(&btr_search_latch);
			os_thread_yield();
			rw_lock_x_lock(&btr_search_latch);
		}
1670

osku's avatar
osku committed
1671 1672 1673 1674 1675 1676
		node = hash_get_nth_cell(btr_search_sys->hash_index, i)->node;

		while (node != NULL) {
			block = buf_block_align(node->data);
			page = buf_frame_align(node->data);
			offsets = rec_get_offsets((rec_t*) node->data,
1677 1678 1679 1680
						  block->index, offsets,
						  block->curr_n_fields
						  + (block->curr_n_bytes > 0),
						  &heap);
osku's avatar
osku committed
1681

1682 1683
			if (!block->is_hashed || node->fold
			    != rec_fold((rec_t*)(node->data),
1684 1685 1686 1687
					offsets,
					block->curr_n_fields,
					block->curr_n_bytes,
					btr_page_get_index_id(page))) {
osku's avatar
osku committed
1688 1689 1690 1691
				ok = FALSE;
				ut_print_timestamp(stderr);

				fprintf(stderr,
1692 1693 1694 1695 1696
					"  InnoDB: Error in an adaptive hash"
					" index pointer to page %lu\n"
					"InnoDB: ptr mem address %p"
					" index id %lu %lu,"
					" node fold %lu, rec fold %lu\n",
osku's avatar
osku committed
1697 1698
					(ulong) buf_frame_get_page_no(page),
					node->data,
1699 1700 1701 1702
					(ulong) ut_dulint_get_high(
						btr_page_get_index_id(page)),
					(ulong) ut_dulint_get_low(
						btr_page_get_index_id(page)),
osku's avatar
osku committed
1703 1704
					(ulong) node->fold,
					(ulong) rec_fold((rec_t*)(node->data),
1705 1706 1707
							 offsets,
							 block->curr_n_fields,
							 block->curr_n_bytes,
1708 1709
							 btr_page_get_index_id(
								 page)));
osku's avatar
osku committed
1710 1711 1712

				fputs("InnoDB: Record ", stderr);
				rec_print_new(stderr, (rec_t*)node->data,
1713
					      offsets);
osku's avatar
osku committed
1714
				fprintf(stderr, "\nInnoDB: on that page."
1715 1716 1717 1718 1719 1720
					" Page mem address %p, is hashed %lu,"
					" n fields %lu, n bytes %lu\n"
					"InnoDB: side %lu\n",
					(void*) page, (ulong) block->is_hashed,
					(ulong) block->curr_n_fields,
					(ulong) block->curr_n_bytes,
1721
					(ulong) block->curr_left_side);
osku's avatar
osku committed
1722

1723
				if (n_page_dumps < 20) {
osku's avatar
osku committed
1724 1725 1726 1727 1728 1729 1730 1731 1732
					buf_page_print(page);
					n_page_dumps++;
				}
			}

			node = node->next;
		}
	}

osku's avatar
osku committed
1733 1734
	for (i = 0; i < cell_count; i += chunk_size) {
		ulint end_index = ut_min(i + chunk_size - 1, cell_count - 1);
1735

osku's avatar
osku committed
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
		/* We release btr_search_latch every once in a while to
		give other queries a chance to run. */
		if (i != 0) {
			rw_lock_x_unlock(&btr_search_latch);
			os_thread_yield();
			rw_lock_x_lock(&btr_search_latch);
		}

		if (!ha_validate(btr_search_sys->hash_index, i, end_index)) {
			ok = FALSE;
		}
osku's avatar
osku committed
1747 1748 1749 1750 1751 1752 1753 1754 1755
	}

	rw_lock_x_unlock(&btr_search_latch);
	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}

	return(ok);
}