sequential_storage.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_STORAGE_SEQUENTIAL_SEQUENTIAL_STORAGE_HPP_
#define FOEDUS_STORAGE_SEQUENTIAL_SEQUENTIAL_STORAGE_HPP_

#include <iosfwd>
#include <string>

#include "foedus/attachable.hpp"
#include "foedus/cxx11.hpp"
#include "foedus/fwd.hpp"
#include "foedus/storage/fwd.hpp"
#include "foedus/storage/storage.hpp"
#include "foedus/storage/storage_id.hpp"
#include "foedus/storage/sequential/fwd.hpp"
#include "foedus/storage/sequential/sequential_id.hpp"
#include "foedus/thread/fwd.hpp"

namespace foedus {
namespace storage {
namespace sequential {
class SequentialStorage CXX11_FINAL : public Storage<SequentialStorageControlBlock> {
 public:
  typedef SequentialStoragePimpl   ThisPimpl;
  typedef SequentialCreateLogType  ThisCreateLogType;
  typedef SequentialMetadata       ThisMetadata;

  SequentialStorage();
  SequentialStorage(Engine* engine, SequentialStorageControlBlock* control_block);
  SequentialStorage(Engine* engine, StorageControlBlock* control_block);
  SequentialStorage(Engine* engine, StorageId id);
  SequentialStorage(Engine* engine, const StorageName& name);
  SequentialStorage(const SequentialStorage& other);
  SequentialStorage& operator=(const SequentialStorage& other);

  // Storage interface
  const SequentialMetadata*  get_sequential_metadata()  const;
  ErrorStack          create(const Metadata &metadata);
  ErrorStack          load(const StorageControlBlock& snapshot_block);
  ErrorStack          drop();

  // this storage type doesn't use moved bit

  ErrorCode  append_record(thread::Thread* context, const void *payload, uint16_t payload_count);

  void       apply_append_record(thread::Thread* context, const SequentialAppendLogType* log_entry);

  ErrorCode     optimistic_read_truncate_epoch(thread::Thread* context, Epoch* out) const;
  Epoch         get_truncate_epoch() const;

  ErrorStack  truncate(Epoch new_truncate_epoch, Epoch* commit_epoch);
  void        apply_truncate(const SequentialTruncateLogType& the_log);

  friend std::ostream& operator<<(std::ostream& o, const SequentialStorage& v);
};
}  // namespace sequential
}  // namespace storage
}  // namespace foedus
#endif  // FOEDUS_STORAGE_SEQUENTIAL_SEQUENTIAL_STORAGE_HPP_