MySQL  8.0.27
Source Code Documentation
psi_mdl.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_MDL_H
24 #define MYSQL_PSI_MDL_H
25 
26 /**
27  @file include/mysql/psi/psi_mdl.h
28  Performance schema instrumentation interface.
29 
30  @defgroup psi_abi_mdl Metadata Lock 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_MDL_VERSION_1
46  Performance Schema Metadata Lock Interface number for version 1.
47  Deprecated in MySQL 8.0.24
48 */
49 #define PSI_MDL_VERSION_1 1
50 
51 /**
52  @def PSI_MDL_VERSION_2
53  Performance Schema Metadata Lock Interface number for version 2.
54  Introduced in MySQL 8.0.24
55  This version is supported.
56 */
57 #define PSI_MDL_VERSION_2 2
58 
59 /**
60  @def PSI_CURRENT_MDL_VERSION
61  Performance Schema Metadata Lock Interface number for the most recent version.
62  The most current version is @c PSI_MDL_VERSION_2
63 */
64 #define PSI_CURRENT_MDL_VERSION 2
65 
66 /** Entry point for the performance schema interface. */
68  /**
69  ABI interface finder.
70  Calling this method with an interface version number returns either
71  an instance of the ABI for this version, or NULL.
72  @sa PSI_MDL_VERSION_1
73  @sa PSI_MDL_VERSION_2
74  @sa PSI_CURRENT_MDL_VERSION
75  */
76  void *(*get_interface)(int version);
77 };
79 
80 #ifdef HAVE_PSI_METADATA_INTERFACE
81 
82 /**
83  Performance Schema Metadata Lock Interface, version 1.
84  @since PSI_MDL_VERSION_1
85 */
92 };
93 
94 /**
95  Performance Schema Metadata Lock Interface, version 2.
96  @since PSI_MDL_VERSION_2
97 */
101  /* Added in version 2. */
106 };
107 
109 
111 
112 #endif /* HAVE_PSI_METADATA_INTERFACE */
113 
114 /** @} (end of group psi_abi_mdl) */
115 
116 #endif /* MYSQL_PSI_MDL_H */
void(* destroy_metadata_lock_v1_t)(PSI_metadata_lock *lock)
Definition: psi_mdl_bits.h:96
void(* end_metadata_wait_v1_t)(struct PSI_metadata_locker *locker, int rc)
Definition: psi_mdl_bits.h:102
PSI_metadata_lock *(* create_metadata_lock_v1_t)(void *identity, const struct MDL_key *key, opaque_mdl_type mdl_type, opaque_mdl_duration mdl_duration, opaque_mdl_status mdl_status, const char *src_file, unsigned int src_line)
Definition: psi_mdl_bits.h:85
MYSQL_PLUGIN_IMPORT PSI_mdl_service_t * psi_mdl_service
Definition: psi_noop.cc:565
struct PSI_metadata_locker *(* start_metadata_wait_v1_t)(struct PSI_metadata_locker_state_v1 *state, struct PSI_metadata_lock *mdl, const char *src_file, unsigned int src_line)
Definition: psi_mdl_bits.h:98
void(* set_metadata_lock_status_v1_t)(PSI_metadata_lock *lock, opaque_mdl_status mdl_status)
Definition: psi_mdl_bits.h:90
void(* set_metadata_lock_duration_v2_t)(PSI_metadata_lock *lock, opaque_mdl_duration mdl_duration)
Definition: psi_mdl_bits.h:93
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_mdl.h:67
Performance Schema Metadata Lock Interface, version 1.
Definition: psi_mdl.h:86
set_metadata_lock_status_v1_t set_metadata_lock_status
Definition: psi_mdl.h:88
create_metadata_lock_v1_t create_metadata_lock
Definition: psi_mdl.h:87
end_metadata_wait_v1_t end_metadata_wait
Definition: psi_mdl.h:91
start_metadata_wait_v1_t start_metadata_wait
Definition: psi_mdl.h:90
destroy_metadata_lock_v1_t destroy_metadata_lock
Definition: psi_mdl.h:89
Performance Schema Metadata Lock Interface, version 2.
Definition: psi_mdl.h:98
set_metadata_lock_duration_v2_t set_metadata_lock_duration
Definition: psi_mdl.h:102
create_metadata_lock_v1_t create_metadata_lock
Definition: psi_mdl.h:99
end_metadata_wait_v1_t end_metadata_wait
Definition: psi_mdl.h:105
start_metadata_wait_v1_t start_metadata_wait
Definition: psi_mdl.h:104
destroy_metadata_lock_v1_t destroy_metadata_lock
Definition: psi_mdl.h:103
set_metadata_lock_status_v1_t set_metadata_lock_status
Definition: psi_mdl.h:100