WRENCH  1.11
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Member Functions | Protected Attributes | List of all members
wrench::CloudComputeService Class Reference

A cloud-based compute service that manages a set of physical hosts and controls access to their resources by (transparently) executing jobs in VM instances. More...

#include <CloudComputeService.h>

Inheritance diagram for wrench::CloudComputeService:
wrench::ComputeService wrench::Service wrench::VirtualizedClusterComputeService

Public Member Functions

 CloudComputeService (const std::string &hostname, std::vector< std::string > execution_hosts, std::string scratch_space_mount_point, WRENCH_PROPERTY_COLLECTION_TYPE property_list={}, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list={})
 Constructor. More...
 
virtual std::string createVM (unsigned long num_cores, double ram_memory, std::string desired_vm_name, WRENCH_PROPERTY_COLLECTION_TYPE property_list={}, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list={})
 Create a BareMetalComputeService VM (balances load on execution hosts) More...
 
virtual std::string createVM (unsigned long num_cores, double ram_memory, WRENCH_PROPERTY_COLLECTION_TYPE property_list={}, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list={})
 Create a BareMetalComputeService VM (balances load on execution hosts) More...
 
virtual void destroyVM (const std::string &vm_name)
 Destroy a VM. More...
 
std::vector< std::string > getExecutionHosts ()
 Get the list of execution hosts available to run VMs. More...
 
virtual std::shared_ptr< BareMetalComputeServicegetVMComputeService (const std::string &vm_name)
 Get the compute service running on a VM, if any. More...
 
virtual std::string getVMPhysicalHostname (const std::string &vm_name)
 Get the name of the physical host on which a VM is running. More...
 
virtual bool isVMDown (const std::string &vm_name)
 Method to check whether a VM is currently down. More...
 
virtual bool isVMRunning (const std::string &vm_name)
 Method to check whether a VM is currently running. More...
 
virtual bool isVMSuspended (const std::string &vm_name)
 Method to check whether a VM is currently running. More...
 
virtual void resumeVM (const std::string &vm_name)
 Resume a suspended VM. More...
 
virtual void shutdownVM (const std::string &vm_name)
 Shutdown an active VM. More...
 
virtual void shutdownVM (const std::string &vm_name, bool send_failure_notifications, ComputeService::TerminationCause termination_cause)
 Shutdown an active VM. More...
 
virtual std::shared_ptr< BareMetalComputeServicestartVM (const std::string &vm_name)
 Start a VM. 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...
 
virtual void suspendVM (const std::string &vm_name)
 Suspend a running VM. 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.
 

Protected Attributes

std::vector< std::string > execution_hosts
 List of execution host names.
 
std::map< std::string, unsigned long > used_cores_per_execution_host
 Map of number of used cores at the hosts.
 
std::map< std::string, double > used_ram_per_execution_host
 Map of used RAM at the hosts.
 
std::map< std::string, std::pair< std::shared_ptr< S4U_VirtualMachine >, std::shared_ptr< BareMetalComputeService > > > vm_list
 A map of VMs.
 

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 cloud-based compute service that manages a set of physical hosts and controls access to their resources by (transparently) executing jobs in VM instances.

Constructor & Destructor Documentation

◆ CloudComputeService()

wrench::CloudComputeService::CloudComputeService ( const std::string &  hostname,
std::vector< std::string >  execution_hosts,
std::string  scratch_space_mount_point,
WRENCH_PROPERTY_COLLECTION_TYPE  property_list = {},
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE  messagepayload_list = {} 
)

Constructor.

Parameters
hostnamethe hostname on which to start the service
execution_hoststhe list of the names of the hosts available for running virtual machines
scratch_space_mount_pointthe mount point for the cloud sercvice's strach space ("" means none)
property_lista property list ({} means "use all defaults")
messagepayload_lista message payload list ({} means "use all defaults")
Exceptions
std::runtime_error

Member Function Documentation

◆ createVM() [1/2]

std::string wrench::CloudComputeService::createVM ( unsigned long  num_cores,
double  ram_memory,
std::string  desired_vm_name,
WRENCH_PROPERTY_COLLECTION_TYPE  property_list = {},
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE  messagepayload_list = {} 
)
virtual

Create a BareMetalComputeService VM (balances load on execution hosts)

Parameters
num_coresthe number of cores for the VM
ram_memorythe VM's RAM memory_manager_service capacity
desired_vm_namethe VM's desired name ("" means "pick a name for me")
property_lista property list for the BareMetalComputeService that will run on the VM ({} means "use all defaults")
messagepayload_lista message payload list for the BareMetalComputeService that will run on the VM ({} means "use all defaults")
Returns
A VM name
Exceptions
ExecutionException
std::runtime_error

◆ createVM() [2/2]

std::string wrench::CloudComputeService::createVM ( unsigned long  num_cores,
double  ram_memory,
WRENCH_PROPERTY_COLLECTION_TYPE  property_list = {},
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE  messagepayload_list = {} 
)
virtual

Create a BareMetalComputeService VM (balances load on execution hosts)

Parameters
num_coresthe number of cores for the VM
ram_memorythe VM's RAM memory_manager_service capacity
property_lista property list for the BareMetalComputeService that will run on the VM ({} means "use all defaults")
messagepayload_lista message payload list for the BareMetalComputeService that will run on the VM ({} means "use all defaults")
Returns
A VM name
Exceptions
ExecutionException
std::runtime_error

◆ destroyVM()

void wrench::CloudComputeService::destroyVM ( const std::string &  vm_name)
virtual

Destroy a VM.

Parameters
vm_namethe name of the VM
Exceptions
ExecutionException
std::invalid_argument

◆ getExecutionHosts()

std::vector< std::string > wrench::CloudComputeService::getExecutionHosts ( )

Get the list of execution hosts available to run VMs.

Returns
a list of hostnames
Exceptions
ExecutionException

◆ getVMComputeService()

std::shared_ptr< BareMetalComputeService > wrench::CloudComputeService::getVMComputeService ( const std::string &  vm_name)
virtual

Get the compute service running on a VM, if any.

Parameters
vm_namethe name of the VM
Returns
A BareMetalComputeService that runs on the VM, or nullptr if none
Exceptions
ExecutionException
std::invalid_argument

◆ getVMPhysicalHostname()

std::string wrench::CloudComputeService::getVMPhysicalHostname ( const std::string &  vm_name)
virtual

Get the name of the physical host on which a VM is running.

Parameters
vm_namethe name of the VM
Returns
physical host name
Exceptions
ExecutionException
std::invalid_argument

◆ isVMDown()

bool wrench::CloudComputeService::isVMDown ( const std::string &  vm_name)
virtual

Method to check whether a VM is currently down.

Parameters
vm_namethe name of the VM
Returns
true or false
Exceptions
std::invalid_argument

◆ isVMRunning()

bool wrench::CloudComputeService::isVMRunning ( const std::string &  vm_name)
virtual

Method to check whether a VM is currently running.

Parameters
vm_namethe name of the VM
Returns
true or false
Exceptions
std::invalid_argument

◆ isVMSuspended()

bool wrench::CloudComputeService::isVMSuspended ( const std::string &  vm_name)
virtual

Method to check whether a VM is currently running.

Parameters
vm_namethe name of the VM
Returns
true or false
Exceptions
std::invalid_argument

◆ resumeVM()

void wrench::CloudComputeService::resumeVM ( const std::string &  vm_name)
virtual

Resume a suspended VM.

Parameters
vm_namethe name of the VM
Exceptions
ExecutionException
std::invalid_argument

◆ shutdownVM() [1/2]

void wrench::CloudComputeService::shutdownVM ( const std::string &  vm_name)
virtual

Shutdown an active VM.

Parameters
vm_namethe name of the VM
Exceptions
ExecutionException
std::invalid_argument

◆ shutdownVM() [2/2]

void wrench::CloudComputeService::shutdownVM ( const std::string &  vm_name,
bool  send_failure_notifications,
ComputeService::TerminationCause  termination_cause 
)
virtual

Shutdown an active VM.

Parameters
vm_namethe name of the VM
send_failure_notificationswhether to send the failure notifications
termination_causethe termination cause (if failure notifications are sent)
Exceptions
ExecutionException
std::invalid_argument

◆ startVM()

std::shared_ptr< BareMetalComputeService > wrench::CloudComputeService::startVM ( const std::string &  vm_name)
virtual

Start a VM.

Parameters
vm_namethe name of the VM
Returns
A BareMetalComputeService that runs on the VM
Exceptions
ExecutionException
std::invalid_argument

◆ supportsCompoundJobs()

bool wrench::CloudComputeService::supportsCompoundJobs ( )
overridevirtual

Returns true if the service supports compound jobs.

Returns
true or false

Implements wrench::ComputeService.

◆ supportsPilotJobs()

bool wrench::CloudComputeService::supportsPilotJobs ( )
overridevirtual

Returns true if the service supports pilot jobs.

Returns
true or false

Implements wrench::ComputeService.

◆ supportsStandardJobs()

bool wrench::CloudComputeService::supportsStandardJobs ( )
overridevirtual

Returns true if the service supports standard jobs.

Returns
true or false

Implements wrench::ComputeService.

◆ suspendVM()

void wrench::CloudComputeService::suspendVM ( const std::string &  vm_name)
virtual

Suspend a running VM.

Parameters
vm_namethe name of the VM
Exceptions
ExecutionException
std::invalid_argument

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