mirror of
https://github.com/MariaDB/server.git
synced 2025-01-20 22:12:30 +01:00
4e1116b2c6
Also, remove empty .ic files that were not removed by my MySQL commit. Problem: InnoDB used to support a compilation mode that allowed to choose whether the function definitions in .ic files are to be inlined or not. This stopped making sense when InnoDB moved to C++ in MySQL 5.6 (and ha_innodb.cc started to #include .ic files), and more so in MySQL 5.7 when inline methods and functions were introduced in .h files. Solution: Remove all references to UNIV_NONINL and UNIV_MUST_NOT_INLINE from all files, assuming that the symbols are never defined. Remove the files fut0fut.cc and ut0byte.cc which only mattered when UNIV_NONINL was defined.
248 lines
8.8 KiB
C
248 lines
8.8 KiB
C
/*****************************************************************************
|
|
|
|
Copyright (c) 1995, 2014, Oracle and/or its affiliates. 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 Street, Suite 500, Boston, MA 02110-1335 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/**************************************************//**
|
|
@file include/mtr0log.h
|
|
Mini-transaction logging routines
|
|
|
|
Created 12/7/1995 Heikki Tuuri
|
|
*******************************************************/
|
|
|
|
#ifndef mtr0log_h
|
|
#define mtr0log_h
|
|
|
|
#include "univ.i"
|
|
#include "mtr0mtr.h"
|
|
#include "dyn0buf.h"
|
|
|
|
// Forward declaration
|
|
struct dict_index_t;
|
|
|
|
/********************************************************//**
|
|
Writes 1, 2 or 4 bytes to a file page. Writes the corresponding log
|
|
record to the mini-transaction log if mtr is not NULL. */
|
|
void
|
|
mlog_write_ulint(
|
|
/*=============*/
|
|
byte* ptr, /*!< in: pointer where to write */
|
|
ulint val, /*!< in: value to write */
|
|
mlog_id_t type, /*!< in: MLOG_1BYTE, MLOG_2BYTES, MLOG_4BYTES */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
|
|
/********************************************************//**
|
|
Writes 8 bytes to a file page. Writes the corresponding log
|
|
record to the mini-transaction log, only if mtr is not NULL */
|
|
void
|
|
mlog_write_ull(
|
|
/*===========*/
|
|
byte* ptr, /*!< in: pointer where to write */
|
|
ib_uint64_t val, /*!< in: value to write */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************//**
|
|
Writes a string to a file page buffered in the buffer pool. Writes the
|
|
corresponding log record to the mini-transaction log. */
|
|
void
|
|
mlog_write_string(
|
|
/*==============*/
|
|
byte* ptr, /*!< in: pointer where to write */
|
|
const byte* str, /*!< in: string to write */
|
|
ulint len, /*!< in: string length */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************//**
|
|
Logs a write of a string to a file page buffered in the buffer pool.
|
|
Writes the corresponding log record to the mini-transaction log. */
|
|
void
|
|
mlog_log_string(
|
|
/*============*/
|
|
byte* ptr, /*!< in: pointer written to */
|
|
ulint len, /*!< in: string length */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************//**
|
|
Writes initial part of a log record consisting of one-byte item
|
|
type and four-byte space and page numbers. */
|
|
void
|
|
mlog_write_initial_log_record(
|
|
/*==========================*/
|
|
const byte* ptr, /*!< in: pointer to (inside) a buffer
|
|
frame holding the file page where
|
|
modification is made */
|
|
mlog_id_t type, /*!< in: log item type: MLOG_1BYTE, ... */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
/********************************************************//**
|
|
Catenates 1 - 4 bytes to the mtr log. The value is not compressed. */
|
|
UNIV_INLINE
|
|
void
|
|
mlog_catenate_ulint(
|
|
/*================*/
|
|
mtr_buf_t* dyn_buf, /*!< in/out: buffer to write */
|
|
ulint val, /*!< in: value to write */
|
|
mlog_id_t type); /*!< in: type of value to write */
|
|
/********************************************************//**
|
|
Catenates 1 - 4 bytes to the mtr log. */
|
|
UNIV_INLINE
|
|
void
|
|
mlog_catenate_ulint(
|
|
/*================*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
ulint val, /*!< in: value to write */
|
|
mlog_id_t type); /*!< in: MLOG_1BYTE, MLOG_2BYTES, MLOG_4BYTES */
|
|
/********************************************************//**
|
|
Catenates n bytes to the mtr log. */
|
|
void
|
|
mlog_catenate_string(
|
|
/*=================*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
const byte* str, /*!< in: string to write */
|
|
ulint len); /*!< in: string length */
|
|
/********************************************************//**
|
|
Catenates a compressed ulint to mlog. */
|
|
UNIV_INLINE
|
|
void
|
|
mlog_catenate_ulint_compressed(
|
|
/*===========================*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
ulint val); /*!< in: value to write */
|
|
/********************************************************//**
|
|
Catenates a compressed 64-bit integer to mlog. */
|
|
UNIV_INLINE
|
|
void
|
|
mlog_catenate_ull_compressed(
|
|
/*=========================*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
ib_uint64_t val); /*!< in: value to write */
|
|
/********************************************************//**
|
|
Opens a buffer to mlog. It must be closed with mlog_close.
|
|
@return buffer, NULL if log mode MTR_LOG_NONE */
|
|
UNIV_INLINE
|
|
byte*
|
|
mlog_open(
|
|
/*======*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
ulint size); /*!< in: buffer size in bytes; MUST be
|
|
smaller than DYN_ARRAY_DATA_SIZE! */
|
|
/********************************************************//**
|
|
Closes a buffer opened to mlog. */
|
|
UNIV_INLINE
|
|
void
|
|
mlog_close(
|
|
/*=======*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
byte* ptr); /*!< in: buffer space from ptr up was
|
|
not used */
|
|
|
|
/** Writes a log record about an operation.
|
|
@param[in] type redo log record type
|
|
@param[in] space_id tablespace identifier
|
|
@param[in] page_no page number
|
|
@param[in,out] log_ptr current end of mini-transaction log
|
|
@param[in,out] mtr mini-transaction
|
|
@return end of mini-transaction log */
|
|
UNIV_INLINE
|
|
byte*
|
|
mlog_write_initial_log_record_low(
|
|
mlog_id_t type,
|
|
ulint space_id,
|
|
ulint page_no,
|
|
byte* log_ptr,
|
|
mtr_t* mtr);
|
|
|
|
/********************************************************//**
|
|
Writes the initial part of a log record (3..11 bytes).
|
|
If the implementation of this function is changed, all
|
|
size parameters to mlog_open() should be adjusted accordingly!
|
|
@return new value of log_ptr */
|
|
UNIV_INLINE
|
|
byte*
|
|
mlog_write_initial_log_record_fast(
|
|
/*===============================*/
|
|
const byte* ptr, /*!< in: pointer to (inside) a buffer
|
|
frame holding the file page where
|
|
modification is made */
|
|
mlog_id_t type, /*!< in: log item type: MLOG_1BYTE, ... */
|
|
byte* log_ptr,/*!< in: pointer to mtr log which has
|
|
been opened */
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
/********************************************************//**
|
|
Parses an initial log record written by mlog_write_initial_log_record.
|
|
@return parsed record end, NULL if not a complete record */
|
|
byte*
|
|
mlog_parse_initial_log_record(
|
|
/*==========================*/
|
|
const byte* ptr, /*!< in: buffer */
|
|
const byte* end_ptr,/*!< in: buffer end */
|
|
mlog_id_t* type, /*!< out: log record type: MLOG_1BYTE, ... */
|
|
ulint* space, /*!< out: space id */
|
|
ulint* page_no);/*!< out: page number */
|
|
/********************************************************//**
|
|
Parses a log record written by mlog_write_ulint or mlog_write_ull.
|
|
@return parsed record end, NULL if not a complete record */
|
|
byte*
|
|
mlog_parse_nbytes(
|
|
/*==============*/
|
|
mlog_id_t type, /*!< in: log record type: MLOG_1BYTE, ... */
|
|
const byte* ptr, /*!< in: buffer */
|
|
const byte* end_ptr,/*!< in: buffer end */
|
|
byte* page, /*!< in: page where to apply the log record,
|
|
or NULL */
|
|
void* page_zip);/*!< in/out: compressed page, or NULL */
|
|
/********************************************************//**
|
|
Parses a log record written by mlog_write_string.
|
|
@return parsed record end, NULL if not a complete record */
|
|
byte*
|
|
mlog_parse_string(
|
|
/*==============*/
|
|
byte* ptr, /*!< in: buffer */
|
|
byte* end_ptr,/*!< in: buffer end */
|
|
byte* page, /*!< in: page where to apply the log record, or NULL */
|
|
void* page_zip);/*!< in/out: compressed page, or NULL */
|
|
|
|
/********************************************************//**
|
|
Opens a buffer for mlog, writes the initial log record and,
|
|
if needed, the field lengths of an index. Reserves space
|
|
for further log entries. The log entry must be closed with
|
|
mtr_close().
|
|
@return buffer, NULL if log mode MTR_LOG_NONE */
|
|
byte*
|
|
mlog_open_and_write_index(
|
|
/*======================*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
const byte* rec, /*!< in: index record or page */
|
|
const dict_index_t* index, /*!< in: record descriptor */
|
|
mlog_id_t type, /*!< in: log item type */
|
|
ulint size); /*!< in: requested buffer size in bytes
|
|
(if 0, calls mlog_close() and
|
|
returns NULL) */
|
|
|
|
/********************************************************//**
|
|
Parses a log record written by mlog_open_and_write_index.
|
|
@return parsed record end, NULL if not a complete record */
|
|
byte*
|
|
mlog_parse_index(
|
|
/*=============*/
|
|
byte* ptr, /*!< in: buffer */
|
|
const byte* end_ptr,/*!< in: buffer end */
|
|
ibool comp, /*!< in: TRUE=compact record format */
|
|
dict_index_t** index); /*!< out, own: dummy index */
|
|
|
|
/** Insert, update, and maybe other functions may use this value to define an
|
|
extra mlog buffer size for variable size data */
|
|
#define MLOG_BUF_MARGIN 256
|
|
|
|
#include "mtr0log.ic"
|
|
|
|
#endif /* mtr0log_h */
|