pfs_events_statements.h

Go to the documentation of this file.

/* Copyright (c) 2010, 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 PFS_EVENTS_STATEMENTS_H
#define PFS_EVENTS_STATEMENTS_H
 
/**
  @file storage/perfschema/pfs_events_statements.h
  Events statements data structures (declarations).
*/
 
#include <sys/types.h>
#include <atomic>
 
#include "my_inttypes.h"
#include "storage/perfschema/pfs_column_types.h"
#include "storage/perfschema/pfs_digest.h"
#include "storage/perfschema/pfs_events.h"
#include "storage/perfschema/pfs_name.h"
 
struct PFS_thread;
struct PFS_account;
struct PFS_user;
struct PFS_host;
 
/** A statement record. */
struct PFS_events_statements : public PFS_events {
  /*
   MAINTAINER:
   See pointer arithmetic in copy_events_statements(),
   attribute here are copied in block.
  */
 
  /** STATEMENT_ID, from the SQL layer QUERY_ID. */
  ulonglong m_statement_id;
 
  enum_object_type m_sp_type;
  PFS_schema_name m_schema_name;
  PFS_object_name m_object_name;
 
  /** Database name. */
  PFS_schema_name m_current_schema_name;
 
  /** Locked time. */
  ulonglong m_lock_time;
 
  /** Diagnostics area, error number. */
  uint m_sql_errno;
  /** Diagnostics area, @c SQLSTATE. */
  char m_sqlstate[SQLSTATE_LENGTH];
  /** Diagnostics area, error count. */
  uint m_error_count;
  /** Diagnostics area, warning count. */
  uint m_warning_count;
  /** Diagnostics area, rows affected. */
  ulonglong m_rows_affected;
 
  /** Optimizer metric, number of rows sent. */
  ulonglong m_rows_sent;
  /** Optimizer metric, number of rows examined. */
  ulonglong m_rows_examined;
  /** Optimizer metric, number of temporary tables created on disk. */
  ulonglong m_created_tmp_disk_tables;
  /** Optimizer metric, number of temporary tables created. */
  ulonglong m_created_tmp_tables;
  /** Optimizer metric, number of full join. */
  ulonglong m_select_full_join;
  /** Optimizer metric, number of full range join. */
  ulonglong m_select_full_range_join;
  /** Optimizer metric, number of select range. */
  ulonglong m_select_range;
  /** Optimizer metric, number of select range checks. */
  ulonglong m_select_range_check;
  /** Optimizer metric, number of select scans. */
  ulonglong m_select_scan;
  /** Optimizer metric, number of sort merge passes. */
  ulonglong m_sort_merge_passes;
  /** Optimizer metric, number of sort ranges. */
  ulonglong m_sort_range;
  /** Optimizer metric, number of sort rows. */
  ulonglong m_sort_rows;
  /** Optimizer metric, number of sort scans. */
  ulonglong m_sort_scan;
  /** Optimizer metric, number of 'no index used'. */
  ulonglong m_no_index_used;
  /** Optimizer metric, number of 'no good index used'. */
  ulonglong m_no_good_index_used;
 
  /**
    CPU time.
    Expressed in STORAGE units (nanoseconds).
  */
  ulonglong m_cpu_time;
 
  ulonglong m_max_controlled_memory;
  ulonglong m_max_total_memory;
 
  /** True if @c SQL_TEXT was truncated. */
  bool m_sqltext_truncated;
  /** Statement character set number. */
  uint m_sqltext_cs_number;
 
  /** Executed on the secondary engine. */
  bool m_secondary;
 
  /*
   MAINTAINER:
   See pointer arithmetic in copy_events_statements(),
   attribute here are copied when needed.
  */
 
  /**
    SQL_TEXT.
    This pointer is immutable,
    and always point to pre allocated memory.
  */
  char *m_sqltext;
  /** Length of @c m_sqltext. */
  uint m_sqltext_length;
  /**
    Statement digest.
    This underlying token array storage pointer is immutable,
    and always point to pre allocated memory.
  */
  sql_digest_storage m_digest_storage;
 
  /**
    Length of @c m_message_text.
    This is placed __before__ m_message_text[], for data locality.
  */
  uint m_message_text_length;
  /** Diagnostics area, message text. */
  char m_message_text[MYSQL_ERRMSG_SIZE + 1];
};
 
void insert_events_statements_history(PFS_thread *thread,
                                      PFS_events_statements *statement);
void insert_events_statements_history_long(PFS_events_statements *statement);
 
extern ulong nested_statement_lost;
 
extern bool flag_events_statements_cpu;
extern bool flag_events_statements_current;
extern bool flag_events_statements_history;
extern bool flag_events_statements_history_long;
 
extern bool events_statements_history_long_full;
extern PFS_cacheline_atomic_uint32 events_statements_history_long_index;
extern PFS_events_statements *events_statements_history_long_array;
extern size_t events_statements_history_long_size;
 
int init_events_statements_history_long(
    size_t events_statements_history_long_sizing);
void cleanup_events_statements_history_long();
 
void reset_events_statements_current();
void reset_events_statements_history();
void reset_events_statements_history_long();
void reset_events_statements_by_thread();
void reset_events_statements_by_account();
void reset_events_statements_by_user();
void reset_events_statements_by_host();
void reset_events_statements_global();
void aggregate_account_statements(PFS_account *account);
void aggregate_user_statements(PFS_user *user);
void aggregate_host_statements(PFS_host *host);
 
#endif