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