MySQL 8.0.31
Source Code Documentation
fut0fut.h
Go to the documentation of this file.
1/*****************************************************************************
2
3Copyright (c) 1995, 2022, Oracle and/or its affiliates.
4
5This program is free software; you can redistribute it and/or modify it under
6the terms of the GNU General Public License, version 2.0, as published by the
7Free Software Foundation.
8
9This program is also distributed with certain software (including but not
10limited to OpenSSL) that is licensed under separate terms, as designated in a
11particular file or component or in included license documentation. The authors
12of MySQL hereby grant you an additional permission to link the program and
13your derivative works with the separately licensed software that they have
14included with MySQL.
15
16This program is distributed in the hope that it will be useful, but WITHOUT
17ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
19for more details.
20
21You should have received a copy of the GNU General Public License along with
22this program; if not, write to the Free Software Foundation, Inc.,
2351 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24
25*****************************************************************************/
26
27/** @file include/fut0fut.h
28 File-based utilities
29
30 Created 12/13/1995 Heikki Tuuri
31 ***********************************************************************/
32
33#ifndef fut0fut_h
34#define fut0fut_h
35
36#include "univ.i"
37
38#include "fil0fil.h"
39#include "mtr0mtr.h"
40
41#ifndef UNIV_HOTBACKUP
42/** Gets a pointer to a file address and latches the page.
43@param[in] space Space id
44@param[in] page_size Page size
45@param[in] addr File address
46@param[in] rw_latch RW_S_LATCH, RW_X_LATCH, RW_SX_LATCH
47@param[out] ptr_block File page
48@param[in,out] mtr Mini-transaction
49@return pointer to a byte in (*ptr_block)->frame; the *ptr_block is
50bufferfixed and latched */
51[[nodiscard]] static inline byte *fut_get_ptr(
52 space_id_t space, const page_size_t &page_size, fil_addr_t addr,
53 rw_lock_type_t rw_latch, mtr_t *mtr, buf_block_t **ptr_block = nullptr);
54
55#include "fut0fut.ic"
56#endif /* !UNIV_HOTBACKUP */
57
58#endif /* fut0fut_h */
uint32_t space_id_t
Tablespace identifier.
Definition: api0api.h:50
Page size descriptor.
Definition: page0size.h:49
The low-level file system.
static byte * fut_get_ptr(space_id_t space, const page_size_t &page_size, fil_addr_t addr, rw_lock_type_t rw_latch, mtr_t *mtr, buf_block_t **ptr_block=nullptr)
Gets a pointer to a file address and latches the page.
File-based utilities.
Mini-transaction buffer.
The buffer control block structure.
Definition: buf0buf.h:1664
File space address.
Definition: fil0fil.h:1139
Mini-transaction handle and buffer.
Definition: mtr0mtr.h:181
rw_lock_type_t
Definition: sync0rw.h:93
Version control for database, common definitions, and include files.