polardbxengine/include/mysql/psi/mysql_cond.h

275 lines
7.7 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 MYSQL_COND_H
#define MYSQL_COND_H
/**
@file include/mysql/psi/mysql_cond.h
Instrumentation helpers for conditions.
*/
#include "mysql/components/services/mysql_cond_bits.h"
#include "mysql/psi/mysql_mutex.h"
#include "mysql/psi/psi_cond.h"
#include "thr_cond.h"
#ifdef MYSQL_SERVER
#ifndef MYSQL_DYNAMIC_PLUGIN
#include "pfs_cond_provider.h"
#endif
#endif
#ifndef PSI_COND_CALL
#define PSI_COND_CALL(M) psi_cond_service->M
#endif
/**
@defgroup psi_api_cond Cond Instrumentation (API)
@ingroup psi_api
@{
*/
#ifndef DISABLE_MYSQL_THREAD_H
/**
@def mysql_cond_register(P1, P2, P3)
Cond registration.
*/
#define mysql_cond_register(P1, P2, P3) inline_mysql_cond_register(P1, P2, P3)
/**
@def mysql_cond_init(K, C)
Instrumented cond_init.
@c mysql_cond_init is a replacement for @c pthread_cond_init.
Note that pthread_condattr_t is not supported in MySQL.
@param C The cond to initialize
@param K The PSI_cond_key for this instrumented cond
*/
#define mysql_cond_init(K, C) mysql_cond_init_with_src(K, C, __FILE__, __LINE__)
#define mysql_cond_init_with_src(K, C, F, L) inline_mysql_cond_init(K, C, F, L)
/**
@def mysql_cond_destroy(C)
Instrumented cond_destroy.
@c mysql_cond_destroy is a drop-in replacement for @c pthread_cond_destroy.
*/
#define mysql_cond_destroy(C) mysql_cond_destroy_with_src(C, __FILE__, __LINE__)
#define mysql_cond_destroy_with_src(C, F, L) inline_mysql_cond_destroy(C, F, L)
/**
@def mysql_cond_wait(C)
Instrumented cond_wait.
@c mysql_cond_wait is a drop-in replacement for @c native_cond_wait.
*/
#define mysql_cond_wait(C, M) mysql_cond_wait_with_src(C, M, __FILE__, __LINE__)
#define mysql_cond_wait_with_src(C, M, F, L) inline_mysql_cond_wait(C, M, F, L)
/**
@def mysql_cond_timedwait(C, M, W)
Instrumented cond_timedwait.
@c mysql_cond_timedwait is a drop-in replacement
for @c native_cond_timedwait.
*/
#define mysql_cond_timedwait(C, M, W) \
mysql_cond_timedwait_with_src(C, M, W, __FILE__, __LINE__)
#define mysql_cond_timedwait_with_src(C, M, W, F, L) \
inline_mysql_cond_timedwait(C, M, W, F, L)
/**
@def mysql_cond_signal(C)
Instrumented cond_signal.
@c mysql_cond_signal is a drop-in replacement for @c pthread_cond_signal.
*/
#define mysql_cond_signal(C) mysql_cond_signal_with_src(C, __FILE__, __LINE__)
#define mysql_cond_signal_with_src(C, F, L) inline_mysql_cond_signal(C, F, L)
/**
@def mysql_cond_broadcast(C)
Instrumented cond_broadcast.
@c mysql_cond_broadcast is a drop-in replacement
for @c pthread_cond_broadcast.
*/
#define mysql_cond_broadcast(C) \
mysql_cond_broadcast_with_src(C, __FILE__, __LINE__)
#define mysql_cond_broadcast_with_src(C, F, L) \
inline_mysql_cond_broadcast(C, F, L)
static inline void inline_mysql_cond_register(
const char *category MY_ATTRIBUTE((unused)),
PSI_cond_info *info MY_ATTRIBUTE((unused)),
int count MY_ATTRIBUTE((unused))) {
#ifdef HAVE_PSI_COND_INTERFACE
PSI_COND_CALL(register_cond)(category, info, count);
#endif
}
static inline int inline_mysql_cond_init(
PSI_cond_key key MY_ATTRIBUTE((unused)), mysql_cond_t *that,
const char *src_file MY_ATTRIBUTE((unused)),
int src_line MY_ATTRIBUTE((unused))) {
#ifdef HAVE_PSI_COND_INTERFACE
that->m_psi = PSI_COND_CALL(init_cond)(key, &that->m_cond);
#else
that->m_psi = NULL;
#endif
return native_cond_init(&that->m_cond);
}
static inline int inline_mysql_cond_destroy(
mysql_cond_t *that, const char *src_file MY_ATTRIBUTE((unused)),
int src_line MY_ATTRIBUTE((unused))) {
#ifdef HAVE_PSI_COND_INTERFACE
if (that->m_psi != NULL) {
PSI_COND_CALL(destroy_cond)(that->m_psi);
that->m_psi = NULL;
}
#endif
return native_cond_destroy(&that->m_cond);
}
static inline int inline_mysql_cond_wait(
mysql_cond_t *that, mysql_mutex_t *mutex,
const char *src_file MY_ATTRIBUTE((unused)),
int src_line MY_ATTRIBUTE((unused))) {
int result;
#ifdef HAVE_PSI_COND_INTERFACE
if (that->m_psi != NULL) {
/* Instrumentation start */
PSI_cond_locker *locker;
PSI_cond_locker_state state;
locker = PSI_COND_CALL(start_cond_wait)(&state, that->m_psi, mutex->m_psi,
PSI_COND_WAIT, src_file, src_line);
/* Instrumented code */
result = my_cond_wait(&that->m_cond, &mutex->m_mutex
#ifdef SAFE_MUTEX
,
src_file, src_line
#endif
);
/* Instrumentation end */
if (locker != NULL) {
PSI_COND_CALL(end_cond_wait)(locker, result);
}
return result;
}
#endif
/* Non instrumented code */
result = my_cond_wait(&that->m_cond, &mutex->m_mutex
#ifdef SAFE_MUTEX
,
src_file, src_line
#endif
);
return result;
}
static inline int inline_mysql_cond_timedwait(
mysql_cond_t *that, mysql_mutex_t *mutex, const struct timespec *abstime,
const char *src_file MY_ATTRIBUTE((unused)),
int src_line MY_ATTRIBUTE((unused))) {
int result;
#ifdef HAVE_PSI_COND_INTERFACE
if (that->m_psi != NULL) {
/* Instrumentation start */
PSI_cond_locker *locker;
PSI_cond_locker_state state;
locker =
PSI_COND_CALL(start_cond_wait)(&state, that->m_psi, mutex->m_psi,
PSI_COND_TIMEDWAIT, src_file, src_line);
/* Instrumented code */
result = my_cond_timedwait(&that->m_cond, &mutex->m_mutex, abstime
#ifdef SAFE_MUTEX
,
src_file, src_line
#endif
);
/* Instrumentation end */
if (locker != NULL) {
PSI_COND_CALL(end_cond_wait)(locker, result);
}
return result;
}
#endif
/* Non instrumented code */
result = my_cond_timedwait(&that->m_cond, &mutex->m_mutex, abstime
#ifdef SAFE_MUTEX
,
src_file, src_line
#endif
);
return result;
}
static inline int inline_mysql_cond_signal(
mysql_cond_t *that, const char *src_file MY_ATTRIBUTE((unused)),
int src_line MY_ATTRIBUTE((unused))) {
int result;
#ifdef HAVE_PSI_COND_INTERFACE
if (that->m_psi != NULL) {
PSI_COND_CALL(signal_cond)(that->m_psi);
}
#endif
result = native_cond_signal(&that->m_cond);
return result;
}
static inline int inline_mysql_cond_broadcast(
mysql_cond_t *that, const char *src_file MY_ATTRIBUTE((unused)),
int src_line MY_ATTRIBUTE((unused))) {
int result;
#ifdef HAVE_PSI_COND_INTERFACE
if (that->m_psi != NULL) {
PSI_COND_CALL(broadcast_cond)(that->m_psi);
}
#endif
result = native_cond_broadcast(&that->m_cond);
return result;
}
#endif /* DISABLE_MYSQL_THREAD_H */
/** @} (end of group psi_api_cond) */
#endif