snapshot_writer_impl.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_SNAPSHOT_SNAPSHOT_WRITER_IMPL_HPP_
#define FOEDUS_SNAPSHOT_SNAPSHOT_WRITER_IMPL_HPP_
#include <stdint.h>

#include <iosfwd>
#include <string>

#include "foedus/assert_nd.hpp"
#include "foedus/compiler.hpp"
#include "foedus/error_stack.hpp"
#include "foedus/fwd.hpp"
#include "foedus/fs/fwd.hpp"
#include "foedus/fs/path.hpp"
#include "foedus/memory/aligned_memory.hpp"
#include "foedus/snapshot/fwd.hpp"
#include "foedus/snapshot/snapshot_id.hpp"
#include "foedus/storage/page.hpp"
#include "foedus/storage/storage_id.hpp"
#include "foedus/thread/thread_id.hpp"

namespace foedus {
namespace snapshot {
class SnapshotWriter final {
 public:
  SnapshotWriter(
    Engine* engine,
    uint16_t numa_node,
    SnapshotId snapshot_id,
    memory::AlignedMemory* pool_memory,
    memory::AlignedMemory* intermediate_memory,
    bool append = false);
  ~SnapshotWriter() { close(); }

  ErrorStack  open();
  bool        is_opened() const { return snapshot_file_; }
  bool        close();

  SnapshotWriter() = delete;
  SnapshotWriter(const SnapshotWriter &other) = delete;
  SnapshotWriter& operator=(const SnapshotWriter &other) = delete;


  uint16_t                get_numa_node() const { return numa_node_; }
  inline storage::Page*   get_page_base() ALWAYS_INLINE {
    return reinterpret_cast<storage::Page*>(pool_memory_->get_block());
  }
  inline memory::PagePoolOffset  get_page_size() const ALWAYS_INLINE {
    return pool_memory_->get_size() / storage::kPageSize;
  }
  inline storage::Page*          get_intermediate_base() ALWAYS_INLINE {
    return reinterpret_cast<storage::Page*>(intermediate_memory_->get_block());
  }
  inline memory::PagePoolOffset  get_intermediate_size() const ALWAYS_INLINE {
    return intermediate_memory_->get_size() / storage::kPageSize;
  }

  storage::SnapshotPagePointer get_next_page_id() const { return next_page_id_; }
  SnapshotId              get_snapshot_id() const { return snapshot_id_; }

  storage::Page*          resolve(memory::PagePoolOffset offset) ALWAYS_INLINE {
    ASSERT_ND(offset > 0);
    ASSERT_ND(offset < get_page_size());
    return get_page_base() + offset;
  }
  memory::PagePoolOffset  resolve(storage::Page* page) ALWAYS_INLINE {
    memory::PagePoolOffset offset = page - get_page_base();
    ASSERT_ND(offset > 0);
    ASSERT_ND(offset < get_page_size());
    return offset;
  }

  ErrorCode dump_pages(memory::PagePoolOffset from_page, uint32_t count) {
    return dump_general(pool_memory_, from_page, count);
  }

  ErrorCode dump_intermediates(memory::PagePoolOffset from_page, uint32_t count) {
    return dump_general(intermediate_memory_, from_page, count);
  }

  std::string             to_string() const {
    return "SnapshotWriter-" + std::to_string(numa_node_) + (append_ ? "(append)" : "");
  }

  ErrorCode expand_pool_memory(uint32_t required_pages, bool retain_content);

  ErrorCode expand_intermediate_memory(uint32_t required_pages, bool retain_content);

  friend std::ostream&    operator<<(std::ostream& o, const SnapshotWriter& v);

 private:
  Engine* const                   engine_;
  const uint16_t                  numa_node_;
  const bool                      append_;
  const SnapshotId                snapshot_id_;

  memory::AlignedMemory* const    pool_memory_;

  memory::AlignedMemory* const    intermediate_memory_;

  fs::DirectIoFile*               snapshot_file_;

  storage::SnapshotPagePointer    next_page_id_;

  fs::Path  get_snapshot_file_path() const;
  ErrorCode dump_general(
    memory::AlignedMemory* buffer,
    memory::PagePoolOffset from_page,
    uint32_t count);
};
}  // namespace snapshot
}  // namespace foedus
#endif  // FOEDUS_SNAPSHOT_SNAPSHOT_WRITER_IMPL_HPP_