MySQL 8.4.3
Source Code Documentation
psi_table.h
Go to the documentation of this file.
1/* Copyright (c) 2008, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef MYSQL_PSI_TABLE_H
25#define MYSQL_PSI_TABLE_H
26
27/**
28 @file include/mysql/psi/psi_table.h
29 Performance schema instrumentation interface.
30
31 @defgroup psi_abi_table Table Instrumentation (ABI)
32 @ingroup psi_abi
33 @{
34*/
35
36#include "my_inttypes.h"
37#include "my_macros.h"
38
39/* HAVE_PSI_*_INTERFACE */
40#include "my_psi_config.h" // IWYU pragma: keep
41
42#include "my_sharedlib.h"
44
45/**
46 @def PSI_TABLE_VERSION_1
47 Performance Schema Table Interface number for version 1.
48 This version is supported.
49*/
50#define PSI_TABLE_VERSION_1 1
51
52/**
53 @def PSI_CURRENT_TABLE_VERSION
54 Performance Schema Table Interface number for the most recent version.
55 The most current version is @c PSI_TABLE_VERSION_1
56*/
57#define PSI_CURRENT_TABLE_VERSION 1
58
59/** Entry point for the performance schema interface. */
61 /**
62 ABI interface finder.
63 Calling this method with an interface version number returns either
64 an instance of the ABI for this version, or NULL.
65 @sa PSI_TABLE_VERSION_1
66 @sa PSI_TABLE_VERSION_2
67 @sa PSI_CURRENT_TABLE_VERSION
68 */
69 void *(*get_interface)(int version);
70};
72
73#ifdef HAVE_PSI_TABLE_INTERFACE
74
75/**
76 Performance Schema Transaction Interface, version 1.
77 @since PSI_TABLE_VERSION_1
78*/
80 /** @sa get_table_share_v1_t. */
82 /** @sa release_table_share_v1_t. */
84 /** @sa drop_table_share_v1_t. */
86 /** @sa open_table_v1_t. */
88 /** @sa unbind_table_v1_t. */
90 /** @sa rebind_table_v1_t. */
92 /** @sa close_table_v1_t. */
94 /** @sa start_table_io_wait_v1_t. */
96 /** @sa end_table_io_wait_v1_t. */
98 /** @sa start_table_lock_wait_v1_t. */
100 /** @sa end_table_lock_wait_v1_t. */
102 /** @sa end_table_lock_wait_v1_t. */
104};
105
107
109
110#endif /* HAVE_PSI_TABLE_INTERFACE */
111
112/** @} (end of group psi_abi_table) */
113
114#endif /* MYSQL_PSI_TRANSACTION_H */
MYSQL_PLUGIN_IMPORT PSI_table_service_t * psi_table_service
Definition: psi_noop.cc:546
void(* end_table_io_wait_v1_t)(struct PSI_table_locker *locker, unsigned long long numrows)
Record a table instrumentation io wait end event.
Definition: psi_table_bits.h:201
void(* release_table_share_v1_t)(struct PSI_table_share *share)
Release a table share.
Definition: psi_table_bits.h:131
struct PSI_table_locker *(* start_table_lock_wait_v1_t)(struct PSI_table_locker_state *state, struct PSI_table *table, enum PSI_table_lock_operation op, unsigned long flags, const char *src_file, unsigned int src_line)
Record a table instrumentation lock wait start event.
Definition: psi_table_bits.h:213
void(* end_table_lock_wait_v1_t)(struct PSI_table_locker *locker)
Record a table instrumentation lock wait end event.
Definition: psi_table_bits.h:222
struct PSI_table *(* open_table_v1_t)(struct PSI_table_share *share, const void *identity)
Open an instrumentation table handle.
Definition: psi_table_bits.h:152
void(* unlock_table_v1_t)(struct PSI_table *table)
Record a table unlock event.
Definition: psi_table_bits.h:228
void(* close_table_v1_t)(struct TABLE_SHARE *server_share, struct PSI_table *table)
Close an instrumentation table handle.
Definition: psi_table_bits.h:179
void(* unbind_table_v1_t)(struct PSI_table *table)
Unbind a table handle from the current thread.
Definition: psi_table_bits.h:160
struct PSI_table_share *(* get_table_share_v1_t)(bool temporary, struct TABLE_SHARE *share)
Acquire a table share instrumentation.
Definition: psi_table_bits.h:124
void(* drop_table_share_v1_t)(bool temporary, const char *schema_name, int schema_name_length, const char *table_name, int table_name_length)
Drop a table share.
Definition: psi_table_bits.h:141
struct PSI_table_locker *(* start_table_io_wait_v1_t)(struct PSI_table_locker_state *state, struct PSI_table *table, enum PSI_table_io_operation op, unsigned int index, const char *src_file, unsigned int src_line)
Record a table instrumentation io wait start event.
Definition: psi_table_bits.h:191
PSI_table *(* rebind_table_v1_t)(PSI_table_share *share, const void *identity, PSI_table *table)
Rebind a table handle to the current thread.
Definition: psi_table_bits.h:170
Some integer typedefs for easier portability.
Some common macros.
Defines various enable/disable and HAVE_ macros related to the performance schema instrumentation sys...
Functions related to handling of plugins and other dynamically loaded libraries.
#define MYSQL_PLUGIN_IMPORT
Definition: my_sharedlib.h:71
Performance schema instrumentation interface.
required uint64 version
Definition: replication_group_member_actions.proto:41
Entry point for the performance schema interface.
Definition: psi_table.h:60
Performance Schema Transaction Interface, version 1.
Definition: psi_table.h:79
start_table_io_wait_v1_t start_table_io_wait
Definition: psi_table.h:95
release_table_share_v1_t release_table_share
Definition: psi_table.h:83
rebind_table_v1_t rebind_table
Definition: psi_table.h:91
start_table_lock_wait_v1_t start_table_lock_wait
Definition: psi_table.h:99
end_table_io_wait_v1_t end_table_io_wait
Definition: psi_table.h:97
close_table_v1_t close_table
Definition: psi_table.h:93
get_table_share_v1_t get_table_share
Definition: psi_table.h:81
unlock_table_v1_t unlock_table
Definition: psi_table.h:103
drop_table_share_v1_t drop_table_share
Definition: psi_table.h:85
open_table_v1_t open_table
Definition: psi_table.h:87
unbind_table_v1_t unbind_table
Definition: psi_table.h:89
end_table_lock_wait_v1_t end_table_lock_wait
Definition: psi_table.h:101