engine_memory.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_MEMORY_ENGINE_MEMORY_HPP_
#define FOEDUS_MEMORY_ENGINE_MEMORY_HPP_

#include <string>
#include <vector>

#include "foedus/assert_nd.hpp"
#include "foedus/cxx11.hpp"
#include "foedus/error_stack.hpp"
#include "foedus/fwd.hpp"
#include "foedus/initializable.hpp"
#include "foedus/cache/fwd.hpp"
#include "foedus/memory/aligned_memory.hpp"
#include "foedus/memory/fwd.hpp"
#include "foedus/memory/page_pool.hpp"
#include "foedus/memory/page_resolver.hpp"
#include "foedus/storage/fwd.hpp"
#include "foedus/thread/thread_id.hpp"

namespace foedus {
namespace memory {
class EngineMemory CXX11_FINAL : public DefaultInitializable {
 public:
  EngineMemory() CXX11_FUNC_DELETE;
  explicit EngineMemory(Engine* engine) : engine_(engine), local_memory_(CXX11_NULLPTR) {}
  ErrorStack  initialize_once() CXX11_OVERRIDE;
  ErrorStack  uninitialize_once() CXX11_OVERRIDE;

  void*     get_shared_user_memory() const;
  uint64_t  get_shared_user_memory_size() const;

  // accessors for child memories
  NumaNodeMemory* get_local_memory() const {
    return local_memory_;
  }
  NumaNodeMemoryRef* get_node_memory(foedus::thread::ThreadGroupId group) const {
    return node_memories_[group];
  }

  std::string     dump_free_memory_stat() const;

  const GlobalVolatilePageResolver& get_global_volatile_page_resolver() const {
    return global_volatile_page_resolver_;
  }

  ErrorStack grab_one_volatile_page(
    foedus::thread::ThreadGroupId node,
    storage::VolatilePagePointer* pointer,
    storage::Page** page);

  ErrorStack load_one_volatile_page(
    cache::SnapshotFileSet* fileset,
    storage::SnapshotPagePointer snapshot_pointer,
    storage::VolatilePagePointer* pointer,
    storage::Page** page);

 private:
  Engine* const                   engine_;

  NumaNodeMemory*                 local_memory_;

  std::vector<NumaNodeMemoryRef*> node_memories_;

  GlobalVolatilePageResolver      global_volatile_page_resolver_;
};
}  // namespace memory
}  // namespace foedus
#endif  // FOEDUS_MEMORY_ENGINE_MEMORY_HPP_