InnoDB Plugin  1.0
Data Structures | Macros | Functions | Variables
page0cur.h File Reference
#include "univ.i"
#include "buf0types.h"
#include "page0page.h"
#include "rem0rec.h"
#include "data0data.h"
#include "mtr0mtr.h"
#include "page0cur.ic"
Include dependency graph for page0cur.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  page_cur_t

Macros

#define PAGE_CUR_ADAPT
#define PAGE_CUR_UNSUPP   0
#define PAGE_CUR_G   1
#define PAGE_CUR_GE   2
#define PAGE_CUR_L   3
#define PAGE_CUR_LE   4

Functions

UNIV_INLINE page_tpage_cur_get_page (page_cur_t *cur)
UNIV_INLINE buf_block_tpage_cur_get_block (page_cur_t *cur)
UNIV_INLINE page_zip_des_tpage_cur_get_page_zip (page_cur_t *cur)
UNIV_INLINE rec_t * page_cur_get_rec (page_cur_t *cur)
UNIV_INLINE void page_cur_set_before_first (const buf_block_t *block, page_cur_t *cur)
UNIV_INLINE void page_cur_set_after_last (const buf_block_t *block, page_cur_t *cur)
UNIV_INLINE ibool page_cur_is_before_first (const page_cur_t *cur)
UNIV_INLINE ibool page_cur_is_after_last (const page_cur_t *cur)
UNIV_INLINE void page_cur_position (const rec_t *rec, const buf_block_t *block, page_cur_t *cur)
UNIV_INLINE void page_cur_invalidate (page_cur_t *cur)
UNIV_INLINE void page_cur_move_to_next (page_cur_t *cur)
UNIV_INLINE void page_cur_move_to_prev (page_cur_t *cur)
UNIV_INLINE rec_t * page_cur_tuple_insert (page_cur_t *cursor, const dtuple_t *tuple, dict_index_t *index, ulint **offsets, mem_heap_t **heap, ulint n_ext, mtr_t *mtr)
UNIV_INLINE rec_t * page_cur_rec_insert (page_cur_t *cursor, const rec_t *rec, dict_index_t *index, ulint *offsets, mtr_t *mtr)
UNIV_INTERN rec_t * page_cur_insert_rec_low (rec_t *current_rec, dict_index_t *index, const rec_t *rec, ulint *offsets, mtr_t *mtr)
UNIV_INTERN rec_t * page_cur_insert_rec_zip (page_cur_t *cursor, dict_index_t *index, const rec_t *rec, ulint *offsets, mtr_t *mtr)
UNIV_INTERN void page_copy_rec_list_end_to_created_page (page_t *new_page, rec_t *rec, dict_index_t *index, mtr_t *mtr)
UNIV_INTERN void page_cur_delete_rec (page_cur_t *cursor, const dict_index_t *index, const ulint *offsets, mtr_t *mtr)
UNIV_INLINE ulint page_cur_search (const buf_block_t *block, const dict_index_t *index, const dtuple_t *tuple, ulint mode, page_cur_t *cursor)
UNIV_INTERN void page_cur_search_with_match (const buf_block_t *block, const dict_index_t *index, const dtuple_t *tuple, ulint mode, ulint *iup_matched_fields, ulint *iup_matched_bytes, ulint *ilow_matched_fields, ulint *ilow_matched_bytes, page_cur_t *cursor)
UNIV_INTERN void page_cur_open_on_rnd_user_rec (buf_block_t *block, page_cur_t *cursor)
UNIV_INTERN byte * page_cur_parse_insert_rec (ibool is_short, byte *ptr, byte *end_ptr, buf_block_t *block, dict_index_t *index, mtr_t *mtr)
UNIV_INTERN byte * page_parse_copy_rec_list_to_created_page (byte *ptr, byte *end_ptr, buf_block_t *block, dict_index_t *index, mtr_t *mtr)
UNIV_INTERN byte * page_cur_parse_delete_rec (byte *ptr, byte *end_ptr, buf_block_t *block, dict_index_t *index, mtr_t *mtr)
UNIV_INTERN bool page_delete_rec (const dict_index_t *index, page_cur_t *pcur, page_zip_des_t *page_zip, const ulint *offsets)

Variables

UNIV_INLINE rec_t warn_unused_result

Detailed Description

The page cursor

Created 10/4/1994 Heikki Tuuri

Function Documentation

UNIV_INTERN void page_copy_rec_list_end_to_created_page ( page_t new_page,
rec_t *  rec,
dict_index_t index,
mtr_t mtr 
)

Copies records from page to a newly created page, from a given record onward, including that record. Infimum and supremum records are not copied.

IMPORTANT: The caller will have to update IBUF_BITMAP_FREE if this is a compressed leaf page in a secondary index. This has to be done either within the same mini-transaction, or by invoking ibuf_reset_free_bits() before mtr_commit(). in: mtr

Parameters
new_pagein/out: index page to copy to
recin: first record to copy
indexin: record descriptor
UNIV_INTERN void page_cur_delete_rec ( page_cur_t cursor,
const dict_index_t index,
const ulint *  offsets,
mtr_t mtr 
)

Deletes a record at the page cursor. The cursor is moved to the next record after the deleted one. in: mini-transaction handle

Parameters
cursorin/out: a page cursor
indexin: record descriptor
offsetsin: rec_get_offsets( cursor->rec, index)
UNIV_INLINE buf_block_t* page_cur_get_block ( page_cur_t cur)

Gets pointer to the buffer block where the cursor is positioned.

Returns
page in: page cursor

Gets pointer to the buffer block where the cursor is positioned.

Returns
page
Parameters
curin: page cursor
UNIV_INLINE page_t* page_cur_get_page ( page_cur_t cur)

Gets pointer to the page frame where the cursor is positioned.

Returns
page in: page cursor

Gets pointer to the page frame where the cursor is positioned.

Returns
page
Parameters
curin: page cursor
UNIV_INLINE page_zip_des_t* page_cur_get_page_zip ( page_cur_t cur)

Gets pointer to the page frame where the cursor is positioned.

Returns
page in: page cursor

Gets pointer to the page frame where the cursor is positioned.

Returns
page
Parameters
curin: page cursor
UNIV_INLINE rec_t* page_cur_get_rec ( page_cur_t cur)

Gets the record where the cursor is positioned.

Returns
record in: page cursor

Gets the record where the cursor is positioned.

Returns
record
Parameters
curin: page cursor
UNIV_INTERN rec_t* page_cur_insert_rec_low ( rec_t *  current_rec,
dict_index_t index,
const rec_t *  rec,
ulint *  offsets,
mtr_t mtr 
)

Inserts a record next to page cursor on an uncompressed page. Returns pointer to inserted record if succeed, i.e., enough space available, NULL otherwise. The cursor stays at the same position.

Returns
pointer to record if succeed, NULL otherwise
Parameters
current_recin: pointer to current record after which the new record is inserted
indexin: record descriptor
recin: pointer to a physical record
offsetsin/out: rec_get_offsets(rec, index)
mtrin: mini-transaction handle, or NULL
UNIV_INTERN rec_t* page_cur_insert_rec_zip ( page_cur_t cursor,
dict_index_t index,
const rec_t *  rec,
ulint *  offsets,
mtr_t mtr 
)

Inserts a record next to page cursor on a compressed and uncompressed page. Returns pointer to inserted record if succeed, i.e., enough space available, NULL otherwise. The cursor stays at the same position.

IMPORTANT: The caller will have to update IBUF_BITMAP_FREE if this is a compressed leaf page in a secondary index. This has to be done either within the same mini-transaction, or by invoking ibuf_reset_free_bits() before mtr_commit().

Returns
pointer to record if succeed, NULL otherwise
Parameters
cursorin/out: page cursor
indexin: record descriptor
recin: pointer to a physical record
offsetsin/out: rec_get_offsets(rec, index)
mtrin: mini-transaction handle, or NULL
UNIV_INLINE void page_cur_invalidate ( page_cur_t cur)

Invalidates a page cursor by setting the record pointer NULL. out: page cursor

Invalidates a page cursor by setting the record pointer NULL.

Parameters
curout: page cursor
UNIV_INLINE ibool page_cur_is_after_last ( const page_cur_t cur)

Returns TRUE if the cursor is after last user record.

Returns
TRUE if at end in: cursor

Returns TRUE if the cursor is after last user record.

Returns
TRUE if at end
Parameters
curin: cursor
UNIV_INLINE ibool page_cur_is_before_first ( const page_cur_t cur)

Returns TRUE if the cursor is before first user record on page.

Returns
TRUE if at start in: cursor

Returns TRUE if the cursor is before first user record on page.

Returns
TRUE if at start
Parameters
curin: cursor
UNIV_INLINE void page_cur_move_to_next ( page_cur_t cur)

Moves the cursor to the next record on page. in/out: cursor; must not be after last

Moves the cursor to the next record on page.

Parameters
curin/out: cursor; must not be after last
UNIV_INLINE void page_cur_move_to_prev ( page_cur_t cur)

Moves the cursor to the previous record on page. in/out: cursor; not before first

Moves the cursor to the previous record on page.

Parameters
curin/out: page cursor, not before first
UNIV_INTERN void page_cur_open_on_rnd_user_rec ( buf_block_t block,
page_cur_t cursor 
)

Positions a page cursor on a randomly chosen user record on a page. If there are no user records, sets the cursor on the infimum record. out: page cursor

Parameters
blockin: page
UNIV_INTERN byte* page_cur_parse_delete_rec ( byte *  ptr,
byte *  end_ptr,
buf_block_t block,
dict_index_t index,
mtr_t mtr 
)

Parses log record of a record delete on a page.

Returns
pointer to record end or NULL in: mtr or NULL
Parameters
ptrin: buffer
end_ptrin: buffer end
blockin: page or NULL
indexin: record descriptor
UNIV_INTERN byte* page_cur_parse_insert_rec ( ibool  is_short,
byte *  ptr,
byte *  end_ptr,
buf_block_t block,
dict_index_t index,
mtr_t mtr 
)

Parses a log record of a record insert on a page.

Returns
end of log record or NULL in: mtr or NULL
Parameters
is_shortin: TRUE if short inserts
ptrin: buffer
end_ptrin: buffer end
blockin: page or NULL
indexin: record descriptor
UNIV_INLINE void page_cur_position ( const rec_t *  rec,
const buf_block_t block,
page_cur_t cur 
)

Positions the cursor on the given record. out: page cursor

Positions the cursor on the given record.

Parameters
recin: record on a page
blockin: buffer block containing the record
curout: page cursor
UNIV_INLINE rec_t* page_cur_rec_insert ( page_cur_t cursor,
const rec_t *  rec,
dict_index_t index,
ulint *  offsets,
mtr_t mtr 
)

Inserts a record next to page cursor. Returns pointer to inserted record if succeed, i.e., enough space available, NULL otherwise. The cursor stays at the same logical position, but the physical position may change if it is pointing to a compressed page that was reorganized.

IMPORTANT: The caller will have to update IBUF_BITMAP_FREE if this is a compressed leaf page in a secondary index. This has to be done either within the same mini-transaction, or by invoking ibuf_reset_free_bits() before mtr_commit().

Returns
pointer to record if succeed, NULL otherwise in: mini-transaction handle, or NULL

Inserts a record next to page cursor. Returns pointer to inserted record if succeed, i.e., enough space available, NULL otherwise. The cursor stays at the same logical position, but the physical position may change if it is pointing to a compressed page that was reorganized.

IMPORTANT: The caller will have to update IBUF_BITMAP_FREE if this is a compressed leaf page in a secondary index. This has to be done either within the same mini-transaction, or by invoking ibuf_reset_free_bits() before mtr_commit().

Returns
pointer to record if succeed, NULL otherwise
Parameters
cursorin/out: a page cursor
recin: record to insert
indexin: record descriptor
offsetsin/out: rec_get_offsets(rec, index)
mtrin: mini-transaction handle, or NULL
UNIV_INLINE ulint page_cur_search ( const buf_block_t block,
const dict_index_t index,
const dtuple_t tuple,
ulint  mode,
page_cur_t cursor 
)

Searches the right position for a page cursor.

Returns
number of matched fields on the left out: page cursor

Searches the right position for a page cursor.

Returns
number of matched fields on the left
Parameters
blockin: buffer block
indexin: record descriptor
tuplein: data tuple
modein: PAGE_CUR_L, PAGE_CUR_LE, PAGE_CUR_G, or PAGE_CUR_GE
cursorout: page cursor
UNIV_INTERN void page_cur_search_with_match ( const buf_block_t block,
const dict_index_t index,
const dtuple_t tuple,
ulint  mode,
ulint *  iup_matched_fields,
ulint *  iup_matched_bytes,
ulint *  ilow_matched_fields,
ulint *  ilow_matched_bytes,
page_cur_t cursor 
)

Searches the right position for a page cursor. out: page cursor

Parameters
blockin: buffer block
indexin: record descriptor
tuplein: data tuple
modein: PAGE_CUR_L, PAGE_CUR_LE, PAGE_CUR_G, or PAGE_CUR_GE
iup_matched_fieldsin/out: already matched fields in upper limit record
iup_matched_bytesin/out: already matched bytes in a field not yet completely matched
ilow_matched_fieldsin/out: already matched fields in lower limit record
ilow_matched_bytesin/out: already matched bytes in a field not yet completely matched
UNIV_INLINE void page_cur_set_after_last ( const buf_block_t block,
page_cur_t cur 
)

Sets the cursor object to point after the last user record on the page. in: cursor

Sets the cursor object to point after the last user record on the page.

Parameters
blockin: index page
curin: cursor
UNIV_INLINE void page_cur_set_before_first ( const buf_block_t block,
page_cur_t cur 
)

Sets the cursor object to point before the first user record on the page. in: cursor

Sets the cursor object to point before the first user record on the page.

Parameters
blockin: index page
curin: cursor
UNIV_INLINE rec_t* page_cur_tuple_insert ( page_cur_t cursor,
const dtuple_t tuple,
dict_index_t index,
ulint **  offsets,
mem_heap_t **  heap,
ulint  n_ext,
mtr_t mtr 
)

Inserts a record next to page cursor. Returns pointer to inserted record if succeed, i.e., enough space available, NULL otherwise. The cursor stays at the same logical position, but the physical position may change if it is pointing to a compressed page that was reorganized.

IMPORTANT: The caller will have to update IBUF_BITMAP_FREE if this is a compressed leaf page in a secondary index. This has to be done either within the same mini-transaction, or by invoking ibuf_reset_free_bits() before mtr_commit().

Returns
pointer to record if succeed, NULL otherwise
Parameters
cursorin/out: a page cursor
tuplein: pointer to a data tuple
indexin: record descriptor
offsetsout: offsets on *rec
heapin/out: pointer to memory heap, or NULL
n_extin: number of externally stored columns
mtrin: mini-transaction handle, or NULL
UNIV_INTERN bool page_delete_rec ( const dict_index_t index,
page_cur_t pcur,
page_zip_des_t page_zip,
const ulint *  offsets 
)

Removes the record from a leaf page. This function does not log any changes. It is used by the IMPORT tablespace functions.

Returns
true if success, i.e., the page did not become too empty in: offsets for record
Parameters
indexin: The index that the record belongs to
pcurin/out: page cursor on record to delete
page_zipin: compressed page descriptor
UNIV_INTERN byte* page_parse_copy_rec_list_to_created_page ( byte *  ptr,
byte *  end_ptr,
buf_block_t block,
dict_index_t index,
mtr_t mtr 
)

Parses a log record of copying a record list end to a new created page.

Returns
end of log record or NULL in: mtr or NULL
Parameters
ptrin: buffer
end_ptrin: buffer end
blockin: page or NULL
indexin: record descriptor