MySQL 8.3.0
Source Code Documentation
pfs_server.h
Go to the documentation of this file.
1/* Copyright (c) 2008, 2023, Oracle and/or its affiliates.
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 PFS_SERVER_H
24#define PFS_SERVER_H
25
26/**
27 @file storage/perfschema/pfs_server.h
28 Private interface for the server (declarations).
29*/
30
31#include <sys/types.h>
32
33#include "my_psi_config.h"
34#include "mysql/psi/psi_cond.h"
36#include "mysql/psi/psi_error.h"
37#include "mysql/psi/psi_file.h"
38#include "mysql/psi/psi_idle.h"
39#include "mysql/psi/psi_mdl.h"
41#include "mysql/psi/psi_mutex.h"
44#include "mysql/psi/psi_stage.h"
47#include "mysql/psi/psi_table.h"
51
52#ifdef HAVE_PSI_INTERFACE
53
54#define PFS_AUTOSCALE_VALUE (-1)
55#define PFS_AUTOSIZE_VALUE (-1)
56
57#ifndef PFS_MAX_MUTEX_CLASS
58#define PFS_MAX_MUTEX_CLASS 350
59#endif
60#ifndef PFS_MAX_RWLOCK_CLASS
61#define PFS_MAX_RWLOCK_CLASS 100
62#endif
63#ifndef PFS_MAX_COND_CLASS
64#define PFS_MAX_COND_CLASS 150
65#endif
66#ifndef PFS_MAX_THREAD_CLASS
67#define PFS_MAX_THREAD_CLASS 100
68#endif
69#ifndef PFS_MAX_FILE_CLASS
70#define PFS_MAX_FILE_CLASS 80
71#endif
72#ifndef PFS_MAX_FILE_HANDLE
73#define PFS_MAX_FILE_HANDLE 32768
74#endif
75#ifndef PFS_MAX_SOCKET_CLASS
76#define PFS_MAX_SOCKET_CLASS 10
77#endif
78#ifndef PFS_MAX_STAGE_CLASS
79#define PFS_MAX_STAGE_CLASS 175
80#endif
81#ifndef PFS_STATEMENTS_STACK_SIZE
82#define PFS_STATEMENTS_STACK_SIZE 10
83#endif
84#ifndef PFS_MAX_MEMORY_CLASS
85#define PFS_MAX_MEMORY_CLASS 470
86#endif
87#ifndef PFS_MAX_METER_CLASS
88#define PFS_MAX_METER_CLASS 30
89#endif
90#ifndef PFS_MAX_METRIC_CLASS
91#define PFS_MAX_METRIC_CLASS 600
92#endif
93
94#ifndef PFS_MAX_GLOBAL_SERVER_ERRORS
95#define PFS_MAX_GLOBAL_SERVER_ERRORS \
96 (1 + pfs_session_error_stat_count + pfs_global_error_stat_count)
97#endif
98
99#ifndef PFS_MAX_SESSION_SERVER_ERRORS
100#define PFS_MAX_SESSION_SERVER_ERRORS (1 + pfs_session_error_stat_count)
101#endif
102
103/** Sizing hints, from the server configuration. */
105 /** Value of @c Sys_table_def_size */
107 /** Value of @c Sys_table_cache_size */
109 /** Value of @c Sys_max_connections */
111 /** Value of @c Sys_open_files_limit */
113 /** Value of @c Sys_max_prepared_stmt_count */
115};
116
117/** Performance schema global sizing parameters. */
119 /** True if the performance schema is enabled. */
121 /** Default values for SETUP_CONSUMERS. */
138
139 /** True if SHOW PROCESSLIST is enabeld in the performance schema. */
141
142 /** Default instrument configuration option. */
144
145 /**
146 Maximum number of instrumented mutex classes.
147 @sa mutex_class_lost.
148 */
150 /**
151 Maximum number of instrumented rwlock classes.
152 @sa rwlock_class_lost.
153 */
155 /**
156 Maximum number of instrumented cond classes.
157 @sa cond_class_lost.
158 */
160 /**
161 Maximum number of instrumented thread classes.
162 @sa thread_class_lost.
163 */
165 /**
166 Maximum number of instrumented table share.
167 @sa table_share_lost.
168 */
170 /**
171 Maximum number of lock statistics collected for tables.
172 @sa table_lock_stat_lost.
173 */
175 /**
176 Maximum number of index statistics collected for tables.
177 @sa table_index_lost.
178 */
180 /**
181 Maximum number of instrumented file classes.
182 @sa file_class_lost.
183 */
185 /**
186 Maximum number of instrumented mutex instances.
187 @sa mutex_lost.
188 */
190 /**
191 Maximum number of instrumented rwlock instances.
192 @sa rwlock_lost.
193 */
195 /**
196 Maximum number of instrumented cond instances.
197 @sa cond_lost.
198 */
200 /**
201 Maximum number of instrumented thread instances.
202 @sa thread_lost.
203 */
205 /**
206 Maximum number of instrumented table handles.
207 @sa table_lost.
208 */
210 /**
211 Maximum number of instrumented file instances.
212 @sa file_lost.
213 */
215 /**
216 Maximum number of instrumented file handles.
217 @sa file_handle_lost.
218 */
220 /**
221 Maximum number of instrumented socket instances
222 @sa socket_lost
223 */
225 /**
226 Maximum number of instrumented socket classes.
227 @sa socket_class_lost.
228 */
230 /** Maximum number of rows per thread in table EVENTS_WAITS_HISTORY. */
232 /** Maximum number of rows in table EVENTS_WAITS_HISTORY_LONG. */
234 /** Maximum number of rows in table SETUP_ACTORS. */
236 /** Maximum number of rows in table SETUP_OBJECTS. */
238 /** Maximum number of rows in table HOSTS. */
240 /** Maximum number of rows in table USERS. */
242 /** Maximum number of rows in table ACCOUNTS. */
244 /**
245 Maximum number of instrumented stage classes.
246 @sa stage_class_lost.
247 */
249 /** Maximum number of rows per thread in table EVENTS_STAGES_HISTORY. */
251 /** Maximum number of rows in table EVENTS_STAGES_HISTORY_LONG. */
253 /**
254 Maximum number of instrumented statement classes.
255 @sa statement_class_lost.
256 */
258 /** Maximum number of rows per thread in table EVENTS_STATEMENTS_HISTORY. */
260 /** Maximum number of rows in table EVENTS_STATEMENTS_HISTORY_LONG. */
262 /** Maximum number of digests to be captured */
264 /** Maximum number of programs to be captured */
266 /** Maximum number of prepared statements to be captured */
268 /** Maximum number of rows per thread in table EVENTS_TRANSACTIONS_HISTORY. */
270 /** Maximum number of rows in table EVENTS_TRANSACTIONS_HISTORY_LONG. */
272
273 /** Maximum number of session attribute strings per thread */
275 /** Maximum size of statement stack */
277
278 /**
279 Maximum number of instrumented memory classes.
280 @sa memory_class_lost.
281 */
283
284 /**
285 Maximum number of instrumented meter classes.
286 @sa meter_class_lost.
287 */
289
290 /**
291 Maximum number of instrumented metric classes.
292 @sa metric_class_lost.
293 */
295
297
300
301 /** Maximum age in seconds for a query sample. */
303
304 /** Maximum number of error instrumented */
306
307 /** Sizing hints, for auto tuning. */
309};
310
311/**
312 Performance schema sizing values for the server.
313 This global variable is set when parsing server startup options.
314*/
316
317/**
318 Null initialization.
319 Disable all instrumentation, size all internal buffers to 0.
320 This pre initialization step is needed to ensure that events can be collected
321 and discarded, until such time @c initialize_performance_schema() is called.
322*/
324
325/**
326 Initialize the performance schema.
327 The performance schema implement several instrumentation services.
328 Each instrumentation service is versioned, and accessible through
329 a bootstrap structure, returned as output parameter.
330 @param param Size parameters to use.
331 @param [out] thread_bootstrap Thread instrumentation service bootstrap
332 @param [out] mutex_bootstrap Mutex instrumentation service bootstrap
333 @param [out] rwlock_bootstrap Rwlock instrumentation service bootstrap
334 @param [out] cond_bootstrap Condition instrumentation service bootstrap
335 @param [out] file_bootstrap File instrumentation service bootstrap
336 @param [out] socket_bootstrap Socket instrumentation service bootstrap
337 @param [out] table_bootstrap Table instrumentation service bootstrap
338 @param [out] mdl_bootstrap Metadata Lock instrumentation service bootstrap
339 @param [out] idle_bootstrap Idle instrumentation service bootstrap
340 @param [out] stage_bootstrap Stage instrumentation service bootstrap
341 @param [out] statement_bootstrap Statement instrumentation service bootstrap
342 @param [out] transaction_bootstrap Transaction instrumentation service
343 bootstrap
344 @param [out] memory_bootstrap Memory instrumentation service bootstrap
345 @param [out] error_bootstrap Error instrumentation service bootstrap
346 @param [out] data_lock_bootstrap Data Lock instrumentation service bootstrap
347 @param [out] system_bootstrap System instrumentation service bootstrap
348 @param [out] tls_channel_bootstrap TLS channel instrumentation service
349 bootstrap
350 @retval 0 success
351*/
353 PFS_global_param *param, PSI_thread_bootstrap **thread_bootstrap,
354 PSI_mutex_bootstrap **mutex_bootstrap,
355 PSI_rwlock_bootstrap **rwlock_bootstrap,
356 PSI_cond_bootstrap **cond_bootstrap, PSI_file_bootstrap **file_bootstrap,
357 PSI_socket_bootstrap **socket_bootstrap,
358 PSI_table_bootstrap **table_bootstrap, PSI_mdl_bootstrap **mdl_bootstrap,
359 PSI_idle_bootstrap **idle_bootstrap, PSI_stage_bootstrap **stage_bootstrap,
360 PSI_statement_bootstrap **statement_bootstrap,
361 PSI_transaction_bootstrap **transaction_bootstrap,
362 PSI_memory_bootstrap **memory_bootstrap,
363 PSI_error_bootstrap **error_bootstrap,
364 PSI_data_lock_bootstrap **data_lock_bootstrap,
365 PSI_system_bootstrap **system_bootstrap,
366 PSI_tls_channel_bootstrap **tls_channel_bootstrap);
367
369
370/**
371 Initialize the performance schema ACL.
372 ACL is strictly enforced when the server is running in normal mode,
373 to enforce that only legal operations are allowed.
374 When running in bootstrap mode, ACL restrictions are relaxed,
375 to allow the bootstrap scripts to DROP / CREATE performance schema tables.
376 @sa ACL_internal_schema_registry
377 @param bootstrap True if the server is starting in bootstrap mode.
378*/
380
381/**
382 Reset the aggregated status counter stats.
383*/
385
386/**
387 Initialize the dynamic array holding individual instrument settings collected
388 from the server configuration options.
389*/
391
392/**
393 Process one PFS_INSTRUMENT configuration string.
394*/
395int add_pfs_instr_to_array(const char *name, const char *value);
396
397/**
398 Shutdown the performance schema.
399*/
401
402#endif /* HAVE_PSI_INTERFACE */
403
404#endif /* PFS_SERVER_H */
void initialize_performance_schema_acl(bool bootstrap)
Initialize the performance schema ACL.
Definition: pfs_engine_table.cc:999
Defines various enable/disable and HAVE_ macros related to the performance schema instrumentation sys...
Definition: bootstrap.cc:70
void reset_pfs_status_stats()
Reset the aggregated status counter stats.
Definition: pfs_variable.cc:1559
void shutdown_performance_schema()
Shutdown the performance schema.
Definition: pfs_server.cc:383
void init_pfs_instrument_array()
Initialize the dynamic array holding individual instrument settings collected from the server configu...
Definition: pfs_server.cc:418
void pfs_automated_sizing(PFS_global_param *param)
Definition: pfs_autosize.cc:158
void pre_initialize_performance_schema()
Null initialization.
Definition: pfs_server.cc:72
int add_pfs_instr_to_array(const char *name, const char *value)
Process one PFS_INSTRUMENT configuration string.
Definition: pfs_server.cc:443
PFS_global_param pfs_param
Performance schema sizing values for the server.
Definition: pfs_server.cc:65
int initialize_performance_schema(PFS_global_param *param, PSI_thread_bootstrap **thread_bootstrap, PSI_mutex_bootstrap **mutex_bootstrap, PSI_rwlock_bootstrap **rwlock_bootstrap, PSI_cond_bootstrap **cond_bootstrap, PSI_file_bootstrap **file_bootstrap, PSI_socket_bootstrap **socket_bootstrap, PSI_table_bootstrap **table_bootstrap, PSI_mdl_bootstrap **mdl_bootstrap, PSI_idle_bootstrap **idle_bootstrap, PSI_stage_bootstrap **stage_bootstrap, PSI_statement_bootstrap **statement_bootstrap, PSI_transaction_bootstrap **transaction_bootstrap, PSI_memory_bootstrap **memory_bootstrap, PSI_error_bootstrap **error_bootstrap, PSI_data_lock_bootstrap **data_lock_bootstrap, PSI_system_bootstrap **system_bootstrap, PSI_tls_channel_bootstrap **tls_channel_bootstrap)
Initialize the performance schema.
Definition: pfs_server.cc:95
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
Performance schema instrumentation interface.
case opt name
Definition: sslopt-case.h:32
Performance schema global sizing parameters.
Definition: pfs_server.h:118
long m_events_stages_history_long_sizing
Maximum number of rows in table EVENTS_STAGES_HISTORY_LONG.
Definition: pfs_server.h:252
ulong m_memory_class_sizing
Maximum number of instrumented memory classes.
Definition: pfs_server.h:282
long m_socket_sizing
Maximum number of instrumented socket instances.
Definition: pfs_server.h:224
long m_session_connect_attrs_sizing
Maximum number of session attribute strings per thread.
Definition: pfs_server.h:274
ulong m_metric_class_sizing
Maximum number of instrumented metric classes.
Definition: pfs_server.h:294
long m_events_transactions_history_long_sizing
Maximum number of rows in table EVENTS_TRANSACTIONS_HISTORY_LONG.
Definition: pfs_server.h:271
bool m_consumer_events_stages_history_enabled
Definition: pfs_server.h:123
ulong m_max_digest_sample_age
Maximum age in seconds for a query sample.
Definition: pfs_server.h:302
long m_account_sizing
Maximum number of rows in table ACCOUNTS.
Definition: pfs_server.h:243
long m_user_sizing
Maximum number of rows in table USERS.
Definition: pfs_server.h:241
long m_events_waits_history_long_sizing
Maximum number of rows in table EVENTS_WAITS_HISTORY_LONG.
Definition: pfs_server.h:233
long m_index_stat_sizing
Maximum number of index statistics collected for tables.
Definition: pfs_server.h:179
long m_prepared_stmt_sizing
Maximum number of prepared statements to be captured.
Definition: pfs_server.h:267
bool m_consumer_events_transactions_history_enabled
Definition: pfs_server.h:130
bool m_consumer_thread_instrumentation_enabled
Definition: pfs_server.h:136
long m_events_stages_history_sizing
Maximum number of rows per thread in table EVENTS_STAGES_HISTORY.
Definition: pfs_server.h:250
bool m_consumer_events_statements_history_enabled
Definition: pfs_server.h:127
bool m_consumer_events_stages_current_enabled
Default values for SETUP_CONSUMERS.
Definition: pfs_server.h:122
bool m_consumer_events_waits_current_enabled
Definition: pfs_server.h:132
long m_table_share_sizing
Maximum number of instrumented table share.
Definition: pfs_server.h:169
long m_digest_sizing
Maximum number of digests to be captured.
Definition: pfs_server.h:263
bool m_consumer_events_statements_current_enabled
Definition: pfs_server.h:126
ulong m_mutex_class_sizing
Maximum number of instrumented mutex classes.
Definition: pfs_server.h:149
long m_program_sizing
Maximum number of programs to be captured.
Definition: pfs_server.h:265
bool m_consumer_events_transactions_history_long_enabled
Definition: pfs_server.h:131
ulong m_meter_class_sizing
Maximum number of instrumented meter classes.
Definition: pfs_server.h:288
bool m_consumer_events_stages_history_long_enabled
Definition: pfs_server.h:124
long m_file_sizing
Maximum number of instrumented file instances.
Definition: pfs_server.h:214
long m_events_statements_history_long_sizing
Maximum number of rows in table EVENTS_STATEMENTS_HISTORY_LONG.
Definition: pfs_server.h:261
ulong m_socket_class_sizing
Maximum number of instrumented socket classes.
Definition: pfs_server.h:229
long m_rwlock_sizing
Maximum number of instrumented rwlock instances.
Definition: pfs_server.h:194
bool m_consumer_events_statements_history_long_enabled
Definition: pfs_server.h:128
long m_file_handle_sizing
Maximum number of instrumented file handles.
Definition: pfs_server.h:219
bool m_enabled
True if the performance schema is enabled.
Definition: pfs_server.h:120
ulong m_file_class_sizing
Maximum number of instrumented file classes.
Definition: pfs_server.h:184
long m_metadata_lock_sizing
Definition: pfs_server.h:296
long m_setup_object_sizing
Maximum number of rows in table SETUP_OBJECTS.
Definition: pfs_server.h:237
ulong m_rwlock_class_sizing
Maximum number of instrumented rwlock classes.
Definition: pfs_server.h:154
long m_events_waits_history_sizing
Maximum number of rows per thread in table EVENTS_WAITS_HISTORY.
Definition: pfs_server.h:231
ulong m_max_sql_text_length
Definition: pfs_server.h:299
long m_events_transactions_history_sizing
Maximum number of rows per thread in table EVENTS_TRANSACTIONS_HISTORY.
Definition: pfs_server.h:269
bool m_consumer_events_waits_history_long_enabled
Definition: pfs_server.h:134
bool m_consumer_events_statements_cpu_enabled
Definition: pfs_server.h:125
long m_cond_sizing
Maximum number of instrumented cond instances.
Definition: pfs_server.h:199
long m_max_digest_length
Definition: pfs_server.h:298
PFS_sizing_hints m_hints
Sizing hints, for auto tuning.
Definition: pfs_server.h:308
ulong m_thread_class_sizing
Maximum number of instrumented thread classes.
Definition: pfs_server.h:164
ulong m_error_sizing
Maximum number of error instrumented.
Definition: pfs_server.h:305
ulong m_statement_class_sizing
Maximum number of instrumented statement classes.
Definition: pfs_server.h:257
long m_mutex_sizing
Maximum number of instrumented mutex instances.
Definition: pfs_server.h:189
bool m_consumer_events_waits_history_enabled
Definition: pfs_server.h:133
ulong m_statement_stack_sizing
Maximum size of statement stack.
Definition: pfs_server.h:276
bool m_processlist_enabled
True if SHOW PROCESSLIST is enabeld in the performance schema.
Definition: pfs_server.h:140
char * m_pfs_instrument
Default instrument configuration option.
Definition: pfs_server.h:143
long m_setup_actor_sizing
Maximum number of rows in table SETUP_ACTORS.
Definition: pfs_server.h:235
long m_events_statements_history_sizing
Maximum number of rows per thread in table EVENTS_STATEMENTS_HISTORY.
Definition: pfs_server.h:259
long m_table_lock_stat_sizing
Maximum number of lock statistics collected for tables.
Definition: pfs_server.h:174
long m_thread_sizing
Maximum number of instrumented thread instances.
Definition: pfs_server.h:204
long m_host_sizing
Maximum number of rows in table HOSTS.
Definition: pfs_server.h:239
ulong m_stage_class_sizing
Maximum number of instrumented stage classes.
Definition: pfs_server.h:248
long m_table_sizing
Maximum number of instrumented table handles.
Definition: pfs_server.h:209
bool m_consumer_global_instrumentation_enabled
Definition: pfs_server.h:135
bool m_consumer_events_transactions_current_enabled
Definition: pfs_server.h:129
ulong m_cond_class_sizing
Maximum number of instrumented cond classes.
Definition: pfs_server.h:159
bool m_consumer_statement_digest_enabled
Definition: pfs_server.h:137
Sizing hints, from the server configuration.
Definition: pfs_server.h:104
ulong m_table_definition_cache
Value of Sys_table_def_size.
Definition: pfs_server.h:106
ulong m_max_connections
Value of Sys_max_connections.
Definition: pfs_server.h:110
ulong m_table_open_cache
Value of Sys_table_cache_size.
Definition: pfs_server.h:108
long m_max_prepared_stmt_count
Value of Sys_max_prepared_stmt_count.
Definition: pfs_server.h:114
long m_open_files_limit
Value of Sys_open_files_limit.
Definition: pfs_server.h:112
Entry point for the performance schema interface.
Definition: psi_cond.h:45
Entry point for the performance schema interface.
Definition: psi_data_lock.h:81
Entry point for the performance schema interface.
Definition: psi_error.h:58
Entry point for the performance schema interface.
Definition: psi_file.h:65
Entry point for the performance schema interface.
Definition: psi_idle.h:59
Entry point for the performance schema interface.
Definition: psi_mdl.h:67
Entry point for the performance schema interface.
Definition: psi_memory.h:84
Entry point for the performance schema interface.
Definition: psi_mutex.h:45
Entry point for the performance schema interface.
Definition: psi_rwlock.h:52
Entry point for the performance schema interface.
Definition: psi_socket.h:51
Entry point for the performance schema interface.
Definition: psi_stage.h:45
Entry point for the performance schema interface.
Definition: psi_statement.h:45
Entry point for the performance schema interface.
Definition: psi_system.h:59
Entry point for the performance schema interface.
Definition: psi_table.h:59
Entry point for the performance schema interface.
Definition: psi_thread.h:101
Entry point for the performance schema interface.
Definition: psi_tls_channel.h:45
Entry point for the performance schema interface.
Definition: psi_transaction.h:59