MySQL 5.6.14 Source Code Document
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ibuf0ibuf.h File Reference
#include "univ.i"
#include "mtr0mtr.h"
#include "dict0mem.h"
#include "fsp0fsp.h"
#include "ibuf0types.h"
#include "ibuf0ibuf.ic"
Include dependency graph for ibuf0ibuf.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define CHANGE_BUFFER_DEFAULT_SIZE   (25)
#define ibuf_page(space, zip_size, page_no, mtr)   ibuf_page_low(space, zip_size, page_no, __FILE__, __LINE__, mtr)
#define IBUF_HEADER_PAGE_NO   FSP_IBUF_HEADER_PAGE_NO
#define IBUF_TREE_ROOT_PAGE_NO   FSP_IBUF_TREE_ROOT_PAGE_NO
#define IBUF_HEADER   PAGE_DATA
#define IBUF_TREE_SEG_HEADER   0 /* fseg header for ibuf tree */
#define IBUF_SPACE_ID   0

Enumerations

enum  ibuf_op_t { IBUF_OP_INSERT = 0, IBUF_OP_DELETE_MARK = 1, IBUF_OP_DELETE = 2, IBUF_OP_COUNT = 3 }
enum  ibuf_use_t {
  IBUF_USE_NONE = 0, IBUF_USE_INSERT, IBUF_USE_DELETE_MARK, IBUF_USE_INSERT_DELETE_MARK,
  IBUF_USE_DELETE, IBUF_USE_ALL, IBUF_USE_COUNT
}

Functions

UNIV_INTERN void ibuf_init_at_db_start (void)
UNIV_INTERN void ibuf_max_size_update (ulint new_val)
UNIV_INTERN void ibuf_update_max_tablespace_id (void)
UNIV_INLINE void ibuf_mtr_start (mtr_t *mtr) __attribute__((nonnull))
UNIV_INLINE void ibuf_mtr_commit (mtr_t *mtr) __attribute__((nonnull))
UNIV_INTERN void ibuf_bitmap_page_init (buf_block_t *block, mtr_t *mtr)
UNIV_INTERN void ibuf_reset_free_bits (buf_block_t *block)
UNIV_INLINE void ibuf_update_free_bits_if_full (buf_block_t *block, ulint max_ins_size, ulint increase)
UNIV_INTERN void ibuf_update_free_bits_low (const buf_block_t *block, ulint max_ins_size, mtr_t *mtr)
UNIV_INTERN void ibuf_update_free_bits_zip (buf_block_t *block, mtr_t *mtr)
UNIV_INTERN void ibuf_update_free_bits_for_two_pages_low (ulint zip_size, buf_block_t *block1, buf_block_t *block2, mtr_t *mtr)
UNIV_INLINE ibool ibuf_should_try (dict_index_t *index, ulint ignore_sec_unique)
UNIV_INLINE ibool ibuf_inside (const mtr_t *mtr) __attribute__((nonnull
UNIV_INLINE ibool ibuf_bitmap_page (ulint zip_size, ulint page_no)
UNIV_INTERN ibool ibuf_page_low (ulint space, ulint zip_size, ulint page_no, const char *file, ulint line, mtr_t *mtr) __attribute__((warn_unused_result))
UNIV_INTERN void ibuf_free_excess_pages (void)
UNIV_INTERN ibool ibuf_insert (ibuf_op_t op, const dtuple_t *entry, dict_index_t *index, ulint space, ulint zip_size, ulint page_no, que_thr_t *thr)
UNIV_INTERN void ibuf_merge_or_delete_for_page (buf_block_t *block, ulint space, ulint page_no, ulint zip_size, ibool update_ibuf_bitmap)
UNIV_INTERN void ibuf_delete_for_discarded_space (ulint space)
UNIV_INTERN ulint ibuf_contract_in_background (table_id_t table_id, ibool full)
UNIV_INTERN byte * ibuf_parse_bitmap_init (byte *ptr, byte *end_ptr, buf_block_t *block, mtr_t *mtr)
UNIV_INTERN bool ibuf_is_empty (void)
UNIV_INTERN void ibuf_print (FILE *file)
UNIV_INTERN ulint ibuf_rec_get_counter (const rec_t *rec)
UNIV_INTERN void ibuf_close (void)
UNIV_INTERN dberr_t ibuf_check_bitmap_on_import (const trx_t *trx, ulint space_id) __attribute__((nonnull

Variables

ibuf_use_t ibuf_use
ibuf_t * ibuf
UNIV_INLINE ibool pure
UNIV_INTERN dberr_t warn_unused_result

Detailed Description

Insert buffer

Created 7/19/1997 Heikki Tuuri

Definition in file ibuf0ibuf.h.

Macro Definition Documentation

#define CHANGE_BUFFER_DEFAULT_SIZE   (25)
Default value for maximum on-disk size of change buffer in terms

of percentage of the buffer pool.

Definition at line 40 of file ibuf0ibuf.h.

#define ibuf_page (   space,
  zip_size,
  page_no,
  mtr 
)    ibuf_page_low(space, zip_size, page_no, __FILE__, __LINE__, mtr)
Checks if a page is a level 2 or 3 page in the ibuf hierarchy of

pages. Must not be called when recv_no_ibuf_operations==TRUE.

Parameters
spacetablespace identifier
zip_sizecompressed page size in bytes, or 0
page_nopage number
mtrmini-transaction or NULL
Returns
TRUE if level 2 or level 3 page

Definition at line 312 of file ibuf0ibuf.h.

Enumeration Type Documentation

enum ibuf_use_t
Combinations of operations that can be buffered.  Because the enum

values are used for indexing innobase_change_buffering_values[], they should start at 0 and there should not be any gaps.

Definition at line 56 of file ibuf0ibuf.h.

Function Documentation

UNIV_INLINE ibool ibuf_bitmap_page ( ulint  zip_size,
ulint  page_no 
)

Checks if a page address is an ibuf bitmap page (level 3 page) address.

Returns
TRUE if a bitmap page in: page number
Parameters
zip_sizein: compressed page size in bytes; 0 for uncompressed pages

Here is the caller graph for this function:

UNIV_INTERN void ibuf_bitmap_page_init ( buf_block_t block,
mtr_t mtr 
)

Initializes an ibuf bitmap page. in: mtr

Initializes an ibuf bitmap page.

Parameters
blockin: bitmap page
mtrin: mtr

Definition at line 620 of file ibuf0ibuf.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN dberr_t ibuf_check_bitmap_on_import ( const trx_t trx,
ulint  space_id 
)

Checks the insert buffer bitmaps on IMPORT TABLESPACE.

Returns
DB_SUCCESS or error code
Parameters
trxin: transaction
space_idin: tablespace identifier

Here is the caller graph for this function:

UNIV_INTERN void ibuf_close ( void  )

Closes insert buffer and frees the data structures.

Definition at line 463 of file ibuf0ibuf.cc.

UNIV_INTERN ulint ibuf_contract_in_background ( table_id_t  table_id,
ibool  full 
)

Contracts insert buffer trees by reading pages to the buffer pool.

Returns
a lower limit for the combined size in bytes of entries which will be merged from ibuf trees to the pages read, 0 if ibuf is empty in: TRUE if the caller wants to do a full contract based on PCT_IO(100). If FALSE then the size of contract batch is determined based on the current size of the ibuf tree.
Parameters
table_idin: if merge should be done only for a specific table, for all tables this should be 0
UNIV_INTERN void ibuf_delete_for_discarded_space ( ulint  space)

Deletes all entries in the insert buffer for a given space id. This is used in DISCARD TABLESPACE and IMPORT TABLESPACE. NOTE: this does not update the page free bitmaps in the space. The space will become CORRUPT when you call this function! in: space id

Here is the caller graph for this function:

UNIV_INTERN void ibuf_free_excess_pages ( void  )

Frees excess pages from the ibuf free list. This function is called when an OS thread calls fsp services to allocate a new file segment, or a new page to a file segment, and the thread did not own the fsp latch before this call.

Definition at line 2255 of file ibuf0ibuf.cc.

Here is the call graph for this function:

UNIV_INTERN void ibuf_init_at_db_start ( void  )

Creates the insert buffer data structure at a database startup.

Creates the insert buffer data structure at a database startup and initializes the data structures for the insert buffer.

Definition at line 506 of file ibuf0ibuf.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN ibool ibuf_insert ( ibuf_op_t  op,
const dtuple_t entry,
dict_index_t index,
ulint  space,
ulint  zip_size,
ulint  page_no,
que_thr_t thr 
)

Buffer an operation in the insert/delete buffer, instead of doing it directly to the disk page, if this is possible. Does not do it if the index is clustered or unique.

Returns
TRUE if success in: query thread
Parameters
opin: operation type
entryin: index entry to insert
indexin: index where to insert
spacein: space id where to insert
zip_sizein: compressed page size in bytes, or 0
page_noin: page number where to insert

Here is the caller graph for this function:

UNIV_INLINE ibool ibuf_inside ( const mtr_t mtr)

Returns TRUE if the current OS thread is performing an insert buffer routine.

For instance, a read-ahead of non-ibuf pages is forbidden by threads that are executing an insert buffer routine.

Returns
TRUE if inside an insert buffer routine
Parameters
mtrin: mini-transaction

Here is the caller graph for this function:

UNIV_INTERN bool ibuf_is_empty ( void  )

Looks if the insert buffer is empty.

Returns
true if empty

Here is the caller graph for this function:

UNIV_INTERN void ibuf_max_size_update ( ulint  new_val)

Updates the max_size value for ibuf. in: new value in terms of percentage of the buffer pool size

Updates the max_size value for ibuf.

Parameters
new_valin: new value in terms of percentage of the buffer pool size

Definition at line 602 of file ibuf0ibuf.cc.

Here is the call graph for this function:

UNIV_INTERN void ibuf_merge_or_delete_for_page ( buf_block_t block,
ulint  space,
ulint  page_no,
ulint  zip_size,
ibool  update_ibuf_bitmap 
)

When an index page is read from a disk to the buffer pool, this function applies any buffered operations to the page and deletes the entries from the insert buffer. If the page is not read, but created in the buffer pool, this function deletes its buffered entries from the insert buffer; there can exist entries for such a page if the page belonged to an index which subsequently was dropped. in: normally this is set to TRUE, but if we have deleted or are deleting the tablespace, then we naturally do not want to update a non-existent bitmap page

Parameters
blockin: if page has been read from disk, pointer to the page x-latched, else NULL
spacein: space id of the index page
page_noin: page number of the index page
zip_sizein: compressed page size in bytes, or 0

Here is the caller graph for this function:

UNIV_INLINE void ibuf_mtr_commit ( mtr_t mtr)

Commits an insert buffer mini-transaction.

Parameters
mtrin/out: mini-transaction

Here is the caller graph for this function:

UNIV_INLINE void ibuf_mtr_start ( mtr_t mtr)

Starts an insert buffer mini-transaction.

Parameters
mtrout: mini-transaction
UNIV_INTERN ibool ibuf_page_low ( ulint  space,
ulint  zip_size,
ulint  page_no,
const char *  file,
ulint  line,
mtr_t mtr 
)

Checks if a page is a level 2 or 3 page in the ibuf hierarchy of pages. Must not be called when recv_no_ibuf_operations==TRUE.

Returns
TRUE if level 2 or level 3 page
Parameters
spacein: space id
zip_sizein: compressed page size in bytes, or 0
page_noin: page number
filein: file name
linein: line where called
mtrin: mtr which will contain an x-latch to the bitmap page if the page is not one of the fixed address ibuf pages, or NULL, in which case a new transaction is created.

Definition at line 1153 of file ibuf0ibuf.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

UNIV_INTERN byte* ibuf_parse_bitmap_init ( byte *  ptr,
byte *  end_ptr,
buf_block_t block,
mtr_t mtr 
)

Parses a redo log record of an ibuf bitmap page init.

Returns
end of log record or NULL in: mtr or NULL
Parameters
ptrin: buffer
end_ptrin: buffer end
blockin: block or NULL
UNIV_INTERN void ibuf_print ( FILE *  file)

Prints info of ibuf. in: file where to print

Here is the caller graph for this function:

UNIV_INTERN ulint ibuf_rec_get_counter ( const rec_t *  rec)

in: ibuf record

Read the first two bytes from a record's fourth field (counter field in new records; something else in older records).

Returns
"counter" field, or ULINT_UNDEFINED if for some reason it can't be read
Parameters
recin: ibuf record

Definition at line 1444 of file ibuf0ibuf.cc.

Here is the call graph for this function:

UNIV_INTERN void ibuf_reset_free_bits ( buf_block_t block)

Resets the free bits of the page in the ibuf bitmap. This is done in a separate mini-transaction, hence this operation does not restrict further work to only ibuf bitmap operations, which would result if the latch to the bitmap page were kept. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to decrement or reset the bits in the bitmap in a mini-transaction that is committed before the mini-transaction that affects the free space. in: index page; free bits are set to 0 if the index is a non-clustered non-unique, and page level is 0

Resets the free bits of the page in the ibuf bitmap. This is done in a separate mini-transaction, hence this operation does not restrict further work to only ibuf bitmap operations, which would result if the latch to the bitmap page were kept. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to decrement or reset the bits in the bitmap in a mini-transaction that is committed before the mini-transaction that affects the free space.

Parameters
blockin: index page; free bits are set to 0 if the index is a non-clustered non-unique, and page level is 0

Definition at line 1003 of file ibuf0ibuf.cc.

Here is the caller graph for this function:

UNIV_INLINE ibool ibuf_should_try ( dict_index_t index,
ulint  ignore_sec_unique 
)

A basic partial test if an insert to the insert buffer could be possible and recommended. in: if != 0, we should ignore UNIQUE constraint on a secondary index when we decide

Parameters
indexin: index where to insert

Here is the caller graph for this function:

UNIV_INTERN void ibuf_update_free_bits_for_two_pages_low ( ulint  zip_size,
buf_block_t block1,
buf_block_t block2,
mtr_t mtr 
)

Updates the free bits for the two pages to reflect the present state. Does this in the mtr given, which means that the latching order rules virtually prevent any further operations until mtr is committed. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to set the free bits in the same mini-transaction that updated the pages. in: mtr

Updates the free bits for the two pages to reflect the present state. Does this in the mtr given, which means that the latching order rules virtually prevent any further operations until mtr is committed. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to set the free bits in the same mini-transaction that updated the pages.

Parameters
zip_sizein: compressed page size in bytes; 0 for uncompressed pages
block1in: index page
block2in: index page
mtrin: mtr

Definition at line 1104 of file ibuf0ibuf.cc.

Here is the call graph for this function:

UNIV_INLINE void ibuf_update_free_bits_if_full ( buf_block_t block,
ulint  max_ins_size,
ulint  increase 
)

Updates the free bits of an uncompressed page in the ibuf bitmap if there is not enough free on the page any more. This is done in a separate mini-transaction, hence this operation does not restrict further work to only ibuf bitmap operations, which would result if the latch to the bitmap page were kept. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is unsafe to increment the bits in a separately committed mini-transaction, because in crash recovery, the free bits could momentarily be set too high. It is only safe to use this function for decrementing the free bits. Should more free space become available, we must not update the free bits here, because that would break crash recovery. in: upper limit for the additional space used in the latest operation, if known, or ULINT_UNDEFINED

Parameters
blockin: index page to which we have added new records; the free bits are updated if the index is non-clustered and non-unique and the page level is 0, and the page becomes fuller
max_ins_sizein: value of maximum insert size with reorganize before the latest operation performed to the page
UNIV_INTERN void ibuf_update_free_bits_low ( const buf_block_t block,
ulint  max_ins_size,
mtr_t mtr 
)

Updates the free bits for an uncompressed page to reflect the present state. Does this in the mtr given, which means that the latching order rules virtually prevent any further operations for this OS thread until mtr is committed. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to set the free bits in the same mini-transaction that updated the page. in/out: mtr

Updates the free bits for an uncompressed page to reflect the present state. Does this in the mtr given, which means that the latching order rules virtually prevent any further operations for this OS thread until mtr is committed. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to set the free bits in the same mini-transaction that updated the page.

Parameters
blockin: index page
max_ins_sizein: value of maximum insert size with reorganize before the latest operation performed to the page
mtrin/out: mtr

Definition at line 1022 of file ibuf0ibuf.cc.

Here is the call graph for this function:

UNIV_INTERN void ibuf_update_free_bits_zip ( buf_block_t block,
mtr_t mtr 
)

Updates the free bits for a compressed page to reflect the present state. Does this in the mtr given, which means that the latching order rules virtually prevent any further operations for this OS thread until mtr is committed. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to set the free bits in the same mini-transaction that updated the page. in/out: mtr

Updates the free bits for a compressed page to reflect the present state. Does this in the mtr given, which means that the latching order rules virtually prevent any further operations for this OS thread until mtr is committed. NOTE: The free bits in the insert buffer bitmap must never exceed the free space on a page. It is safe to set the free bits in the same mini-transaction that updated the page.

Parameters
blockin/out: index page
mtrin/out: mtr

Definition at line 1060 of file ibuf0ibuf.cc.

Here is the call graph for this function:

UNIV_INTERN void ibuf_update_max_tablespace_id ( void  )

Reads the biggest tablespace id from the high end of the insert buffer tree and updates the counter in fil_system.

Variable Documentation

ibuf_t* ibuf

The insert buffer control structure

Definition at line 204 of file ibuf0ibuf.cc.

ibuf_use_t ibuf_use

Operations that can currently be buffered.

Definition at line 196 of file ibuf0ibuf.cc.