Context.h

Go to the documentation of this file.

/* -*- c++ -*-
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 3 of the
 * License, or any later version.
 *
 * Hypertable 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 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 Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#ifndef Hypertable_Master_Context_h
#define Hypertable_Master_Context_h

#include "HyperspaceMasterFile.h"
#include "MetricsHandler.h"
#include "Monitoring.h"
#include "RangeServerConnection.h"
#include "RangeServerConnectionManager.h"
#include "RecoveredServers.h"
#include "RecoveryStepFuture.h"
#include "SystemState.h"

#include <Hypertable/Lib/NameIdMapper.h>
#include <Hypertable/Lib/MetaLogDefinition.h>
#include <Hypertable/Lib/MetaLogWriter.h>
#include <Hypertable/Lib/Table.h>

#include <Hyperspace/Session.h>

#include <AsyncComm/Comm.h>
#include <AsyncComm/ConnectionManager.h>
#include <AsyncComm/ApplicationQueue.h>

#include <Common/Filesystem.h>
#include <Common/Properties.h>
#include <Common/StringExt.h>
#include <Common/Thread.h>

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/thread/condition.hpp>

#include <condition_variable>
#include <memory>
#include <mutex>
#include <set>
#include <unordered_map>

using namespace Hypertable::Master;

namespace Hypertable {


  class LoadBalancer;
  class Operation;
  class OperationTimedBarrier;
  class OperationProcessor;
  class ResponseManager;
  class ReferenceManager;
  class BalancePlanAuthority;

  class Context : public std::enable_shared_from_this<Context> {

    class RecoveryState {
      public:
        void install_replay_future(int64_t id, RecoveryStepFuturePtr &future);
        RecoveryStepFuturePtr get_replay_future(int64_t id);
        void erase_replay_future(int64_t id);

        void install_prepare_future(int64_t id, RecoveryStepFuturePtr &future);
        RecoveryStepFuturePtr get_prepare_future(int64_t id);
        void erase_prepare_future(int64_t id);

        void install_commit_future(int64_t id, RecoveryStepFuturePtr &future);
        RecoveryStepFuturePtr get_commit_future(int64_t id);
        void erase_commit_future(int64_t id);

      private:
        friend class Context;

        typedef std::map<int64_t, RecoveryStepFuturePtr> FutureMap;

      std::mutex m_mutex;
      FutureMap m_replay_map;
      FutureMap m_prepare_map;
      FutureMap m_commit_map;
    };

  public:

    Context(PropertiesPtr &p, Hyperspace::SessionPtr hs);

    Context(PropertiesPtr &p) : Context(p, Hyperspace::SessionPtr()) {}

    ~Context();

    bool set_startup_status(bool status);

    bool startup_in_progress();

    void start_shutdown();

    bool shutdown_in_progress();

    std::mutex mutex;
    std::condition_variable cond;
    Comm *comm {};
    SystemStatePtr system_state; 
    RangeServerConnectionManagerPtr rsc_manager;
    StringSet available_servers;
    PropertiesPtr props;
    ConnectionManagerPtr conn_manager;
    MetricsHandlerPtr metrics_handler;
    Hyperspace::SessionPtr hyperspace;
    ApplicationQueuePtr app_queue;
    RangeLocatorPtr range_locator;
    String toplevel_dir;
    NameIdMapperPtr namemap;
    std::unique_ptr<HyperspaceMasterFile> master_file;
    LoadBalancer *balancer {};
    MonitoringPtr monitoring;
    RecoveredServersPtr recovered_servers;
    std::unique_ptr<ReferenceManager> reference_manager;
    std::unique_ptr<Thread> response_manager_thread;
    std::unique_ptr<ResponseManager> response_manager;
    MetaLog::WriterPtr mml_writer;
    MetaLog::DefinitionPtr mml_definition;
    FilesystemPtr dfs;
    TablePtr metadata_table;
    TablePtr rs_metrics_table;
    time_t request_timeout {};
    uint32_t timer_interval {};
    uint32_t monitoring_interval {};
    uint32_t gc_interval {};
    time_t next_monitoring_time {};
    time_t next_gc_time {};
    std::unique_ptr<OperationProcessor> op;
    std::shared_ptr<OperationTimedBarrier> recovery_barrier_op;
    String cluster_name;               
    String location_hash;
    int32_t disk_threshold {};            
    int32_t max_allowable_skew {};
    bool test_mode {};
    bool quorum_reached {};

    bool add_move_operation(std::shared_ptr<Operation> operation);

    void remove_move_operation(std::shared_ptr<Operation> operation);

    std::shared_ptr<Operation> get_move_operation(int64_t hash_code);

    void add_available_server(const String &location);
    void remove_available_server(const String &location);
    size_t available_server_count();
    void get_available_servers(StringSet &servers);

    bool can_accept_ranges(const RangeServerStatistics &stats);
    void replay_status(EventPtr &event);
    void replay_complete(EventPtr &event);
    void prepare_complete(EventPtr &event);
    void commit_complete(EventPtr &event);

    void notification_hook(const String &subject, const String &message);

    void set_balance_plan_authority(MetaLog::EntityPtr bpa);

    // get the BalancePlanAuthority; this creates a new instance when
    // called for the very first time 
    BalancePlanAuthority *get_balance_plan_authority();

    // Gets smart pointer to BalancePlanAuthority.
    void get_balance_plan_authority(MetaLog::EntityPtr &entity);

    RecoveryState &recovery_state() { return m_recovery_state; }

    // Instantiate a new table object
    TablePtr new_table(const std::string &name);

  private:

    RecoveryState m_recovery_state;

    MetaLog::EntityPtr m_balance_plan_authority {};

    std::mutex m_outstanding_move_ops_mutex;

    std::unordered_map<int64_t, int64_t> m_outstanding_move_ops;

    bool m_startup {true};

    bool m_shutdown {};
  };

  typedef std::shared_ptr<Context> ContextPtr;


}

#endif // Hypertable_Master_Context_h