btr0sea.h

Go to the documentation of this file.

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

Copyright (c) 1996, 2011, Oracle and/or its affiliates. All Rights Reserved.

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

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA

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

/********************************************************************/
#ifndef btr0sea_h
#define btr0sea_h

#include "univ.i"

#include "rem0rec.h"
#include "dict0dict.h"
#include "btr0types.h"
#include "mtr0mtr.h"
#include "ha0ha.h"

/*****************************************************************/
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);
#if defined UNIV_AHI_DEBUG || defined UNIV_DEBUG
/********************************************************************/
UNIV_INTERN
ibool
btr_search_validate(void);
/*======================*/
#else
# define btr_search_validate()  TRUE
#endif /* defined UNIV_AHI_DEBUG || defined UNIV_DEBUG */

struct btr_search_t{
        ulint   ref_count;      
        /* @{ The following fields are not protected by any latch.
        Unfortunately, this means that they must be aligned to
        the machine word, i.e., they cannot be turned into bit-fields. */
        buf_block_t* root_guess;
        ulint   hash_analysis;  
        ibool   last_hash_succ; 
        ulint   n_hash_potential;
        /* @} */
        /*---------------------- @{ */
        ulint   n_fields;       
        ulint   n_bytes;        
        ibool   left_side;      
        /*---------------------- @} */
#ifdef UNIV_SEARCH_PERF_STAT
        ulint   n_hash_succ;    
        ulint   n_hash_fail;    
        ulint   n_patt_succ;    
        ulint   n_searches;     
#endif /* UNIV_SEARCH_PERF_STAT */
#ifdef UNIV_DEBUG
        ulint   magic_n;        
# define BTR_SEARCH_MAGIC_N     1112765
#endif /* UNIV_DEBUG */
};

struct btr_search_sys_t{
        hash_table_t*   hash_index;     
};

extern btr_search_sys_t*        btr_search_sys;

#ifdef UNIV_SEARCH_PERF_STAT

extern ulint    btr_search_n_succ;
extern ulint    btr_search_n_hash_fail;
#endif /* UNIV_SEARCH_PERF_STAT */

#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

#ifndef UNIV_NONINL
#include "btr0sea.ic"
#endif

#endif