btr0sea.c 44.2 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
/************************************************************************
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"

22 23 24
/* Flag: has the search system been disabled? */
ibool	btr_search_disabled	= FALSE;

osku's avatar
osku committed
25 26 27 28 29 30
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;
31
#endif /* UNIV_SEARCH_PERF_STAT */
osku's avatar
osku committed
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

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 */
76
	buf_block_t*	block,	/* in: index page, s- or x-latched */
osku's avatar
osku committed
77 78 79
	ulint		n_fields,/* in: hash this many full fields */
	ulint		n_bytes,/* in: hash this many bytes from the next
				field */
80
	ibool		left_side);/* in: hash for searches from left side? */
osku's avatar
osku committed
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 106 107

/*********************************************************************
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)
/*=====================================*/
{
	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;
108

osku's avatar
osku committed
109 110 111 112 113
	/* 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) {
114
		buf_block_t*	block = buf_block_alloc(0);
osku's avatar
osku committed
115 116 117 118

		rw_lock_x_lock(&btr_search_latch);

		if (heap->free_block == NULL) {
119
			heap->free_block = block;
osku's avatar
osku committed
120
		} else {
121
			buf_block_free(block);
osku's avatar
osku committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
		}

		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 */
138

osku's avatar
osku committed
139
	btr_search_latch_temp = mem_alloc(sizeof(rw_lock_t));
140

141
	rw_lock_create(&btr_search_latch, SYNC_SEARCH_SYS);
osku's avatar
osku committed
142 143 144

	btr_search_sys = mem_alloc(sizeof(btr_search_sys_t));

145
	btr_search_sys->hash_index = ha_create(hash_size, 0, 0);
osku's avatar
osku committed
146 147 148

}

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
/************************************************************************
Disable the adaptive hash search system and empty the index. */

void
btr_search_disable(void)
/*====================*/
{
	btr_search_disabled = TRUE;
	rw_lock_x_lock(&btr_search_latch);

	ha_clear(btr_search_sys->hash_index);

	rw_lock_x_unlock(&btr_search_latch);
}

/************************************************************************
Enable the adaptive hash search system. */

void
btr_search_enable(void)
/*====================*/
{
	btr_search_disabled = FALSE;
}

osku's avatar
osku committed
174 175 176 177 178 179 180 181 182 183 184 185 186
/*********************************************************************
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));

187
#ifdef UNIV_DEBUG
osku's avatar
osku committed
188
	info->magic_n = BTR_SEARCH_MAGIC_N;
189
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
190 191 192 193 194 195 196 197

	info->root_guess = NULL;

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

	info->last_hash_succ = FALSE;

198
#ifdef UNIV_SEARCH_PERF_STAT
199 200 201 202
	info->n_hash_succ = 0;
	info->n_hash_fail = 0;
	info->n_patt_succ = 0;
	info->n_searches = 0;
203
#endif /* UNIV_SEARCH_PERF_STAT */
osku's avatar
osku committed
204 205 206 207 208

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

209
	info->left_side = TRUE;
osku's avatar
osku committed
210 211 212 213 214 215 216 217 218 219 220 221

	return(info);
}

/*************************************************************************
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
{
#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));
352 353
	ut_ad(rw_lock_own(&block->lock, RW_LOCK_SHARED)
	      || rw_lock_own(&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
#endif /* UNIV_SYNC_DEBUG */
439 440
	ut_ad(page_align(btr_cur_get_rec(cursor))
	      == buf_block_get_frame(block));
osku's avatar
osku committed
441 442 443
	ut_a(!block->is_hashed || block->index == cursor->index);

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

452 453 454
		rec = btr_cur_get_rec(cursor);

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

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

459
		index_id = cursor->index->id;
460 461 462
		fold = rec_fold(rec,
				rec_get_offsets(rec, cursor->index, offsets_,
						ULINT_UNDEFINED, &heap),
osku's avatar
osku committed
463
				block->curr_n_fields,
464
				block->curr_n_bytes, index_id);
osku's avatar
osku committed
465 466 467 468 469 470 471
		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 */

472 473
		ha_insert_for_fold(btr_search_sys->hash_index, fold,
				   block, rec);
osku's avatar
osku committed
474
	}
475 476
}

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

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

osku's avatar
osku committed
491 492 493 494 495
#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 */

496
	block = btr_cur_get_block(cursor);
osku's avatar
osku committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510

	/* 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();
	}
511

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

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

		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;
538
		params[2] = block->left_side;
osku's avatar
osku committed
539 540 541 542 543

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

		params2 = params + btr_search_this_is_zero;
544

osku's avatar
osku committed
545
		btr_search_build_page_hash_index(cursor->index,
546
						 block,
547 548 549
						 params2[0],
						 params2[1],
						 params2[2]);
osku's avatar
osku committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563
		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 */
564 565
	ibool		can_only_compare_to_cursor_rec,
				/* in: if we do not have a latch on the page
osku's avatar
osku committed
566
				of cursor, but only a latch on
567
				btr_search_latch, then ONLY the columns
osku's avatar
osku committed
568 569 570 571
				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! */
572
	const dtuple_t*	tuple,	/* in: data tuple */
osku's avatar
osku committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
	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);
589

osku's avatar
osku committed
590 591 592 593 594 595 596 597
	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,
598
				  n_unique, &heap);
osku's avatar
osku committed
599
	cmp = page_cmp_dtuple_rec_with_match(tuple, rec,
600
					     offsets, &match, &bytes);
osku's avatar
osku committed
601 602 603 604 605 606 607 608 609 610 611

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

		cursor->up_match = match;

		if (match >= n_unique) {
			success = TRUE;
			goto exit_func;
612
		}
osku's avatar
osku committed
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
	} 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) {
631 632
		/* 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
633 634 635 636 637 638 639 640 641 642
		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));
643

osku's avatar
osku committed
644 645 646
		prev_rec = page_rec_get_prev(rec);

		if (page_rec_is_infimum(prev_rec)) {
647 648
			success = btr_page_get_prev(page_align(prev_rec), mtr)
				== FIL_NULL;
osku's avatar
osku committed
649 650 651 652 653

			goto exit_func;
		}

		offsets = rec_get_offsets(prev_rec, cursor->index, offsets,
654
					  n_unique, &heap);
osku's avatar
osku committed
655
		cmp = page_cmp_dtuple_rec_with_match(tuple, prev_rec,
656
						     offsets, &match, &bytes);
osku's avatar
osku committed
657 658 659 660 661 662 663 664 665 666 667
		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));
668

osku's avatar
osku committed
669 670 671
		next_rec = page_rec_get_next(rec);

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

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

			goto exit_func;
		}

		offsets = rec_get_offsets(next_rec, cursor->index, offsets,
683
					  n_unique, &heap);
osku's avatar
osku committed
684
		cmp = page_cmp_dtuple_rec_with_match(tuple, next_rec,
685
						     offsets, &match, &bytes);
osku's avatar
osku committed
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
		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(
/*=====================*/
709
					/* out: TRUE if succeeded */
osku's avatar
osku committed
710 711
	dict_index_t*	index,		/* in: index */
	btr_search_t*	info,		/* in: index search info */
712
	const dtuple_t*	tuple,		/* in: logical record */
osku's avatar
osku committed
713
	ulint		mode,		/* in: PAGE_CUR_L, ... */
714
	ulint		latch_mode,	/* in: BTR_SEARCH_LEAF, ...;
osku's avatar
osku committed
715 716 717 718 719
					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! */
720
	btr_cur_t*	cursor,		/* out: tree cursor */
osku's avatar
osku committed
721 722 723 724 725 726 727
	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;
728
	const page_t*	page;
osku's avatar
osku committed
729 730
	ulint		fold;
	ulint		tuple_n_fields;
731
	dulint		index_id;
732
	ibool		can_only_compare_to_cursor_rec = TRUE;
osku's avatar
osku committed
733 734 735 736 737 738
#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)
739
	      || (latch_mode == BTR_MODIFY_LEAF));
osku's avatar
osku committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759

	/* 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)
760
	    && (cursor->n_bytes > 0)) {
osku's avatar
osku committed
761

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

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

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

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

osku's avatar
osku committed
775 776 777 778 779 780 781 782 783 784 785 786 787
	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;
	}

788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
	page = page_align((rec_t*) rec);
	{
		ulint	page_no		= page_get_page_no(page);
		ulint	space_id	= page_get_space_id(page);

		mutex_enter(&buf_pool->mutex);
		block = buf_page_hash_get(space_id, page_no);
		mutex_exit(&buf_pool->mutex);
	}

	if (UNIV_UNLIKELY(!block)) {

		/* The block is most probably being freed.
		The function buf_LRU_search_and_free_block()
		first removes the block from buf_pool->page_hash
		by calling buf_LRU_block_remove_hashed_page().
		After that, it invokes btr_search_drop_page_hash_index().
		Let us pretend that the block was also removed from
		the adaptive hash index. */
		goto failure_unlock;
	}
osku's avatar
osku committed
809 810 811

	if (UNIV_LIKELY(!has_search_latch)) {

812
		if (UNIV_UNLIKELY(
813
			    !buf_page_get_known_nowait(latch_mode, block,
814 815 816
						       BUF_MAKE_YOUNG,
						       __FILE__, __LINE__,
						       mtr))) {
osku's avatar
osku committed
817 818 819 820 821 822 823
			goto failure_unlock;
		}

		rw_lock_s_unlock(&btr_search_latch);
		can_only_compare_to_cursor_rec = FALSE;

#ifdef UNIV_SYNC_DEBUG
824
		buf_block_dbg_add_level(block, SYNC_TREE_NODE_FROM_HASH);
osku's avatar
osku committed
825 826 827
#endif /* UNIV_SYNC_DEBUG */
	}

828 829
	if (UNIV_UNLIKELY(buf_block_get_state(block)
			  == BUF_BLOCK_REMOVE_HASH)) {
osku's avatar
osku committed
830
		if (UNIV_LIKELY(!has_search_latch)) {
831

832
			btr_leaf_page_release(block, latch_mode, mtr);
osku's avatar
osku committed
833 834 835 836 837
		}

		goto failure;
	}

838
	ut_ad(buf_block_get_state(block) == BUF_BLOCK_FILE_PAGE);
osku's avatar
osku committed
839 840
	ut_ad(page_rec_is_user_rec(rec));

841
	btr_cur_position(index, rec, block, cursor);
osku's avatar
osku committed
842 843 844 845 846 847 848 849

	/* 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. */
850 851
	if (UNIV_EXPECT(
		    ut_dulint_cmp(index_id, btr_page_get_index_id(page)), 0)
852 853 854
	    || !btr_search_check_guess(cursor,
				       can_only_compare_to_cursor_rec,
				       tuple, mode, mtr)) {
osku's avatar
osku committed
855
		if (UNIV_LIKELY(!has_search_latch)) {
856
			btr_leaf_page_release(block, latch_mode, mtr);
osku's avatar
osku committed
857 858 859 860 861 862
		}

		goto failure;
	}

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

osku's avatar
osku committed
864 865 866 867 868 869
		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: */
870

osku's avatar
osku committed
871 872 873 874
	info->last_hash_succ = FALSE;

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

876
	btr_leaf_page_release(block, latch_mode, mtr);
osku's avatar
osku committed
877 878

	btr_cur_search_to_nth_level(index, 0, tuple, mode, latch_mode,
879
				    &cursor2, 0, mtr);
osku's avatar
osku committed
880
	if (mode == PAGE_CUR_GE
881
	    && page_rec_is_supremum(btr_cur_get_rec(&cursor2))) {
osku's avatar
osku committed
882 883 884 885

		/* 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 */
886

osku's avatar
osku committed
887 888 889
		info->last_hash_succ = FALSE;

		btr_pcur_open_on_user_rec(index, tuple, mode, latch_mode,
890
					  &pcur, mtr);
osku's avatar
osku committed
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
		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)
906
	    && buf_block_peek_if_too_old(block)) {
osku's avatar
osku committed
907

908
		buf_page_make_young(block);
909
	}
osku's avatar
osku committed
910 911 912 913 914 915

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

	buf_pool->n_page_gets++;

916
	return(TRUE);
osku's avatar
osku committed
917 918 919 920 921 922 923 924 925 926

	/*-------------------------------------------*/
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
927 928
	info->n_hash_fail++;

osku's avatar
osku committed
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
	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(
/*============================*/
944 945 946 947
	buf_block_t*	block)	/* in: block containing 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
948 949 950 951
{
	hash_table_t*	table;
	ulint		n_fields;
	ulint		n_bytes;
952
	page_t*		page;
osku's avatar
osku committed
953 954 955
	rec_t*		rec;
	ulint		fold;
	ulint		prev_fold;
956
	dulint		index_id;
osku's avatar
osku committed
957 958 959 960 961
	ulint		n_cached;
	ulint		n_recs;
	ulint*		folds;
	ulint		i;
	mem_heap_t*	heap;
962
	dict_index_t*	index;
osku's avatar
osku committed
963 964 965 966 967 968
	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 */
969

970
retry:
osku's avatar
osku committed
971
	rw_lock_s_lock(&btr_search_latch);
972
	page = block->frame;
osku's avatar
osku committed
973

974
	if (UNIV_LIKELY(!block->is_hashed)) {
osku's avatar
osku committed
975 976 977 978 979 980 981 982 983 984

		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)
985 986
	      || rw_lock_own(&(block->lock), RW_LOCK_EX)
	      || (block->buf_fix_count == 0));
osku's avatar
osku committed
987 988 989 990
#endif /* UNIV_SYNC_DEBUG */

	n_fields = block->curr_n_fields;
	n_bytes = block->curr_n_bytes;
991
	index = block->index;
osku's avatar
osku committed
992

993 994 995
	/* 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
996 997

	rw_lock_s_unlock(&btr_search_latch);
998

999 1000
	ut_a(n_fields + n_bytes > 0);

osku's avatar
osku committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
	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);

1013
	index_id = btr_page_get_index_id(page);
1014

1015
	ut_a(0 == ut_dulint_cmp(index_id, index->id));
1016

osku's avatar
osku committed
1017 1018 1019 1020 1021 1022
	prev_fold = 0;

	heap = NULL;
	offsets = NULL;

	while (!page_rec_is_supremum(rec)) {
1023
		offsets = rec_get_offsets(rec, index, offsets,
1024
					  n_fields + (n_bytes > 0), &heap);
1025
		ut_a(rec_offs_n_fields(offsets) == n_fields + (n_bytes > 0));
1026
		fold = rec_fold(rec, offsets, n_fields, n_bytes, index_id);
osku's avatar
osku committed
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048

		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);

1049 1050 1051 1052 1053 1054 1055 1056 1057
	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)
1058
	    || UNIV_UNLIKELY(block->curr_n_bytes != n_bytes)) {
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068

		/* 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
1069 1070
	for (i = 0; i < n_cached; i++) {

1071
		ha_remove_all_nodes_to_page(table, folds[i], page);
osku's avatar
osku committed
1072 1073 1074 1075
	}

	block->is_hashed = FALSE;
	block->index = NULL;
1076
cleanup:
1077
#ifdef UNIV_DEBUG
1078 1079 1080 1081
	if (UNIV_UNLIKELY(block->n_pointers)) {
		/* Corruption */
		ut_print_timestamp(stderr);
		fprintf(stderr,
1082 1083 1084 1085
			"  InnoDB: Corruption of adaptive hash index."
			" After dropping\n"
			"InnoDB: the hash index to a page of %s,"
			" still %lu hash nodes remain.\n",
1086 1087
			index->name, (ulong) block->n_pointers);
		rw_lock_x_unlock(&btr_search_latch);
osku's avatar
osku committed
1088

1089 1090 1091 1092
		btr_search_validate();
	} else {
		rw_lock_x_unlock(&btr_search_latch);
	}
1093 1094 1095
#else /* UNIV_DEBUG */
	rw_lock_x_unlock(&btr_search_latch);
#endif /* UNIV_DEBUG */
osku's avatar
osku committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109

	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 */
{
1110 1111
	buf_block_t*	block;
	mtr_t		mtr;
osku's avatar
osku committed
1112

1113
	if (!buf_page_peek_if_search_hashed(space, page_no)) {
osku's avatar
osku committed
1114 1115 1116

		return;
	}
1117

osku's avatar
osku committed
1118 1119 1120 1121 1122 1123
	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. */
1124

1125
	block = buf_page_get_gen(space, page_no, RW_S_LATCH, NULL,
osku's avatar
osku committed
1126 1127 1128 1129
				BUF_GET_IF_IN_POOL, __FILE__, __LINE__,
				&mtr);

#ifdef UNIV_SYNC_DEBUG
1130
	buf_block_dbg_add_level(block, SYNC_TREE_NODE_FROM_HASH);
osku's avatar
osku committed
1131 1132
#endif /* UNIV_SYNC_DEBUG */

1133
	btr_search_drop_page_hash_index(block);
osku's avatar
osku committed
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147

	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 */
1148
	buf_block_t*	block,	/* in: index page, s- or x-latched */
osku's avatar
osku committed
1149 1150 1151
	ulint		n_fields,/* in: hash this many full fields */
	ulint		n_bytes,/* in: hash this many bytes from the next
				field */
1152
	ibool		left_side)/* in: hash for searches from left side? */
osku's avatar
osku committed
1153 1154
{
	hash_table_t*	table;
1155
	page_t*		page;
osku's avatar
osku committed
1156 1157 1158 1159
	rec_t*		rec;
	rec_t*		next_rec;
	ulint		fold;
	ulint		next_fold;
1160
	dulint		index_id;
osku's avatar
osku committed
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
	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);

	table = btr_search_sys->hash_index;
1174
	page = buf_block_get_frame(block);
osku's avatar
osku committed
1175 1176 1177 1178

#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)
1179
	      || rw_lock_own(&(block->lock), RW_LOCK_EX));
osku's avatar
osku committed
1180 1181 1182
#endif /* UNIV_SYNC_DEBUG */

	rw_lock_s_lock(&btr_search_latch);
1183

osku's avatar
osku committed
1184
	if (block->is_hashed && ((block->curr_n_fields != n_fields)
1185
				 || (block->curr_n_bytes != n_bytes)
1186
				 || (block->curr_left_side != left_side))) {
osku's avatar
osku committed
1187 1188 1189

		rw_lock_s_unlock(&btr_search_latch);

1190
		btr_search_drop_page_hash_index(block);
osku's avatar
osku committed
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
	} 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 */
1203

osku's avatar
osku committed
1204 1205 1206 1207 1208 1209
	if (n_fields + n_bytes == 0) {

		return;
	}

	if (dict_index_get_n_unique_in_tree(index) < n_fields
1210 1211
	    || (dict_index_get_n_unique_in_tree(index) == n_fields
		&& n_bytes > 0)) {
osku's avatar
osku committed
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
		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;

1223
	index_id = btr_page_get_index_id(page);
osku's avatar
osku committed
1224

1225
	rec = page_rec_get_next(page_get_infimum_rec(page));
osku's avatar
osku committed
1226 1227

	offsets = rec_get_offsets(rec, index, offsets,
1228
				  n_fields + (n_bytes > 0), &heap);
osku's avatar
osku committed
1229 1230 1231 1232 1233 1234 1235 1236 1237

	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));
		}
	}

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

1240
	if (left_side) {
osku's avatar
osku committed
1241 1242 1243 1244 1245

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

osku's avatar
osku committed
1247 1248 1249 1250 1251
	for (;;) {
		next_rec = page_rec_get_next(rec);

		if (page_rec_is_supremum(next_rec)) {

1252
			if (!left_side) {
1253

osku's avatar
osku committed
1254 1255 1256 1257 1258
				folds[n_cached] = fold;
				recs[n_cached] = rec;
				n_cached++;
			}

1259
			break;
osku's avatar
osku committed
1260 1261 1262
		}

		offsets = rec_get_offsets(next_rec, index, offsets,
1263
					  n_fields + (n_bytes > 0), &heap);
osku's avatar
osku committed
1264
		next_fold = rec_fold(next_rec, offsets, n_fields,
1265
				     n_bytes, index_id);
osku's avatar
osku committed
1266 1267 1268 1269

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

1270
			if (left_side) {
osku's avatar
osku committed
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290

				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)
1291
				 || (block->curr_n_bytes != n_bytes)
1292
				 || (block->curr_left_side != left_side))) {
osku's avatar
osku committed
1293 1294
		goto exit_func;
	}
1295

osku's avatar
osku committed
1296 1297
	block->is_hashed = TRUE;
	block->n_hash_helps = 0;
1298

osku's avatar
osku committed
1299 1300
	block->curr_n_fields = n_fields;
	block->curr_n_bytes = n_bytes;
1301
	block->curr_left_side = left_side;
osku's avatar
osku committed
1302 1303 1304
	block->index = index;

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

1306
		ha_insert_for_fold(table, folds[i], block, recs[i]);
osku's avatar
osku committed
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
	}

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(
/*===================================*/
1328
	buf_block_t*	new_block,	/* in: records are copied
osku's avatar
osku committed
1329
					to this page */
1330
	buf_block_t*	block,		/* in: index page from which
osku's avatar
osku committed
1331 1332 1333 1334 1335
					records were copied, and the
					copied records will be deleted
					from this page */
	dict_index_t*	index)		/* in: record descriptor */
{
1336 1337 1338
	ulint	n_fields;
	ulint	n_bytes;
	ibool	left_side;
osku's avatar
osku committed
1339 1340 1341 1342 1343 1344 1345 1346 1347

#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);
1348

osku's avatar
osku committed
1349 1350 1351 1352
	if (new_block->is_hashed) {

		rw_lock_s_unlock(&btr_search_latch);

1353
		btr_search_drop_page_hash_index(block);
osku's avatar
osku committed
1354 1355 1356 1357 1358 1359 1360 1361

		return;
	}

	if (block->is_hashed) {

		n_fields = block->curr_n_fields;
		n_bytes = block->curr_n_bytes;
1362
		left_side = block->curr_left_side;
osku's avatar
osku committed
1363 1364 1365

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

		rw_lock_s_unlock(&btr_search_latch);

		ut_a(n_fields + n_bytes > 0);

1372
		btr_search_build_page_hash_index(index, new_block, n_fields,
1373
						 n_bytes, left_side);
1374 1375 1376
		ut_ad(n_fields == block->curr_n_fields);
		ut_ad(n_bytes == block->curr_n_bytes);
		ut_ad(left_side == block->curr_left_side);
osku's avatar
osku committed
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
		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;
1397
	dulint		index_id;
osku's avatar
osku committed
1398 1399 1400 1401 1402 1403 1404
	ibool		found;
	ulint		offsets_[REC_OFFS_NORMAL_SIZE];
	mem_heap_t*	heap		= NULL;
	*offsets_ = (sizeof offsets_) / sizeof *offsets_;

	rec = btr_cur_get_rec(cursor);

1405
	block = btr_cur_get_block(cursor);
osku's avatar
osku committed
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420

#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;

1421
	index_id = cursor->index->id;
osku's avatar
osku committed
1422
	fold = rec_fold(rec, rec_get_offsets(rec, cursor->index, offsets_,
1423
					     ULINT_UNDEFINED, &heap),
1424
			block->curr_n_fields, block->curr_n_bytes, index_id);
osku's avatar
osku committed
1425 1426 1427 1428 1429
	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}
	rw_lock_x_lock(&btr_search_latch);

1430
	found = ha_search_and_delete_if_found(table, fold, rec);
osku's avatar
osku committed
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451

	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);

1452
	block = btr_cur_get_block(cursor);
osku's avatar
osku committed
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467

#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)
1468 1469
	    && (cursor->n_fields == block->curr_n_fields)
	    && (cursor->n_bytes == block->curr_n_bytes)
1470
	    && !block->curr_left_side) {
1471 1472

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

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

		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 */
{
1496
	hash_table_t*	table;
osku's avatar
osku committed
1497 1498 1499 1500
	buf_block_t*	block;
	rec_t*		rec;
	rec_t*		ins_rec;
	rec_t*		next_rec;
1501
	dulint		index_id;
osku's avatar
osku committed
1502 1503 1504 1505 1506
	ulint		fold;
	ulint		ins_fold;
	ulint		next_fold = 0; /* remove warning (??? bug ???) */
	ulint		n_fields;
	ulint		n_bytes;
1507
	ibool		left_side;
osku's avatar
osku committed
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
	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);

1520
	block = btr_cur_get_block(cursor);
osku's avatar
osku committed
1521 1522 1523 1524

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

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

		return;
	}

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

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

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

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

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

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

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

			rw_lock_x_lock(&btr_search_latch);

			locked = TRUE;

1564
			ha_insert_for_fold(table, ins_fold, block, ins_rec);
osku's avatar
osku committed
1565 1566 1567 1568 1569
		}

		goto check_next_rec;
	}

1570 1571 1572
	if (fold != ins_fold) {

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

			rw_lock_x_lock(&btr_search_latch);

			locked = TRUE;
		}

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

check_next_rec:
	if (page_rec_is_supremum(next_rec)) {

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

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

				locked = TRUE;
			}
1596

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

		goto function_exit;
	}
1602

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

1605 1606
		if (!locked) {

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

			locked = TRUE;
		}

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

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

osku's avatar
osku committed
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
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;
1648
	ulint		cell_count;
osku's avatar
osku committed
1649 1650 1651
	mem_heap_t*	heap		= NULL;
	ulint		offsets_[REC_OFFS_NORMAL_SIZE];
	ulint*		offsets		= offsets_;
1652 1653 1654 1655

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

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

osku's avatar
osku committed
1659
	rw_lock_x_lock(&btr_search_latch);
1660
	mutex_enter(&buf_pool->mutex);
osku's avatar
osku committed
1661

1662
	cell_count = hash_get_n_cells(btr_search_sys->hash_index);
1663

1664 1665 1666 1667
	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)) {
1668
			mutex_exit(&buf_pool->mutex);
1669 1670 1671
			rw_lock_x_unlock(&btr_search_latch);
			os_thread_yield();
			rw_lock_x_lock(&btr_search_latch);
1672
			mutex_enter(&buf_pool->mutex);
1673
		}
1674

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

1677
		for (; node != NULL; node = node->next) {
1678
			page = page_align(node->data);
1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
			{
				ulint	page_no	= page_get_page_no(page);
				ulint	space_id= page_get_space_id(page);

				block = buf_page_hash_get(space_id, page_no);
			}

			if (UNIV_UNLIKELY(!block)) {

				/* The block is most probably being freed.
				The function buf_LRU_search_and_free_block()
				first removes the block from
				buf_pool->page_hash by calling
				buf_LRU_block_remove_hashed_page().
				After that, it invokes
				btr_search_drop_page_hash_index().
				Let us pretend that the block was also removed
				from the adaptive hash index. */
				continue;
			}

osku's avatar
osku committed
1700
			offsets = rec_get_offsets((rec_t*) node->data,
1701 1702 1703 1704
						  block->index, offsets,
						  block->curr_n_fields
						  + (block->curr_n_bytes > 0),
						  &heap);
osku's avatar
osku committed
1705

1706 1707
			if (!block->is_hashed || node->fold
			    != rec_fold((rec_t*)(node->data),
1708 1709 1710 1711
					offsets,
					block->curr_n_fields,
					block->curr_n_bytes,
					btr_page_get_index_id(page))) {
osku's avatar
osku committed
1712 1713 1714 1715
				ok = FALSE;
				ut_print_timestamp(stderr);

				fprintf(stderr,
1716 1717 1718 1719 1720
					"  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",
1721
					(ulong) page_get_page_no(page),
osku's avatar
osku committed
1722
					node->data,
1723 1724 1725 1726
					(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
1727 1728
					(ulong) node->fold,
					(ulong) rec_fold((rec_t*)(node->data),
1729 1730 1731
							 offsets,
							 block->curr_n_fields,
							 block->curr_n_bytes,
1732 1733
							 btr_page_get_index_id(
								 page)));
osku's avatar
osku committed
1734 1735 1736

				fputs("InnoDB: Record ", stderr);
				rec_print_new(stderr, (rec_t*)node->data,
1737
					      offsets);
osku's avatar
osku committed
1738
				fprintf(stderr, "\nInnoDB: on that page."
1739 1740 1741 1742 1743 1744
					" 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,
1745
					(ulong) block->curr_left_side);
osku's avatar
osku committed
1746

1747
				if (n_page_dumps < 20) {
1748
					buf_page_print(page, 0);
osku's avatar
osku committed
1749 1750 1751 1752 1753 1754
					n_page_dumps++;
				}
			}
		}
	}

1755 1756
	for (i = 0; i < cell_count; i += chunk_size) {
		ulint end_index = ut_min(i + chunk_size - 1, cell_count - 1);
1757

1758 1759 1760
		/* We release btr_search_latch every once in a while to
		give other queries a chance to run. */
		if (i != 0) {
1761
			mutex_exit(&buf_pool->mutex);
1762 1763 1764
			rw_lock_x_unlock(&btr_search_latch);
			os_thread_yield();
			rw_lock_x_lock(&btr_search_latch);
1765
			mutex_enter(&buf_pool->mutex);
1766 1767 1768 1769 1770
		}

		if (!ha_validate(btr_search_sys->hash_index, i, end_index)) {
			ok = FALSE;
		}
osku's avatar
osku committed
1771 1772
	}

1773
	mutex_exit(&buf_pool->mutex);
osku's avatar
osku committed
1774 1775 1776 1777 1778 1779 1780
	rw_lock_x_unlock(&btr_search_latch);
	if (UNIV_LIKELY_NULL(heap)) {
		mem_heap_free(heap);
	}

	return(ok);
}