mirror of
https://github.com/MariaDB/server.git
synced 2025-01-23 15:24:16 +01:00
3486135bb5
Merge Facebook commit 25295d003cb0c17aa8fb756523923c77250b3294 authored by Steaphan Greene from https://github.com/facebook/mysql-5.6 This adds a pointer to the trx to each mtr. This allows the trx to be accessed in parts of the code where it was otherwise not available. This is needed later.
434 lines
14 KiB
C
434 lines
14 KiB
C
/*****************************************************************************
|
|
|
|
Copyright (c) 1995, 2013, Oracle and/or its affiliates. All Rights Reserved.
|
|
Copyright (c) 2012, Facebook Inc.
|
|
|
|
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/mtr0mtr.h
|
|
Mini-transaction buffer
|
|
|
|
Created 11/26/1995 Heikki Tuuri
|
|
*******************************************************/
|
|
|
|
#ifndef mtr0mtr_h
|
|
#define mtr0mtr_h
|
|
|
|
#include "univ.i"
|
|
#include "mem0mem.h"
|
|
#include "dyn0dyn.h"
|
|
#include "buf0types.h"
|
|
#include "sync0rw.h"
|
|
#include "ut0byte.h"
|
|
#include "mtr0types.h"
|
|
#include "page0types.h"
|
|
#include "trx0types.h"
|
|
|
|
/* Logging modes for a mini-transaction */
|
|
#define MTR_LOG_ALL 21 /* default mode: log all operations
|
|
modifying disk-based data */
|
|
#define MTR_LOG_NONE 22 /* log no operations */
|
|
#define MTR_LOG_NO_REDO 23 /* Don't generate REDO */
|
|
/*#define MTR_LOG_SPACE 23 */ /* log only operations modifying
|
|
file space page allocation data
|
|
(operations in fsp0fsp.* ) */
|
|
#define MTR_LOG_SHORT_INSERTS 24 /* inserts are logged in a shorter
|
|
form */
|
|
|
|
/* Types for the mlock objects to store in the mtr memo; NOTE that the
|
|
first 3 values must be RW_S_LATCH, RW_X_LATCH, RW_NO_LATCH */
|
|
#define MTR_MEMO_PAGE_S_FIX RW_S_LATCH
|
|
#define MTR_MEMO_PAGE_X_FIX RW_X_LATCH
|
|
#define MTR_MEMO_BUF_FIX RW_NO_LATCH
|
|
#ifdef UNIV_DEBUG
|
|
# define MTR_MEMO_MODIFY 54
|
|
#endif /* UNIV_DEBUG */
|
|
#define MTR_MEMO_S_LOCK 55
|
|
#define MTR_MEMO_X_LOCK 56
|
|
|
|
/** @name Log item types
|
|
The log items are declared 'byte' so that the compiler can warn if val
|
|
and type parameters are switched in a call to mlog_write_ulint. NOTE!
|
|
For 1 - 8 bytes, the flag value must give the length also! @{ */
|
|
#define MLOG_SINGLE_REC_FLAG 128 /*!< if the mtr contains only
|
|
one log record for one page,
|
|
i.e., write_initial_log_record
|
|
has been called only once,
|
|
this flag is ORed to the type
|
|
of that first log record */
|
|
#define MLOG_1BYTE (1) /*!< one byte is written */
|
|
#define MLOG_2BYTES (2) /*!< 2 bytes ... */
|
|
#define MLOG_4BYTES (4) /*!< 4 bytes ... */
|
|
#define MLOG_8BYTES (8) /*!< 8 bytes ... */
|
|
#define MLOG_REC_INSERT ((byte)9) /*!< record insert */
|
|
#define MLOG_REC_CLUST_DELETE_MARK ((byte)10) /*!< mark clustered index record
|
|
deleted */
|
|
#define MLOG_REC_SEC_DELETE_MARK ((byte)11) /*!< mark secondary index record
|
|
deleted */
|
|
#define MLOG_REC_UPDATE_IN_PLACE ((byte)13) /*!< update of a record,
|
|
preserves record field sizes */
|
|
#define MLOG_REC_DELETE ((byte)14) /*!< delete a record from a
|
|
page */
|
|
#define MLOG_LIST_END_DELETE ((byte)15) /*!< delete record list end on
|
|
index page */
|
|
#define MLOG_LIST_START_DELETE ((byte)16) /*!< delete record list start on
|
|
index page */
|
|
#define MLOG_LIST_END_COPY_CREATED ((byte)17) /*!< copy record list end to a
|
|
new created index page */
|
|
#define MLOG_PAGE_REORGANIZE ((byte)18) /*!< reorganize an
|
|
index page in
|
|
ROW_FORMAT=REDUNDANT */
|
|
#define MLOG_PAGE_CREATE ((byte)19) /*!< create an index page */
|
|
#define MLOG_UNDO_INSERT ((byte)20) /*!< insert entry in an undo
|
|
log */
|
|
#define MLOG_UNDO_ERASE_END ((byte)21) /*!< erase an undo log
|
|
page end */
|
|
#define MLOG_UNDO_INIT ((byte)22) /*!< initialize a page in an
|
|
undo log */
|
|
#define MLOG_UNDO_HDR_DISCARD ((byte)23) /*!< discard an update undo log
|
|
header */
|
|
#define MLOG_UNDO_HDR_REUSE ((byte)24) /*!< reuse an insert undo log
|
|
header */
|
|
#define MLOG_UNDO_HDR_CREATE ((byte)25) /*!< create an undo
|
|
log header */
|
|
#define MLOG_REC_MIN_MARK ((byte)26) /*!< mark an index
|
|
record as the
|
|
predefined minimum
|
|
record */
|
|
#define MLOG_IBUF_BITMAP_INIT ((byte)27) /*!< initialize an
|
|
ibuf bitmap page */
|
|
/*#define MLOG_FULL_PAGE ((byte)28) full contents of a page */
|
|
#ifdef UNIV_LOG_LSN_DEBUG
|
|
# define MLOG_LSN ((byte)28) /* current LSN */
|
|
#endif
|
|
#define MLOG_INIT_FILE_PAGE ((byte)29) /*!< this means that a
|
|
file page is taken
|
|
into use and the prior
|
|
contents of the page
|
|
should be ignored: in
|
|
recovery we must not
|
|
trust the lsn values
|
|
stored to the file
|
|
page */
|
|
#define MLOG_WRITE_STRING ((byte)30) /*!< write a string to
|
|
a page */
|
|
#define MLOG_MULTI_REC_END ((byte)31) /*!< if a single mtr writes
|
|
several log records,
|
|
this log record ends the
|
|
sequence of these records */
|
|
#define MLOG_DUMMY_RECORD ((byte)32) /*!< dummy log record used to
|
|
pad a log block full */
|
|
#define MLOG_FILE_CREATE ((byte)33) /*!< log record about an .ibd
|
|
file creation */
|
|
#define MLOG_FILE_RENAME ((byte)34) /*!< log record about an .ibd
|
|
file rename */
|
|
#define MLOG_FILE_DELETE ((byte)35) /*!< log record about an .ibd
|
|
file deletion */
|
|
#define MLOG_COMP_REC_MIN_MARK ((byte)36) /*!< mark a compact
|
|
index record as the
|
|
predefined minimum
|
|
record */
|
|
#define MLOG_COMP_PAGE_CREATE ((byte)37) /*!< create a compact
|
|
index page */
|
|
#define MLOG_COMP_REC_INSERT ((byte)38) /*!< compact record insert */
|
|
#define MLOG_COMP_REC_CLUST_DELETE_MARK ((byte)39)
|
|
/*!< mark compact
|
|
clustered index record
|
|
deleted */
|
|
#define MLOG_COMP_REC_SEC_DELETE_MARK ((byte)40)/*!< mark compact
|
|
secondary index record
|
|
deleted; this log
|
|
record type is
|
|
redundant, as
|
|
MLOG_REC_SEC_DELETE_MARK
|
|
is independent of the
|
|
record format. */
|
|
#define MLOG_COMP_REC_UPDATE_IN_PLACE ((byte)41)/*!< update of a
|
|
compact record,
|
|
preserves record field
|
|
sizes */
|
|
#define MLOG_COMP_REC_DELETE ((byte)42) /*!< delete a compact record
|
|
from a page */
|
|
#define MLOG_COMP_LIST_END_DELETE ((byte)43) /*!< delete compact record list
|
|
end on index page */
|
|
#define MLOG_COMP_LIST_START_DELETE ((byte)44) /*!< delete compact record list
|
|
start on index page */
|
|
#define MLOG_COMP_LIST_END_COPY_CREATED ((byte)45)
|
|
/*!< copy compact
|
|
record list end to a
|
|
new created index
|
|
page */
|
|
#define MLOG_COMP_PAGE_REORGANIZE ((byte)46) /*!< reorganize an index page */
|
|
#define MLOG_FILE_CREATE2 ((byte)47) /*!< log record about creating
|
|
an .ibd file, with format */
|
|
#define MLOG_ZIP_WRITE_NODE_PTR ((byte)48) /*!< write the node pointer of
|
|
a record on a compressed
|
|
non-leaf B-tree page */
|
|
#define MLOG_ZIP_WRITE_BLOB_PTR ((byte)49) /*!< write the BLOB pointer
|
|
of an externally stored column
|
|
on a compressed page */
|
|
#define MLOG_ZIP_WRITE_HEADER ((byte)50) /*!< write to compressed page
|
|
header */
|
|
#define MLOG_ZIP_PAGE_COMPRESS ((byte)51) /*!< compress an index page */
|
|
#define MLOG_ZIP_PAGE_COMPRESS_NO_DATA ((byte)52)/*!< compress an index page
|
|
without logging it's image */
|
|
#define MLOG_ZIP_PAGE_REORGANIZE ((byte)53) /*!< reorganize a compressed
|
|
page */
|
|
#define MLOG_BIGGEST_TYPE ((byte)53) /*!< biggest value (used in
|
|
assertions) */
|
|
/* @} */
|
|
|
|
/** @name Flags for MLOG_FILE operations
|
|
(stored in the page number parameter, called log_flags in the
|
|
functions). The page number parameter was originally written as 0. @{ */
|
|
#define MLOG_FILE_FLAG_TEMP 1 /*!< identifies TEMPORARY TABLE in
|
|
MLOG_FILE_CREATE, MLOG_FILE_CREATE2 */
|
|
/* @} */
|
|
|
|
/* included here because it needs MLOG_LSN defined */
|
|
#include "log0log.h"
|
|
|
|
/***************************************************************//**
|
|
Starts a mini-transaction. */
|
|
UNIV_INLINE
|
|
void
|
|
mtr_start_trx(
|
|
/*======*/
|
|
mtr_t* mtr, /*!< out: mini-transaction */
|
|
trx_t* trx) /*!< in: transaction */
|
|
__attribute__((nonnull (1)));
|
|
/***************************************************************//**
|
|
Starts a mini-transaction. */
|
|
UNIV_INLINE
|
|
void
|
|
mtr_start(
|
|
/*======*/
|
|
mtr_t* mtr) /*!< out: mini-transaction */
|
|
{
|
|
mtr_start_trx(mtr, NULL);
|
|
}
|
|
__attribute__((nonnull))
|
|
/***************************************************************//**
|
|
Commits a mini-transaction. */
|
|
UNIV_INTERN
|
|
void
|
|
mtr_commit(
|
|
/*=======*/
|
|
mtr_t* mtr) /*!< in/out: mini-transaction */
|
|
__attribute__((nonnull));
|
|
/**********************************************************//**
|
|
Sets and returns a savepoint in mtr.
|
|
@return savepoint */
|
|
UNIV_INLINE
|
|
ulint
|
|
mtr_set_savepoint(
|
|
/*==============*/
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
#ifndef UNIV_HOTBACKUP
|
|
/**********************************************************//**
|
|
Releases the (index tree) s-latch stored in an mtr memo after a
|
|
savepoint. */
|
|
UNIV_INLINE
|
|
void
|
|
mtr_release_s_latch_at_savepoint(
|
|
/*=============================*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
ulint savepoint, /*!< in: savepoint */
|
|
prio_rw_lock_t* lock); /*!< in: latch to release */
|
|
#else /* !UNIV_HOTBACKUP */
|
|
# define mtr_release_s_latch_at_savepoint(mtr,savepoint,lock) ((void) 0)
|
|
#endif /* !UNIV_HOTBACKUP */
|
|
/***************************************************************//**
|
|
Gets the logging mode of a mini-transaction.
|
|
@return logging mode: MTR_LOG_NONE, ... */
|
|
UNIV_INLINE
|
|
ulint
|
|
mtr_get_log_mode(
|
|
/*=============*/
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
/***************************************************************//**
|
|
Changes the logging mode of a mini-transaction.
|
|
@return old mode */
|
|
UNIV_INLINE
|
|
ulint
|
|
mtr_set_log_mode(
|
|
/*=============*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
ulint mode); /*!< in: logging mode: MTR_LOG_NONE, ... */
|
|
/********************************************************//**
|
|
Reads 1 - 4 bytes from a file page buffered in the buffer pool.
|
|
@return value read */
|
|
UNIV_INTERN
|
|
ulint
|
|
mtr_read_ulint(
|
|
/*===========*/
|
|
const byte* ptr, /*!< in: pointer from where to read */
|
|
ulint type, /*!< in: MLOG_1BYTE, MLOG_2BYTES, MLOG_4BYTES */
|
|
mtr_t* mtr); /*!< in: mini-transaction handle */
|
|
#ifndef UNIV_HOTBACKUP
|
|
/*********************************************************************//**
|
|
This macro locks an rw-lock in s-mode. */
|
|
#define mtr_s_lock(B, MTR) mtr_s_lock_func((B), __FILE__, __LINE__,\
|
|
(MTR))
|
|
/*********************************************************************//**
|
|
This macro locks an rw-lock in x-mode. */
|
|
#define mtr_x_lock(B, MTR) mtr_x_lock_func((B), __FILE__, __LINE__,\
|
|
(MTR))
|
|
/*********************************************************************//**
|
|
NOTE! Use the macro above!
|
|
Locks a lock in s-mode. */
|
|
UNIV_INLINE
|
|
void
|
|
mtr_s_lock_func(
|
|
/*============*/
|
|
prio_rw_lock_t* lock, /*!< in: rw-lock */
|
|
const char* file, /*!< in: file name */
|
|
ulint line, /*!< in: line number */
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
/*********************************************************************//**
|
|
NOTE! Use the macro above!
|
|
Locks a lock in x-mode. */
|
|
UNIV_INLINE
|
|
void
|
|
mtr_x_lock_func(
|
|
/*============*/
|
|
prio_rw_lock_t* lock, /*!< in: rw-lock */
|
|
const char* file, /*!< in: file name */
|
|
ulint line, /*!< in: line number */
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
#endif /* !UNIV_HOTBACKUP */
|
|
|
|
/***************************************************//**
|
|
Releases an object in the memo stack.
|
|
@return true if released */
|
|
UNIV_INTERN
|
|
bool
|
|
mtr_memo_release(
|
|
/*=============*/
|
|
mtr_t* mtr, /*!< in/out: mini-transaction */
|
|
void* object, /*!< in: object */
|
|
ulint type) /*!< in: object type: MTR_MEMO_S_LOCK, ... */
|
|
__attribute__((nonnull));
|
|
#ifdef UNIV_DEBUG
|
|
# ifndef UNIV_HOTBACKUP
|
|
/**********************************************************//**
|
|
Checks if memo contains the given item.
|
|
@return TRUE if contains */
|
|
UNIV_INLINE
|
|
bool
|
|
mtr_memo_contains(
|
|
/*==============*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
const void* object, /*!< in: object to search */
|
|
ulint type) /*!< in: type of object */
|
|
__attribute__((warn_unused_result, nonnull));
|
|
|
|
/**********************************************************//**
|
|
Checks if memo contains the given page.
|
|
@return TRUE if contains */
|
|
UNIV_INTERN
|
|
ibool
|
|
mtr_memo_contains_page(
|
|
/*===================*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
const byte* ptr, /*!< in: pointer to buffer frame */
|
|
ulint type); /*!< in: type of object */
|
|
/*********************************************************//**
|
|
Prints info of an mtr handle. */
|
|
UNIV_INTERN
|
|
void
|
|
mtr_print(
|
|
/*======*/
|
|
mtr_t* mtr); /*!< in: mtr */
|
|
# else /* !UNIV_HOTBACKUP */
|
|
# define mtr_memo_contains(mtr, object, type) TRUE
|
|
# define mtr_memo_contains_page(mtr, ptr, type) TRUE
|
|
# endif /* !UNIV_HOTBACKUP */
|
|
#endif /* UNIV_DEBUG */
|
|
/*######################################################################*/
|
|
|
|
#define MTR_BUF_MEMO_SIZE 200 /* number of slots in memo */
|
|
|
|
/***************************************************************//**
|
|
Returns the log object of a mini-transaction buffer.
|
|
@return log */
|
|
UNIV_INLINE
|
|
dyn_array_t*
|
|
mtr_get_log(
|
|
/*========*/
|
|
mtr_t* mtr); /*!< in: mini-transaction */
|
|
/***************************************************//**
|
|
Pushes an object to an mtr memo stack. */
|
|
UNIV_INLINE
|
|
void
|
|
mtr_memo_push(
|
|
/*==========*/
|
|
mtr_t* mtr, /*!< in: mtr */
|
|
void* object, /*!< in: object */
|
|
ulint type); /*!< in: object type: MTR_MEMO_S_LOCK, ... */
|
|
|
|
/** Mini-transaction memo stack slot. */
|
|
struct mtr_memo_slot_t{
|
|
ulint type; /*!< type of the stored object (MTR_MEMO_S_LOCK, ...) */
|
|
void* object; /*!< pointer to the object */
|
|
};
|
|
|
|
/* Mini-transaction handle and buffer */
|
|
struct mtr_t{
|
|
#ifdef UNIV_DEBUG
|
|
ulint state; /*!< MTR_ACTIVE, MTR_COMMITTING, MTR_COMMITTED */
|
|
#endif
|
|
dyn_array_t memo; /*!< memo stack for locks etc. */
|
|
dyn_array_t log; /*!< mini-transaction log */
|
|
unsigned inside_ibuf:1;
|
|
/*!< TRUE if inside ibuf changes */
|
|
unsigned modifications:1;
|
|
/*!< TRUE if the mini-transaction
|
|
modified buffer pool pages */
|
|
unsigned made_dirty:1;
|
|
/*!< TRUE if mtr has made at least
|
|
one buffer pool page dirty */
|
|
ulint n_log_recs;
|
|
/* count of how many page initial log records
|
|
have been written to the mtr log */
|
|
ulint n_freed_pages;
|
|
/* number of pages that have been freed in
|
|
this mini-transaction */
|
|
ulint log_mode; /* specifies which operations should be
|
|
logged; default value MTR_LOG_ALL */
|
|
lsn_t start_lsn;/* start lsn of the possible log entry for
|
|
this mtr */
|
|
lsn_t end_lsn;/* end lsn of the possible log entry for
|
|
this mtr */
|
|
#ifdef UNIV_DEBUG
|
|
ulint magic_n;
|
|
#endif /* UNIV_DEBUG */
|
|
trx_t* trx; /*!< transaction */
|
|
};
|
|
|
|
#ifdef UNIV_DEBUG
|
|
# define MTR_MAGIC_N 54551
|
|
#endif /* UNIV_DEBUG */
|
|
|
|
#define MTR_ACTIVE 12231
|
|
#define MTR_COMMITTING 56456
|
|
#define MTR_COMMITTED 34676
|
|
|
|
#ifndef UNIV_NONINL
|
|
#include "mtr0mtr.ic"
|
|
#endif
|
|
|
|
#endif
|