TierEngineBase Class Reference

Base class of TierEngine. Deals with calling config_ constructor and holds onto some members used in multiple other components. More...

#include <base.hpp>

Inheritance diagram for TierEngineBase:

Collaboration diagram for TierEngineBase:

Public Member Functions
	TierEngineBase (const fs::path &config_path, const ConfigOverrides &config_overrides)
	Construct a new Tier Engine Base object. More...
virtual	~TierEngineBase (void)
	Destroy the Tier Engine Base object. More...
int	create_run_path (void) const
	Creates path for FIFOs and database, chowning to root:autotier. More...
std::list< Tier > &	get_tiers (void)
	Get reference to the list of tiers.Used in fusePassthrough.cpp to get references to each tier for finding full backend paths. More...
Tier *	tier_lookup (fs::path p)
	Find Tier from path. More...
Tier *	tier_lookup (std::string id)
	Find tier from ID. More...
void	mount_point (const fs::path &mount_point)
	Set the mount_point_ variable. More...
virtual bool	tier (void)
	Virtual tier function to allow other components to call TierEngineTiering::tier(). More...
virtual bool	currently_tiering (void) const

Protected Member Functions
virtual void	exit (int status) const
	Virtual exit function that can be overridden by other components for cleanup. More...

Protected Attributes
bool	stop_flag_
	Set to false to make thread exit. Used to continue or cancel sleeping after being woken to do ad hoc command work. More...
std::list< Tier >	tiers_
	List of tiers built from configuration file.
Config	config_
	Configuration read from config_file path.
fs::path	run_path_
	Path to mutex lock file, ad hoc FIFO, and database. Defaults to /var/lib/autotier/<hash of config path>, can be overridden in config.
fs::path	mount_point_
	Where autotier filesystem is mounted, set by mount_point().
ConcurrentQueue< AdHoc >	adhoc_work_
std::condition_variable	sleep_cv_
	Condition variable to use wait_until to sleep between tiering, used for the ad hoc server thread or the main thread to wake the tiering thread from sleep. More...
std::shared_ptr< rocksdb::DB >	db_
	Nosql database holding file metadata.

Detailed Description

Base class of TierEngine. Deals with calling config_ constructor and holds onto some members used in multiple other components.

Constructor & Destructor Documentation

TierEngineBase()

TierEngineBase::TierEngineBase	(	const fs::path &	config_path,
		const ConfigOverrides &	config_overrides
	)

Construct a new Tier Engine Base object.

Parameters

config_path
config_overrides

~TierEngineBase()

TierEngineBase::~TierEngineBase ( void  )

virtual

Destroy the Tier Engine Base object.

Member Function Documentation

create_run_path()

int TierEngineBase::create_run_path

(

void

)

const

Creates path for FIFOs and database, chowning to root:autotier.

Returns

int 0 if okay, -1 if error.

exit()

void TierEngineBase::exit ( int  status ) const

protectedvirtual

Virtual exit function that can be overridden by other components for cleanup.

Parameters

status

Exit code of process

get_tiers()

std::list< Tier > & TierEngineBase::get_tiers

(

void

)

Get reference to the list of tiers.Used in fusePassthrough.cpp to get references to each tier for finding full backend paths.

Returns

std::list<Tier>& Reference to list of tiers.

mount_point()

void TierEngineBase::mount_point

(

const fs::path &

mount_point

)

Set the mount_point_ variable.

Parameters

mount_point

Path to filesystem mount point

tier()

bool TierEngineBase::tier ( void  )

virtual

Virtual tier function to allow other components to call TierEngineTiering::tier().

Returns

true Tiering finished successfully

false Tiering failed

Reimplemented in TierEngineTiering.

tier_lookup() [1/2]

Tier * TierEngineBase::tier_lookup

(

fs::path

p

)

Find Tier from path.

Parameters

p	Backend path to tier

Returns

Tier* Tier matching path if found, else nullptr

tier_lookup() [2/2]

Tier * TierEngineBase::tier_lookup

(

std::string

id

)

Find tier from ID.

Parameters

id	ID of tier from config

Returns

Tier* Tier matching ID if found, else nullptr

Member Data Documentation

adhoc_work_

ConcurrentQueue<AdHoc> TierEngineBase::adhoc_work_

protected

Single-consumer concurrentQueue for the ad hoc command server to queue work.

sleep_cv_

std::condition_variable TierEngineBase::sleep_cv_

protected

Condition variable to use wait_until to sleep between tiering, used for the ad hoc server thread or the main thread to wake the tiering thread from sleep.

stop_flag_

bool TierEngineBase::stop_flag_

protected

Set to false to make thread exit. Used to continue or cancel sleeping after being woken to do ad hoc command work.

---

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

• src/incl/TierEngine/components/base.hpp
• src/impl/autotierfs/TierEngine/components/base.cpp