The compute service base class. More...

#include <ComputeService.h>

Inheritance diagram for wrench::ComputeService:

Public Types
enum	TerminationCause { TERMINATION_NONE, TERMINATION_COMPUTE_SERVICE_TERMINATED, TERMINATION_JOB_KILLED, TERMINATION_JOB_TIMEOUT }
	Job termination cause enum.

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::vector< std::string >	getHosts ()
	Get the list of the compute service's compute host. 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< StorageService >	getScratchSharedPtr ()
	Get a shared pointer to the compute service's scratch storage space. 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. Note that this doesn't mean that asking for these cores right will mean immediate execution (since jobs may be pending and "ahead" in the queue, e.g., because they depend on current actions that are not using all available resources). 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...

virtual bool	hasScratch () const
	Checks if the compute service has a scratch space. More...

virtual bool	isThereAtLeastOneHostWithIdleResources (unsigned long num_cores, double ram)
	Method to find out if, right now, the compute service has at least one host with some idle number of cores and some available RAM. Note that this doesn't mean that asking for these resources right will mean immediate execution (since jobs may be pending and "ahead" in the queue, e.g., because they depend on current actions that are not using all available resources). More...

void	stop () override
	Stop the compute service.

virtual void	stop (bool send_failure_notifications, ComputeService::TerminationCause termination_cause)
	Stop the compute service. More...

virtual bool	supportsCompoundJobs ()=0
	Returns true if the service supports pilot jobs. More...

virtual bool	supportsPilotJobs ()=0
	Returns true if the service supports compound jobs. More...

virtual bool	supportsStandardJobs ()=0
	Returns true if the service supports standard jobs. More...

void	terminateJob (std::shared_ptr< CompoundJob > job)
	Terminate a previously-submitted job (which may or may not be running yet) 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	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	start (std::shared_ptr< Service > this_service, bool daemonize, bool auto_restart)
	Start the service. More...

void	suspend ()
	Suspend the service.

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.

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

ExecutionException

◆ getFreeScratchSpaceSize()

double wrench::ComputeService::getFreeScratchSpaceSize ( )

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

Returns: a size (in bytes)

◆ getHosts()

std::vector< std::string > wrench::ComputeService::getHosts ( )

Get the list of the compute service's compute host.

Returns: a vector of hostnames

Exceptions

ExecutionException
std::runtime_error

◆ 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

ExecutionException

◆ getNumHosts()

unsigned long wrench::ComputeService::getNumHosts ( )

Get the number of hosts that the compute service manages.

Returns: the host count

Exceptions

ExecutionException
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

ExecutionException
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

ExecutionException
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). Note that this doesn't mean that asking for these cores right will mean immediate execution (since jobs may be pending and "ahead" in the queue, e.g., because they depend on current actions that are not using all available resources).

Exceptions

ExecutionException
std::runtime_error

◆ 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

◆ getTotalNumCores()

unsigned long wrench::ComputeService::getTotalNumCores ( )

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

Returns: total core counts

Exceptions

ExecutionException
std::runtime_error

◆ getTotalNumIdleCores()

unsigned long wrench::ComputeService::getTotalNumIdleCores ( )

virtual

Get the total idle core count for all hosts of the compute service. Note that this doesn't mean that asking for these cores right will mean immediate execution (since jobs may be pending and "ahead" in the queue, e.g., because they depend on current actions that are not using all available resources).

Returns: total idle core count.

Exceptions

ExecutionException
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

ExecutionException

◆ hasScratch()

bool wrench::ComputeService::hasScratch ( ) const

virtual

Checks if the compute service has a scratch space.

Returns: true if the compute service has some scratch storage space, false otherwise

◆ isThereAtLeastOneHostWithIdleResources()

bool wrench::ComputeService::isThereAtLeastOneHostWithIdleResources	(	unsigned long	num_cores,
		double	ram
	)

virtual

Method to find out if, right now, the compute service has at least one host with some idle number of cores and some available RAM. Note that this doesn't mean that asking for these resources right will mean immediate execution (since jobs may be pending and "ahead" in the queue, e.g., because they depend on current actions that are not using all available resources).

Parameters

num_cores	the desired number of cores
ram	the desired RAM

Returns: true if idle resources are available, false otherwise

◆ stop()

void wrench::ComputeService::stop	(	bool	send_failure_notifications,
		ComputeService::TerminationCause	termination_cause
	)

virtual

Stop the compute service.

Parameters

send_failure_notifications	whether to send job failure notifications or not
termination_cause	the cause (reason) of the service's termination

THIS IS CODE DUPLICATION FROM Service::stop(), which is not great

◆ supportsCompoundJobs()

virtual bool wrench::ComputeService::supportsCompoundJobs ( )

pure virtual

Returns true if the service supports pilot jobs.

Returns: true or false

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

◆ supportsPilotJobs()

virtual bool wrench::ComputeService::supportsPilotJobs ( )

pure virtual

Returns true if the service supports compound jobs.

Returns: true or false

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

◆ supportsStandardJobs()

virtual bool wrench::ComputeService::supportsStandardJobs ( )

pure virtual

Returns true if the service supports standard jobs.

Returns: true or false

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

◆ terminateJob()

void wrench::ComputeService::terminateJob ( std::shared_ptr< CompoundJob > job )

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

Parameters

job	the job to terminate

Exceptions

std::invalid_argument
ExecutionException
std::runtime_error

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

ComputeService.h
ComputeService.cpp

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getCoreFlopRate()

◆ getFreeScratchSpaceSize()

◆ getHosts()

◆ getMemoryCapacity()

◆ getNumHosts()

◆ getPerHostAvailableMemoryCapacity()

◆ getPerHostNumCores()

◆ getPerHostNumIdleCores()

◆ getScratchSharedPtr()

◆ getTotalNumCores()

◆ getTotalNumIdleCores()

◆ getTotalScratchSpaceSize()

◆ getTTL()

◆ hasScratch()

◆ isThereAtLeastOneHostWithIdleResources()

◆ stop()

◆ supportsCompoundJobs()

◆ supportsPilotJobs()

◆ supportsStandardJobs()

◆ terminateJob()