The compute service base class. More...

#include <ComputeService.h>

Inheritance diagram for wrench::ComputeService:
wrench::Service wrench::S4U_Daemon wrench::BareMetalComputeService wrench::BatchComputeService wrench::CloudComputeService wrench::HTCondorCentralManagerService wrench::HTCondorComputeService wrench::VirtualizedClusterComputeService

Public Member Functions

 ComputeService (const std::string &hostname, std::string service_name, std::string mailbox_name_prefix, std::string scratch_space_mount_point)
 Constructor. More...
 
std::map< std::string, 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::map< std::string, double > getMemoryCapacity ()
 Get the RAM capacities for each of the compute service's hosts. More...
 
unsigned long getNumHosts ()
 Get the number of hosts that the compute service manages. More...
 
std::map< std::string, double > getPerHostAvailableMemoryCapacity ()
 Get ram availability for each of the compute service's host. More...
 
std::map< std::string, unsigned long > getPerHostNumCores ()
 Get core counts for each of the compute service's host. More...
 
std::map< std::string, unsigned long > getPerHostNumIdleCores ()
 Get idle core counts for each of the compute service's host. More...
 
std::shared_ptr< StorageServicegetScratch ()
 Method that returns the computer service's scratch space's storage service. More...
 
unsigned long getTotalNumCores ()
 Get the total core counts for all hosts of the compute service. More...
 
virtual unsigned long getTotalNumIdleCores ()
 Get the total idle core count for all hosts of the compute service. 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
 Method to submit a pilot job to the service. More...
 
virtual void submitStandardJob (StandardJob *job, std::map< std::string, std::string > &service_specific_arguments)=0
 Method to submit a standard job to the service. More...
 
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
 Method to terminate a running pilot job. More...
 
virtual void terminateStandardJob (StandardJob *job)=0
 Method to terminate a running standard job. More...
 
- 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 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.
 

Protected Member Functions

 ComputeService (const std::string &hostname, std::string service_name, std::string mailbox_name_prefix, std::shared_ptr< StorageService > scratch_space)
 Constructor. 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...
 
 ~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)
 

Protected Attributes

std::shared_ptr< StorageServicescratch_space_storage_service
 A scratch storage service associated to the compute service.
 
- 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...
 
- 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.
 
- 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
 
- 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...
 

Detailed Description

The compute service base class.

Constructor & Destructor Documentation

◆ ComputeService() [1/2]

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

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_mount_pointthe service's scratch space's mount point ("" if none)

◆ ComputeService() [2/2]

wrench::ComputeService::ComputeService ( const std::string &  hostname,
std::string  service_name,
std::string  mailbox_name_prefix,
std::shared_ptr< 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

◆ getCoreFlopRate()

std::map< std::string, 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
WorkflowExecutionException

◆ getFreeScratchSpaceSize()

double wrench::ComputeService::getFreeScratchSpaceSize ( )

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

Returns
a size (in bytes)

◆ getMemoryCapacity()

std::map< std::string, double > wrench::ComputeService::getMemoryCapacity ( )

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

Returns
a map of RAM capacities, indexed by hostname
Exceptions
WorkflowExecutionException

◆ getNumHosts()

unsigned long wrench::ComputeService::getNumHosts ( )

Get the number of hosts that the compute service manages.

Returns
the host count
Exceptions
WorkflowExecutionException
std::runtime_error

◆ getPerHostAvailableMemoryCapacity()

std::map< std::string, double > wrench::ComputeService::getPerHostAvailableMemoryCapacity ( )

Get ram availability for each of the compute service's host.

Returns
the ram availability map (could be empty)
Exceptions
WorkflowExecutionException
std::runtime_error

◆ getPerHostNumCores()

std::map< std::string, unsigned long > wrench::ComputeService::getPerHostNumCores ( )

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

Returns
a map of core counts, indexed by hostnames
Exceptions
WorkflowExecutionException
std::runtime_error

◆ getPerHostNumIdleCores()

std::map< std::string, unsigned long > wrench::ComputeService::getPerHostNumIdleCores ( )

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

◆ getScratch()

std::shared_ptr< StorageService > wrench::ComputeService::getScratch ( )

Method that returns the computer service's scratch space's storage service.

Get the compute service's scratch storage space.

Returns
the scratch space, or nullptr if none
a pointer to the shared scratch space

◆ getScratchSharedPtr()

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

◆ getTotalNumCores()

unsigned long wrench::ComputeService::getTotalNumCores ( )

Get the total core counts for all hosts of the compute service.

Returns
total core counts
Exceptions
WorkflowExecutionException
std::runtime_error

◆ getTotalNumIdleCores()

unsigned long wrench::ComputeService::getTotalNumIdleCores ( )
virtual

Get the total idle core count for all hosts of the compute service.

Returns
total idle core count
Exceptions
WorkflowExecutionException
std::runtime_error

◆ getTotalScratchSpaceSize()

double wrench::ComputeService::getTotalScratchSpaceSize ( )

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

Returns
a size (in bytes)

◆ getTTL()

double wrench::ComputeService::getTTL ( )

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

Returns
the ttl in seconds
Exceptions
WorkflowExecutionException

◆ hasScratch()

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

◆ submitJob()

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:
  • to a BareMetalComputeService: {}
    • If no entry is provided for a taskID, the service will pick on which host and with how many cores to run the task
    • If a number of cores is provided (e.g., {"task1", "12"}), the service will pick the host on which to run the task
    • If a hostname and a number of cores is provided (e.g., {"task1", "host1:12"}, the service will run the task on that host with the specified number of cores
  • to a BatchComputeService: {"-t":"<int>","-N":"<int>","-c":"<int>"} (SLURM-like)
    • "-t": number of requested job duration in minutes
    • "-N": number of requested compute hosts
    • "-c": number of requested cores per compute host
  • to a CloudComputeService: {}
Exceptions
WorkflowExecutionException
std::invalid_argument
std::runtime_error

◆ submitPilotJob()

virtual void wrench::ComputeService::submitPilotJob ( PilotJob job,
std::map< std::string, std::string > &  service_specific_arguments 
)
pure virtual

Method to submit a pilot job to the service.

Parameters
jobThe job being submitted
service_specific_argumentsthe set of service-specific arguments

Implemented in wrench::HTCondorComputeService, wrench::HTCondorCentralManagerService, wrench::CloudComputeService, and wrench::BareMetalComputeService.

◆ submitStandardJob()

virtual void wrench::ComputeService::submitStandardJob ( StandardJob job,
std::map< std::string, std::string > &  service_specific_arguments 
)
pure virtual

Method to submit a standard job to the service.

Parameters
jobThe job being submitted
service_specific_argumentsthe set of service-specific arguments

Implemented in wrench::HTCondorComputeService, wrench::HTCondorCentralManagerService, wrench::CloudComputeService, and wrench::BareMetalComputeService.

◆ supportsPilotJobs()

bool wrench::ComputeService::supportsPilotJobs ( )

Get whether the compute service supports pilot jobs or not.

Returns
true or false

◆ supportsStandardJobs()

bool wrench::ComputeService::supportsStandardJobs ( )

Get whether the compute service supports standard jobs or not.

Returns
true or false

◆ terminateJob()

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

◆ terminatePilotJob()

virtual void wrench::ComputeService::terminatePilotJob ( PilotJob job)
pure virtual

Method to terminate a running pilot job.

Parameters
jobthe pilot job

Implemented in wrench::CloudComputeService, wrench::BareMetalComputeService, wrench::HTCondorComputeService, and wrench::HTCondorCentralManagerService.

◆ terminateStandardJob()

virtual void wrench::ComputeService::terminateStandardJob ( StandardJob job)
pure virtual

Method to terminate a running standard job.

Parameters
jobthe standard job

Implemented in wrench::CloudComputeService, wrench::BareMetalComputeService, wrench::HTCondorComputeService, and wrench::HTCondorCentralManagerService.


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