buf0lru.h

Go to the documentation of this file.

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

Copyright (c) 1995, 2013, 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 buf0lru_h
#define buf0lru_h

#include "univ.i"
#ifndef UNIV_HOTBACKUP
#include "ut0byte.h"
#include "buf0types.h"

// Forward declaration
struct trx_t;

/******************************************************************/
UNIV_INTERN
ibool
buf_LRU_buf_pool_running_out(void);
/*==============================*/

/*#######################################################################
These are low-level functions
#########################################################################*/

#define BUF_LRU_OLD_MIN_LEN     512     /* 8 megabytes of 16k pages */

/******************************************************************/
UNIV_INTERN
void
buf_LRU_flush_or_remove_pages(
/*==========================*/
        ulint           id,             
        buf_remove_t    buf_remove,     
        const trx_t*    trx);           
#if defined UNIV_DEBUG || defined UNIV_BUF_DEBUG
/********************************************************************/
UNIV_INTERN
void
buf_LRU_insert_zip_clean(
/*=====================*/
        buf_page_t*     bpage); 
#endif /* UNIV_DEBUG || UNIV_BUF_DEBUG */

/******************************************************************/
UNIV_INTERN
bool
buf_LRU_free_page(
/*==============*/
        buf_page_t*     bpage,  
        bool            zip)    
        __attribute__((nonnull));
/******************************************************************/
UNIV_INTERN
ibool
buf_LRU_scan_and_free_block(
/*========================*/
        buf_pool_t*     buf_pool,       
        ibool           scan_all)       
        __attribute__((nonnull,warn_unused_result));
/******************************************************************/
UNIV_INTERN
buf_block_t*
buf_LRU_get_free_only(
/*==================*/
        buf_pool_t*     buf_pool);      
/******************************************************************/
UNIV_INTERN
buf_block_t*
buf_LRU_get_free_block(
/*===================*/
        buf_pool_t*     buf_pool)       
        __attribute__((nonnull,warn_unused_result));
/******************************************************************/
UNIV_INTERN
ibool
buf_LRU_evict_from_unzip_LRU(
/*=========================*/
        buf_pool_t*     buf_pool);
/******************************************************************/
UNIV_INTERN
void
buf_LRU_block_free_non_file_page(
/*=============================*/
        buf_block_t*    block); 
/******************************************************************/
UNIV_INTERN
void
buf_LRU_add_block(
/*==============*/
        buf_page_t*     bpage,  
        ibool           old);   
/******************************************************************/
UNIV_INTERN
void
buf_unzip_LRU_add_block(
/*====================*/
        buf_block_t*    block,  
        ibool           old);   
/******************************************************************/
UNIV_INTERN
void
buf_LRU_make_block_young(
/*=====================*/
        buf_page_t*     bpage); 
/******************************************************************/
UNIV_INTERN
void
buf_LRU_make_block_old(
/*===================*/
        buf_page_t*     bpage); 
/**********************************************************************/
UNIV_INTERN
ulint
buf_LRU_old_ratio_update(
/*=====================*/
        uint    old_pct,
        ibool   adjust);
/********************************************************************/
UNIV_INTERN
void
buf_LRU_stat_update(void);
/*=====================*/

/******************************************************************/
UNIV_INTERN
void
buf_LRU_free_one_page(
/*==================*/
        buf_page_t*     bpage)  
        __attribute__((nonnull));

#if defined UNIV_DEBUG || defined UNIV_BUF_DEBUG
/**********************************************************************/
UNIV_INTERN
ibool
buf_LRU_validate(void);
/*==================*/
#endif /* UNIV_DEBUG || UNIV_BUF_DEBUG */
#if defined UNIV_DEBUG_PRINT || defined UNIV_DEBUG || defined UNIV_BUF_DEBUG
/**********************************************************************/
UNIV_INTERN
void
buf_LRU_print(void);
/*===============*/
#endif /* UNIV_DEBUG_PRINT || UNIV_DEBUG || UNIV_BUF_DEBUG */

#define BUF_LRU_OLD_RATIO_DIV   1024

#define BUF_LRU_OLD_RATIO_MAX   BUF_LRU_OLD_RATIO_DIV

#define BUF_LRU_OLD_RATIO_MIN   51

#if BUF_LRU_OLD_RATIO_MIN >= BUF_LRU_OLD_RATIO_MAX
# error "BUF_LRU_OLD_RATIO_MIN >= BUF_LRU_OLD_RATIO_MAX"
#endif
#if BUF_LRU_OLD_RATIO_MAX > BUF_LRU_OLD_RATIO_DIV
# error "BUF_LRU_OLD_RATIO_MAX > BUF_LRU_OLD_RATIO_DIV"
#endif

extern uint     buf_LRU_old_threshold_ms;
/* @} */

struct buf_LRU_stat_t
{
        ulint   io;     
        ulint   unzip;  
};

extern buf_LRU_stat_t   buf_LRU_stat_cur;

extern buf_LRU_stat_t   buf_LRU_stat_sum;

/********************************************************************/
#define buf_LRU_stat_inc_io() buf_LRU_stat_cur.io++
/********************************************************************/
#define buf_LRU_stat_inc_unzip() buf_LRU_stat_cur.unzip++

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

#endif /* !UNIV_HOTBACKUP */

#endif