MySQL  8.0.27
Source Code Documentation
psi_table.h
Go to the documentation of this file.
1 /* Copyright (c) 2008, 2021, 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 also distributed 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 included with MySQL.
13 
14  This program is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License, version 2.0, for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with this program; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22 
23 #ifndef MYSQL_PSI_TABLE_H
24 #define MYSQL_PSI_TABLE_H
25 
26 /**
27  @file include/mysql/psi/psi_table.h
28  Performance schema instrumentation interface.
29 
30  @defgroup psi_abi_table Table Instrumentation (ABI)
31  @ingroup psi_abi
32  @{
33 */
34 
35 #include "my_inttypes.h"
36 #include "my_macros.h"
37 
38 /* HAVE_PSI_*_INTERFACE */
39 #include "my_psi_config.h" // IWYU pragma: keep
40 
41 #include "my_sharedlib.h"
43 
44 /**
45  @def PSI_TABLE_VERSION_1
46  Performance Schema Table Interface number for version 1.
47  This version is supported.
48 */
49 #define PSI_TABLE_VERSION_1 1
50 
51 /**
52  @def PSI_CURRENT_TABLE_VERSION
53  Performance Schema Table Interface number for the most recent version.
54  The most current version is @c PSI_TABLE_VERSION_1
55 */
56 #define PSI_CURRENT_TABLE_VERSION 1
57 
58 /** Entry point for the performance schema interface. */
60  /**
61  ABI interface finder.
62  Calling this method with an interface version number returns either
63  an instance of the ABI for this version, or NULL.
64  @sa PSI_TABLE_VERSION_1
65  @sa PSI_TABLE_VERSION_2
66  @sa PSI_CURRENT_TABLE_VERSION
67  */
68  void *(*get_interface)(int version);
69 };
71 
72 #ifdef HAVE_PSI_TABLE_INTERFACE
73 
74 /**
75  Performance Schema Transaction Interface, version 1.
76  @since PSI_TABLE_VERSION_1
77 */
79  /** @sa get_table_share_v1_t. */
81  /** @sa release_table_share_v1_t. */
83  /** @sa drop_table_share_v1_t. */
85  /** @sa open_table_v1_t. */
87  /** @sa unbind_table_v1_t. */
89  /** @sa rebind_table_v1_t. */
91  /** @sa close_table_v1_t. */
93  /** @sa start_table_io_wait_v1_t. */
95  /** @sa end_table_io_wait_v1_t. */
97  /** @sa start_table_lock_wait_v1_t. */
99  /** @sa end_table_lock_wait_v1_t. */
101  /** @sa end_table_lock_wait_v1_t. */
103 };
104 
106 
108 
109 #endif /* HAVE_PSI_TABLE_INTERFACE */
110 
111 /** @} (end of group psi_abi_table) */
112 
113 #endif /* MYSQL_PSI_TRANSACTION_H */
MYSQL_PLUGIN_IMPORT PSI_table_service_t * psi_table_service
Definition: psi_noop.cc:528
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:169
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:190
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:200
void(* release_table_share_v1_t)(struct PSI_table_share *share)
Release a table share.
Definition: psi_table_bits.h:130
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:151
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:212
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:221
void(* unlock_table_v1_t)(struct PSI_table *table)
Record a table unlock event.
Definition: psi_table_bits.h:227
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:123
void(* close_table_v1_t)(struct TABLE_SHARE *server_share, struct PSI_table *table)
Close an instrumentation table handle.
Definition: psi_table_bits.h:178
void(* unbind_table_v1_t)(struct PSI_table *table)
Unbind a table handle from the current thread.
Definition: psi_table_bits.h:159
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:140
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:70
Performance schema instrumentation interface.
required uint64 version
Definition: replication_group_member_actions.proto:40
Entry point for the performance schema interface.
Definition: psi_table.h:59
Performance Schema Transaction Interface, version 1.
Definition: psi_table.h:78
start_table_io_wait_v1_t start_table_io_wait
Definition: psi_table.h:94
release_table_share_v1_t release_table_share
Definition: psi_table.h:82
rebind_table_v1_t rebind_table
Definition: psi_table.h:90
start_table_lock_wait_v1_t start_table_lock_wait
Definition: psi_table.h:98
end_table_io_wait_v1_t end_table_io_wait
Definition: psi_table.h:96
close_table_v1_t close_table
Definition: psi_table.h:92
get_table_share_v1_t get_table_share
Definition: psi_table.h:80
unlock_table_v1_t unlock_table
Definition: psi_table.h:102
drop_table_share_v1_t drop_table_share
Definition: psi_table.h:84
open_table_v1_t open_table
Definition: psi_table.h:86
unbind_table_v1_t unbind_table
Definition: psi_table.h:88
end_table_lock_wait_v1_t end_table_lock_wait
Definition: psi_table.h:100