#include "univ.i"
#include "rem0rec.h"
#include "dict0dict.h"
#include "btr0types.h"
#include "mtr0mtr.h"
#include "ha0ha.h"
#include "btr0sea.ic"

Include dependency graph for btr0sea.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	btr_search_t
struct	btr_search_sys_t

Macros
#define	btr_search_validate() TRUE
#define	BTR_SEARCH_HASH_ANALYSIS 17
#define	BTR_SEARCH_ON_PATTERN_LIMIT 3
#define	BTR_SEARCH_ON_HASH_LIMIT 3
#define	BTR_SEA_TIMEOUT 10000

Functions
UNIV_INTERN void	btr_search_sys_create (ulint hash_size)
UNIV_INTERN void	btr_search_sys_free (void)
UNIV_INTERN void	btr_search_disable (void)
UNIV_INTERN void	btr_search_enable (void)
UNIV_INLINE btr_search_t *	btr_search_get_info (dict_index_t *index) __attribute__((nonnull))
UNIV_INTERN btr_search_t *	btr_search_info_create (mem_heap_t *heap)
UNIV_INTERN ulint	btr_search_info_get_ref_count (btr_search_t *info)
UNIV_INLINE void	btr_search_info_update (dict_index_t index, btr_cur_t cursor)
UNIV_INTERN ibool	btr_search_guess_on_hash (dict_index_t index, btr_search_t info, const dtuple_t tuple, ulint mode, ulint latch_mode, btr_cur_t cursor, ulint has_search_latch, mtr_t *mtr)
UNIV_INTERN void	btr_search_move_or_delete_hash_entries (buf_block_t new_block, buf_block_t block, dict_index_t *index)
UNIV_INTERN void	btr_search_drop_page_hash_index (buf_block_t *block)
UNIV_INTERN void	btr_search_drop_page_hash_when_freed (ulint space, ulint zip_size, ulint page_no)
UNIV_INTERN void	btr_search_update_hash_node_on_insert (btr_cur_t *cursor)
UNIV_INTERN void	btr_search_update_hash_on_insert (btr_cur_t *cursor)
UNIV_INTERN void	btr_search_update_hash_on_delete (btr_cur_t *cursor)

Variables
btr_search_sys_t *	btr_search_sys

Detailed Description

The index tree adaptive search

Created 2/17/1996 Heikki Tuuri

Definition in file btr0sea.h.

Macro Definition Documentation

#define BTR_SEA_TIMEOUT 10000

We do this many searches before trying to keep the search latch

over calls from MySQL. If we notice someone waiting for the latch, we again set this much timeout. This is to reduce contention.

Definition at line 284 of file btr0sea.h.

#define BTR_SEARCH_HASH_ANALYSIS 17

After change in n_fields or n_bytes in info, this many rounds are waited

before starting the hash analysis again: this is to save CPU time when there is no hope in building a hash index.

Definition at line 271 of file btr0sea.h.

#define BTR_SEARCH_ON_HASH_LIMIT 3

Limit of consecutive searches for trying a search shortcut using

the hash index

Definition at line 279 of file btr0sea.h.

#define BTR_SEARCH_ON_PATTERN_LIMIT 3

Limit of consecutive searches for trying a search shortcut on the search

pattern

Definition at line 275 of file btr0sea.h.

Function Documentation

UNIV_INTERN void btr_search_disable ( void )

Disable the adaptive hash search system and empty the index.

Definition at line 228 of file btr0sea.cc.

Here is the call graph for this function:

UNIV_INTERN void btr_search_drop_page_hash_index ( buf_block_t * block )

Drops a page hash index. in: block containing index page, s- or x-latched, or an index page for which we know that block->buf_fix_count == 0

Drops a page hash index.

Parameters

block in: block containing index page, s- or x-latched, or an index page for which we know that block->buf_fix_count == 0 or it is an index page which has already been removed from the buf_pool->page_hash i.e.: it is in state BUF_BLOCK_REMOVE_HASH

Definition at line 1053 of file btr0sea.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN void btr_search_drop_page_hash_when_freed	(	ulint	space,
		ulint	zip_size,
		ulint	page_no
	)

Drops a possible page hash index when a page is evicted from the buffer pool or freed in a file segment. in: page number

Drops a possible page hash index when a page is evicted from the buffer pool or freed in a file segment.

Parameters

space	in: space id
zip_size	in: compressed page size in bytes or 0 for uncompressed pages
page_no	in: page number

Definition at line 1258 of file btr0sea.cc.

Here is the call graph for this function:

UNIV_INTERN void btr_search_enable ( void )

Enable the adaptive hash search system.

Definition at line 268 of file btr0sea.cc.

UNIV_INLINE btr_search_t* btr_search_get_info ( dict_index_t * index )

Returns search info for an index.

Returns: search info; search mutex reserved

Parameters

index in: index

Here is the caller graph for this function:

UNIV_INTERN ibool btr_search_guess_on_hash	(	dict_index_t *	index,
		btr_search_t *	info,
		const dtuple_t *	tuple,
		ulint	mode,
		ulint	latch_mode,
		btr_cur_t *	cursor,
		ulint	has_search_latch,
		mtr_t *	mtr
	)

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.

Returns: TRUE if succeeded in: mtr

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.

Returns: TRUE if succeeded

Parameters

index	in: index
info	in: index search info
tuple	in: logical record
mode	in: PAGE_CUR_L, ...
latch_mode	in: BTR_SEARCH_LEAF, ...; 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!
cursor	out: tree cursor
has_search_latch	in: latch mode the caller currently has on btr_search_latch: RW_S_LATCH, RW_X_LATCH, or 0
mtr	in: mtr

Definition at line 847 of file btr0sea.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN btr_search_t* btr_search_info_create ( mem_heap_t * heap )

Creates and initializes a search info struct.

Returns: own: search info struct in: heap where created

Creates and initializes a search info struct.

Returns: own: search info struct

Parameters

heap	in: heap where created

Definition at line 283 of file btr0sea.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN ulint btr_search_info_get_ref_count ( btr_search_t * info )

Returns the value of ref_count. The value is protected by btr_search_latch.

Returns: ref_count value. in: search info.

Returns the value of ref_count. The value is protected by btr_search_latch.

Returns: ref_count value.

Parameters

info	in: search info.

Definition at line 325 of file btr0sea.cc.

UNIV_INLINE void btr_search_info_update	(	dict_index_t *	index,
		btr_cur_t *	cursor
	)

Updates the search info. in: cursor which was just positioned

Parameters

index in: index of the cursor

Here is the caller graph for this function:

UNIV_INTERN void btr_search_move_or_delete_hash_entries	(	buf_block_t *	new_block,
		buf_block_t *	block,
		dict_index_t *	index
	)

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). in: record descriptor

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

Parameters

new_block	in: records are copied to this page
block	in: index page from which records were copied, and the copied records will be deleted from this page
index	in: record descriptor

Definition at line 1497 of file btr0sea.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN void btr_search_sys_create ( ulint hash_size )

Creates and initializes the adaptive search system at a database start. in: hash index hash table size

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

Parameters

hash_size in: hash index hash table size

Definition at line 163 of file btr0sea.cc.

Here is the caller graph for this function:

UNIV_INTERN void btr_search_sys_free ( void )

Frees the adaptive search system at a database shutdown.

Definition at line 190 of file btr0sea.cc.

Here is the call graph for this function:

UNIV_INTERN void btr_search_update_hash_node_on_insert ( btr_cur_t * cursor )

Updates the page hash index when a single record is inserted on a page. 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

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

Parameters

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

Definition at line 1624 of file btr0sea.cc.

Here is the call graph for this function:

UNIV_INTERN void btr_search_update_hash_on_delete ( btr_cur_t * cursor )

Updates the page hash index when a single record is deleted from a page. in: cursor which was positioned on the record to delete using btr_cur_search_..., the record is not yet deleted

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

Parameters

cursor in: cursor which was positioned on the record to delete using btr_cur_search_..., the record is not yet deleted

Definition at line 1561 of file btr0sea.cc.

Here is the call graph for this function:

UNIV_INTERN void btr_search_update_hash_on_insert ( btr_cur_t * cursor )

Updates the page hash index when a single record is inserted on a page. 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

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

Parameters

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

Definition at line 1689 of file btr0sea.cc.

Here is the call graph for this function: