A workload management framework compute service. More...

#include <HTCondorService.h>

Inheritance diagram for wrench::HTCondorService:

Public Member Functions
	HTCondorService (const std::string &hostname, const std::string &pool_name, std::set< ComputeService *> compute_resources, std::map< std::string, std::string > property_list={}, std::map< std::string, std::string > messagepayload_list={})
	Constructor. More...

	~HTCondorService () override
	Destructor.

StorageService *	getLocalStorageService () const

void	setLocalStorageService (StorageService *local_storage_service)

void	submitPilotJob (PilotJob *job, std::map< std::string, std::string > &service_specific_arguments) override
	Asynchronously submit a pilot job to the cloud service. More...

void	submitStandardJob (StandardJob *job, std::map< std::string, std::string > &service_specific_arguments) override
	Submit a standard job to the HTCondor service. More...

void	terminatePilotJob (PilotJob *job) override
	Terminate a pilot job to the compute service. More...

void	terminateStandardJob (StandardJob *job) override
	Terminate a standard job to the compute service (virtual) More...

Public Member Functions inherited from wrench::ComputeService
	ComputeService (const std::string &hostname, std::string service_name, std::string mailbox_name_prefix, double scratch_space_size)
	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...

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...

unsigned long	getTotalNumCores ()
	Get the total core counts for all hosts of the compute service. More...

unsigned long	getTotalNumIdleCores ()
	Get the total idle core counts 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...

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	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, bool auto_restart)
	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...

bool	hasCleanlyTerminated ()
	Returned the terminated status of the daemon/actor.

bool	isSetToAutoRestart ()
	Return the auto-restart status of the daemon. More...

bool	join ()
	Join (i.e., wait for) the daemon. More...

void	resume ()
	Resume the daemon/actor.

void	setCleanlyTerminated ()
	Set the terminated status of the daemon/actor.

void	startDaemon (bool daemonized, bool auto_restart)
	Start the daemon. More...

void	suspend ()
	Suspend the daemon/actor.

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.

Simulation *	simulation
	a pointer to the simulation object

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.

static StorageService *	SCRATCH = (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 inherited from wrench::ComputeService
	ComputeService (const std::string &hostname, std::string service_name, std::string mailbox_name_prefix, StorageService *scratch_space)
	Constructor. More...

StorageService *	getScratch ()
	Get the compute service's scratch storage space. More...

std::shared_ptr< StorageService >	getScratchSharedPtr ()
	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.

void	runMainMethod ()
	Method that run's the user-defined main method (that's called by the S4U actor class)

Protected Attributes inherited from wrench::ComputeService
StorageService *	scratch_space_storage_service
	A scratch storage service associated to the compute service.

std::shared_ptr< StorageService >	scratch_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.

Protected Attributes inherited from wrench::S4U_Daemon
unsigned int	num_starts = 0

Detailed Description

A workload management framework compute service.

Constructor & Destructor Documentation

◆ HTCondorService()

wrench::HTCondorService::HTCondorService	(	const std::string &	hostname,
		const std::string &	pool_name,
		std::set< ComputeService *>	compute_resources,
		std::map< std::string, std::string >	property_list = `{}`,
		std::map< std::string, std::string >	messagepayload_list = `{}`
	)

Constructor.

Parameters

hostname	the hostname on which to start the service
pool_name	HTCondor pool name
compute_resources	a set of compute resources available via the HTCondor pool
property_list	a property list ({} means "use all defaults")
messagepayload_list	a message payload list ({} means "use all defaults")

Exceptions

std::runtime_error

Member Function Documentation

◆ getLocalStorageService()

StorageService * wrench::HTCondorService::getLocalStorageService ( ) const

Get a pointer to the service local StorageService object

Returns: a pointer to the service local StorageService object

◆ submitPilotJob()

void wrench::HTCondorService::submitPilotJob	(	PilotJob *	job,
		std::map< std::string, std::string > &	service_specific_args
	)

overridevirtual

Asynchronously submit a pilot job to the cloud service.

Parameters

job	a pilot job
service_specific_args	service specific arguments

Exceptions

WorkflowExecutionException
std::runtime_error

Implements wrench::ComputeService.

◆ submitStandardJob()

void wrench::HTCondorService::submitStandardJob	(	StandardJob *	job,
		std::map< std::string, std::string > &	service_specific_args
	)

overridevirtual

Submit a standard job to the HTCondor service.

Parameters

job	a standard job
service_specific_args	service specific arguments

Exceptions

WorkflowExecutionException
std::runtime_error

Implements wrench::ComputeService.

◆ terminatePilotJob()

void wrench::HTCondorService::terminatePilotJob ( PilotJob * job )

overridevirtual

Terminate a pilot job to the compute service.

Parameters

job the job

Exceptions

std::runtime_error

Implements wrench::ComputeService.

◆ terminateStandardJob()

void wrench::HTCondorService::terminateStandardJob ( StandardJob * job )

overridevirtual

Terminate a standard job to the compute service (virtual)

Parameters

job the job

Exceptions

std::runtime_error

Implements wrench::ComputeService.

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

/Users/rafsilva/Documents/isi/workspace/wrench/wrench/include/wrench/services/compute/htcondor/HTCondorService.h
/Users/rafsilva/Documents/isi/workspace/wrench/wrench/src/wrench/services/compute/htcondor/HTCondorService.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HTCondorService()

Member Function Documentation

◆ getLocalStorageService()

◆ submitPilotJob()

◆ submitStandardJob()

◆ terminatePilotJob()

◆ terminateStandardJob()