table_setup_instruments.h

Go to the documentation of this file.

/* Copyright (c) 2008, 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 TABLE_SETUP_INSTRUMENTS_H
#define TABLE_SETUP_INSTRUMENTS_H
 
/**
  @file storage/perfschema/table_setup_instruments.h
  Table SETUP_INSTRUMENTS (declarations).
*/
 
#include <sys/types.h>
 
#include "my_base.h"
#include "storage/perfschema/pfs_engine_table.h"
#include "storage/perfschema/table_helper.h"
 
class Field;
class Plugin_table;
struct PFS_instr_class;
struct TABLE;
struct THR_LOCK;
 
/**
  @addtogroup performance_schema_tables
  @{
*/
 
/** A row of PERFORMANCE_SCHEMA.SETUP_INSTRUMENTS. */
struct row_setup_instruments {
  /** Columns NAME, ENABLED, TIMED. */
  PFS_instr_class *m_instr_class;
  /** True if column ENABLED can be updated. */
  bool m_update_enabled;
  /** True if column TIMED can be updated. */
  bool m_update_timed;
  /** True if column FLAGS can be updated. */
  bool m_update_flags;
};
 
/** Position of a cursor on PERFORMANCE_SCHEMA.SETUP_INSTRUMENTS. */
struct pos_setup_instruments : public PFS_double_index,
                               public PFS_instrument_view_constants {
  pos_setup_instruments() : PFS_double_index(FIRST_INSTRUMENT, 1) {}
 
  inline void reset() {
    m_index_1 = FIRST_INSTRUMENT;
    m_index_2 = 1;
  }
 
  inline bool has_more_view() { return (m_index_1 <= LAST_INSTRUMENT); }
 
  inline void next_view() {
    m_index_1++;
    m_index_2 = 1;
  }
};
 
class PFS_index_setup_instruments : public PFS_engine_index {
 public:
  PFS_index_setup_instruments() : PFS_engine_index(&m_key), m_key("NAME") {}
 
  ~PFS_index_setup_instruments() override = default;
 
  bool match_view(uint view);
  bool match(PFS_instr_class *klass);
 
 private:
  PFS_key_event_name m_key;
};
 
/** Table PERFORMANCE_SCHEMA.SETUP_INSTRUMENTS. */
class table_setup_instruments : public PFS_engine_table {
 public:
  /** Table share. */
  static PFS_engine_table_share m_share;
  static PFS_engine_table *create(PFS_engine_table_share *);
  static ha_rows get_row_count();
 
  void reset_position() override;
 
  int rnd_next() override;
  int rnd_pos(const void *pos) override;
 
  int index_init(uint idx, bool sorted) override;
  int index_next() override;
 
 protected:
  int read_row_values(TABLE *table, unsigned char *buf, Field **fields,
                      bool read_all) override;
 
  int update_row_values(TABLE *table, const unsigned char *old_buf,
                        unsigned char *new_buf, Field **fields) override;
 
  table_setup_instruments();
 
 public:
  ~table_setup_instruments() override = default;
 
 private:
  int make_row(PFS_instr_class *klass, bool update_enabled);
 
  /** Table share lock. */
  static THR_LOCK m_table_lock;
  /** Table definition. */
  static Plugin_table m_table_def;
 
  /** Current row. */
  row_setup_instruments m_row;
  /** Current position. */
  pos_setup_instruments m_pos;
  /** Next position. */
  pos_setup_instruments m_next_pos;
 
  PFS_index_setup_instruments *m_opened_index;
};
 
/** @} */
#endif