MySQL  8.0.21
Source Code Documentation
buf0lru.h File Reference

The database buffer pool LRU replacement algorithm. More...

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

Go to the source code of this file.

Classes

struct  buf_LRU_stat_t
 Statistics for selecting the LRU list for eviction. More...
 

Macros

#define BUF_LRU_OLD_MIN_LEN   512 /* 8 megabytes of 16k pages */
 Minimum LRU list length for which the LRU_old pointer is defined. More...
 
#define buf_LRU_stat_inc_io()   buf_LRU_stat_cur.io++
 Increments the I/O counter in buf_LRU_stat_cur. More...
 
#define buf_LRU_stat_inc_unzip()   buf_LRU_stat_cur.unzip++
 Increments the page_zip_decompress() counter in buf_LRU_stat_cur. More...
 

Functions

ibool buf_LRU_buf_pool_running_out (void)
 Returns TRUE if less than 25 % of the buffer pool is available. More...
 
void buf_LRU_flush_or_remove_pages (space_id_t id, buf_remove_t buf_remove, const trx_t *trx, bool strict=true)
 Flushes all dirty pages or removes all pages belonging to a given tablespace. More...
 
void buf_LRU_insert_zip_clean (buf_page_t *bpage)
 Insert a compressed block into buf_pool->zip_clean in the LRU order. More...
 
bool buf_LRU_free_page (buf_page_t *bpage, bool zip)
 Try to free a block. More...
 
bool buf_LRU_scan_and_free_block (buf_pool_t *buf_pool, bool scan_all)
 Try to free a replaceable block. More...
 
buf_block_tbuf_LRU_get_free_only (buf_pool_t *buf_pool)
 Returns a free block from the buf_pool. More...
 
buf_block_tbuf_LRU_get_free_block (buf_pool_t *buf_pool)
 Returns a free block from the buf_pool. More...
 
ibool buf_LRU_evict_from_unzip_LRU (buf_pool_t *buf_pool)
 Determines if the unzip_LRU list should be used for evicting a victim instead of the general LRU list. More...
 
void buf_LRU_block_free_non_file_page (buf_block_t *block)
 Puts a block back to the free list. More...
 
void buf_LRU_add_block (buf_page_t *bpage, ibool old)
 Adds a block to the LRU list. More...
 
void buf_unzip_LRU_add_block (buf_block_t *block, ibool old)
 Adds a block to the LRU list of decompressed zip pages. More...
 
void buf_LRU_make_block_young (buf_page_t *bpage)
 Moves a block to the start of the LRU list. More...
 
uint buf_LRU_old_ratio_update (uint old_pct, ibool adjust)
 Updates buf_pool->LRU_old_ratio. More...
 
void buf_LRU_stat_update (void)
 Update the historical stats that we are collecting for LRU eviction policy at the end of each interval. More...
 
void buf_LRU_free_one_page (buf_page_t *bpage, bool zip, bool ignore_content)
 Remove one page from LRU list and put it to free list. More...
 
void buf_LRU_adjust_hp (buf_pool_t *buf_pool, const buf_page_t *bpage)
 Adjust LRU hazard pointers if needed. More...
 
ibool buf_LRU_validate (void)
 Validates the LRU list. More...
 
void buf_LRU_print (void)
 Prints the LRU list. More...
 

Variables

buf_LRU_stat_t buf_LRU_stat_cur
 Current operation counters. More...
 
buf_LRU_stat_t buf_LRU_stat_sum
 Running sum of past values of buf_LRU_stat_cur. More...
 

Heuristics for detecting index scan @{

#define BUF_LRU_OLD_RATIO_DIV   1024
 The denominator of buf_pool->LRU_old_ratio. More...
 
#define BUF_LRU_OLD_RATIO_MAX   BUF_LRU_OLD_RATIO_DIV
 Maximum value of buf_pool->LRU_old_ratio. More...
 
#define BUF_LRU_OLD_RATIO_MIN   51
 Minimum value of buf_pool->LRU_old_ratio. More...
 
uint buf_LRU_old_threshold_ms
 Move blocks to "new" LRU list only if the first access was at least this many milliseconds ago. More...
 

Detailed Description

The database buffer pool LRU replacement algorithm.

Created 11/5/1995 Heikki Tuuri

Macro Definition Documentation

◆ BUF_LRU_OLD_MIN_LEN

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

Minimum LRU list length for which the LRU_old pointer is defined.

◆ BUF_LRU_OLD_RATIO_DIV

#define BUF_LRU_OLD_RATIO_DIV   1024

The denominator of buf_pool->LRU_old_ratio.

◆ BUF_LRU_OLD_RATIO_MAX

#define BUF_LRU_OLD_RATIO_MAX   BUF_LRU_OLD_RATIO_DIV

Maximum value of buf_pool->LRU_old_ratio.

See also
buf_LRU_old_adjust_len
buf_pool->LRU_old_ratio_update

◆ BUF_LRU_OLD_RATIO_MIN

#define BUF_LRU_OLD_RATIO_MIN   51

Minimum value of buf_pool->LRU_old_ratio.

See also
buf_LRU_old_adjust_len
buf_pool->LRU_old_ratio_update The minimum must exceed (BUF_LRU_OLD_TOLERANCE + 5) * BUF_LRU_OLD_RATIO_DIV / BUF_LRU_OLD_MIN_LEN.

◆ buf_LRU_stat_inc_io

#define buf_LRU_stat_inc_io ( )    buf_LRU_stat_cur.io++

Increments the I/O counter in buf_LRU_stat_cur.

◆ buf_LRU_stat_inc_unzip

#define buf_LRU_stat_inc_unzip ( )    buf_LRU_stat_cur.unzip++

Increments the page_zip_decompress() counter in buf_LRU_stat_cur.

Function Documentation

◆ buf_LRU_add_block()

void buf_LRU_add_block ( buf_page_t bpage,
ibool  old 
)

Adds a block to the LRU list.

Please make sure that the page_size is already set when invoking the function, so that we can get correct page_size from the buffer page when adding a block into LRU in: TRUE if should be put to the old blocks in the LRU list, else put to the start; if the LRU list is very short, added to the start regardless of this parameter

Please make sure that the page_size is already set when invoking the function, so that we can get correct page_size from the buffer page when adding a block into LRU

Parameters
bpagein: control block
oldin: TRUE if should be put to the old blocks in the LRU list, else put to the start; if the LRU list is very short, the block is added to the start, regardless of this parameter

◆ buf_LRU_adjust_hp()

void buf_LRU_adjust_hp ( buf_pool_t buf_pool,
const buf_page_t bpage 
)

Adjust LRU hazard pointers if needed.

in: control block

Parameters
buf_poolin: buffer pool instance
bpagein: control block

◆ buf_LRU_block_free_non_file_page()

void buf_LRU_block_free_non_file_page ( buf_block_t block)

Puts a block back to the free list.

Parameters
[in]blockblock must not contain a file page

◆ buf_LRU_buf_pool_running_out()

ibool buf_LRU_buf_pool_running_out ( void  )

Returns TRUE if less than 25 % of the buffer pool is available.

This can be used in heuristics to prevent huge transactions eating up the whole buffer pool for their locks.

Returns
true if less than 25 % of buffer pool left

Returns TRUE if less than 25 % of the buffer pool is available.

This can be used in heuristics to prevent huge transactions eating up the whole buffer pool for their locks.

Returns
true if less than 25 % of buffer pool left

◆ buf_LRU_evict_from_unzip_LRU()

ibool buf_LRU_evict_from_unzip_LRU ( buf_pool_t buf_pool)

Determines if the unzip_LRU list should be used for evicting a victim instead of the general LRU list.

Parameters
[in,out]buf_poolbuffer pool instance
Returns
true if should use unzip_LRU

◆ buf_LRU_flush_or_remove_pages()

void buf_LRU_flush_or_remove_pages ( space_id_t  id,
buf_remove_t  buf_remove,
const trx_t trx,
bool  strict = true 
)

Flushes all dirty pages or removes all pages belonging to a given tablespace.

A PROBLEM: if readahead is being started, what guarantees that it will not try to read in pages after this operation has completed?

Parameters
[in]idtablespace ID
[in]buf_removeremove or flush strategy
[in]trxto check if the operation must be interrupted
[in]stricttrue, if no page from tablespace can be in buffer pool just after flush

◆ buf_LRU_free_one_page()

void buf_LRU_free_one_page ( buf_page_t bpage,
bool  zip,
bool  ignore_content 
)

Remove one page from LRU list and put it to free list.

The caller must hold the LRU list and block mutexes and have page hash latched in X. The latch and the block mutexes will be released.

Parameters
[in,out]bpageblock, must contain a file page and be in a state where it can be freed; there may or may not be a hash index to the page
[in]ziptrue if should remove also the compressed page of an uncompressed page
[in]ignore_contenttrue if should ignore page content, since it could be not initialized

◆ buf_LRU_free_page()

bool buf_LRU_free_page ( buf_page_t bpage,
bool  zip 
)

Try to free a block.

If bpage is a descriptor of a compressed-only page, the descriptor object will be freed as well. NOTE: this function may temporarily release and relock the buf_page_get_get_mutex(). Furthermore, the page frame will no longer be accessible via bpage. If this function returns true, it will also release the LRU list mutex. The caller must hold the LRU list and buf_page_get_mutex() mutexes.

Parameters
[in]bpageblock to be freed
[in]ziptrue if should remove also the compressed page of an uncompressed page
Returns
true if freed, false otherwise.

If bpage is a descriptor of a compressed-only page, the descriptor object will be freed as well. NOTE: this function may temporarily release and relock the buf_page_get_mutex(). Furthermore, the page frame will no longer be accessible via bpage. If this function returns true, it will also release the LRU list mutex. The caller must hold the LRU list and buf_page_get_mutex() mutexes.

Parameters
[in]bpageblock to be freed
[in]ziptrue if should remove also the compressed page of an uncompressed page
Returns
true if freed, false otherwise.

◆ buf_LRU_get_free_block()

buf_block_t* buf_LRU_get_free_block ( buf_pool_t buf_pool)

Returns a free block from the buf_pool.

The block is taken off the free list. If free list is empty, blocks are moved from the end of the LRU list to the free list. This function is called from a user thread when it needs a clean block to read in a page. Note that we only ever get a block from the free list. Even when we flush a page or find a page in LRU scan we put it to free list to be used. iteration 0: get a block from free list, success:done if buf_pool->try_LRU_scan is set scan LRU up to srv_LRU_scan_depth to find a clean block the above will put the block on free list success:retry the free list flush one dirty page from tail of LRU to disk the above will put the block on free list success: retry the free list iteration 1: same as iteration 0 except: scan whole LRU list scan LRU list even if buf_pool->try_LRU_scan is not set iteration > 1: same as iteration 1 but sleep 10ms

Parameters
[in,out]buf_poolbuffer pool instance
Returns
the free control block, in state BUF_BLOCK_READY_FOR_USE

◆ buf_LRU_get_free_only()

buf_block_t* buf_LRU_get_free_only ( buf_pool_t buf_pool)

Returns a free block from the buf_pool.

The block is taken off the free list. If it is empty, returns NULL.

Parameters
[in]buf_poolbuffer pool instance
Returns
a free control block, or NULL if the buf_block->free list is empty

◆ buf_LRU_insert_zip_clean()

void buf_LRU_insert_zip_clean ( buf_page_t bpage)

Insert a compressed block into buf_pool->zip_clean in the LRU order.

Parameters
[in]bpagepointer to the block in question

◆ buf_LRU_make_block_young()

void buf_LRU_make_block_young ( buf_page_t bpage)

Moves a block to the start of the LRU list.

Parameters
[in]bpagecontrol block

◆ buf_LRU_old_ratio_update()

uint buf_LRU_old_ratio_update ( uint  old_pct,
ibool  adjust 
)

Updates buf_pool->LRU_old_ratio.

Returns
updated old_pct in: TRUE=adjust the LRU list; FALSE=just assign buf_pool->LRU_old_ratio during the initialization of InnoDB
updated old_pct
Parameters
old_pctin: Reserve this percentage of the buffer pool for "old" blocks.
adjustin: TRUE=adjust the LRU list; FALSE=just assign buf_pool->LRU_old_ratio during the initialization of InnoDB

◆ buf_LRU_print()

void buf_LRU_print ( void  )

Prints the LRU list.

◆ buf_LRU_scan_and_free_block()

bool buf_LRU_scan_and_free_block ( buf_pool_t buf_pool,
bool  scan_all 
)

Try to free a replaceable block.

Parameters
[in,out]buf_poolbuffer pool instance
[in]scan_allscan whole LRU list if ture, otherwise scan only BUF_LRU_SEARCH_SCAN_THRESHOLD blocks
Returns
true if found and freed

◆ buf_LRU_stat_update()

void buf_LRU_stat_update ( void  )

Update the historical stats that we are collecting for LRU eviction policy at the end of each interval.

◆ buf_LRU_validate()

ibool buf_LRU_validate ( void  )

Validates the LRU list.

Returns
true

◆ buf_unzip_LRU_add_block()

void buf_unzip_LRU_add_block ( buf_block_t block,
ibool  old 
)

Adds a block to the LRU list of decompressed zip pages.

Parameters
[in]blockcontrol block
[in]oldTRUE if should be put to the end of the list, else put to the start

Variable Documentation

◆ buf_LRU_old_threshold_ms

uint buf_LRU_old_threshold_ms

Move blocks to "new" LRU list only if the first access was at least this many milliseconds ago.

Not protected by any mutex or latch.

◆ buf_LRU_stat_cur

buf_LRU_stat_t buf_LRU_stat_cur

Current operation counters.

Not protected by any mutex. Cleared by buf_LRU_stat_update().

◆ buf_LRU_stat_sum

buf_LRU_stat_t buf_LRU_stat_sum

Running sum of past values of buf_LRU_stat_cur.

Updated by buf_LRU_stat_update(). Accesses protected by memory barriers.

Updated by buf_LRU_stat_update(). Not Protected by any mutex.