snapshot_options.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_OPTIONS_HPP_
#define FOEDUS_SNAPSHOT_SNAPSHOT_OPTIONS_HPP_
#include <string>
#include <vector>

#include "foedus/cxx11.hpp"
#include "foedus/externalize/externalizable.hpp"
#include "foedus/fs/device_emulation_options.hpp"
#include "foedus/fs/filesystem.hpp"

namespace foedus {
namespace snapshot {
struct SnapshotOptions CXX11_FINAL : public virtual externalize::Externalizable {
  enum Constants {
    kDefaultSnapshotTriggerPagePoolPercent = 100,
    kDefaultSnapshotIntervalMilliseconds  = 60000,
    kDefaultLogMapperBucketKb             = 1024,
    kDefaultLogMapperIoBufferMb           = 64,
    kDefaultLogReducerBufferMb            = 256,
    kDefaultLogReducerDumpIoBufferMb      = 8,
    kDefaultLogReducerReadIoBufferKb      = 1024,
    kDefaultSnapshotWriterPagePoolSizeMb  = 128,
    kDefaultSnapshotWriterIntermediatePoolSizeMb  = 16,
  };

  SnapshotOptions();

  fs::FixedPath                       folder_path_pattern_;

  uint16_t                            snapshot_trigger_page_pool_percent_;

  uint32_t                            snapshot_interval_milliseconds_;

  uint32_t                            log_mapper_bucket_kb_;

  uint16_t                            log_mapper_io_buffer_mb_;

  bool                                log_mapper_sort_before_send_;

  uint32_t                            log_reducer_buffer_mb_;

  uint32_t                            log_reducer_dump_io_buffer_mb_;

  uint32_t                            log_reducer_read_io_buffer_kb_;

  uint32_t                            snapshot_writer_page_pool_size_mb_;

  uint32_t                            snapshot_writer_intermediate_pool_size_mb_;

  foedus::fs::DeviceEmulationOptions  emulation_;

  std::string     convert_folder_path_pattern(int node) const;

  std::string     construct_snapshot_file_path(int snapshot_id, int node) const;

  std::string     get_primary_folder_path() const {
    return convert_folder_path_pattern(0);
  }

  EXTERNALIZABLE(SnapshotOptions);
};
}  // namespace snapshot
}  // namespace foedus
#endif  // FOEDUS_SNAPSHOT_SNAPSHOT_OPTIONS_HPP_