savepoint.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_SAVEPOINT_SAVEPOINT_HPP_
#define FOEDUS_SAVEPOINT_SAVEPOINT_HPP_
#include <vector>

#include "foedus/assert_nd.hpp"
#include "foedus/cxx11.hpp"
#include "foedus/epoch.hpp"
#include "foedus/externalize/externalizable.hpp"
#include "foedus/log/log_id.hpp"
#include "foedus/snapshot/snapshot_id.hpp"

namespace foedus {
namespace savepoint {
struct Savepoint CXX11_FINAL : public virtual externalize::Externalizable {
  Savepoint();

  Epoch::EpochInteger             current_epoch_;

  Epoch::EpochInteger             durable_epoch_;

  Epoch::EpochInteger             earliest_epoch_;

  snapshot::SnapshotId            latest_snapshot_id_;
  Epoch::EpochInteger             latest_snapshot_epoch_;

  uint64_t                        meta_log_oldest_offset_;
  uint64_t                        meta_log_durable_offset_;

  // for all the following, index is LoggerId

  std::vector<log::LogFileOrdinal>    oldest_log_files_;

  std::vector<uint64_t>               oldest_log_files_offset_begin_;

  std::vector<log::LogFileOrdinal>    current_log_files_;

  std::vector<uint64_t>               current_log_files_offset_durable_;

  EXTERNALIZABLE(Savepoint);

  void                                populate_empty(log::LoggerId logger_count);
  bool                                consistent(log::LoggerId logger_count) const {
    assert_epoch_values();
    return (current_epoch_ >= durable_epoch_
      && current_epoch_ >= earliest_epoch_
      && durable_epoch_ >= earliest_epoch_
      && meta_log_oldest_offset_ <= meta_log_durable_offset_
      && oldest_log_files_.size() == logger_count
      && oldest_log_files_offset_begin_.size() == logger_count
      && current_log_files_.size() == logger_count
      && current_log_files_offset_durable_.size() == logger_count);
  }

  Epoch  get_durable_epoch() const { return Epoch(durable_epoch_); }
  Epoch  get_current_epoch() const { return Epoch(current_epoch_); }
  Epoch  get_earliest_epoch() const { return Epoch(earliest_epoch_); }
  void        assert_epoch_values() const;
};
struct LoggerSavepointInfo {
  log::LogFileOrdinal oldest_log_file_;

  log::LogFileOrdinal current_log_file_;

  uint64_t            oldest_log_file_offset_begin_;

  uint64_t            current_log_file_offset_durable_;
};

struct FixedSavepoint CXX11_FINAL {
  // only for reinterpret_cast
  FixedSavepoint() CXX11_FUNC_DELETE;
  ~FixedSavepoint() CXX11_FUNC_DELETE;

  Epoch::EpochInteger             current_epoch_;
  Epoch::EpochInteger             durable_epoch_;
  Epoch::EpochInteger             earliest_epoch_;
  snapshot::SnapshotId            latest_snapshot_id_;
  Epoch::EpochInteger             latest_snapshot_epoch_;

  uint16_t                        node_count_;
  uint16_t                        loggers_per_node_count_;

  uint64_t                        meta_log_oldest_offset_;
  uint64_t                        meta_log_durable_offset_;

  LoggerSavepointInfo             logger_info_[1U << 16];

  uint32_t                        get_total_logger_count() const {
    return static_cast<uint32_t>(node_count_) * loggers_per_node_count_;
  }

  void update(uint16_t node_count, uint16_t loggers_per_node_count, const Savepoint& src);
};

}  // namespace savepoint
}  // namespace foedus
#endif  // FOEDUS_SAVEPOINT_SAVEPOINT_HPP_