mysql_sp.h

Go to the documentation of this file.

/* Copyright (c) 2013, 2025, Oracle and/or its affiliates.
 
  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 designed to work 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 either included with
  the program or referenced in the documentation.
 
  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_SP_H
#define MYSQL_SP_H
 
/**
  @file include/mysql/psi/mysql_sp.h
  Instrumentation helpers for stored programs.
*/
 
/* HAVE_PSI_*_INTERFACE */
#include "my_psi_config.h"  // IWYU pragma: keep
 
#include "mysql/psi/psi_statement.h"
 
#if defined(MYSQL_SERVER) || defined(PFS_DIRECT_CALL)
/* PSI_SP_CALL() as direct call. */
#include "pfs_statement_provider.h"  // IWYU pragma: keep
#endif
 
#ifndef PSI_SP_CALL
#define PSI_SP_CALL(M) psi_statement_service->M
#endif
 
/**
  @defgroup psi_api_sp Stored Program Instrumentation (API)
  @ingroup psi_api
  @{
*/
 
/**
  @def MYSQL_START_SP(STATE, SP_SHARE)
  Instrument a stored program execution start.
  @param STATE Event state data
  @param SP_SHARE Stored Program share instrumentation
  @return An event locker
*/
#ifdef HAVE_PSI_SP_INTERFACE
#define MYSQL_START_SP(STATE, SP_SHARE) inline_mysql_start_sp(STATE, SP_SHARE)
#else
#define MYSQL_START_SP(STATE, SP_SHARE) NULL
#endif
 
/**
  @def MYSQL_END_SP(LOCKER)
  Instrument a stored program execution end.
  @param LOCKER Event locker
*/
#ifdef HAVE_PSI_SP_INTERFACE
#define MYSQL_END_SP(LOCKER) inline_mysql_end_sp(LOCKER)
#else
#define MYSQL_END_SP(LOCKER) \
  do {                       \
  } while (0)
#endif
 
/**
  @def MYSQL_DROP_SP(OT, SN, SNL, ON, ONL)
  Instrument a drop stored program event.
  @param OT Object type
  @param SN Schema name
  @param SNL Schema name length
  @param ON Object name
  @param ONL Object name length
*/
#ifdef HAVE_PSI_SP_INTERFACE
#define MYSQL_DROP_SP(OT, SN, SNL, ON, ONL) \
  inline_mysql_drop_sp(OT, SN, SNL, ON, ONL)
#else
#define MYSQL_DROP_SP(OT, SN, SNL, ON, ONL) \
  do {                                      \
  } while (0)
#endif
 
/**
  @def MYSQL_GET_SP_SHARE(OT, SN, SNL, ON, ONL)
  Instrument a stored program share.
  @param OT Object type
  @param SN Schema name
  @param SNL Schema name length
  @param ON Object name
  @param ONL Object name length
  @return The instrumented stored program share.
*/
#ifdef HAVE_PSI_SP_INTERFACE
#define MYSQL_GET_SP_SHARE(OT, SN, SNL, ON, ONL) \
  inline_mysql_get_sp_share(OT, SN, SNL, ON, ONL)
#else
#define MYSQL_GET_SP_SHARE(OT, SN, SNL, ON, ONL) NULL
#endif
 
#ifdef HAVE_PSI_SP_INTERFACE
static inline struct PSI_sp_locker *inline_mysql_start_sp(
    PSI_sp_locker_state *state, PSI_sp_share *sp_share) {
  return PSI_SP_CALL(start_sp)(state, sp_share);
}
 
static inline void inline_mysql_end_sp(PSI_sp_locker *locker) {
  if (likely(locker != nullptr)) {
    PSI_SP_CALL(end_sp)(locker);
  }
}
 
static inline void inline_mysql_drop_sp(uint sp_type, const char *schema_name,
                                        uint shcema_name_length,
                                        const char *object_name,
                                        uint object_name_length) {
  PSI_SP_CALL(drop_sp)
  (sp_type, schema_name, shcema_name_length, object_name, object_name_length);
}
 
static inline PSI_sp_share *inline_mysql_get_sp_share(uint sp_type,
                                                      const char *schema_name,
                                                      uint shcema_name_length,
                                                      const char *object_name,
                                                      uint object_name_length) {
  return PSI_SP_CALL(get_sp_share)(sp_type, schema_name, shcema_name_length,
                                   object_name, object_name_length);
}
#endif
 
/** @} (end of group psi_api_sp) */
 
#endif