page0page.h

Go to the documentation of this file.

/*****************************************************************************
 
Copyright (c) 1994, 2026, Oracle and/or its affiliates.
 
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License, version 2.0, as published by the
Free Software Foundation.
 
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation.  The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
 
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, version 2.0,
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
 
*****************************************************************************/
 
#include <stddef.h>
#include <sys/types.h>
 
/** @file include/page0page.h
 Index page routines
 
 Created 2/2/1994 Heikki Tuuri
 *******************************************************/
 
#ifndef page0page_h
#define page0page_h
 
#include "univ.i"
 
#include "buf0buf.h"
#include "data0data.h"
#include "dict0dict.h"
#include "fil0fil.h"
#include "fsp0fsp.h"
#include "mtr0mtr.h"
#include "page0types.h"
#include "rem0rec.h"
 
/*                      PAGE DIRECTORY
                        ==============
*/
 
typedef byte page_dir_slot_t;
typedef page_dir_slot_t page_dir_t;
 
/* Offset of the directory start down from the page end. We call the
slot with the highest file address directory start, as it points to
the first record in the list of records. */
constexpr uint32_t PAGE_DIR = FIL_PAGE_DATA_END;
 
/* We define a slot in the page directory as two bytes */
constexpr uint32_t PAGE_DIR_SLOT_SIZE = 2;
 
/* The offset of the physically lower end of the directory, counted from
page end, when the page is empty */
constexpr uint32_t PAGE_EMPTY_DIR_START = PAGE_DIR + 2 * PAGE_DIR_SLOT_SIZE;
 
/* The maximum and minimum number of records owned by a directory slot. The
number may drop below the minimum in the first and the last slot in the
directory. */
constexpr uint32_t PAGE_DIR_SLOT_MAX_N_OWNED = 8;
constexpr uint32_t PAGE_DIR_SLOT_MIN_N_OWNED = 4;
 
/* The infimum and supremum records are omitted from the compressed page.
On compress, we compare that the records are there, and on uncompress we
restore the records. */
/** Extra bytes of an infimum record */
static const byte infimum_extra[] = {
    0x01,          /* info_bits=0, n_owned=1 */
    0x00, 0x02     /* heap_no=0, status=2 */
    /* ?, ?     */ /* next=(first user rec, or supremum) */
};
/** Data bytes of an infimum record */
static const byte infimum_data[] = {
    0x69, 0x6e, 0x66, 0x69, 0x6d, 0x75, 0x6d, 0x00 /* "infimum\0" */
};
/** Extra bytes and data bytes of a supremum record */
static const byte supremum_extra_data[] = {
    /* 0x0?, */ /* info_bits=0, n_owned=1..8 */
    0x00,
    0x0b, /* heap_no=1, status=3 */
    0x00,
    0x00, /* next=0 */
    0x73,
    0x75,
    0x70,
    0x72,
    0x65,
    0x6d,
    0x75,
    0x6d /* "supremum" */
};
 
/** Gets the start of a page.
@param[in]  ptr     pointer to page frame
@return start of the page */
static inline page_t *page_align(const void *ptr);
 
/** Gets the offset within a page.
@param[in]  ptr     pointer to page frame
@return offset from the start of the page */
static inline ulint page_offset(const void *ptr);
 
/** Returns the max trx id field value. */
static inline trx_id_t page_get_max_trx_id(const page_t *page); /*!< in: page */
 
/** Sets the max trx id field value.
@param[in,out] block Page
@param[in,out] page_zip Compressed page, or NULL
@param[in] trx_id Transaction id
@param[in,out] mtr Mini-transaction, or NULL */
void page_set_max_trx_id(buf_block_t *block, page_zip_des_t *page_zip,
                         trx_id_t trx_id, mtr_t *mtr);
 
/** Sets the max trx id field value if trx_id is bigger than the previous
value.
@param[in,out]  block           Page
@param[in,out]  page_zip        Compressed page whose uncompressed part will
                                be updated, or NULL
@param[in]      trx_id          Transaction id
@param[in,out]  mtr             Mini-transaction */
static inline void page_update_max_trx_id(buf_block_t *block,
                                          page_zip_des_t *page_zip,
                                          trx_id_t trx_id, mtr_t *mtr);
 
/** Returns the RTREE SPLIT SEQUENCE NUMBER (FIL_RTREE_SPLIT_SEQ_NUM).
@param[in]      page    page
@return SPLIT SEQUENCE NUMBER */
static inline node_seq_t page_get_ssn_id(const page_t *page);
 
/** Sets the RTREE SPLIT SEQUENCE NUMBER field value
@param[in,out]  block           Page
@param[in,out]  page_zip        Compressed page whose uncompressed part will
                                be updated, or NULL
@param[in]      ssn_id          Split sequence id
@param[in,out]  mtr             Mini-transaction */
static inline void page_set_ssn_id(buf_block_t *block, page_zip_des_t *page_zip,
                                   node_seq_t ssn_id, mtr_t *mtr);
 
/** Reads the given header field.
@param[in]      page    page
@param[in]      field   PAGE_N_DIR_SLOTS, ... */
static inline uint16_t page_header_get_field(const page_t *page, ulint field);
 
/** Sets the given header field.
@param[in,out]  page            page
@param[in,out]  page_zip        compressed page whose uncompressed part will
                                be updated, or NULL
@param[in]      field           PAGE_N_DIR_SLOTS, ...
@param[in]      val             value */
static inline void page_header_set_field(page_t *page, page_zip_des_t *page_zip,
                                         ulint field, ulint val);
 
/** Returns the offset stored in the given header field.
@param[in] page Page.
@param[in] field PAGE_FREE, ...
@return offset from the start of the page, or 0 */
[[nodiscard]] static inline ulint page_header_get_offs(const page_t *page,
                                                       ulint field);
 
/** Returns the pointer stored in the given header field, or NULL. */
static inline byte *page_header_get_ptr(page_t *page, uint32_t field) {
  if (page_header_get_offs(page, field)) {
    return page + page_header_get_offs(page, field);
  }
  return nullptr;
}
 
static inline const byte *page_header_get_ptr(const page_t *page,
                                              uint32_t field) {
  if (page_header_get_offs(page, field)) {
    return page + page_header_get_offs(page, field);
  }
  return nullptr;
}
 
/** Sets the pointer stored in the given header field.
@param[in,out]  page            page
@param[in,out]  page_zip        compressed page whose uncompressed part will
                                be updated, or NULL
@param[in,out]  field           PAGE_FREE, ...
@param[in]      ptr             pointer or NULL */
static inline void page_header_set_ptr(page_t *page, page_zip_des_t *page_zip,
                                       ulint field, const byte *ptr);
#ifndef UNIV_HOTBACKUP
 
/** Resets the last insert info field in the page header. Writes to mlog about
this operation.
@param[in]      page            page
@param[in,out]  page_zip        compressed page whose uncompressed part will
                                be updated, or NULL
@param[in]      mtr             mtr */
static inline void page_header_reset_last_insert(page_t *page,
                                                 page_zip_des_t *page_zip,
                                                 mtr_t *mtr);
#endif /* !UNIV_HOTBACKUP */
 
/** Gets the offset of the first record on the page.
 @return offset of the first record in record list, relative from page */
static inline ulint page_get_infimum_offset(
    const page_t *page); /*!< in: page which must have record(s) */
/** Gets the offset of the last record on the page.
 @return offset of the last record in record list, relative from page */
static inline ulint page_get_supremum_offset(
    const page_t *page); /*!< in: page which must have record(s) */
static inline byte *page_get_infimum_rec(byte *page) {
  return page + page_get_infimum_offset(page);
}
static inline const byte *page_get_infimum_rec(const byte *page) {
  return page + page_get_infimum_offset(page);
}
static inline byte *page_get_supremum_rec(byte *page) {
  return page + page_get_supremum_offset(page);
}
static inline const byte *page_get_supremum_rec(const byte *page) {
  return page + page_get_supremum_offset(page);
}
 
/** Returns the nth record of the record list.
 This is the inverse function of page_rec_get_n_recs_before().
 @return nth record */
[[nodiscard]] const rec_t *page_rec_get_nth_const(
    const page_t *page, /*!< in: page */
    ulint nth);         /*!< in: nth record */
 
/** Returns the nth record of the record list.
This is the inverse function of page_rec_get_n_recs_before().
@param[in]      page    page
@param[in]      nth     nth record
@return nth record */
[[nodiscard]] static inline rec_t *page_rec_get_nth(page_t *page, ulint nth);
 
#ifndef UNIV_HOTBACKUP
/** Returns the middle record of the records on the page. If there is an
 even number of records in the list, returns the first record of the
 upper half-list.
 @return middle record */
[[nodiscard]] static inline rec_t *page_get_middle_rec(
    page_t *page); /*!< in: page */
#endif             /* !UNIV_HOTBACKUP */
/** Gets the page number.
 @return page number */
static inline page_no_t page_get_page_no(const page_t *page); /*!< in: page */
/** Gets the tablespace identifier.
 @return space id */
static inline space_id_t page_get_space_id(const page_t *page); /*!< in: page */
 
/** Gets the space id and page number identifying the page.
 @return page number */
static inline page_id_t page_get_page_id(const page_t *page);
 
/** Gets the number of user records on page (the infimum and supremum records
 are not user records).
 @return number of user records */
static inline ulint page_get_n_recs(const page_t *page); /*!< in: index page */
/** Returns the number of records before the given record in chain.
 The number includes infimum and supremum records.
 This is the inverse function of page_rec_get_nth().
 @return number of records */
ulint page_rec_get_n_recs_before(
    const rec_t *rec); /*!< in: the physical record */
/** Gets the number of records in the heap.
 @param[in] page index page
 @return number of user records */
static inline uint16_t page_dir_get_n_heap(const page_t *page);
 
/** Sets the number of records in the heap.
@param[in,out]  page            index page
@param[in,out]  page_zip        compressed page whose uncompressed part will
                                be updated, or NULL. Note that the size of the
                                dense page directory in the compressed page
                                trailer is n_heap * PAGE_ZIP_DIR_SLOT_SIZE.
@param[in]      n_heap          number of records*/
static inline void page_dir_set_n_heap(page_t *page, page_zip_des_t *page_zip,
                                       ulint n_heap);
 
/** Gets the number of dir slots in directory.
 @return number of slots */
static inline ulint page_dir_get_n_slots(
    const page_t *page); /*!< in: index page */
 
/** Sets the number of dir slots in directory.
@param[in,out]  page            page
@param[in,out]  page_zip        compressed page whose uncompressed part will
                                be updated, or NULL
@param[in]      n_slots         number of slots */
static inline void page_dir_set_n_slots(page_t *page, page_zip_des_t *page_zip,
                                        ulint n_slots);
 
#ifdef UNIV_DEBUG
/** Gets pointer to nth directory slot.
@param[in]      page    index page
@param[in]      n       position
@return pointer to dir slot */
static inline page_dir_slot_t *page_dir_get_nth_slot(const page_t *page,
                                                     ulint n);
#else /* UNIV_DEBUG */
#define page_dir_get_nth_slot(page, n) \
  ((page) + (UNIV_PAGE_SIZE - PAGE_DIR - (n + 1) * PAGE_DIR_SLOT_SIZE))
#endif /* UNIV_DEBUG */
 
/** Used to check the consistency of a record on a page.
 @return true if succeed */
static inline bool page_rec_check(const rec_t *rec); /*!< in: record */
/** Gets the record pointed to by a directory slot.
 @return pointer to record */
static inline const rec_t *page_dir_slot_get_rec(
    const page_dir_slot_t *slot); /*!< in: directory slot */
 
/** This is used to set the record offset in a directory slot.
@param[in]      rec     record on the page
@param[in]      slot    directory slot */
static inline void page_dir_slot_set_rec(page_dir_slot_t *slot, rec_t *rec);
 
/** Gets the number of records owned by a directory slot.
 @return number of records */
static inline ulint page_dir_slot_get_n_owned(
    const page_dir_slot_t *slot); /*!< in: page directory slot */
 
/** This is used to set the owned records field of a directory slot.
@param[in,out]  slot            directory slot
@param[in,out]  page_zip        compressed page, or NULL
@param[in]      n               number of records owned by the slot */
static inline void page_dir_slot_set_n_owned(page_dir_slot_t *slot,
                                             page_zip_des_t *page_zip, ulint n);
 
/** Calculates the space reserved for directory slots of a given
 number of records. The exact value is a fraction number
 n * PAGE_DIR_SLOT_SIZE / PAGE_DIR_SLOT_MIN_N_OWNED, and it is
 rounded upwards to an integer. */
static inline ulint page_dir_calc_reserved_space(
    ulint n_recs); /*!< in: number of records */
/** Looks for the directory slot which owns the given record.
 @return the directory slot number */
ulint page_dir_find_owner_slot(
    const rec_t *rec); /*!< in: the physical record */
/** Determine whether the page is in new-style compact format.
 @return nonzero if the page is in compact format, zero if it is in
 old-style format */
static inline bool page_is_comp(const page_t *page); /*!< in: index page */
/** true if the record is on a page in compact format.
 @return nonzero if in compact format */
static inline bool page_rec_is_comp(const rec_t *rec); /*!< in: record */
/** Returns the heap number of a record.
 @return heap number */
static inline ulint page_rec_get_heap_no(
    const rec_t *rec); /*!< in: the physical record */
/** Determine whether the page is a B-tree leaf.
 @return true if the page is a B-tree leaf (PAGE_LEVEL = 0) */
[[nodiscard]] static inline bool page_is_leaf(
    const page_t *page); /*!< in: page */
/** Determine whether the page is empty.
 @return true if the page is empty (PAGE_N_RECS = 0) */
[[nodiscard]] static inline bool page_is_empty(
    const page_t *page); /*!< in: page */
/** Determine whether a page is an index root page.
@param[in]      page    page frame
@return true if the page is a root page of an index */
[[nodiscard]] static inline bool page_is_root(const page_t *page);
/** Determine whether the page contains garbage.
 @return true if the page contains garbage (PAGE_GARBAGE is not 0) */
[[nodiscard]] static inline bool page_has_garbage(
    const page_t *page); /*!< in: page */
 
/** Gets the pointer to the next record on the page.
@param[in]      rec     pointer to record
@param[in]      comp    nonzero=compact page layout
@return pointer to next record */
static inline const rec_t *page_rec_get_next_low(const rec_t *rec, ulint comp);
 
/** Gets the offset of the next record on the page after validating that it is
safe for page-level record access.
@param[in]      rec     pointer to record
@param[in]      comp    true iff compact page layout is used
@return the page offset of the next chained record, or unexpected offset in case
the encoded next field is invalid. */
[[nodiscard]] static inline ut::Expected<uint16_t, uint16_t>
page_rec_try_get_next_offs(const rec_t *rec, bool comp);
 
/** Gets the pointer to the next record on the page.
 @return pointer to next record */
static inline rec_t *page_rec_get_next(
    rec_t *rec); /*!< in: pointer to record */
/** Gets the pointer to the next record on the page.
 @return pointer to next record */
static inline const rec_t *page_rec_get_next_const(
    const rec_t *rec); /*!< in: pointer to record */
/** Gets the pointer to the next non delete-marked record on the page.
 If all subsequent records are delete-marked, then this function
 will return the supremum record.
 @return pointer to next non delete-marked record or pointer to supremum */
static inline const rec_t *page_rec_get_next_non_del_marked(
    const rec_t *rec); /*!< in: pointer to record */
 
/** Sets the pointer to the next record on the page.
@param[in]      rec     pointer to record, must not be page supremum
@param[in]      next    pointer to next record, must not be page infimum */
static inline void page_rec_set_next(rec_t *rec, const rec_t *next);
 
/** Gets the pointer to the previous record.
 @return pointer to previous record */
static inline const rec_t *page_rec_get_prev_const(
    const rec_t *rec); /*!< in: pointer to record, must not be page
                       infimum */
/** Gets the pointer to the previous record.
 @return pointer to previous record */
static inline rec_t *page_rec_get_prev(rec_t *rec); /*!< in: pointer to record,
                                                    must not be page infimum */
/** true if the record is a user record on the page.
@param[in]  offset      record offset on page
@return true if a user record */
static inline bool page_rec_is_user_rec_low(ulint offset);
 
/** true if the record is the supremum record on a page.
@param[in]  offset      record offset on page
@return true if the supremum record */
static inline bool page_rec_is_supremum_low(ulint offset);
 
/** true if the record is the infimum record on a page.
@param[in]  offset      record offset on page
@return true if the infimum record */
static inline bool page_rec_is_infimum_low(ulint offset);
 
/** true if the record is a user record on the page.
 @return true if a user record */
[[nodiscard]] static inline bool page_rec_is_user_rec(
    const rec_t *rec); /*!< in: record */
/** true if the record is the supremum record on a page.
 @return true if the supremum record */
[[nodiscard]] static inline bool page_rec_is_supremum(
    const rec_t *rec); /*!< in: record */
 
/** true if the record is the infimum record on a page.
 @return true if the infimum record */
[[nodiscard]] static inline bool page_rec_is_infimum(
    const rec_t *rec); /*!< in: record */
 
/** true if the record is the first user record on a page.
@param[in] rec  Record.
@param[in] page Page.
@return true if the first user record */
[[nodiscard]] static inline bool page_rec_is_first(const rec_t *rec,
                                                   const page_t *page);
 
/** true if the record is the second user record on a page.
@param[in] rec  Record.
@param[in] page Page.
@return true if the second user record */
[[nodiscard]] static inline bool page_rec_is_second(const rec_t *rec,
                                                    const page_t *page);
 
/** true if the record is the last user record on a page.
@param[in] rec  Record.
@param[in] page Page.
@return true if the last user record */
[[nodiscard]] static inline bool page_rec_is_last(const rec_t *rec,
                                                  const page_t *page);
 
/** true if distance between the records (measured in number of times we have to
move to the next record) is at most the specified value
@param[in]  left_rec    lefter record
@param[in]  right_rec   righter record
@param[in]  val         specified value to compare
@return true if the distance is smaller than the value */
[[nodiscard]] static inline bool page_rec_distance_is_at_most(
    const rec_t *left_rec, const rec_t *right_rec, ulint val);
 
/** true if the record is the second last user record on a page.
@param[in] rec  Record.
@param[in] page Page.
@return true if the second last user record */
[[nodiscard]] static inline bool page_rec_is_second_last(const rec_t *rec,
                                                         const page_t *page);
 
/** Looks for the record which owns the given record.
 @return the owner record */
static inline rec_t *page_rec_find_owner_rec(
    rec_t *rec); /*!< in: the physical record */
 
/** Returns the maximum combined size of records which can be inserted on top
of record heap.
@param[in]      page    index page
@param[in]      n_recs  number of records
@return maximum combined size for inserted records */
static inline ulint page_get_max_insert_size(const page_t *page, ulint n_recs);
 
/** Returns the maximum combined size of records which can be inserted on top
of record heap if page is first reorganized.
@param[in]      page    index page
@param[in]      n_recs  number of records
@return maximum combined size for inserted records */
static inline ulint page_get_max_insert_size_after_reorganize(
    const page_t *page, ulint n_recs);
 
/** Calculates free space if a page is emptied.
@param[in]  comp    nonzero=compact page format
@return free space */
static inline ulint page_get_free_space_of_empty(bool comp);
 
/** Returns the base extra size of a physical record.  This is the
 size of the fixed header, independent of the record size.
 @return REC_N_NEW_EXTRA_BYTES or REC_N_OLD_EXTRA_BYTES */
static inline ulint page_rec_get_base_extra_size(
    const rec_t *rec); /*!< in: physical record */
/** Returns the sum of the sizes of the records in the record list
 excluding the infimum and supremum records.
 @return data in bytes */
static inline ulint page_get_data_size(
    const page_t *page); /*!< in: index page */
 
/** Allocates a block of memory from the head of the free list of an index
page.
@param[in,out]  page            index page
@param[in,out]  page_zip        compressed page with enough space available
                                for inserting the record, or NULL
@param[in]      next_rec        pointer to the new head of the free record
                                list
@param[in]      need            number of bytes allocated */
static inline void page_mem_alloc_free(page_t *page, page_zip_des_t *page_zip,
                                       rec_t *next_rec, ulint need);
 
/** Allocates a block of memory from the heap of an index page.
 @return pointer to start of allocated buffer, or NULL if allocation fails */
byte *page_mem_alloc_heap(
    page_t *page,             /*!< in/out: index page */
    page_zip_des_t *page_zip, /*!< in/out: compressed page with enough
                             space available for inserting the record,
                             or NULL */
    ulint need,               /*!< in: total number of bytes needed */
    ulint *heap_no);          /*!< out: this contains the heap number
                             of the allocated record
                             if allocation succeeds */
 
/** Puts a record to free list.
@param[in,out]  page            index page
@param[in,out]  page_zip        compressed page, or NULL
@param[in]      rec             pointer to the (origin of) record
@param[in]      index           index of rec
@param[in]      offsets         array returned by rec_get_offsets() */
static inline void page_mem_free(page_t *page, page_zip_des_t *page_zip,
                                 rec_t *rec, const dict_index_t *index,
                                 const ulint *offsets);
 
/** Create an uncompressed B-tree or R-tree or SDI index page.
@param[in]      block           A buffer block where the page is created
@param[in]      mtr             Mini-transaction handle
@param[in]      comp            nonzero=compact page format
@param[in]      page_type       Page type
@return pointer to the page */
page_t *page_create(buf_block_t *block, mtr_t *mtr, ulint comp,
                    page_type_t page_type);
 
/** Create a compressed B-tree index page.
@param[in,out]  block           Buffer frame where the page is created
@param[in]      index           Index of the page, or NULL when applying
                                TRUNCATE log record during recovery
@param[in]      level           The B-tree level of the page
@param[in]      max_trx_id      PAGE_MAX_TRX_ID
@param[in]      mtr             Mini-transaction handle
@param[in]      page_type       Page type to be created. Only FIL_PAGE_INDEX,
                                FIL_PAGE_RTREE, FIL_PAGE_SDI allowed
@return pointer to the page */
page_t *page_create_zip(buf_block_t *block, dict_index_t *index, ulint level,
                        trx_id_t max_trx_id, mtr_t *mtr, page_type_t page_type);
 
/** Empty a previously created B-tree index page.
@param[in,out] block B-tree block
@param[in] index The index of the page
@param[in,out] mtr Mini-transaction */
void page_create_empty(buf_block_t *block, dict_index_t *index, mtr_t *mtr);
 
/** Differs from page_copy_rec_list_end, because this function does not
 touch the lock table and max trx id on page or compress the page.
 
 IMPORTANT: The caller will have to update IBUF_BITMAP_FREE
 if new_block 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(). */
void page_copy_rec_list_end_no_locks(
    buf_block_t *new_block, /*!< in: index page to copy to */
    buf_block_t *block,     /*!< in: index page of rec */
    rec_t *rec,             /*!< in: record on page */
    dict_index_t *index,    /*!< in: record descriptor */
    mtr_t *mtr);            /*!< in: mtr */
/** Copies records from page to new_page, from the given record onward,
 including that record. Infimum and supremum records are not copied.
 The records are copied to the start of the record list on new_page.
 
 IMPORTANT: The caller will have to update IBUF_BITMAP_FREE
 if new_block 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().
 
 @return pointer to the original successor of the infimum record on
 new_page, or NULL on zip overflow (new_block will be decompressed) */
rec_t *page_copy_rec_list_end(
    buf_block_t *new_block, /*!< in/out: index page to copy to */
    buf_block_t *block,     /*!< in: index page containing rec */
    rec_t *rec,             /*!< in: record on page */
    dict_index_t *index,    /*!< in: record descriptor */
    mtr_t *mtr);            /*!< in: mtr */
/** Copies records from page to new_page, up to the given record, NOT
 including that record. Infimum and supremum records are not copied.
 The records are copied to the end of the record list on new_page.
 
 IMPORTANT: The caller will have to update IBUF_BITMAP_FREE
 if new_block 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().
 
 @return pointer to the original predecessor of the supremum record on
 new_page, or NULL on zip overflow (new_block will be decompressed) */
rec_t *page_copy_rec_list_start(
    buf_block_t *new_block, /*!< in/out: index page to copy to */
    buf_block_t *block,     /*!< in: index page containing rec */
    rec_t *rec,             /*!< in: record on page */
    dict_index_t *index,    /*!< in: record descriptor */
    mtr_t *mtr);            /*!< in: mtr */
/** Deletes records from a page from a given record onward, including that
 record. The infimum and supremum records are not deleted. */
void page_delete_rec_list_end(
    rec_t *rec,          /*!< in: pointer to record on page */
    buf_block_t *block,  /*!< in: buffer block of the page */
    dict_index_t *index, /*!< in: record descriptor */
    ulint n_recs,        /*!< in: number of records to delete,
                         or ULINT_UNDEFINED if not known */
    ulint size,          /*!< in: the sum of the sizes of the
                         records in the end of the chain to
                         delete, or ULINT_UNDEFINED if not known */
    mtr_t *mtr);         /*!< in: mtr */
/** Deletes records from page, up to the given record, NOT including
 that record. Infimum and supremum records are not deleted. */
void page_delete_rec_list_start(
    rec_t *rec,          /*!< in: record on page */
    buf_block_t *block,  /*!< in: buffer block of the page */
    dict_index_t *index, /*!< in: record descriptor */
    mtr_t *mtr);         /*!< in: mtr */
/** Moves record list end to another page. Moved records include
 split_rec.
 
 IMPORTANT: The caller will have to update IBUF_BITMAP_FREE
 if new_block 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().
 
 @return true on success; false on compression failure (new_block will
 be decompressed) */
bool page_move_rec_list_end(
    buf_block_t *new_block, /*!< in/out: index page where to move */
    buf_block_t *block,     /*!< in: index page from where to move */
    rec_t *split_rec,       /*!< in: first record to move */
    dict_index_t *index,    /*!< in: record descriptor */
    mtr_t *mtr);            /*!< in: mtr */
/** Moves record list start to another page. Moved records do not include
 split_rec.
 
 IMPORTANT: The caller will have to update IBUF_BITMAP_FREE
 if new_block 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().
 
 @return true on success; false on compression failure */
bool page_move_rec_list_start(
    buf_block_t *new_block, /*!< in/out: index page where to move */
    buf_block_t *block,     /*!< in/out: page containing split_rec */
    rec_t *split_rec,       /*!< in: first record not to move */
    dict_index_t *index,    /*!< in: record descriptor */
    mtr_t *mtr);            /*!< in: mtr */
 
/** Splits a directory slot which owns too many records.
@param[in,out] page Index page
@param[in,out] page_zip Compressed page whose uncompressed part will be written,
or null
@param[in] slot_no The directory slot */
void page_dir_split_slot(page_t *page, page_zip_des_t *page_zip, ulint slot_no);
 
/** Tries to balance the given directory slot with too few records with the
 upper neighbor, so that there are at least the minimum number of records
owned by the slot; this may result in the merging of two slots.
@param[in,out] page Index page
@param[in,out] page_zip Compressed page, or null
@param[in] slot_no The directory slot */
void page_dir_balance_slot(page_t *page, page_zip_des_t *page_zip,
                           ulint slot_no);
 
/** Parses a log record of a record list end or start deletion.
 @return end of log record or NULL */
const byte *page_parse_delete_rec_list(
    mlog_id_t type,      /*!< in: MLOG_LIST_END_DELETE,
                         MLOG_LIST_START_DELETE,
                         MLOG_COMP_LIST_END_DELETE or
                         MLOG_COMP_LIST_START_DELETE */
    const byte *ptr,     /*!< in: buffer */
    const byte *end_ptr, /*!< in: buffer end */
    buf_block_t *block,  /*!< in/out: buffer block or NULL */
    dict_index_t *index, /*!< in: record descriptor */
    mtr_t *mtr);         /*!< in: mtr or NULL */
 
/** Parses a redo log record of creating a page.
@param[in,out]  block           buffer block, or NULL
@param[in]      comp            nonzero=compact page format
@param[in]      page_type       page type (FIL_PAGE_INDEX, FIL_PAGE_RTREE
                                or FIL_PAGE_SDI) */
void page_parse_create(buf_block_t *block, ulint comp, page_type_t page_type);
 
#ifndef UNIV_HOTBACKUP
/** Prints record contents including the data relevant only in
 the index page context.
@param[in] rec Physical record
@param[in] offsets Record descriptor */
void page_rec_print(const rec_t *rec, const ulint *offsets);
#ifdef UNIV_DEBUG
/** This is used to print the contents of the directory for
 debugging purposes. */
void page_dir_print(page_t *page, /*!< in: index page */
                    ulint pr_n);  /*!< in: print n first and n last entries */
/** This is used to print the contents of the page record list for
 debugging purposes. */
void page_print_list(
    buf_block_t *block,  /*!< in: index page */
    dict_index_t *index, /*!< in: dictionary index of the page */
    ulint pr_n);         /*!< in: print n first and n last entries */
/** Prints the info in a page header. */
void page_header_print(const page_t *page); /*!< in: index page */
/** This is used to print the contents of the page for
 debugging purposes. */
void page_print(buf_block_t *block,  /*!< in: index page */
                dict_index_t *index, /*!< in: dictionary index of the page */
                ulint dn,            /*!< in: print dn first and last entries
                                     in directory */
                ulint rn);           /*!< in: print rn first and last records
                                     in directory */
#endif                               /* UNIV_DEBUG */
#endif                               /* !UNIV_HOTBACKUP */
/** The following is used to validate a record on a page. This function
 differs from rec_validate as it can also check the n_owned field and
 the heap_no field.
 @return true if ok */
bool page_rec_validate(
    const rec_t *rec,      /*!< in: physical record */
    const ulint *offsets); /*!< in: array returned by rec_get_offsets() */
#ifdef UNIV_DEBUG
/** Checks that the first directory slot points to the infimum record and
 the last to the supremum. This function is intended to track if the
 bug fixed in 4.0.14 has caused corruption to users' databases. */
void page_check_dir(const page_t *page); /*!< in: index page */
#endif                                   /* UNIV_DEBUG */
/** This function checks the consistency of an index page when we do not
 know the index. This is also resilient so that this should never crash
 even if the page is total garbage.
 @return true if ok */
bool page_simple_validate_old(
    const page_t *page); /*!< in: index page in ROW_FORMAT=REDUNDANT */
/** This function checks the consistency of an index page when we do not
 know the index. This is also resilient so that this should never crash
 even if the page is total garbage.
 @return true if ok */
bool page_simple_validate_new(
    const page_t *page); /*!< in: index page in ROW_FORMAT!=REDUNDANT */
 
/** This function checks the consistency of an index page.
@param[in]  page   index page
@param[in]  index  data dictionary index containing the page record type
definition
@param[in]  check_min_rec  check whether min rec flag (REC_INFO_MIN_REC_FLAG)
is correctly set in the page. The default value is true.
@return true if ok */
bool page_validate(const page_t *page, dict_index_t *index,
                   bool check_min_rec = true);
 
/** Looks in the page record list for a record with the given heap number.
 @return record, NULL if not found */
const rec_t *page_find_rec_with_heap_no(
    const page_t *page, /*!< in: index page */
    ulint heap_no);     /*!< in: heap number */
/** Get the last non-delete-marked record on a page.
@param[in]      page    index tree leaf page
@return the last record, not delete-marked
@retval infimum record if all records are delete-marked */
const rec_t *page_find_rec_last_not_deleted(const page_t *page);
 
/** Issue a warning when the checksum that is stored in the page is valid,
but different than the global setting innodb_checksum_algorithm.
@param[in]      curr_algo       current checksum algorithm
@param[in]      page_checksum   page valid checksum
@param[in]      page_id         page identifier */
void page_warn_strict_checksum(srv_checksum_algorithm_t curr_algo,
                               srv_checksum_algorithm_t page_checksum,
                               const page_id_t &page_id);
 
/** Check that a page_size is correct for InnoDB.
If correct, set the associated page_size_shift which is the power of 2
for this page size.
@param[in]      page_size       Page Size to evaluate
@return an associated page_size_shift if valid, 0 if invalid. */
inline ulong page_size_validate(ulong page_size);
 
/** This function checks if the page in which record is present is a
non-leaf node of a spatial index.
param[in]       rec     Btree record
param[in]       index   index
@return true if ok */
bool page_is_spatial_non_leaf(const rec_t *rec, dict_index_t *index);
 
page_t *page_create_low(buf_block_t *block, ulint comp, page_type_t page_type);
 
#include "page0page.ic"
 
#endif