wrench::StorageService Class Reference

The storage service base class. More...

#include <StorageService.h>

Inheritance diagram for wrench::StorageService:

Public Member Functions
	StorageService (const std::string &hostname, const std::set< std::string > mount_points, const std::string &service_name)
	Constructor. More...
virtual std::map< std::string, double >	getFreeSpace ()
	Synchronously asks the storage service for its capacity at all its mount points. More...
std::string	getMountPoint ()
	Get the mount point (will throw is more than one) More...
std::set< std::string >	getMountPoints ()
	Get the set of mount points. More...
virtual std::map< std::string, double >	getTotalSpace ()
	Get the total static capacity of the storage service (in zero simulation time) More...
bool	hasMountPoint (std::string mp)
	Checked whether the storage service has a particular mount point. More...
bool	hasMultipleMountPoints ()
	Checked whether the storage service has multiple mount points. More...
bool	isScratch ()
	Determines whether the storage service is a scratch service of a ComputeService. More...
void	setScratch ()
	Indicate that this storace service is a scratch service of a ComputeService.
void	stop () override
	Stop the service.
Public Member Functions inherited from wrench::Service
void	assertServiceIsUp ()
	Throws an exception if the service is not up. More...
std::string	getHostname ()
	Get the name of the host on which the service is / will be running. More...
const WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE &	getMessagePayloadList () const
	Get all message payloads and their values of the Service. More...
double	getMessagePayloadValue (WRENCH_MESSAGEPAYLOAD_TYPE)
	Get a message payload of the Service as a double. More...
double	getNetworkTimeoutValue ()
	Returns the service's network timeout value. More...
std::string	getPhysicalHostname ()
	Get the physical name of the host on which the service is / will be running. More...
bool	getPropertyValueAsBoolean (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a boolean. More...
double	getPropertyValueAsDouble (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a double. More...
std::string	getPropertyValueAsString (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a string. More...
unsigned long	getPropertyValueAsUnsignedLong (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as an unsigned long. More...
bool	isUp ()
	Returns true if the service is UP, false otherwise. More...
void	resume ()
	Resume the service. More...
void	setNetworkTimeoutValue (double value)
	Sets the service's network timeout value. More...
void	setStateToDown ()
	Set the state of the service to DOWN.
void	start (std::shared_ptr< Service > this_service, bool daemonize, bool auto_restart)
	Start the service. More...
void	suspend ()
	Suspend the service.
Public Member Functions inherited from wrench::S4U_Daemon
	S4U_Daemon (std::string hostname, std::string process_name_prefix)
	Constructor (daemon with a mailbox) More...
void	acquireDaemonLock ()
	Method to acquire the daemon's lock. More...
virtual void	cleanup (bool has_returned_from_main, int return_value)
	Cleanup function called when the daemon terminates (for whatever reason). The default behavior is to throw an exception if the host is off. This method should be overriden in a daemons implements some fault-tolerant behavior, or is naturally tolerant. More...
void	createLifeSaver (std::shared_ptr< S4U_Daemon > reference)
	Create a life saver for the daemon. More...
std::string	getName ()
	Retrieve the process name. More...
int	getReturnValue ()
	Returns the value returned by main() (if the daemon has returned from main) More...
Simulation *	getSimulation ()
	Get the service's simulation. More...
S4U_Daemon::State	getState ()
	Get the daemon's state. More...
bool	hasReturnedFromMain ()
	Returns true if the daemon has returned from main() (i.e., not brutally killed) More...
bool	isDaemonized ()
	Return the daemonized status of the daemon. More...
bool	isSetToAutoRestart ()
	Return the auto-restart status of the daemon. More...
std::pair< bool, int >	join ()
	Join (i.e., wait for) the daemon. More...
virtual int	main ()=0
	The daemon's main method, to be overridden. More...
void	releaseDaemonLock ()
	Method to release the daemon's lock. More...
void	resumeActor ()
	Resume the daemon/actor.
void	setSimulation (Simulation *simulation)
	Set the service's simulation. More...
void	setupOnExitFunction ()
	Sets up the on_exit function for the actor.
void	startDaemon (bool _daemonized, bool _auto_restart)
	Start the daemon. More...
void	suspendActor ()
	Suspend the daemon/actor.

Static Public Member Functions
static void	copyFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > src_location, std::shared_ptr< FileLocation > dst_location)
	Synchronously ask the storage service to read a file from another storage service. More...
static void	createFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > location)
	Store a file at a particular mount point ex nihilo (this instantly creates the file at the storage service - zero simulation time). Will do nothing (and won't complain) if the file already exists at that location. More...
static void	deleteFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > location, std::shared_ptr< FileRegistryService > file_registry_service=nullptr)
	Synchronously delete a file at a location. More...
static void	initiateFileCopy (simgrid::s4u::Mailbox *answer_mailbox, std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > src_location, std::shared_ptr< FileLocation > dst_location)
	Asynchronously ask for a file copy between two storage services. More...
static bool	lookupFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > location)
	Synchronously asks the storage service whether it holds a file. More...
static void	readFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > location)
	Synchronously read a file from the storage service. More...
static void	readFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > location, double num_bytes)
	Synchronously read a file from the storage service. More...
static void	readFiles (std::map< std::shared_ptr< DataFile >, std::shared_ptr< FileLocation >> locations)
	Synchronously and sequentially read a set of files from storage services. More...
static void	writeFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > location)
	Synchronously write a file to the storage service. More...
static void	writeFiles (std::map< std::shared_ptr< DataFile >, std::shared_ptr< FileLocation >> locations)
	Synchronously and sequentially upload a set of files from storage services. More...
Static Public Member Functions inherited from wrench::S4U_Daemon
static simgrid::s4u::Mailbox *	getRunningActorRecvMailbox ()
	Return the running actor's recv mailbox. More...

Static Protected Member Functions
static void	stageFile (std::shared_ptr< DataFile >file, std::shared_ptr< FileLocation > location)
	Store a file at a particular mount point BEFORE the simulation is launched. More...
Static Protected Member Functions inherited from wrench::Service
static void	assertServiceIsUp (std::shared_ptr< Service > s)
	Assert for the service being up. More...

Protected Attributes
unsigned long	buffer_size
	The service's buffer size.
std::map< std::string, std::unique_ptr< LogicalFileSystem > >	file_systems
	File systems.
Protected Attributes inherited from wrench::Service
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE	messagepayload_list
	The service's messagepayload list.
std::string	name
	The service's name.
double	network_timeout = 30.0
	The time (in seconds) after which a service that doesn't send back a reply (control) message causes a NetworkTimeOut exception. (default: 30 second; if <0 never timeout)
WRENCH_PROPERTY_COLLECTION_TYPE	property_list
	The service's property list.
bool	shutting_down = false
	A boolean that indicates if the service is in the middle of shutting down.
Protected Attributes inherited from wrench::S4U_Daemon
unsigned int	num_starts = 0
	The number of time that this daemon has started (i.e., 1 + number of restarts)
Simulation *	simulation
	a pointer to the simulation object
State	state
	The service's state.

Additional Inherited Members
Public Types inherited from wrench::S4U_Daemon
enum	State { UP, DOWN, SUSPENDED }
	Daemon states. More...
Public Attributes inherited from wrench::S4U_Daemon
std::string	hostname
	The name of the host on which the daemon is running.
LifeSaver *	life_saver = nullptr
	The daemon's life saver.
simgrid::s4u::Mailbox *	mailbox
	The daemon's mailbox.
std::string	process_name
	The name of the daemon.
simgrid::s4u::Mailbox *	recv_mailbox
	The daemon's receive mailbox (to send to another daemon so that that daemon can reply)
Static Public Attributes inherited from wrench::S4U_Daemon
static std::unordered_map< aid_t, simgrid::s4u::Mailbox * >	map_actor_to_recv_mailbox
Protected Member Functions inherited from wrench::Service
	Service (std::string hostname, std::string process_name_prefix)
	Constructor. More...
	~Service () override
	Destructor.
template<class T >
std::shared_ptr< T >	getSharedPtr ()
	Method to retrieve the shared_ptr to a service. More...
void	serviceSanityCheck ()
	Check whether the service is properly configured and running. More...
void	setMessagePayload (WRENCH_MESSAGEPAYLOAD_TYPE, double)
	Set a message payload of the Service. More...
void	setMessagePayloads (WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE default_messagepayload_values, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE overriden_messagepayload_values)
	Set default and user-defined message payloads. More...
void	setProperties (WRENCH_PROPERTY_COLLECTION_TYPE default_property_values, WRENCH_PROPERTY_COLLECTION_TYPE overriden_property_values)
	Set default and user-defined properties. More...
void	setProperty (WRENCH_PROPERTY_TYPE, const std::string &)
	Set a property of the Service. More...
Protected Member Functions inherited from wrench::S4U_Daemon
bool	killActor ()
	Kill the daemon/actor (does nothing if already dead) More...
void	runMainMethod ()
	Method that run's the user-defined main method (that's called by the S4U actor class)

Detailed Description

The storage service base class.

Constructor & Destructor Documentation

StorageService()

wrench::StorageService::StorageService	(	const std::string &	hostname,
		const std::set< std::string >	mount_points,
		const std::string &	service_name
	)

Constructor.

Parameters

hostname	the name of the host on which the service should run
mount_points	the mount points of each disk usable by the service
service_name	the name of the storage service
mailbox_name_prefix	the mailbox name prefix

Exceptions

std::invalid_argument

Member Function Documentation

copyFile()

void wrench::StorageService::copyFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  src_location, std::shared_ptr< FileLocation >  dst_location  )

static

Synchronously ask the storage service to read a file from another storage service.

Parameters

file	the file to copy
src_location	the location where to read the file
dst_location	the location where to write the file

Exceptions

ExecutionException
std::invalid_argument

createFile()

void wrench::StorageService::createFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  location  )

static

Store a file at a particular mount point ex nihilo (this instantly creates the file at the storage service - zero simulation time). Will do nothing (and won't complain) if the file already exists at that location.

Parameters

file	a file
location	a file location

Exceptions

std::invalid_argument

deleteFile()

void wrench::StorageService::deleteFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  location, std::shared_ptr< FileRegistryService >  file_registry_service = nullptr  )

static

Synchronously delete a file at a location.

Parameters

file	the file
location	the file's location
file_registry_service	a file registry service that should be updated once the file deletion has (successfully) completed (none if nullptr)

Exceptions

ExecutionException
std::runtime_error
std::invalid_argument

getFreeSpace()

std::map< std::string, double > wrench::StorageService::getFreeSpace ( )

virtual

Synchronously asks the storage service for its capacity at all its mount points.

Returns

The free space in bytes of each mount point, as a map

Exceptions

ExecutionException
std::runtime_error

getMountPoint()

std::string wrench::StorageService::getMountPoint

(

)

Get the mount point (will throw is more than one)

Returns

the (sole) mount point of the service

getMountPoints()

std::set< std::string > wrench::StorageService::getMountPoints

(

)

Get the set of mount points.

Returns

the set of mount points

getTotalSpace()

std::map< std::string, double > wrench::StorageService::getTotalSpace ( )

virtual

Get the total static capacity of the storage service (in zero simulation time)

Returns

capacity of the storage service (double) for each mount point, in a map

hasMountPoint()

bool wrench::StorageService::hasMountPoint

(

std::string

mp

)

Checked whether the storage service has a particular mount point.

Parameters

mp	a mount point

Returns

true whether the service has that mount point

hasMultipleMountPoints()

bool wrench::StorageService::hasMultipleMountPoints

(

)

Checked whether the storage service has multiple mount points.

Returns

true whether the service has multiple mount points

initiateFileCopy()

void wrench::StorageService::initiateFileCopy ( simgrid::s4u::Mailbox *  answer_mailbox, std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  src_location, std::shared_ptr< FileLocation >  dst_location  )

static

Asynchronously ask for a file copy between two storage services.

Parameters

answer_mailbox	the mailbox to which a notification message will be sent
file	the file
src_location	the source location
dst_location	the destination location

Exceptions

ExecutionException
std::invalid_argument

isScratch()

bool wrench::StorageService::isScratch

(

)

Determines whether the storage service is a scratch service of a ComputeService.

Returns

true if it is, false otherwise

lookupFile()

bool wrench::StorageService::lookupFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  location  )

static

Synchronously asks the storage service whether it holds a file.

Parameters

file	the file
location	the file location

Returns

true or false

Exceptions

ExecutionException
std::invalid_arguments

readFile() [1/2]

void wrench::StorageService::readFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  location  )

static

Synchronously read a file from the storage service.

Parameters

file	the file
location	the location to read the file from

Exceptions

ExecutionException
std::invalid_arguments

readFile() [2/2]

void wrench::StorageService::readFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  location, double  num_bytes_to_read  )

static

Synchronously read a file from the storage service.

Parameters

file	the file
location	the location to read the file from
num_bytes_to_read	number of bytes to read from the file

Exceptions

ExecutionException
std::invalid_arguments

readFiles()

void wrench::StorageService::readFiles ( std::map< std::shared_ptr< DataFile >, std::shared_ptr< FileLocation >>  locations )

static

Synchronously and sequentially read a set of files from storage services.

Parameters

locations

a map of files to locations

Exceptions

std::runtime_error
ExecutionException

stageFile()

void wrench::StorageService::stageFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  location  )

staticprotected

Store a file at a particular mount point BEFORE the simulation is launched.

Parameters

file	a file
location	a file location

Exceptions

std::invalid_argument

writeFile()

void wrench::StorageService::writeFile ( std::shared_ptr< DataFile >  file, std::shared_ptr< FileLocation >  location  )

static

Synchronously write a file to the storage service.

Parameters

file	the file
location	the location to write it to

Exceptions

ExecutionException

writeFiles()

void wrench::StorageService::writeFiles ( std::map< std::shared_ptr< DataFile >, std::shared_ptr< FileLocation >>  locations )

static

Synchronously and sequentially upload a set of files from storage services.

Parameters

locations

a map of files to locations

Exceptions

std::runtime_error
ExecutionException

---

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

• StorageService.h
• StorageService.cpp