MySQL  8.0.18
Source Code Documentation
mysql_mutex_bits.h
Go to the documentation of this file.
1 /* Copyright (c) 2008, 2019, Oracle and/or its affiliates. All rights reserved.
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 COMPONENTS_SERVICES_MYSQL_MUTEX_BITS_H
24 #define COMPONENTS_SERVICES_MYSQL_MUTEX_BITS_H
25 
26 /**
27  @file
28  ABI for instrumented mutexes.
29 */
30 
32 
33 /**
34  @defgroup psi_api_mutex Mutex Instrumentation (API)
35  @ingroup psi_api
36  @{
37 */
38 
39 /**
40  An instrumented mutex structure.
41  @c mysql_mutex_t is a drop-in replacement for @c my_mutex_t.
42  @sa mysql_mutex_assert_owner
43  @sa mysql_mutex_assert_not_owner
44  @sa mysql_mutex_init
45  @sa mysql_mutex_lock
46  @sa mysql_mutex_unlock
47  @sa mysql_mutex_destroy
48 */
49 struct mysql_mutex_t {
50  /** The real mutex. */
52  /**
53  The instrumentation hook.
54  Note that this hook is not conditionally defined,
55  for binary compatibility of the @c mysql_mutex_t interface.
56  */
57  struct PSI_mutex *m_psi{nullptr};
58 };
59 
60 /** @} (end of group psi_api_mutex) */
61 
62 #endif /* COMPONENTS_SERVICES_MYSQL_MUTEX_BITS_H */
my_mutex_t m_mutex
The real mutex.
Definition: mysql_mutex_bits.h:51
struct PSI_mutex PSI_mutex
Definition: psi_mutex_bits.h:95
struct PSI_mutex * m_psi
The instrumentation hook.
Definition: mysql_mutex_bits.h:57
An instrumented mutex structure.
Definition: mysql_mutex_bits.h:49
Definition: thr_mutex_bits.h:60
ABI for thd_mutex.