wrench::BareMetalComputeService Class Reference

A compute service that manages a set of multi-core compute hosts and provides access to their resources. More...

#include <BareMetalComputeService.h>

Inheritance diagram for wrench::BareMetalComputeService:

Public Member Functions
	BareMetalComputeService (const std::string &hostname, const std::map< std::string, std::tuple< unsigned long, double >> compute_resources, std::string scratch_space_mount_point, std::map< std::string, std::string > property_list={}, std::map< std::string, double > messagepayload_list={})
	Constructor. More...
	BareMetalComputeService (const std::string &hostname, const std::vector< std::string > compute_hosts, std::string scratch_space_mount_point, std::map< std::string, std::string > property_list={}, std::map< std::string, double > messagepayload_list={})
	Constructor. More...
Public Member Functions inherited from wrench::ComputeService
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. 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...
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. More...
void	stop () override
	Stop the compute service - must be called by the stop() method of derived classes.
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 (std::shared_ptr< WorkflowJob > 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...
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	start (std::shared_ptr< Service > this_service, bool daemonize, bool auto_restart)
	Start the service. More...
void	suspend ()
	Suspend the service.

Additional Inherited Members
Static Public Attributes inherited from wrench::ComputeService
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

A compute service that manages a set of multi-core compute hosts and provides access to their resources.

One can think of this as a simple service that allows the user to run tasks and to specify for each task on which host it should run and with how many cores. If no host is specified, the service will pick the least loaded host. If no number of cores is specified, the service will use as many cores as possible. The service will make sure that the RAM capacity of a host is not exceeded by possibly delaying task executions until enough RAM is available.

Constructor & Destructor Documentation

BareMetalComputeService() [1/2]

wrench::BareMetalComputeService::BareMetalComputeService	(	const std::string &	hostname,
		const std::map< std::string, std::tuple< unsigned long, double >>	compute_resources,
		std::string	scratch_space_mount_point,
		std::map< std::string, std::string >	property_list = {},
		std::map< std::string, double >	messagepayload_list = {}
	)

Constructor.

Parameters

hostname	the name of the host on which the service should be started
compute_resources	a map of <num_cores, memory_manager_service> tuples, indexed by hostname, which represents the compute resources available to this service. use num_cores = ComputeService::ALL_CORES to use all cores available on the host use memory_manager_service = ComputeService::ALL_RAM to use all RAM available on the host
scratch_space_mount_point	the compute service's scratch space's mount point ("" means none)
property_list	a property list ({} means "use all defaults")
messagepayload_list	a message payload list ({} means "use all defaults")

BareMetalComputeService() [2/2]

wrench::BareMetalComputeService::BareMetalComputeService	(	const std::string &	hostname,
		const std::vector< std::string >	compute_hosts,
		std::string	scratch_space_mount_point,
		std::map< std::string, std::string >	property_list = {},
		std::map< std::string, double >	messagepayload_list = {}
	)

Constructor.

Parameters

hostname	the name of the host on which the service should be started
compute_hosts,:	the names of the hosts available as compute resources (the service will use all the cores and all the RAM of each host)
scratch_space_mount_point	the compute service's scratch space's mount point ("" means none)
property_list	a property list ({} means "use all defaults")
messagepayload_list	a message payload list ({} means "use all defaults")

---

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

• BareMetalComputeService.h
• BareMetalComputeService.cpp