/* Copyright (c) 2017, 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 DD__BOOTSTRAP_CTX_INCLUDED
#define DD__BOOTSTRAP_CTX_INCLUDED

#include <assert.h>
#include <set>

#include "my_inttypes.h"                  // uint
#include "mysql_version.h"                // MYSQL_VERSION_ID
#include "sql/dd/dd_version.h"            // DD_VERSION
#include "sql/dd/info_schema/metadata.h"  // IS_DD_VERSION
#include "sql/mysqld.h"                   // opt_initialize

class THD;

namespace dd {
namespace bootstrap {

// Enumeration of bootstrapping stages.
enum class Stage {
  NOT_STARTED,          // Not started.
  STARTED,              // Started, nothing prepared yet.
  CREATED_TABLESPACES,  // Created predefined tablespaces.
  FETCHED_PROPERTIES,   // Done reading DD properties.
  CREATED_TABLES,       // Tables created, able to store persistently.
  SYNCED,               // Cached meta data synced with persistent storage.
  UPGRADED_TABLES,      // Created new table versions and migrated meta data.
  POPULATED,            // (Re)populated tables with meta data.
  STORED_DD_META_DATA,  // Stored the hard coded meta data of the DD tables.
  VERSION_UPDATED,      // The properties in 'dd_properties' are updated.
  FINISHED              // Completed.
};

// Individual DD version labels that we can refer to.
static constexpr uint DD_VERSION_80011 = 80011;
static constexpr uint DD_VERSION_80012 = 80012;
static constexpr uint DD_VERSION_80013 = 80013;
static constexpr uint DD_VERSION_80014 = 80014;
static constexpr uint DD_VERSION_80015 = 80015;
static constexpr uint DD_VERSION_80016 = 80016;
static constexpr uint DD_VERSION_80017 = 80017;
static constexpr uint DD_VERSION_80021 = 80021;
static constexpr uint DD_VERSION_80022 = 80022;
static constexpr uint DD_VERSION_80023 = 80023;

/*
  Set of supported DD version labels. A supported DD version is a version
  from which we can upgrade. In the case of downgrade, this is not relevant,
  since the set of supported versions is defined when the server is built,
  and newer version numbers are not added to this set. in the case of
  downgrade, we instead have to check the MINOR_DOWNGRADE_THRESHOLD, which is
  stored in the 'dd_properties' table by the server from which we downgrade.
*/
static std::set<uint> supported_dd_versions = {
    DD_VERSION_80011, DD_VERSION_80012, DD_VERSION_80013, DD_VERSION_80014,
    DD_VERSION_80015, DD_VERSION_80016, DD_VERSION_80017, DD_VERSION_80021,
    DD_VERSION_80022, DD_VERSION_80023};

// Individual server version labels that we can refer to.
static constexpr uint SERVER_VERSION_50700 = 50700;
static constexpr uint SERVER_VERSION_80011 = 80011;
static constexpr uint SERVER_VERSION_80013 = 80013;
static constexpr uint SERVER_VERSION_80014 = 80014;
static constexpr uint SERVER_VERSION_80015 = 80015;
static constexpr uint SERVER_VERSION_80016 = 80016;

/*
  Set of unsupported server version labels. An unsupported server version is a
  version from which we can't upgrade or downgrade.
*/
static std::set<uint> unsupported_server_versions = {};

class DD_bootstrap_ctx {
 private:
  uint m_did_dd_upgrade_from = 0;
  uint m_actual_dd_version = 0;
  uint m_upgraded_server_version = 0;
  Stage m_stage = Stage::NOT_STARTED;

  uint m_did_I_S_upgrade_from = 0;
  uint m_actual_I_S_version = 0;

 public:
  DD_bootstrap_ctx() = default;

  static DD_bootstrap_ctx &instance();

  Stage get_stage() const { return m_stage; }

  void set_stage(Stage stage) { m_stage = stage; }

  bool supported_dd_version() const {
    return (supported_dd_versions.find(m_actual_dd_version) !=
            supported_dd_versions.end());
  }

  void set_actual_dd_version(uint actual_dd_version) {
    m_actual_dd_version = actual_dd_version;
  }

  void set_actual_I_S_version(uint actual_I_S_version) {
    m_actual_I_S_version = actual_I_S_version;
  }

  uint get_actual_dd_version() const { return m_actual_dd_version; }

  uint get_actual_I_S_version() const { return m_actual_I_S_version; }

  void set_dd_upgrade_done() {
    assert(m_did_dd_upgrade_from == 0);
    assert(is_dd_upgrade());
    m_did_dd_upgrade_from = m_actual_dd_version;
  }

  bool dd_upgrade_done() const { return m_did_dd_upgrade_from != 0; }

  void set_I_S_upgrade_done() {
    assert(m_did_I_S_upgrade_from == 0);
    m_did_I_S_upgrade_from = m_actual_I_S_version;
  }

  bool I_S_upgrade_done() const { return m_did_I_S_upgrade_from != 0; }

  bool actual_dd_version_is(uint compare_actual_dd_version) const {
    return (m_actual_dd_version == compare_actual_dd_version);
  }

  bool supported_server_version(uint version) const {
    return (unsupported_server_versions.find(version) ==
            unsupported_server_versions.end()) &&
           (MYSQL_VERSION_ID > version || is_server_patch_downgrade(version));
  }

  bool supported_server_version() const {
    return supported_server_version(m_upgraded_server_version);
  }

  bool is_server_patch_downgrade(uint compare_server_version) const {
    return (compare_server_version / 100 == MYSQL_VERSION_ID / 100) &&
           (compare_server_version % 100 > MYSQL_VERSION_ID % 100);
  }

  bool is_server_patch_downgrade() const {
    return is_server_patch_downgrade(m_upgraded_server_version);
  }

  void set_upgraded_server_version(uint upgraded_server_version) {
    m_upgraded_server_version = upgraded_server_version;
  }

  uint get_upgraded_server_version() const { return m_upgraded_server_version; }

  bool upgraded_server_version_is(uint compare_upgraded_server_version) const {
    return (m_upgraded_server_version == compare_upgraded_server_version);
  }

  bool is_restart() const {
    return !opt_initialize && (m_actual_dd_version == dd::DD_VERSION) &&
           (m_upgraded_server_version == MYSQL_VERSION_ID);
  }

  bool is_dd_upgrade() const {
    return !opt_initialize && (m_actual_dd_version < dd::DD_VERSION);
  }

  bool is_server_upgrade() const {
    return !opt_initialize && (m_upgraded_server_version < MYSQL_VERSION_ID);
  }

  bool is_dd_upgrade_from_before(uint compare_actual_dd_version) const {
    return (is_dd_upgrade() && m_actual_dd_version < compare_actual_dd_version);
  }

  bool is_server_upgrade_from_before(
      uint compare_upgraded_server_version) const {
    return (is_server_upgrade() &&
            m_upgraded_server_version < compare_upgraded_server_version);
  }

  bool is_server_upgrade_from_after(
      uint compare_upgraded_server_version) const {
    return (is_server_upgrade() &&
            m_upgraded_server_version > compare_upgraded_server_version);
  }

  bool is_minor_downgrade() const {
    return !opt_initialize &&
           (m_actual_dd_version / 10000 == dd::DD_VERSION / 10000) &&
           (m_actual_dd_version > dd::DD_VERSION);
  }

  bool is_above_minor_downgrade_threshold(THD *thd) const;

  bool is_initialize() const {
    return opt_initialize && (m_actual_dd_version == dd::DD_VERSION);
  }
};

}  // namespace bootstrap
}  // namespace dd

#endif  // DD__BOOTSTRAP_CTX_INCLUDED