WRENCH  1.10
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Member Functions | List of all members
wrench::HTCondorComputeService Class Reference

A workload management framework compute service. More...

#include <HTCondorComputeService.h>

Inheritance diagram for wrench::HTCondorComputeService:
wrench::ComputeService wrench::Service

Public Member Functions

 HTCondorComputeService (const std::string &hostname, std::set< std::shared_ptr< ComputeService >> compute_services, std::map< std::string, std::string > property_list={}, std::map< std::string, double > messagepayload_list={})
 Constructor. More...
 
void addComputeService (std::shared_ptr< ComputeService > compute_service)
 Add a new 'child' compute service. More...
 
std::shared_ptr< StorageServicegetLocalStorageService () const
 Get the service's local storage service. More...
 
void setLocalStorageService (std::shared_ptr< StorageService > local_storage_service)
 Set the service's local storage service. More...
 
void submitPilotJob (std::shared_ptr< PilotJob > job, const std::map< std::string, std::string > &service_specific_arguments) override
 Asynchronously submit a pilot job to the cloud service. More...
 
void submitStandardJob (std::shared_ptr< StandardJob > job, const std::map< std::string, std::string > &service_specific_arguments) override
 Submit a standard job to the HTCondor service. 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< StorageServicegetScratchSharedPtr ()
 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 workload management framework compute service.

Constructor & Destructor Documentation

◆ HTCondorComputeService()

wrench::HTCondorComputeService::HTCondorComputeService ( const std::string &  hostname,
std::set< std::shared_ptr< ComputeService >>  compute_services,
std::map< std::string, std::string >  property_list = {},
std::map< std::string, double >  messagepayload_list = {} 
)

Constructor.

Parameters
hostnamethe name of the host on which to start the service
compute_servicesa set of 'child' compute services that have been added to the simulation and that are available to and usable through the HTCondor pool.
  • BatchComputeService instances will be used for Condor jobs in the "grid" universe
  • BareMetalComputeService instances will be used for Condor jobs not in the "grid" universe
  • other types of compute services are disallowed
property_lista property list ({} means "use all defaults")
messagepayload_lista message payload list ({} means "use all defaults")
Exceptions
std::runtime_error

Member Function Documentation

◆ addComputeService()

void wrench::HTCondorComputeService::addComputeService ( std::shared_ptr< ComputeService compute_service)

Add a new 'child' compute service.

Parameters
compute_servicethe compute service to add

◆ getLocalStorageService()

std::shared_ptr< StorageService > wrench::HTCondorComputeService::getLocalStorageService ( ) const

Get the service's local storage service.

Returns
the local storage service object

◆ setLocalStorageService()

void wrench::HTCondorComputeService::setLocalStorageService ( std::shared_ptr< StorageService local_storage_service)

Set the service's local storage service.

Parameters
local_storage_servicea storage service

◆ submitPilotJob()

void wrench::HTCondorComputeService::submitPilotJob ( std::shared_ptr< PilotJob job,
const std::map< std::string, std::string > &  service_specific_args 
)
override

Asynchronously submit a pilot job to the cloud service.

Parameters
joba pilot job
service_specific_argsservice specific arguments
Exceptions
WorkflowExecutionException
std::runtime_error

◆ submitStandardJob()

void wrench::HTCondorComputeService::submitStandardJob ( std::shared_ptr< StandardJob >  job,
const std::map< std::string, std::string > &  service_specific_args 
)
override

Submit a standard job to the HTCondor service.

Parameters
joba standard job
service_specific_argsservice specific arguments
Exceptions
WorkflowExecutionException
std::runtime_error

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