The storage service base class. More...

#include <StorageService.h>

Inheritance diagram for wrench::StorageService:
wrench::Service wrench::S4U_Daemon wrench::SimpleStorageService

Public Member Functions

 StorageService (const std::string &hostname, const std::set< std::string > mount_points, const std::string &service_name, const std::string &data_mailbox_name_prefix)
 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...
 
double getMessagePayloadValue (std::string)
 Get a message payload of the Service as a double. More...
 
double getNetworkTimeoutValue ()
 Returns the service's network timeout value. More...
 
bool getPropertyValueAsBoolean (std::string)
 Get a property of the Service as a boolean. More...
 
double getPropertyValueAsDouble (std::string)
 Get a property of the Service as a double. More...
 
std::string getPropertyValueAsString (std::string)
 Get a property of the Service as a string. More...
 
unsigned long getPropertyValueAsUnsignedLong (std::string)
 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, std::string mailbox_prefix)
 Constructor (daemon with a mailbox) More...
 
virtual ~S4U_Daemon ()
 
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...
 
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 resumeActor ()
 Resume the daemon/actor.
 
void setupOnExitFunction ()
 Sets up the on_exit functionf 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 (WorkflowFile *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 deleteFile (WorkflowFile *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 (std::string answer_mailbox, WorkflowFile *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 (WorkflowFile *file, std::shared_ptr< FileLocation > location)
 Synchronously asks the storage service whether it holds a file. More...
 
static void readFile (WorkflowFile *file, std::shared_ptr< FileLocation > location)
 Synchronously read a file from the storage service. More...
 
static void readFiles (std::map< WorkflowFile *, std::shared_ptr< FileLocation >> locations)
 Synchronously and sequentially read a set of files from storage services. More...
 
static void writeFile (WorkflowFile *file, std::shared_ptr< FileLocation > location)
 Synchronously write a file to the storage service. More...
 
static void writeFiles (std::map< WorkflowFile *, std::shared_ptr< FileLocation >> locations)
 Synchronously and sequentially upload a set of files from storage services. More...
 
- Static Public Member Functions inherited from wrench::Service
static void cleanupTrackedServices ()
 Go through the tracked services and remove all entries with a refcount of 1!
 
static void clearTrackedServices ()
 Forget all tracked services.
 
static void increaseNumCompletedServicesCount ()
 Increase the completed service count.
 

Static Protected Member Functions

static void stageFile (WorkflowFile *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...
 
template<class T >
static std::shared_ptr< T > getServiceByName (std::string name)
 Method to retrieve the shared_ptr to a service based on the service's name (not efficient) 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
std::map< std::string, double > 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)
 
std::map< std::string, std::string > property_list
 The service's property list.
 
- 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)
 
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.
 
std::string initial_mailbox_name
 The initial name of the daemon's mailbox.
 
LifeSaver * life_saver = nullptr
 The daemon's life saver.
 
std::string mailbox_name
 The current name of the daemon's mailbox.
 
std::string process_name
 The name of the daemon.
 
Simulationsimulation
 a pointer to the simulation object
 
- Protected Member Functions inherited from wrench::Service
 Service (std::string hostname, std::string process_name_prefix, std::string mailbox_name_prefix)
 Constructor. More...
 
 ~Service ()
 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 (std::string, double)
 Set a message payload of the Service. More...
 
void setMessagePayloads (std::map< std::string, double > default_messagepayload_values, std::map< std::string, double > overriden_messagepayload_values)
 Set default and user-defined message payloads. More...
 
void setProperties (std::map< std::string, std::string > default_property_values, std::map< std::string, std::string > overriden_property_values)
 Set default and user-defined properties. More...
 
void setProperty (std::string, std::string)
 Set a property of the Service. More...
 
- Protected Member Functions inherited from wrench::S4U_Daemon
void acquireDaemonLock ()
 Lock the daemon's lock.
 
void killActor ()
 Kill the daemon/actor (does nothing if already dead) More...
 
void releaseDaemonLock ()
 Unlock the daemon's lock.
 
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,
const std::string &  mailbox_name_prefix 
)

Constructor.

Parameters
hostnamethe name of the host on which the service should run
mount_pointsthe mount points of each disk usable by the service
service_namethe name of the storage service
mailbox_name_prefixthe mailbox name prefix
Exceptions
std::invalid_argument

Member Function Documentation

◆ copyFile()

void wrench::StorageService::copyFile ( WorkflowFile 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
filethe file to copy
src_locationthe location where to read the file
dst_locationthe location where to write the file
Exceptions
WorkflowExecutionException
std::invalid_argument

◆ deleteFile()

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

Synchronously delete a file at a location.

Parameters
filethe file
locationthe file's location
file_registry_servicea file registry service that should be updated once the file deletion has (successfully) completed (none if nullptr)
Exceptions
WorkflowExecutionException
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
WorkflowExecutionException
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
mpa 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 ( std::string  answer_mailbox,
WorkflowFile 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_mailboxthe mailbox to which a notification message will be sent
filethe file
src_locationthe source location
dst_locationthe destination location
Exceptions
WorkflowExecutionException
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 ( WorkflowFile file,
std::shared_ptr< FileLocation location 
)
static

Synchronously asks the storage service whether it holds a file.

Parameters
filethe file
locationthe file location
Returns
true or false
Exceptions
WorkflowExecutionException
std::invalid_arguments

◆ readFile()

void wrench::StorageService::readFile ( WorkflowFile file,
std::shared_ptr< FileLocation location 
)
static

Synchronously read a file from the storage service.

Parameters
filethe file
locationthe location to read the file from
Exceptions
WorkflowExecutionException
std::invalid_arguments

◆ readFiles()

void wrench::StorageService::readFiles ( std::map< WorkflowFile *, std::shared_ptr< FileLocation >>  locations)
static

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

Parameters
locationsa map of files to locations
Exceptions
std::runtime_error
WorkflowExecutionException

◆ stageFile()

void wrench::StorageService::stageFile ( WorkflowFile file,
std::shared_ptr< FileLocation location 
)
staticprotected

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

Parameters
filea file
locationa file location
Exceptions
std::invalid_argument

◆ writeFile()

void wrench::StorageService::writeFile ( WorkflowFile file,
std::shared_ptr< FileLocation location 
)
static

Synchronously write a file to the storage service.

Parameters
filethe file
locationthe location to write it to
Exceptions
WorkflowExecutionException

◆ writeFiles()

void wrench::StorageService::writeFiles ( std::map< WorkflowFile *, std::shared_ptr< FileLocation >>  locations)
static

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

Parameters
locationsa map of files to locations
Exceptions
std::runtime_error
WorkflowExecutionException

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