primary_election_primary_process.h

Go to the documentation of this file.

/* Copyright (c) 2018, 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 PRIMARY_ELECTION_PRIMARY_PROCESS_INCLUDED
#define PRIMARY_ELECTION_PRIMARY_PROCESS_INCLUDED
 
#include <list>
#include <string>
 
#include "plugin/group_replication/include/member_info.h"
#include "plugin/group_replication/include/pipeline_interfaces.h"
#include "plugin/group_replication/include/plugin_handlers/primary_election_include.h"
#include "plugin/group_replication/include/plugin_handlers/stage_monitor_handler.h"
#include "plugin/group_replication/include/plugin_observers/group_event_observer.h"
#include "plugin/group_replication/include/plugin_utils.h"
 
/**
  @class Primary_election_primary_process
  Class that contains the primary election process logic for the elected primary
*/
class Primary_election_primary_process : public Group_event_observer {
 public:
  /**
    Class constructor for primary election process
  */
  Primary_election_primary_process();
 
  /**
    Class destructor for primary election process
  */
  ~Primary_election_primary_process() override;
 
  /**
    Launch the local process on the primary member for primary election
 
    @param election_mode the context on which election is occurring
    @param primary_to_elect the uuid of the primary to elect
    @param group_members_info the member info about group members
 
    @returns 0 in case of success, or 1 otherwise
  */
  int launch_primary_election_process(
      enum_primary_election_mode election_mode, std::string &primary_to_elect,
      Group_member_info_list *group_members_info);
 
  /**
    Is the election process running?
    @returns  election_process_running
  */
  bool is_election_process_running();
 
  /**
   Is the process already terminating?
   @returns election_process_ending
  */
  bool is_election_process_terminating();
 
  /**
    Terminate the election process on shutdown
    @param wait should it wait for the process to finish (default true).
  */
  int terminate_election_process(bool wait = true);
 
  /**
    Waits for the election thread process to finish
  */
  void wait_on_election_process_termination();
 
  /*
    Internal thread execution method with the election process
  */
  int primary_election_process_handler();
 
  /**
    Sets the component stop timeout.
 
    @param[in]  timeout      the timeout
  */
  void set_stop_wait_timeout(ulong timeout);
 
 private:
  // The listeners for group events
 
  int after_view_change(const std::vector<Gcs_member_identifier> &joining,
                        const std::vector<Gcs_member_identifier> &leaving,
                        const std::vector<Gcs_member_identifier> &group,
                        bool is_leaving, bool *skip_election,
                        enum_primary_election_mode *election_mode,
                        std::string &suggested_primary) override;
  int after_primary_election(
      std::string primary_uuid,
      enum_primary_election_primary_change_status primary_change_status,
      enum_primary_election_mode election_mode, int error) override;
  int before_message_handling(const Plugin_gcs_message &message,
                              const std::string &message_origin,
                              bool *skip_message) override;
 
  /**
     Signal that the read mode is ready on this member
     @returns false in case of success, or true otherwise
  */
  bool signal_read_mode_ready();
 
  /** Continuation object to wait on the applier queue consumption*/
  std::shared_ptr<Continuation> applier_checkpoint_condition;
 
  /** The election thread status */
  thread_state election_process_thd_state;
  /** Is the process aborted */
  bool election_process_aborted;
 
  /* Is the primary ready? */
  bool primary_ready;
  /** Are all group members in read mode */
  bool group_in_read_mode;
  /** Waiting for old primary transaction execution */
  bool waiting_on_queue_applied_message;
  /** Are the main stages of the election process finished*/
  bool election_process_ending;
  /** The election invocation context */
  enum_primary_election_mode election_mode;
 
  /** The primary to be elected */
  std::string primary_uuid;
 
  /** The number of known members when the election started */
  ulong number_of_know_members;
  /** The members known for the current action */
  std::list<std::string> known_members_addresses;
 
  /** The stage handler for progress reporting */
  Plugin_stage_monitor_handler *stage_handler;
 
  /* Component stop timeout on shutdown */
  ulong stop_wait_timeout;
 
  // Run thread locks and conditions
 
  /** The thread run lock*/
  mysql_mutex_t election_lock;
  /** The thread run condition*/
  mysql_cond_t election_cond;
  /** The thread handle*/
  my_thread_handle primary_election_pthd;
};
 
#endif /* PRIMARY_ELECTION_PRIMARY_PROCESS_INCLUDED */