foedus::storage::sequential::SequentialMetadata Struct Reference

Metadata of a sequential storage. More...

Detailed Description

Metadata of a sequential storage.

About root_snapshot_page_id

In sequential storage, root_snapshot_page_id points to the head of stable root pages. A sequential storage has zero or more stable root pages (SequentialRootPage) that form a singly-linked list. Each of them contains a number of page pointers to head pages. In reality, most sequential storage should have only one root page which has only a few head pages.

When this pointer is zero, there is no stable head page.

This page pointer is not dual page pointer because we never have volatile (modify-able) root pages. All the volatile part are stored as the in-memory append-only list, which is totally orthogonal to snapshot pages.

Definition at line 53 of file sequential_metadata.hpp.

#include <sequential_metadata.hpp>

Inheritance diagram for foedus::storage::sequential::SequentialMetadata:

Collaboration diagram for foedus::storage::sequential::SequentialMetadata:

Public Member Functions
	SequentialMetadata ()
	SequentialMetadata (StorageId id, const StorageName &name)
	SequentialMetadata (const StorageName &name)
	This one is for newly creating a storage. More...
std::string	describe () const
uint32_t	unused_dummy_func_padding () const
Public Member Functions inherited from foedus::storage::Metadata
	Metadata ()
	Metadata (StorageId id, StorageType type, const StorageName &name)
	Metadata (StorageId id, StorageType type, const StorageName &name, SnapshotPagePointer root_snapshot_page_id)
bool	keeps_all_volatile_pages () const

Public Attributes
Epoch::EpochInteger	truncate_epoch_
	The min epoch value (truncate-epoch) for all valid records in this storage. More...
uint32_t	padding_
Public Attributes inherited from foedus::storage::Metadata
StorageId	id_
	the unique ID of this storage. More...
StorageType	type_
	type of the storage. More...
StorageName	name_
	the unique name of this storage. More...
SnapshotPagePointer	root_snapshot_page_id_
	Pointer to a snapshotted page this storage is rooted at. More...
SnapshotThresholds	snapshot_thresholds_

Friends
std::ostream &	operator<< (std::ostream &o, const SequentialMetadata &v)

Additional Inherited Members
Static Public Member Functions inherited from foedus::storage::Metadata
static std::string	describe (const Metadata &metadata)
	to_string operator of all Metadata objects. More...

Constructor & Destructor Documentation

foedus::storage::sequential::SequentialMetadata::SequentialMetadata ( )

inline

Definition at line 54 of file sequential_metadata.hpp.

    : Metadata(0, kSequentialStorage, ""), truncate_epoch_(Epoch::kEpochInvalid), padding_(0) {}

foedus::storage::sequential::SequentialMetadata::SequentialMetadata ( StorageId  id, const StorageName &  name  )

inline

Definition at line 56 of file sequential_metadata.hpp.

    : Metadata(id, kSequentialStorage, name), truncate_epoch_(Epoch::kEpochInvalid), padding_(0) {
  }

foedus::storage::sequential::SequentialMetadata::SequentialMetadata ( const StorageName &  name )

inlineexplicit

This one is for newly creating a storage.

Definition at line 60 of file sequential_metadata.hpp.

    : Metadata(0, kSequentialStorage, name), truncate_epoch_(Epoch::kEpochInvalid), padding_(0) {
  }

Member Function Documentation

std::string foedus::storage::sequential::SequentialMetadata::describe

(

)

const

Definition at line 29 of file sequential_metadata.cpp.

                                             {
  std::stringstream o;
  o << SequentialMetadataSerializer(const_cast<SequentialMetadata*>(this));
  return o.str();
}

uint32_t foedus::storage::sequential::SequentialMetadata::unused_dummy_func_padding ( ) const

inline

Definition at line 67 of file sequential_metadata.hpp.

References padding_.

{ return padding_; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o, const SequentialMetadata &  v  )

friend

Definition at line 34 of file sequential_metadata.cpp.

                                                                   {
  o << SequentialMetadataSerializer(const_cast<SequentialMetadata*>(&v));
  return o;
}

Member Data Documentation

uint32_t foedus::storage::sequential::SequentialMetadata::padding_

Definition at line 77 of file sequential_metadata.hpp.

Referenced by unused_dummy_func_padding().

Epoch::EpochInteger foedus::storage::sequential::SequentialMetadata::truncate_epoch_

The min epoch value (truncate-epoch) for all valid records in this storage.

When a physical record or a page has an epoch value less than a truncate-epoch, they are logically non-existent. Truncate-epoch is always valid, starting from the system's lowest epoch.

Definition at line 75 of file sequential_metadata.hpp.

Referenced by foedus::storage::sequential::SequentialMetadataSerializer::load(), and foedus::storage::sequential::SequentialMetadataSerializer::save().

---

The documentation for this struct was generated from the following files:

• /home/shino/foedus_code/foedus-core/include/foedus/storage/sequential/sequential_metadata.hpp
• /home/shino/foedus_code/foedus-core/src/foedus/storage/sequential/sequential_metadata.cpp