MySQL 9.0.0
Source Code Documentation
psi_mutex.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_MUTEX_H
25#define MYSQL_PSI_MUTEX_H
26
27/**
28 @file include/mysql/psi/psi_mutex.h
29 Performance schema instrumentation interface.
30
31 @defgroup psi_abi_mutex Mutex 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/** Entry point for the performance schema interface. */
47 /**
48 ABI interface finder.
49 Calling this method with an interface version number returns either
50 an instance of the ABI for this version, or NULL.
51 @sa PSI_MUTEX_VERSION_1
52 @sa PSI_MUTEX_VERSION_2
53 @sa PSI_CURRENT_MUTEX_VERSION
54 */
55 void *(*get_interface)(int version);
56};
57
58#ifdef HAVE_PSI_MUTEX_INTERFACE
59
60/**
61 Performance Schema Mutex Interface, version 1.
62 @since PSI_MUTEX_VERSION_1
63*/
65 /** @sa register_mutex_v1_t. */
67 /** @sa init_mutex_v1_t. */
69 /** @sa destroy_mutex_v1_t. */
71 /** @sa start_mutex_wait_v1_t. */
73 /** @sa end_mutex_wait_v1_t. */
75 /** @sa unlock_mutex_v1_t. */
77};
78
80
82
83#endif /* HAVE_PSI_MUTEX_INTERFACE */
84
85/** @} (end of group psi_abi_mutex) */
86
87#endif /* MYSQL_PSI_MUTEX_H */
struct PSI_mutex *(* init_mutex_v1_t)(PSI_mutex_key key, const void *identity)
Mutex instrumentation initialization API.
Definition: psi_mutex_bits.h:158
void(* end_mutex_wait_v1_t)(struct PSI_mutex_locker *locker, int rc)
Record a mutex instrumentation wait end event.
Definition: psi_mutex_bits.h:191
MYSQL_PLUGIN_IMPORT PSI_mutex_service_t * psi_mutex_service
Definition: psi_noop.cc:279
void(* destroy_mutex_v1_t)(struct PSI_mutex *mutex)
Mutex instrumentation destruction API.
Definition: psi_mutex_bits.h:165
void(* register_mutex_v1_t)(const char *category, struct PSI_mutex_info_v1 *info, int count)
Mutex registration API.
Definition: psi_mutex_bits.h:149
void(* unlock_mutex_v1_t)(struct PSI_mutex *mutex)
Record a mutex instrumentation unlock event.
Definition: psi_mutex_bits.h:171
struct PSI_mutex_locker *(* start_mutex_wait_v1_t)(struct PSI_mutex_locker_state_v1 *state, struct PSI_mutex *mutex, enum PSI_mutex_operation op, const char *src_file, unsigned int src_line)
Record a mutex instrumentation wait start event.
Definition: psi_mutex_bits.h:182
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
Instrumentation helpers for mutexes.
required uint64 version
Definition: replication_group_member_actions.proto:41
Entry point for the performance schema interface.
Definition: psi_mutex.h:46
Performance Schema Mutex Interface, version 1.
Definition: psi_mutex.h:64
init_mutex_v1_t init_mutex
Definition: psi_mutex.h:68
register_mutex_v1_t register_mutex
Definition: psi_mutex.h:66
unlock_mutex_v1_t unlock_mutex
Definition: psi_mutex.h:76
end_mutex_wait_v1_t end_mutex_wait
Definition: psi_mutex.h:74
start_mutex_wait_v1_t start_mutex_wait
Definition: psi_mutex.h:72
destroy_mutex_v1_t destroy_mutex
Definition: psi_mutex.h:70