buf0lru.h

Go to the documentation of this file.

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

Copyright (C) 1995, 2009, Innobase Oy. 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
St, Fifth Floor, Boston, MA 02110-1301 USA

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

/**************************************************/
#pragma once
#ifndef buf0lru_h
#define buf0lru_h

#include <sys/types.h>
#include "univ.i"
#include "ut0byte.h"
#include "buf0types.h"

enum buf_lru_free_block_status {
  BUF_LRU_FREED = 0,
  BUF_LRU_CANNOT_RELOCATE,
  BUF_LRU_NOT_FREED
};

/******************************************************************/
UNIV_INTERN
void
buf_LRU_try_free_flushed_blocks(
/*============================*/
  buf_pool_t* buf_pool);  
/******************************************************************/
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 */

#define BUF_LRU_FREE_SEARCH_LEN(b)  (5 + 2 * BUF_READ_AHEAD_AREA(b))

/******************************************************************/
UNIV_INTERN
void
buf_LRU_invalidate_tablespace(
/*==========================*/
  ulint id);  
/********************************************************************/
UNIV_INTERN
void
buf_LRU_insert_zip_clean(
/*=====================*/
  buf_page_t* bpage); 
/******************************************************************/
UNIV_INTERN
enum buf_lru_free_block_status
buf_LRU_free_block(
/*===============*/
  buf_page_t* bpage,  
  ibool   zip,  
  ibool*    buf_pool_mutex_released);
/******************************************************************/
UNIV_INTERN
ibool
buf_LRU_search_and_free_block(
/*==========================*/
  buf_pool_t* buf_pool, 
  ulint   n_iterations);  
/******************************************************************/
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, 
  ulint   zip_size);  
/******************************************************************/
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
bool
buf_LRU_file_dump(void);
/*===================*/

/********************************************************************/
UNIV_INTERN
bool
buf_LRU_file_restore(void);
/*======================*/

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

extern uint buf_LRU_old_ratio;
#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_struct
{
  ulint io; 
  ulint unzip;  
};

typedef struct buf_LRU_stat_struct buf_LRU_stat_t;

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