proc_manager_pimpl.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_PROC_PROC_MANAGER_PIMPL_HPP_
#define FOEDUS_PROC_PROC_MANAGER_PIMPL_HPP_

#include <string>
#include <vector>

#include "foedus/fwd.hpp"
#include "foedus/initializable.hpp"
#include "foedus/proc/fwd.hpp"
#include "foedus/proc/proc_id.hpp"
#include "foedus/soc/shared_memory_repo.hpp"
#include "foedus/soc/shared_mutex.hpp"

namespace foedus {
namespace proc {
struct ProcManagerControlBlock {
  // this is backed by shared memory. not instantiation. just reinterpret_cast.
  ProcManagerControlBlock() = delete;
  ~ProcManagerControlBlock() = delete;

  void initialize() {
    lock_.initialize();
    count_ = 0;
  }
  void uninitialize() {
    lock_.uninitialize();
  }

  soc::SharedMutex  lock_;
  LocalProcId       count_;
};

class ProcManagerPimpl final : public DefaultInitializable {
 public:
  struct SharedData {
    SharedData() : control_block_(nullptr), procs_(nullptr), name_sort_(nullptr) {}
    ProcManagerControlBlock* control_block_;
    ProcAndName*  procs_;
    LocalProcId*  name_sort_;
  };

  ProcManagerPimpl() = delete;
  explicit ProcManagerPimpl(Engine* engine) : engine_(engine) {}

  ErrorStack  initialize_once() override;
  ErrorStack  uninitialize_once() override;

  std::string describe_registered_procs() const;
  ErrorStack  get_proc(const ProcName& name, Proc* out);
  ErrorStack  pre_register(const ProcAndName& proc_and_name);
  ErrorStack  local_register(const ProcAndName& proc_and_name);
  ErrorStack  emulated_register(const ProcAndName& proc_and_name);
  SharedData* get_local_data();
  const SharedData* get_local_data() const;

  static LocalProcId find_by_name(const ProcName& name, SharedData* shared_data);
  static LocalProcId insert(const ProcAndName& proc_and_name, SharedData* shared_data);

  Engine* const               engine_;
  std::vector< ProcAndName >  pre_registered_procs_;
  std::vector< SharedData >   all_soc_procs_;
};
static_assert(
  sizeof(ProcManagerControlBlock) <= soc::NodeMemoryAnchors::kProcManagerMemorySize,
  "ProcManagerControlBlock is too large.");
}  // namespace proc
}  // namespace foedus
#endif  // FOEDUS_PROC_PROC_MANAGER_PIMPL_HPP_