polardbxengine/include/mysql/components/services/mysql_rwlock_bits.h

85 lines
2.6 KiB
C

/* Copyright (c) 2008, 2019, Oracle and/or its affiliates. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2.0,
as published by the Free Software Foundation.
This program is also distributed with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation. The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have included with MySQL.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License, version 2.0, for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
#ifndef COMPONENTS_SERVICES_MYSQL_RWLOCK_BITS_H
#define COMPONENTS_SERVICES_MYSQL_RWLOCK_BITS_H
/**
@file
Instrumentation helpers for rwlock.
*/
#include "mysql/components/services/thr_rwlock_bits.h"
/**
@defgroup psi_api_rwlock Rwlock Instrumentation (API)
@ingroup psi_api
@{
*/
/**
An instrumented rwlock structure.
@c mysql_rwlock_t is a drop-in replacement for @c pthread_rwlock_t.
@sa mysql_rwlock_init
@sa mysql_rwlock_rdlock
@sa mysql_rwlock_tryrdlock
@sa mysql_rwlock_wrlock
@sa mysql_rwlock_trywrlock
@sa mysql_rwlock_unlock
@sa mysql_rwlock_destroy
*/
struct mysql_rwlock_t {
/** The real rwlock */
native_rw_lock_t m_rwlock;
/**
The instrumentation hook.
Note that this hook is not conditionally defined,
for binary compatibility of the @c mysql_rwlock_t interface.
*/
struct PSI_rwlock *m_psi;
};
/**
An instrumented prlock structure.
A prlock is a read write lock that 'prefers readers' (pr).
@c mysql_prlock_t is a drop-in replacement for @c rw_pr_lock_t.
@sa mysql_prlock_init
@sa mysql_prlock_rdlock
@sa mysql_prlock_wrlock
@sa mysql_prlock_unlock
@sa mysql_prlock_destroy
*/
struct mysql_prlock_t {
/** The real prlock */
rw_pr_lock_t m_prlock;
/**
The instrumentation hook.
Note that this hook is not conditionally defined,
for binary compatibility of the @c mysql_rwlock_t interface.
*/
struct PSI_rwlock *m_psi;
};
/** @} (end of group psi_api_rwlock) */
#endif /* COMPONENTS_SERVICES_MYSQL_RWLOCK_BITS_H */