The compute service base class. More...

#include <ComputeService.h>

Inheritance diagram for wrench::ComputeService:
wrench::Service wrench::S4U_Daemon wrench::BatchService wrench::CloudService wrench::HTCondorCentralManagerService wrench::HTCondorService wrench::MultihostMulticoreComputeService wrench::VirtualizedClusterService

Public Member Functions

 ComputeService (const std::string &hostname, std::string service_name, std::string mailbox_name_prefix, double scratch_space_size)
 Constructor. More...
 
std::vector< double > getCoreFlopRate ()
 Get the per-core flop rate of the compute service's hosts. More...
 
double getFreeScratchSpaceSize ()
 Get the free space on the compute service's scratch storage space. More...
 
std::vector< double > getMemoryCapacity ()
 Get the RAM capacities for each of the compute service's hosts. More...
 
std::vector< unsigned long > getNumCores ()
 Get core counts for each of the compute service's host. More...
 
unsigned long getNumHosts ()
 Get the number of hosts that the compute service manages. More...
 
std::vector< unsigned long > getNumIdleCores ()
 Get idle core counts for each of the compute service's host. More...
 
double getTotalScratchSpaceSize ()
 Get the total capacity of the compute service's scratch storage space. More...
 
double getTTL ()
 Get the time-to-live of the compute service. More...
 
bool hasScratch ()
 Checks if the compute service has a scratch space. More...
 
void stop () override
 Stop the compute service - must be called by the stop() method of derived classes.
 
void submitJob (WorkflowJob *job, std::map< std::string, std::string >={})
 Submit a job to the compute service. More...
 
virtual void submitPilotJob (PilotJob *job, std::map< std::string, std::string > &service_specific_arguments)=0
 
virtual void submitStandardJob (StandardJob *job, std::map< std::string, std::string > &service_specific_arguments)=0
 
bool supportsPilotJobs ()
 Get whether the compute service supports pilot jobs or not. More...
 
bool supportsStandardJobs ()
 Get whether the compute service supports standard jobs or not. More...
 
void terminateJob (WorkflowJob *job)
 Terminate a previously-submitted job (which may or may not be running yet) More...
 
virtual void terminatePilotJob (PilotJob *job)=0
 
virtual void terminateStandardJob (StandardJob *job)=0
 
- Public Member Functions inherited from wrench::Service
std::string getHostname ()
 Get the name of the host on which the service is / will be running. More...
 
double getMessagePayloadValueAsDouble (std::string)
 Get a message payload of the Service as a double. More...
 
std::string getMessagePayloadValueAsString (std::string)
 Get a message payload of the Service as a string. 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...
 
bool isUp ()
 Returns true if the service is UP, false otherwise. 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=false)
 Start the service. More...
 
- 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 ()
 Constructor (daemon without a mailbox) More...
 
virtual void cleanup ()
 Cleanup function called when the daemon terminates (for whatever reason)
 
void createLifeSaver (std::shared_ptr< S4U_Daemon > reference)
 Create a life saver for the daemon. More...
 
std::string getName ()
 Retrieve the process name. More...
 
void join ()
 Join (i.e., wait for) the daemon.
 
virtual int main ()=0
 The daemon's main method, to be overridden. More...
 
void resume ()
 Resume the daemon/actor.
 
void setTerminated ()
 Set the terminated status of the daemon/actor.
 
void startDaemon (bool daemonized)
 Start the daemon. More...
 
void suspend ()
 Suspend the daemon/actor.
 

Static Public Attributes

static constexpr unsigned long ALL_CORES = ULONG_MAX
 A convenient constant to mean "use all cores of a physical host" whenever a number of cores is needed when instantiating compute services.
 
static constexpr double ALL_RAM = DBL_MAX
 A convenient constant to mean "use all ram of a physical host" whenever a ram capacity is needed when instantiating compute services.
 
static StorageServiceSCRATCH = (StorageService *)ULONG_MAX
 A convenient constant to mean "the scratch storage space" of a ComputeService. This is used to move data to a ComputeService's scratch storage space.
 

Protected Member Functions

 ComputeService (const std::string &hostname, std::string service_name, std::string mailbox_name_prefix, StorageService *scratch_space)
 Constructor. More...
 
StorageServicegetScratch ()
 Get the compute service's scratch storage space. More...
 
std::shared_ptr< StorageServicegetScratchSharedPtr ()
 Get a shared pointer to the compute service's scratch storage space. More...
 
- Protected Member Functions inherited from wrench::Service
 Service (std::string hostname, std::string process_name_prefix, std::string mailbox_name_prefix)
 Constructor. More...
 
void serviceSanityCheck ()
 Check whether the service is properly configured and running. More...
 
void setMessagePayload (std::string, std::string)
 Set a message payload of the Service. More...
 
void setMessagePayloads (std::map< std::string, std::string > default_messagepayload_values, std::map< std::string, std::string > 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.
 
void releaseDaemonLock ()
 Unlock the daemon's lock.
 

Protected Attributes

StorageServicescratch_space_storage_service
 A scratch storage service associated to the compute service.
 
std::shared_ptr< StorageServicescratch_space_storage_service_shared_ptr
 
- Protected Attributes inherited from wrench::Service
std::map< std::string,
std::string > 
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.
 
State state
 The service's state.
 

Additional Inherited Members

- Public Types inherited from wrench::Service
enum  State { UP, DOWN }
 Service 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.
 
std::string mailbox_name
 The name of the daemon's mailbox.
 
std::string process_name
 The name of the daemon.
 
Simulationsimulation
 a pointer to the simulation object
 

Detailed Description

The compute service base class.

Constructor & Destructor Documentation

wrench::ComputeService::ComputeService ( const std::string &  hostname,
std::string  service_name,
std::string  mailbox_name_prefix,
double  scratch_space_size 
)

Constructor.

Parameters
hostnamethe name of the host on which the compute service runs
service_namethe name of the compute service
mailbox_name_prefixthe mailbox name prefix
scratch_space_sizethe size for the scratch storage space of the compute service (0 if none)
wrench::ComputeService::ComputeService ( const std::string &  hostname,
std::string  service_name,
std::string  mailbox_name_prefix,
StorageService scratch_space 
)
protected

Constructor.

Parameters
hostnamethe name of the host on which the compute service runs
service_namethe name of the compute service
mailbox_name_prefixthe mailbox name prefix
scratch_spacescratch storage space of the compute service (nullptr if none)

Member Function Documentation

std::vector< double > wrench::ComputeService::getCoreFlopRate ( )

Get the per-core flop rate of the compute service's hosts.

Returns
a list of flop rates in flop/sec
Exceptions
std::runtime_error
double wrench::ComputeService::getFreeScratchSpaceSize ( )

Get the free space on the compute service's scratch storage space.

Returns
a size (in bytes)
std::vector< double > wrench::ComputeService::getMemoryCapacity ( )

Get the RAM capacities for each of the compute service's hosts.

Returns
a vector of RAM capacities
Exceptions
std::runtime_error
std::vector< unsigned long > wrench::ComputeService::getNumCores ( )

Get core counts for each of the compute service's host.

Returns
the core counts
Exceptions
WorkflowExecutionException
std::runtime_error
unsigned long wrench::ComputeService::getNumHosts ( )

Get the number of hosts that the compute service manages.

Returns
the host count
Exceptions
WorkflowExecutionException
std::runtime_error
std::vector< unsigned long > wrench::ComputeService::getNumIdleCores ( )

Get idle core counts for each of the compute service's host.

Returns
the idle core counts (could be empty)
Exceptions
WorkflowExecutionException
std::runtime_error
StorageService * wrench::ComputeService::getScratch ( )
protected

Get the compute service's scratch storage space.

Returns
a pointer to the shared scratch space
std::shared_ptr< StorageService > wrench::ComputeService::getScratchSharedPtr ( )
protected

Get a shared pointer to the compute service's scratch storage space.

Returns
a shared pointer to the shared scratch space
double wrench::ComputeService::getTotalScratchSpaceSize ( )

Get the total capacity of the compute service's scratch storage space.

Returns
a size (in bytes)
double wrench::ComputeService::getTTL ( )

Get the time-to-live of the compute service.

Returns
the ttl in seconds
Exceptions
std::runtime_error
bool wrench::ComputeService::hasScratch ( )

Checks if the compute service has a scratch space.

Returns
true if the compute service has some scratch storage space, false otherwise
void wrench::ComputeService::submitJob ( WorkflowJob job,
std::map< std::string, std::string >  service_specific_args = {} 
)

Submit a job to the compute service.

Parameters
jobthe job
service_specific_argsarguments specific to compute services when needed:
Exceptions
WorkflowExecutionException
std::invalid_argument
std::runtime_error
bool wrench::ComputeService::supportsPilotJobs ( )

Get whether the compute service supports pilot jobs or not.

Returns
true or false
bool wrench::ComputeService::supportsStandardJobs ( )

Get whether the compute service supports standard jobs or not.

Returns
true or false
void wrench::ComputeService::terminateJob ( WorkflowJob job)

Terminate a previously-submitted job (which may or may not be running yet)

Parameters
jobthe job to terminate
Exceptions
std::invalid_argument
WorkflowExecutionException
std::runtime_error

The documentation for this class was generated from the following files:
  • /home/wrench/wrench/include/wrench/services/compute/ComputeService.h
  • /home/wrench/wrench/src/wrench/services/compute/ComputeService.cpp