Instrumentation Interface

The Performance Schema instrumentation interface (PSI) that the server and plugins use to report locks, I/O, statements, and other events, with links to each instrumentation group.

Groups

Name	Description
File Instrumentation
Idle Instrumentation
Metadata Instrumentation
Memory Instrumentation
Socket Instrumentation
Stage Instrumentation
Statement Instrumentation
Table Instrumentation
Thread Instrumentation
Transaction Instrumentation
Application Binary Interface, version 1

Classes

Name	Description
PSI_stage_progress	Interface for an instrumented stage progress. This is a public structure, for efficiency.
PSI_table_locker_state	State data storage for start_table_io_wait_v1_t, start_table_lock_wait_v1_t. This structure provide temporary storage to a table locker. The content of this structure is considered opaque, the fields are only hints of what an implementation of the psi interface can use. This memory is provided by the instrumented code for performance reasons. See also: start_table_io_wait_v1_t
PSI_bootstrap	Entry point for the performance schema interface.
PSI_none	Dummy structure, used to declare PSI_server when no instrumentation is available. The content does not matter, since PSI_server will be NULL.
PSI_stage_info_none	Stage instrument information. Since: PSI_VERSION_1 This structure is used to register an instrumented stage.

Macros

Name	Description
PSI_DYNAMIC_CALL
PSI_INSTRUMENT_ME
PSI_INSTRUMENT_MEM
PSI_NOT_INSTRUMENTED
PSI_FLAG_GLOBAL	Global flag. This flag indicate that an instrumentation point is a global variable, or a singleton.
PSI_FLAG_MUTABLE	Mutable flag. This flag indicate that an instrumentation point is a general placeholder, that can mutate into a more specific instrumentation point.
PSI_FLAG_THREAD
PSI_FLAG_STAGE_PROGRESS	Stage progress flag. This flag apply to the stage instruments only. It indicates the instrumentation provides progress data.
PSI_RWLOCK_FLAG_SX	Shared Exclusive flag. Indicates that rwlock support the shared exclusive state.
PSI_FLAG_TRANSFER	Transferable flag. This flag indicate that an instrumented object can be created by a thread and destroyed by another thread.
PSI_FLAG_VOLATILITY_SESSION	Volatility flag. This flag indicate that an instrumented object has a volatility (life cycle) comparable to the volatility of a session.
PSI_FLAG_THREAD_SYSTEM	System thread flag. Indicates that the instrumented object exists on a system thread.

---

PSI_DYNAMIC_CALL

#define PSI_DYNAMIC_CALL(M, M) PSI_server->M

Defined in psi/psi.h:3028

---

PSI_INSTRUMENT_ME

#define PSI_INSTRUMENT_ME 0

Defined in psi/psi_base.h:47

---

PSI_INSTRUMENT_MEM

#define PSI_INSTRUMENT_MEM ((PSI_memory_key)0)

Defined in psi/psi_base.h:48

---

PSI_NOT_INSTRUMENTED

#define PSI_NOT_INSTRUMENTED 0

Defined in psi/psi_base.h:50

---

PSI_FLAG_GLOBAL

#define PSI_FLAG_GLOBAL (1 << 0)

Defined in psi/psi_base.h:57

Global flag. This flag indicate that an instrumentation point is a global variable, or a singleton.

---

PSI_FLAG_MUTABLE

#define PSI_FLAG_MUTABLE (1 << 1)

Defined in psi/psi_base.h:64

Mutable flag. This flag indicate that an instrumentation point is a general placeholder, that can mutate into a more specific instrumentation point.

---

PSI_FLAG_THREAD

#define PSI_FLAG_THREAD (1 << 2)

Defined in psi/psi_base.h:66

---

PSI_FLAG_STAGE_PROGRESS

#define PSI_FLAG_STAGE_PROGRESS (1 << 3)

Defined in psi/psi_base.h:73

Stage progress flag. This flag apply to the stage instruments only. It indicates the instrumentation provides progress data.

---

PSI_RWLOCK_FLAG_SX

#define PSI_RWLOCK_FLAG_SX (1 << 4)

Defined in psi/psi_base.h:79

Shared Exclusive flag. Indicates that rwlock support the shared exclusive state.

---

PSI_FLAG_TRANSFER

#define PSI_FLAG_TRANSFER (1 << 5)

Defined in psi/psi_base.h:86

Transferable flag. This flag indicate that an instrumented object can be created by a thread and destroyed by another thread.

---

PSI_FLAG_VOLATILITY_SESSION

#define PSI_FLAG_VOLATILITY_SESSION (1 << 6)

Defined in psi/psi_base.h:94

Volatility flag. This flag indicate that an instrumented object has a volatility (life cycle) comparable to the volatility of a session.

---

PSI_FLAG_THREAD_SYSTEM

#define PSI_FLAG_THREAD_SYSTEM (1 << 9)

Defined in psi/psi_base.h:100

System thread flag. Indicates that the instrumented object exists on a system thread.

Enumerations

Name	Description
PSI_table_io_operation	IO operation performed on an instrumented table.

---

PSI_table_io_operation

enum PSI_table_io_operation

Defined in psi/psi.h:241

IO operation performed on an instrumented table.

Value	Description
PSI_TABLE_FETCH_ROW	Row fetch.
PSI_TABLE_WRITE_ROW	Row write.
PSI_TABLE_UPDATE_ROW	Row update.
PSI_TABLE_DELETE_ROW	Row delete.

Typedefs

Return	Name	Description
struct PSI_mutex	PSI_mutex
struct PSI_rwlock	PSI_rwlock
struct PSI_cond	PSI_cond
struct PSI_table_share	PSI_table_share
struct PSI_table	PSI_table
struct PSI_thread	PSI_thread
struct PSI_file	PSI_file
struct PSI_socket	PSI_socket
struct PSI_prepared_stmt	PSI_prepared_stmt
struct PSI_table_locker	PSI_table_locker
struct PSI_statement_locker	PSI_statement_locker
struct PSI_transaction_locker	PSI_transaction_locker
struct PSI_idle_locker	PSI_idle_locker
struct PSI_digest_locker	PSI_digest_locker
struct PSI_sp_share	PSI_sp_share
struct PSI_sp_locker	PSI_sp_locker
struct PSI_metadata_lock	PSI_metadata_lock
struct PSI_stage_progress	PSI_stage_progress
enum PSI_table_io_operation	PSI_table_io_operation
struct PSI_table_locker_state	PSI_table_locker_state
struct PSI_bootstrap	PSI_bootstrap
unsigned int	PSI_mutex_key	Instrumented mutex key. To instrument a mutex, a mutex key must be obtained using register_mutex. Using a zero key always disable the instrumentation.
unsigned int	PSI_rwlock_key	Instrumented rwlock key. To instrument a rwlock, a rwlock key must be obtained using register_rwlock. Using a zero key always disable the instrumentation.
unsigned int	PSI_cond_key	Instrumented cond key. To instrument a condition, a condition key must be obtained using register_cond. Using a zero key always disable the instrumentation.
unsigned int	PSI_thread_key	Instrumented thread key. To instrument a thread, a thread key must be obtained using register_thread. Using a zero key always disable the instrumentation.
unsigned int	PSI_file_key	Instrumented file key. To instrument a file, a file key must be obtained using register_file. Using a zero key always disable the instrumentation.
unsigned int	PSI_stage_key	Instrumented stage key. To instrument a stage, a stage key must be obtained using register_stage. Using a zero key always disable the instrumentation.
unsigned int	PSI_statement_key	Instrumented statement key. To instrument a statement, a statement key must be obtained using register_statement. Using a zero key always disable the instrumentation.
unsigned int	PSI_socket_key	Instrumented socket key. To instrument a socket, a socket key must be obtained using register_socket. Using a zero key always disable the instrumentation.
struct PSI_v1	PSI	The instrumentation interface for the current version. See also: PSI_CURRENT_VERSION
struct PSI_mutex_info_v1	PSI_mutex_info	The mutex information structure for the current version.
struct PSI_rwlock_info_v1	PSI_rwlock_info	The rwlock information structure for the current version.
struct PSI_cond_info_v1	PSI_cond_info	The cond information structure for the current version.
struct PSI_thread_info_v1	PSI_thread_info	The thread information structure for the current version.
struct PSI_file_info_v1	PSI_file_info	The file information structure for the current version.
struct PSI_stage_info_v1	PSI_stage_info	The stage instrumentation has to co exist with the legacy THD::set_proc_info instrumentation. To avoid duplication of the instrumentation in the server, the common PSI_stage_info structure is used, so we export it here, even when not building with HAVE_PSI_INTERFACE.
struct PSI_statement_info_v1	PSI_statement_info
struct PSI_transaction_info_v1	PSI_transaction_info
struct PSI_socket_info_v1	PSI_socket_info
struct PSI_idle_locker_state_v1	PSI_idle_locker_state
struct PSI_mutex_locker_state_v1	PSI_mutex_locker_state
struct PSI_rwlock_locker_state_v1	PSI_rwlock_locker_state
struct PSI_cond_locker_state_v1	PSI_cond_locker_state
struct PSI_file_locker_state_v1	PSI_file_locker_state
struct PSI_statement_locker_state_v1	PSI_statement_locker_state
struct PSI_transaction_locker_state_v1	PSI_transaction_locker_state
struct PSI_socket_locker_state_v1	PSI_socket_locker_state
struct PSI_sp_locker_state_v1	PSI_sp_locker_state
struct PSI_metadata_locker_state_v1	PSI_metadata_locker_state
struct PSI_stage_info_none	PSI_metadata_locker
struct PSI_memory_info_v1	PSI_memory_info

---

PSI_mutex

using PSI_mutex = struct PSI_mutex

Type: struct PSI_mutex

Defined in psi/psi.h:115

---

PSI_rwlock

using PSI_rwlock = struct PSI_rwlock

Type: struct PSI_rwlock

Defined in psi/psi.h:122

---

PSI_cond

using PSI_cond = struct PSI_cond

Type: struct PSI_cond

Defined in psi/psi.h:129

---

PSI_table_share

using PSI_table_share = struct PSI_table_share

Type: struct PSI_table_share

Defined in psi/psi.h:136

---

PSI_table

using PSI_table = struct PSI_table

Type: struct PSI_table

Defined in psi/psi.h:143

---

PSI_thread

using PSI_thread = struct PSI_thread

Type: struct PSI_thread

Defined in psi/psi.h:150

---

PSI_file

using PSI_file = struct PSI_file

Type: struct PSI_file

Defined in psi/psi.h:157

---

PSI_socket

using PSI_socket = struct PSI_socket

Type: struct PSI_socket

Defined in psi/psi.h:164

---

PSI_prepared_stmt

using PSI_prepared_stmt = struct PSI_prepared_stmt

Type: struct PSI_prepared_stmt

Defined in psi/psi.h:171

---

PSI_table_locker

using PSI_table_locker = struct PSI_table_locker

Type: struct PSI_table_locker

Defined in psi/psi.h:178

---

PSI_statement_locker

using PSI_statement_locker = struct PSI_statement_locker

Type: struct PSI_statement_locker

Defined in psi/psi.h:185

---

PSI_transaction_locker

using PSI_transaction_locker = struct PSI_transaction_locker

Type: struct PSI_transaction_locker

Defined in psi/psi.h:192

---

PSI_idle_locker

using PSI_idle_locker = struct PSI_idle_locker

Type: struct PSI_idle_locker

Defined in psi/psi.h:199

---

PSI_digest_locker

using PSI_digest_locker = struct PSI_digest_locker

Type: struct PSI_digest_locker

Defined in psi/psi.h:206

---

PSI_sp_share

using PSI_sp_share = struct PSI_sp_share

Type: struct PSI_sp_share

Defined in psi/psi.h:213

---

PSI_sp_locker

using PSI_sp_locker = struct PSI_sp_locker

Type: struct PSI_sp_locker

Defined in psi/psi.h:220

---

PSI_metadata_lock

using PSI_metadata_lock = struct PSI_metadata_lock

Type: struct PSI_metadata_lock

Defined in psi/psi.h:227

---

PSI_stage_progress

using PSI_stage_progress = struct PSI_stage_progress

Type: struct PSI_stage_progress

Defined in psi/psi.h:238

---

PSI_table_io_operation

using PSI_table_io_operation = enum PSI_table_io_operation

Type: enum PSI_table_io_operation

Defined in psi/psi.h:252

---

PSI_table_locker_state

using PSI_table_locker_state = struct PSI_table_locker_state

Type: struct PSI_table_locker_state

Defined in psi/psi.h:290

---

PSI_bootstrap

using PSI_bootstrap = struct PSI_bootstrap

Type: struct PSI_bootstrap

Defined in psi/psi.h:310

---

PSI_mutex_key

using PSI_mutex_key = unsigned int

Defined in psi/psi.h:792

Instrumented mutex key. To instrument a mutex, a mutex key must be obtained using register_mutex. Using a zero key always disable the instrumentation.

---

PSI_rwlock_key

using PSI_rwlock_key = unsigned int

Defined in psi/psi.h:800

Instrumented rwlock key. To instrument a rwlock, a rwlock key must be obtained using register_rwlock. Using a zero key always disable the instrumentation.

---

PSI_cond_key

using PSI_cond_key = unsigned int

Defined in psi/psi.h:808

Instrumented cond key. To instrument a condition, a condition key must be obtained using register_cond. Using a zero key always disable the instrumentation.

---

PSI_thread_key

using PSI_thread_key = unsigned int

Defined in psi/psi.h:816

Instrumented thread key. To instrument a thread, a thread key must be obtained using register_thread. Using a zero key always disable the instrumentation.

---

PSI_file_key

using PSI_file_key = unsigned int

Defined in psi/psi.h:823

Instrumented file key. To instrument a file, a file key must be obtained using register_file. Using a zero key always disable the instrumentation.

---

PSI_stage_key

using PSI_stage_key = unsigned int

Defined in psi/psi.h:830

Instrumented stage key. To instrument a stage, a stage key must be obtained using register_stage. Using a zero key always disable the instrumentation.

---

PSI_statement_key

using PSI_statement_key = unsigned int

Defined in psi/psi.h:837

Instrumented statement key. To instrument a statement, a statement key must be obtained using register_statement. Using a zero key always disable the instrumentation.

---

PSI_socket_key

using PSI_socket_key = unsigned int

Defined in psi/psi.h:844

Instrumented socket key. To instrument a socket, a socket key must be obtained using register_socket. Using a zero key always disable the instrumentation.

---

PSI

using PSI = struct PSI_v1

Type: struct PSI_v1

Defined in psi/psi.h:2930

The instrumentation interface for the current version. See also: PSI_CURRENT_VERSION

---

PSI_mutex_info

using PSI_mutex_info = struct PSI_mutex_info_v1

Type: struct PSI_mutex_info_v1

Defined in psi/psi.h:2931

The mutex information structure for the current version.

---

PSI_rwlock_info

using PSI_rwlock_info = struct PSI_rwlock_info_v1

Type: struct PSI_rwlock_info_v1

Defined in psi/psi.h:2932

The rwlock information structure for the current version.

---

PSI_cond_info

using PSI_cond_info = struct PSI_cond_info_v1

Type: struct PSI_cond_info_v1

Defined in psi/psi.h:2933

The cond information structure for the current version.

---

PSI_thread_info

using PSI_thread_info = struct PSI_thread_info_v1

Type: struct PSI_thread_info_v1

Defined in psi/psi.h:2934

The thread information structure for the current version.

---

PSI_file_info

using PSI_file_info = struct PSI_file_info_v1

Type: struct PSI_file_info_v1

Defined in psi/psi.h:2935

The file information structure for the current version.

---

PSI_stage_info

using PSI_stage_info = struct PSI_stage_info_v1

Type: struct PSI_stage_info_v1

Defined in psi/psi.h:2936

The stage instrumentation has to co exist with the legacy THD::set_proc_info instrumentation. To avoid duplication of the instrumentation in the server, the common PSI_stage_info structure is used, so we export it here, even when not building with HAVE_PSI_INTERFACE.

---

PSI_statement_info

using PSI_statement_info = struct PSI_statement_info_v1

Type: struct PSI_statement_info_v1

Defined in psi/psi.h:2937

---

PSI_transaction_info

using PSI_transaction_info = struct PSI_transaction_info_v1

Defined in psi/psi.h:2938

---

PSI_socket_info

using PSI_socket_info = struct PSI_socket_info_v1

Type: struct PSI_socket_info_v1

Defined in psi/psi.h:2939

---

PSI_idle_locker_state

using PSI_idle_locker_state = struct PSI_idle_locker_state_v1

Type: struct PSI_idle_locker_state_v1

Defined in psi/psi.h:2940

---

PSI_mutex_locker_state

using PSI_mutex_locker_state = struct PSI_mutex_locker_state_v1

Type: struct PSI_mutex_locker_state_v1

Defined in psi/psi.h:2941

---

PSI_rwlock_locker_state

using PSI_rwlock_locker_state = struct PSI_rwlock_locker_state_v1

Type: struct PSI_rwlock_locker_state_v1

Defined in psi/psi.h:2942

---

PSI_cond_locker_state

using PSI_cond_locker_state = struct PSI_cond_locker_state_v1

Type: struct PSI_cond_locker_state_v1

Defined in psi/psi.h:2943

---

PSI_file_locker_state

using PSI_file_locker_state = struct PSI_file_locker_state_v1

Type: struct PSI_file_locker_state_v1

Defined in psi/psi.h:2944

---

PSI_statement_locker_state

using PSI_statement_locker_state = struct PSI_statement_locker_state_v1

Type: struct PSI_statement_locker_state_v1

Defined in psi/psi.h:2945

---

PSI_transaction_locker_state

using PSI_transaction_locker_state = struct PSI_transaction_locker_state_v1

Type: struct PSI_transaction_locker_state_v1

Defined in psi/psi.h:2946

---

PSI_socket_locker_state

using PSI_socket_locker_state = struct PSI_socket_locker_state_v1

Type: struct PSI_socket_locker_state_v1

Defined in psi/psi.h:2947

---

PSI_sp_locker_state

using PSI_sp_locker_state = struct PSI_sp_locker_state_v1

Type: struct PSI_sp_locker_state_v1

Defined in psi/psi.h:2948

---

PSI_metadata_locker_state

using PSI_metadata_locker_state = struct PSI_metadata_locker_state_v1

Type: struct PSI_metadata_locker_state_v1

Defined in psi/psi.h:2949

---

PSI_metadata_locker

using PSI_metadata_locker = struct PSI_stage_info_none

Type: struct PSI_stage_info_none

Defined in psi/psi.h:3015

---

PSI_memory_info

using PSI_memory_info = struct PSI_memory_info_v1

Type: struct PSI_memory_info_v1

Defined in psi/psi_memory.h:148

Variables

Return	Name	Description
MYSQL_PLUGIN_IMPORT PSI *	PSI_server

---

PSI_server

MYSQL_PLUGIN_IMPORT PSI * PSI_server

Type: MYSQL_PLUGIN_IMPORT PSI *

Defined in psi/psi.h:3019

Class Definitions

PSI_stage_progress

#include <psi.h>

struct PSI_stage_progress

Defined in psi/psi.h:233

Interface for an instrumented stage progress. This is a public structure, for efficiency.

Public Attributes

Return	Name	Description
ulonglong	m_work_completed
ulonglong	m_work_estimated

---

m_work_completed

ulonglong m_work_completed

Defined in psi/psi.h:235

---

m_work_estimated

ulonglong m_work_estimated

Defined in psi/psi.h:236

PSI_table_locker_state

#include <psi.h>

struct PSI_table_locker_state

Defined in psi/psi.h:265

State data storage for start_table_io_wait_v1_t, start_table_lock_wait_v1_t. This structure provide temporary storage to a table locker. The content of this structure is considered opaque, the fields are only hints of what an implementation of the psi interface can use. This memory is provided by the instrumented code for performance reasons. See also: start_table_io_wait_v1_t

See also: start_table_lock_wait_v1_t

Public Attributes

Return	Name	Description
uint	m_flags	Internal state.
enum PSI_table_io_operation	m_io_operation	Current io operation.
struct PSI_table *	m_table	Current table handle.
struct PSI_table_share *	m_table_share	Current table share.
struct PSI_thread *	m_thread	Current thread.
ulonglong	m_timer_start	Timer start.
ulonglong(*	m_timer	Timer function.
void *	m_wait	Internal data.
uint	m_index	Implementation specific. For table io, the table io index. For table lock, the lock type.

---

m_flags

uint m_flags

Defined in psi/psi.h:268

Internal state.

---

m_io_operation

enum PSI_table_io_operation m_io_operation

Type: enum PSI_table_io_operation

Defined in psi/psi.h:270

Current io operation.

---

m_table

struct PSI_table * m_table

Type: struct PSI_table *

Defined in psi/psi.h:272

Current table handle.

---

m_table_share

struct PSI_table_share * m_table_share

Type: struct PSI_table_share *

Defined in psi/psi.h:274

Current table share.

---

m_thread

struct PSI_thread * m_thread

Type: struct PSI_thread *

Defined in psi/psi.h:276

Current thread.

---

m_timer_start

ulonglong m_timer_start

Defined in psi/psi.h:278

Timer start.

---

m_timer

ulonglong(* m_timer)(void)

Defined in psi/psi.h:280

Timer function.

---

m_wait

void * m_wait

Defined in psi/psi.h:282

Internal data.

---

m_index

uint m_index

Defined in psi/psi.h:288

Implementation specific. For table io, the table io index. For table lock, the lock type.

PSI_bootstrap

#include <psi.h>

struct PSI_bootstrap

Defined in psi/psi.h:293

Entry point for the performance schema interface.

Public Attributes

Return	Name	Description
void *(*	get_interface	ABI interface finder. Calling this method with an interface version number returns either an instance of the ABI for this version, or NULL.

---

get_interface

void *(* get_interface)(int version)

Defined in psi/psi.h:308

ABI interface finder. Calling this method with an interface version number returns either an instance of the ABI for this version, or NULL.

Returns

a versioned interface (PSI_v1, PSI_v2 or PSI)

See also: PSI_VERSION_1

See also: PSI_v1

See also: PSI_VERSION_2

See also: PSI_v2

See also: PSI_CURRENT_VERSION

See also: PSI

Parameters

Parameter	Type	Description
version		the interface version number to find

PSI_none

#include <psi.h>

struct PSI_none

Defined in psi/psi.h:2982

Dummy structure, used to declare PSI_server when no instrumentation is available. The content does not matter, since PSI_server will be NULL.

Public Attributes

Return	Name	Description
int	opaque

---

opaque

int opaque

Defined in psi/psi.h:2984

PSI_stage_info_none

#include <psi.h>

struct PSI_stage_info_none

Defined in psi/psi.h:2993

Stage instrument information. Since: PSI_VERSION_1 This structure is used to register an instrumented stage.

Public Attributes

Return	Name	Description
unsigned int	m_key	Unused stage key.
const char *	m_name	The name of the stage instrument.
int	m_flags	Unused stage flags.

---

m_key

unsigned int m_key

Defined in psi/psi.h:2996

Unused stage key.

---

m_name

const char * m_name

Defined in psi/psi.h:2998

The name of the stage instrument.

---

m_flags

int m_flags

Defined in psi/psi.h:3000

Unused stage flags.