engine.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
 * This program 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; either version 2 of the License, or (at your option)
 * any later version.
 *
 * 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 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * HP designates this particular file as subject to the "Classpath" exception
 * as provided by HP in the LICENSE.txt file that accompanied this code.
 */
#ifndef FOEDUS_ENGINE_HPP_
#define FOEDUS_ENGINE_HPP_

#include <string>

#include "foedus/cxx11.hpp"
#include "foedus/engine_type.hpp"
#include "foedus/epoch.hpp"
#include "foedus/error_stack.hpp"
#include "foedus/initializable.hpp"
#include "foedus/module_type.hpp"
#include "foedus/cache/fwd.hpp"
#include "foedus/debugging/fwd.hpp"
#include "foedus/log/fwd.hpp"
#include "foedus/memory/fwd.hpp"
#include "foedus/proc/fwd.hpp"
#include "foedus/restart/fwd.hpp"
#include "foedus/savepoint/fwd.hpp"
#include "foedus/snapshot/fwd.hpp"
#include "foedus/soc/fwd.hpp"
#include "foedus/soc/soc_id.hpp"
#include "foedus/storage/fwd.hpp"
#include "foedus/thread/fwd.hpp"
#include "foedus/xct/fwd.hpp"
namespace foedus {

// forward declarations
class EnginePimpl;
struct EngineOptions;

class Engine CXX11_FINAL : public virtual Initializable {
 public:
  explicit Engine(const EngineOptions &options);

  Engine(EngineType type, soc::Upid master_upid, Eid master_eid, soc::SocId soc_id);

  ~Engine();

  // Disable default constructors
  Engine() CXX11_FUNC_DELETE;
  Engine(const Engine &) CXX11_FUNC_DELETE;
  Engine& operator=(const Engine &) CXX11_FUNC_DELETE;

  std::string describe_short() const;

  ErrorStack  initialize() CXX11_OVERRIDE;

  bool        is_initialized() const CXX11_OVERRIDE;

  ErrorStack  uninitialize() CXX11_OVERRIDE;

  const EngineOptions&            get_options() const;
  cache::CacheManager*            get_cache_manager() const;
  debugging::DebuggingSupports*   get_debug() const;
  log::LogManager*                get_log_manager() const;
  memory::EngineMemory*           get_memory_manager() const;
  proc::ProcManager*              get_proc_manager() const;
  thread::ThreadPool*             get_thread_pool() const;
  savepoint::SavepointManager*    get_savepoint_manager() const;
  snapshot::SnapshotManager*      get_snapshot_manager() const;
  soc::SocManager*                get_soc_manager() const;
  storage::StorageManager*        get_storage_manager() const;
  xct::XctManager*                get_xct_manager() const;
  restart::RestartManager*        get_restart_manager() const;

  EngineType  get_type() const;
  bool        is_master() const;
  bool        is_emulated_child() const;
  bool        is_forked_child() const;
  bool        is_local_spawned_child() const;
  bool        is_remote_spawned_child() const;
  soc::SocId  get_soc_id() const;
  soc::SocId  get_soc_count() const;
  soc::Upid   get_master_upid() const;
  Eid         get_master_eid() const;
  Epoch       get_earliest_epoch() const;

  Epoch       get_current_global_epoch() const;

  Epoch       get_current_grace_epoch() const;

  Epoch       get_durable_global_epoch() const;

  EngineOptions*                  get_nonconst_options();

 private:
  EnginePimpl* pimpl_;
};
}  // namespace foedus
#endif  // FOEDUS_ENGINE_HPP_