Shared data in SnapshotManagerPimpl. More...

Detailed Description

Definition at line 120 of file snapshot_manager_pimpl.hpp.

#include <snapshot_manager_pimpl.hpp>

Collaboration diagram for foedus::snapshot::SnapshotManagerControlBlock:

[legend]

Public Member Functions
	SnapshotManagerControlBlock ()=delete

	~SnapshotManagerControlBlock ()=delete

void	initialize ()

void	uninitialize ()

Epoch	get_snapshot_epoch () const

Epoch	get_snapshot_epoch_weak () const

SnapshotId	get_previous_snapshot_id () const

SnapshotId	get_previous_snapshot_id_weak () const

Epoch	get_requested_snapshot_epoch () const

void	wakeup_snapshot_children ()
	Fires snapshot_children_wakeup_. More...

Public Attributes
std::atomic< Epoch::EpochInteger >	snapshot_epoch_
	The most recently snapshot-ed epoch, all logs upto this epoch is safe to delete. More...

std::atomic< Epoch::EpochInteger >	requested_snapshot_epoch_
	When a caller wants to immediately invoke snapshot, it calls trigger_snapshot_immediate(), which sets this value and then wakes up snapshot_thread_. More...

std::atomic< SnapshotId >	previous_snapshot_id_
	ID of previously completed snapshot. More...

soc::SharedPolling	snapshot_taken_
	Fired (notify_all) whenever snapshotting is completed. More...

soc::SharedPolling	snapshot_wakeup_
	Snapshot thread sleeps on this condition variable. More...

soc::SharedPolling	snapshot_children_wakeup_
	Child snapshot managers (the ones in SOC engines) sleep on this condition until the master snapshot manager requests them to launch mappers/reducers for snapshot. More...

LogGleanerControlBlock	gleaner_
	Gleaner-related variables. More...

Constructor & Destructor Documentation

foedus::snapshot::SnapshotManagerControlBlock::SnapshotManagerControlBlock ( )

delete

foedus::snapshot::SnapshotManagerControlBlock::~SnapshotManagerControlBlock ( )

delete

Member Function Documentation

SnapshotId foedus::snapshot::SnapshotManagerControlBlock::get_previous_snapshot_id ( ) const

inline

Definition at line 140 of file snapshot_manager_pimpl.hpp.

References previous_snapshot_id_.

Referenced by foedus::snapshot::SnapshotManagerPimpl::get_previous_snapshot_id().

140 { return previous_snapshot_id_.load(); }

foedus::snapshot::SnapshotManagerControlBlock::previous_snapshot_id_

std::atomic< SnapshotId > previous_snapshot_id_

ID of previously completed snapshot.

Definition: snapshot_manager_pimpl.hpp:175

Here is the caller graph for this function:

SnapshotId foedus::snapshot::SnapshotManagerControlBlock::get_previous_snapshot_id_weak ( ) const

inline

Definition at line 141 of file snapshot_manager_pimpl.hpp.

References previous_snapshot_id_.

Referenced by foedus::snapshot::SnapshotManagerPimpl::get_previous_snapshot_id_weak().

                                                    {
     return previous_snapshot_id_.load(std::memory_order_relaxed);
   }

Here is the caller graph for this function:

Epoch foedus::snapshot::SnapshotManagerControlBlock::get_requested_snapshot_epoch ( ) const

inline

Definition at line 144 of file snapshot_manager_pimpl.hpp.

References requested_snapshot_epoch_.

Referenced by foedus::snapshot::SnapshotManagerPimpl::handle_snapshot(), and foedus::snapshot::SnapshotManagerPimpl::handle_snapshot_triggered().

144 { return Epoch(requested_snapshot_epoch_.load()); }

foedus::snapshot::SnapshotManagerControlBlock::requested_snapshot_epoch_

std::atomic< Epoch::EpochInteger > requested_snapshot_epoch_

When a caller wants to immediately invoke snapshot, it calls trigger_snapshot_immediate(), which sets this value and then wakes up snapshot_thread_.

Definition: snapshot_manager_pimpl.hpp:168

Here is the caller graph for this function:

Epoch foedus::snapshot::SnapshotManagerControlBlock::get_snapshot_epoch ( ) const

inline

Definition at line 136 of file snapshot_manager_pimpl.hpp.

References snapshot_epoch_.

Referenced by foedus::snapshot::SnapshotManagerPimpl::get_snapshot_epoch().

136 { return Epoch(snapshot_epoch_.load()); }

foedus::snapshot::SnapshotManagerControlBlock::snapshot_epoch_

std::atomic< Epoch::EpochInteger > snapshot_epoch_

The most recently snapshot-ed epoch, all logs upto this epoch is safe to delete.

Definition: snapshot_manager_pimpl.hpp:160

Here is the caller graph for this function:

Epoch foedus::snapshot::SnapshotManagerControlBlock::get_snapshot_epoch_weak ( ) const

inline

Definition at line 137 of file snapshot_manager_pimpl.hpp.

References snapshot_epoch_.

Referenced by foedus::snapshot::SnapshotManagerPimpl::get_snapshot_epoch_weak().

                                         {
     return Epoch(snapshot_epoch_.load(std::memory_order_relaxed));
   }

Here is the caller graph for this function:

void foedus::snapshot::SnapshotManagerControlBlock::initialize ( )

inline

Definition at line 125 of file snapshot_manager_pimpl.hpp.

References gleaner_, foedus::snapshot::LogGleanerControlBlock::initialize(), foedus::soc::SharedPolling::initialize(), foedus::Epoch::kEpochInvalid, requested_snapshot_epoch_, snapshot_children_wakeup_, snapshot_taken_, and snapshot_wakeup_.

Referenced by foedus::snapshot::SnapshotManagerPimpl::initialize_once().

                     {
     snapshot_taken_.initialize();
     snapshot_wakeup_.initialize();
     snapshot_children_wakeup_.initialize();
     gleaner_.initialize();
     requested_snapshot_epoch_.store(Epoch::kEpochInvalid);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

void foedus::snapshot::SnapshotManagerControlBlock::uninitialize ( )

inline

Definition at line 132 of file snapshot_manager_pimpl.hpp.

References gleaner_, and foedus::snapshot::LogGleanerControlBlock::uninitialize().

Referenced by foedus::snapshot::SnapshotManagerPimpl::uninitialize_once().

                       {
     gleaner_.uninitialize();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

void foedus::snapshot::SnapshotManagerControlBlock::wakeup_snapshot_children ( )

inline

Fires snapshot_children_wakeup_.

This is n-to-n condition variable, so expect spurrious wakeups.

Definition at line 150 of file snapshot_manager_pimpl.hpp.

References foedus::assorted::memory_fence_release(), foedus::soc::SharedPolling::signal(), and snapshot_children_wakeup_.

Referenced by foedus::snapshot::SnapshotManagerPimpl::stop_snapshot_thread().

                                   {
     assorted::memory_fence_release();
     snapshot_children_wakeup_.signal();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

LogGleanerControlBlock foedus::snapshot::SnapshotManagerControlBlock::gleaner_

Gleaner-related variables.

Definition at line 194 of file snapshot_manager_pimpl.hpp.

Referenced by foedus::snapshot::SnapshotManagerPimpl::handle_snapshot_child(), foedus::snapshot::SnapshotManagerPimpl::handle_snapshot_triggered(), initialize(), foedus::snapshot::SnapshotManagerPimpl::initialize_once(), foedus::snapshot::SnapshotManagerPimpl::is_gleaning(), foedus::snapshot::LogGleanerRef::LogGleanerRef(), foedus::snapshot::SnapshotManagerPimpl::stop_snapshot_thread(), and uninitialize().

std::atomic<SnapshotId> foedus::snapshot::SnapshotManagerControlBlock::previous_snapshot_id_

ID of previously completed snapshot.

kNullSnapshotId if no snapshot has been taken. Used to issue a next snapshot ID.

Definition at line 175 of file snapshot_manager_pimpl.hpp.

Referenced by get_previous_snapshot_id(), get_previous_snapshot_id_weak(), foedus::snapshot::SnapshotManagerPimpl::handle_snapshot_triggered(), foedus::snapshot::SnapshotManagerPimpl::initialize_once(), and foedus::snapshot::SnapshotManagerPimpl::issue_next_snapshot_id().

std::atomic< Epoch::EpochInteger > foedus::snapshot::SnapshotManagerControlBlock::requested_snapshot_epoch_

When a caller wants to immediately invoke snapshot, it calls trigger_snapshot_immediate(), which sets this value and then wakes up snapshot_thread_.

snapshot_thread_ sees this value then immediately starts snapshotting if the value is larger than the current snapshot_epoch_.

Definition at line 168 of file snapshot_manager_pimpl.hpp.

Referenced by get_requested_snapshot_epoch(), initialize(), foedus::snapshot::SnapshotManagerPimpl::initialize_once(), and foedus::snapshot::SnapshotManagerPimpl::trigger_snapshot_immediate().

soc::SharedPolling foedus::snapshot::SnapshotManagerControlBlock::snapshot_children_wakeup_

Child snapshot managers (the ones in SOC engines) sleep on this condition until the master snapshot manager requests them to launch mappers/reducers for snapshot.

The real condition is the various status flag in gleaner_.

Definition at line 191 of file snapshot_manager_pimpl.hpp.

Referenced by foedus::snapshot::SnapshotManagerPimpl::handle_snapshot_child(), initialize(), and wakeup_snapshot_children().

std::atomic< Epoch::EpochInteger > foedus::snapshot::SnapshotManagerControlBlock::snapshot_epoch_

The most recently snapshot-ed epoch, all logs upto this epoch is safe to delete.

If not snapshot has been taken, invalid epoch. This is equivalent to snapshots_.back().valid_entil_epoch_ with empty check.

Definition at line 160 of file snapshot_manager_pimpl.hpp.

Referenced by get_snapshot_epoch(), get_snapshot_epoch_weak(), foedus::snapshot::SnapshotManagerPimpl::handle_snapshot_triggered(), and foedus::snapshot::SnapshotManagerPimpl::initialize_once().

soc::SharedPolling foedus::snapshot::SnapshotManagerControlBlock::snapshot_taken_

Fired (notify_all) whenever snapshotting is completed.

Definition at line 178 of file snapshot_manager_pimpl.hpp.

Referenced by foedus::snapshot::SnapshotManagerPimpl::handle_snapshot_triggered(), initialize(), and foedus::snapshot::SnapshotManagerPimpl::trigger_snapshot_immediate().

soc::SharedPolling foedus::snapshot::SnapshotManagerControlBlock::snapshot_wakeup_

Snapshot thread sleeps on this condition variable.

The real variable is requested_snapshot_epoch_.

Definition at line 184 of file snapshot_manager_pimpl.hpp.

Referenced by initialize(), foedus::snapshot::SnapshotManagerPimpl::sleep_a_while(), and foedus::snapshot::SnapshotManagerPimpl::wakeup().

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

/home/shino/foedus_code/foedus-core/include/foedus/snapshot/snapshot_manager_pimpl.hpp

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation