table_table_handles.h

Go to the documentation of this file.

/* Copyright (c) 2012, 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_TABLE_HANDLES_H
#define TABLE_TABLE_HANDLES_H
 
/**
  @file storage/perfschema/table_table_handles.h
  Table TABLE_HANDLES (declarations).
*/
 
#include <sys/types.h>
 
#include "my_base.h"
#include "my_inttypes.h"
#include "storage/perfschema/pfs_engine_table.h"
#include "storage/perfschema/pfs_stat.h"
#include "storage/perfschema/table_helper.h"
 
class Field;
class Plugin_table;
struct PFS_table;
struct TABLE;
struct THR_LOCK;
 
/**
  @addtogroup performance_schema_tables
  @{
*/
 
/**
  A row of table
  PERFORMANCE_SCHEMA.TABLE_HANDLES.
*/
struct row_table_handles {
  /** Column OBJECT_TYPE, SCHEMA_NAME, OBJECT_NAME. */
  PFS_object_row m_object;
  /** Column OBJECT_INSTANCE_BEGIN. */
  const void *m_identity;
  /** Column OWNER_THREAD_ID. */
  ulonglong m_owner_thread_id;
  /** Column OWNER_EVENT_ID. */
  ulonglong m_owner_event_id;
  /** Column INTERNAL_LOCK. */
  PFS_TL_LOCK_TYPE m_internal_lock;
  /** Column EXTERNAL_LOCK. */
  PFS_TL_LOCK_TYPE m_external_lock;
};
 
class PFS_index_table_handles : public PFS_engine_index {
 public:
  explicit PFS_index_table_handles(PFS_engine_key *key_1)
      : PFS_engine_index(key_1) {}
 
  PFS_index_table_handles(PFS_engine_key *key_1, PFS_engine_key *key_2)
      : PFS_engine_index(key_1, key_2) {}
 
  PFS_index_table_handles(PFS_engine_key *key_1, PFS_engine_key *key_2,
                          PFS_engine_key *key_3)
      : PFS_engine_index(key_1, key_2, key_3) {}
 
  ~PFS_index_table_handles() override = default;
 
  virtual bool match(PFS_table *table) = 0;
};
 
class PFS_index_table_handles_by_object : public PFS_index_table_handles {
 public:
  PFS_index_table_handles_by_object()
      : PFS_index_table_handles(&m_key_1, &m_key_2, &m_key_3),
        m_key_1("OBJECT_TYPE"),
        m_key_2("OBJECT_SCHEMA"),
        m_key_3("OBJECT_NAME") {}
 
  ~PFS_index_table_handles_by_object() override = default;
 
  bool match(PFS_table *pfs) override;
 
 private:
  PFS_key_object_type m_key_1;
  PFS_key_object_schema m_key_2;
  PFS_key_object_name m_key_3;
};
 
class PFS_index_table_handles_by_instance : public PFS_index_table_handles {
 public:
  PFS_index_table_handles_by_instance()
      : PFS_index_table_handles(&m_key), m_key("OBJECT_INSTANCE_BEGIN") {}
 
  ~PFS_index_table_handles_by_instance() override = default;
 
  bool match(PFS_table *pfs) override;
 
 private:
  PFS_key_object_instance m_key;
};
 
class PFS_index_table_handles_by_owner : public PFS_index_table_handles {
 public:
  PFS_index_table_handles_by_owner()
      : PFS_index_table_handles(&m_key_1, &m_key_2),
        m_key_1("OWNER_THREAD_ID"),
        m_key_2("OWNER_EVENT_ID") {}
 
  ~PFS_index_table_handles_by_owner() override = default;
 
  bool match(PFS_table *pfs) override;
 
 private:
  PFS_key_thread_id m_key_1;
  PFS_key_event_id m_key_2;
};
 
/** Table PERFORMANCE_SCHEMA.TABLE_HANDLES. */
class table_table_handles : 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_init(bool scan) 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;
  table_table_handles();
 
 public:
  ~table_table_handles() override = default;
 
 protected:
  int make_row(PFS_table *table);
 
 private:
  /** Table share lock. */
  static THR_LOCK m_table_lock;
  /** Table definition. */
  static Plugin_table m_table_def;
 
  /** Current row. */
  row_table_handles m_row;
  /** Current position. */
  PFS_simple_index m_pos;
  /** Next position. */
  PFS_simple_index m_next_pos;
 
 protected:
  PFS_index_table_handles *m_opened_index;
};
 
/** @} */
#endif