WRENCH  1.11
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, WRENCH_PROPERTY_COLLECTION_TYPE property_list={}, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE 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 submitCompoundJob (std::shared_ptr< CompoundJob > job, const std::map< std::string, std::string > &service_specific_arguments) override
 Submit a compound job to the HTCondor service. More...
 
virtual bool supportsCompoundJobs () override
 Returns true if the service supports compound jobs. More...
 
virtual bool supportsPilotJobs () override
 Returns true if the service supports pilot jobs. More...
 
virtual bool supportsStandardJobs () override
 Returns true if the service supports standard jobs. More...
 
void validateJobsUseOfScratch (std::map< std::string, std::string > &service_specific_args) override
 Determine whether compute service has scratch. More...
 
void validateServiceSpecificArguments (std::shared_ptr< CompoundJob > compound_job, std::map< std::string, std::string > &service_specific_args) override
 Method the validates service-specific arguments (throws std::invalid_argument if invalid) 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. 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...
 
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.
 

Additional Inherited Members

- Public Types inherited from wrench::ComputeService
enum  TerminationCause { TERMINATION_NONE, TERMINATION_COMPUTE_SERVICE_TERMINATED, TERMINATION_JOB_KILLED, TERMINATION_JOB_TIMEOUT }
 Job termination cause enum.
 
- 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,
WRENCH_PROPERTY_COLLECTION_TYPE  property_list = {},
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE  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

◆ submitCompoundJob()

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

Submit a compound job to the HTCondor service.

Parameters
joba compound job
service_specific_argsservice specific arguments
Exceptions
ExecutionException
std::runtime_error

◆ supportsCompoundJobs()

bool wrench::HTCondorComputeService::supportsCompoundJobs ( )
overridevirtual

Returns true if the service supports compound jobs.

Returns
true or false

Implements wrench::ComputeService.

◆ supportsPilotJobs()

bool wrench::HTCondorComputeService::supportsPilotJobs ( )
overridevirtual

Returns true if the service supports pilot jobs.

Returns
true or false

Implements wrench::ComputeService.

◆ supportsStandardJobs()

bool wrench::HTCondorComputeService::supportsStandardJobs ( )
overridevirtual

Returns true if the service supports standard jobs.

Returns
true or false

Implements wrench::ComputeService.

◆ validateJobsUseOfScratch()

void wrench::HTCondorComputeService::validateJobsUseOfScratch ( std::map< std::string, std::string > &  service_specific_args)
override

Determine whether compute service has scratch.

Parameters
service_specific_argsthe service-specific arguments (useful for some services)

◆ validateServiceSpecificArguments()

void wrench::HTCondorComputeService::validateServiceSpecificArguments ( std::shared_ptr< CompoundJob >  job,
std::map< std::string, std::string > &  service_specific_args 
)
override

Method the validates service-specific arguments (throws std::invalid_argument if invalid)

Parameters
jobthe job that's being submitted
service_specific_argsthe service-specific arguments

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