MySQL 9.0.0
Source Code Documentation
mysql_rwlock_bits.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 COMPONENTS_SERVICES_BITS_MYSQL_RWLOCK_BITS_H
25#define COMPONENTS_SERVICES_BITS_MYSQL_RWLOCK_BITS_H
26
27/**
28 @file mysql/components/services/bits/mysql_rwlock_bits.h
29 Instrumentation helpers for rwlock.
30*/
31
33
34/**
35 @defgroup psi_api_rwlock Rwlock Instrumentation (API)
36 @ingroup psi_api
37 @{
38*/
39
40/**
41 An instrumented rwlock structure.
42 @c mysql_rwlock_t is a drop-in replacement for @c pthread_rwlock_t.
43 @sa mysql_rwlock_init
44 @sa mysql_rwlock_rdlock
45 @sa mysql_rwlock_tryrdlock
46 @sa mysql_rwlock_wrlock
47 @sa mysql_rwlock_trywrlock
48 @sa mysql_rwlock_unlock
49 @sa mysql_rwlock_destroy
50*/
52 /** The real rwlock */
54 /**
55 The instrumentation hook.
56 Note that this hook is not conditionally defined,
57 for binary compatibility of the @c mysql_rwlock_t interface.
58 */
60};
61
62/**
63 An instrumented prlock structure.
64 A prlock is a read write lock that 'prefers readers' (pr).
65 @c mysql_prlock_t is a drop-in replacement for @c rw_pr_lock_t.
66 @sa mysql_prlock_init
67 @sa mysql_prlock_rdlock
68 @sa mysql_prlock_wrlock
69 @sa mysql_prlock_unlock
70 @sa mysql_prlock_destroy
71*/
73 /** The real prlock */
75 /**
76 The instrumentation hook.
77 Note that this hook is not conditionally defined,
78 for binary compatibility of the @c mysql_rwlock_t interface.
79 */
81};
82
83/** @} (end of group psi_api_rwlock) */
84
85#endif /* COMPONENTS_SERVICES_BITS_MYSQL_RWLOCK_BITS_H */
Interface for an instrumented rwlock.
Definition: psi_rwlock_bits.h:71
An instrumented prlock structure.
Definition: mysql_rwlock_bits.h:72
struct PSI_rwlock * m_psi
The instrumentation hook.
Definition: mysql_rwlock_bits.h:80
rw_pr_lock_t m_prlock
The real prlock.
Definition: mysql_rwlock_bits.h:74
An instrumented rwlock structure.
Definition: mysql_rwlock_bits.h:51
struct PSI_rwlock * m_psi
The instrumentation hook.
Definition: mysql_rwlock_bits.h:59
native_rw_lock_t m_rwlock
The real rwlock.
Definition: mysql_rwlock_bits.h:53
Portable implementation of special type of read-write locks.
Definition: thr_rwlock_bits.h:95
MySQL rwlock ABI.
pthread_rwlock_t native_rw_lock_t
Definition: thr_rwlock_bits.h:61