libfoedus-core
FOEDUS Core Library
snapshot_metadata.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
3  * This program is free software; you can redistribute it and/or modify it
4  * under the terms of the GNU General Public License as published by the Free
5  * Software Foundation; either version 2 of the License, or (at your option)
6  * any later version.
7  *
8  * This program is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11  * more details. You should have received a copy of the GNU General Public
12  * License along with this program; if not, write to the Free Software
13  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14  *
15  * HP designates this particular file as subject to the "Classpath" exception
16  * as provided by HP in the LICENSE.txt file that accompanied this code.
17  */
18 #ifndef FOEDUS_SNAPSHOT_SNAPSHOT_METADATA_HPP_
19 #define FOEDUS_SNAPSHOT_SNAPSHOT_METADATA_HPP_
20 #include <vector>
21 
22 #include "foedus/cxx11.hpp"
23 #include "foedus/epoch.hpp"
24 #include "foedus/externalize/externalizable.hpp"
25 #include "foedus/memory/aligned_memory.hpp"
26 #include "foedus/snapshot/snapshot_id.hpp"
27 #include "foedus/storage/fwd.hpp"
28 #include "foedus/storage/storage.hpp"
29 #include "foedus/storage/storage_id.hpp"
30 
31 namespace foedus {
32 namespace snapshot {
33 
44 struct SnapshotMetadata CXX11_FINAL : public virtual externalize::Externalizable {
45  void clear();
46  storage::Metadata* get_metadata(storage::StorageId id) {
47  return &storage_control_blocks_[id].meta_;
48  }
49 
50  ErrorStack load(tinyxml2::XMLElement* element) CXX11_OVERRIDE;
51  ErrorStack save(tinyxml2::XMLElement* element) const CXX11_OVERRIDE;
52  const char* get_tag_name() const CXX11_OVERRIDE { return "SnapshotMetadata"; }
53  void assign(const foedus::externalize::Externalizable *other) CXX11_OVERRIDE;
54 
56  SnapshotId id_;
57 
59  Epoch::EpochInteger base_epoch_;
60 
62  Epoch::EpochInteger valid_until_epoch_;
63 
65  storage::StorageId largest_storage_id_;
66 
72  storage::StorageControlBlock* storage_control_blocks_;
73 
75  memory::AlignedMemory storage_control_blocks_memory_;
76 };
77 } // namespace snapshot
78 } // namespace foedus
79 #endif // FOEDUS_SNAPSHOT_SNAPSHOT_METADATA_HPP_
foedus::snapshot::SnapshotMetadata::get_tag_name
const char * get_tag_name() const override
Returns an XML tag name for this object as a root element.
Definition: snapshot_metadata.hpp:52
foedus::snapshot::SnapshotMetadata
Represents the data in one snapshot metadata file.
Definition: snapshot_metadata.hpp:44
foedus::snapshot::SnapshotMetadata::storage_control_blocks_
storage::StorageControlBlock * storage_control_blocks_
control block of all storages.
Definition: snapshot_metadata.hpp:72
foedus::snapshot::SnapshotMetadata::save
ErrorStack save(tinyxml2::XMLElement *element) const override
Writes the content of this object to the given XML element.
Definition: snapshot_metadata.cpp:76
foedus::storage::StorageControlBlock::meta_
Metadata meta_
common part of the metadata.
Definition: storage.hpp:84
aligned_memory.hpp
storage_id.hpp
Definitions of IDs in this package and a few related constant values.
foedus::externalize::Externalizable
Represents an object that can be written to and read from files/bytes in XML format.
Definition: externalizable.hpp:53
snapshot_id.hpp
Typedefs of ID types used in snapshot package.
foedus::snapshot::SnapshotMetadata::valid_until_epoch_
Epoch::EpochInteger valid_until_epoch_
Equivalent to Snapshot::valid_until_epoch_.
Definition: snapshot_metadata.hpp:62
foedus::storage::StorageId
uint32_t StorageId
Unique ID for storage.
Definition: storage_id.hpp:55
foedus
Root package of FOEDUS (Fast Optimistic Engine for Data Unification Services).
Definition: assert_nd.hpp:44
foedus::Epoch::EpochInteger
uint32_t EpochInteger
Unsigned integer representation of epoch.
Definition: epoch.hpp:64
foedus::ErrorStack
Brings error stacktrace information as return value of functions.
Definition: error_stack.hpp:81
foedus::snapshot::SnapshotMetadata::load
ErrorStack load(tinyxml2::XMLElement *element) override
Reads the content of this object from the given XML element.
Definition: snapshot_metadata.cpp:42
foedus::storage::Metadata
Metadata of one storage.
Definition: metadata.hpp:58
fwd.hpp
Forward declarations of classes in storage package.
CXX11_FINAL
#define CXX11_FINAL
Used in public headers in place of "final" of C++11.
Definition: cxx11.hpp:131
foedus::snapshot::SnapshotMetadata::storage_control_blocks_memory_
memory::AlignedMemory storage_control_blocks_memory_
Memory backing storage_control_blocks_.
Definition: snapshot_metadata.hpp:75
foedus::snapshot::SnapshotMetadata::id_
SnapshotId id_
Equivalent to Snapshot::id_.
Definition: snapshot_metadata.hpp:56
foedus::snapshot::SnapshotId
uint16_t SnapshotId
Unique ID of Snapshot.
Definition: snapshot_id.hpp:43
CXX11_OVERRIDE
#define CXX11_OVERRIDE
Used in public headers in place of "override" of C++11.
Definition: cxx11.hpp:134
foedus::memory::AlignedMemory
Represents one memory block aligned to actual OS/hardware pages.
Definition: aligned_memory.hpp:67
foedus::snapshot::SnapshotMetadata::get_metadata
storage::Metadata * get_metadata(storage::StorageId id)
Definition: snapshot_metadata.hpp:46
foedus::snapshot::SnapshotMetadata::base_epoch_
Epoch::EpochInteger base_epoch_
Equivalent to Snapshot::base_epoch_.
Definition: snapshot_metadata.hpp:59
foedus::snapshot::SnapshotMetadata::assign
void assign(const foedus::externalize::Externalizable *other) override
Polymorphic assign operator.
Definition: snapshot_metadata.cpp:100
foedus::storage::StorageControlBlock
A base layout of shared data for all storage types.
Definition: storage.hpp:53
foedus::snapshot::SnapshotMetadata::largest_storage_id_
storage::StorageId largest_storage_id_
The largest StorageId we so far observed.
Definition: snapshot_metadata.hpp:65