wrench::ComputeService Class Reference

The compute service base class. More...

#include <ComputeService.h>

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

Public Member Functions

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...
 
std::map< std::string, 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::map< std::string, unsigned long > getNumIdleCores ()
 Get idle core counts for each of the compute service's host. 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...
 
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...
 
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...
 
- 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 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 start (std::shared_ptr< Service > this_service, bool daemonize=false)
 Start the service. More...
 

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.
 

Additional Inherited Members

- Public Types inherited from wrench::Service
enum  State { UP, DOWN }
 Service states. More...
 

Detailed Description

The compute service base class.

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
std::runtime_error

◆ 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
std::runtime_error

◆ getNumCores()

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

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

◆ 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

◆ getNumIdleCores()

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

◆ getScratch()

StorageService * wrench::ComputeService::getScratch ( )

Get the compute service's scratch storage space.

Returns
a pointer to the shared scratch space

◆ getScratchSharedPtr()

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

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

Returns
a shared pointer to the shared scratch space

◆ 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
std::runtime_error

◆ 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 BatchService: {"-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 CloudService: {}
Exceptions
WorkflowExecutionException
std::invalid_argument
std::runtime_error

◆ 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

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