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

Inheritance diagram for wrench::CloudService:
wrench::ComputeService wrench::Service wrench::S4U_Daemon wrench::VirtualizedClusterService

Public Member Functions

 CloudService (const std::string &hostname, std::vector< std::string > &execution_hosts, double scratch_space_size, std::map< std::string, std::string > property_list={}, std::map< std::string, std::string > messagepayload_list={})
 Constructor. More...
 
 ~CloudService ()
 Destructor.
 
virtual std::string createVM (unsigned long num_cores=ComputeService::ALL_CORES, double ram_memory=ComputeService::ALL_RAM, std::map< std::string, std::string > property_list={}, std::map< std::string, std::string > messagepayload_list={})
 Create a MultihostMulticoreComputeService VM (balances load on execution hosts) More...
 
std::vector< std::string > getExecutionHosts ()
 Get the list of execution hosts available to run VMs. More...
 
virtual bool resumeVM (const std::string &vm_hostname)
 Resume a suspended VM. More...
 
virtual bool shutdownVM (const std::string &vm_hostname)
 Shutdown an active VM. More...
 
virtual bool startVM (const std::string &vm_hostname)
 Start a VM. More...
 
void submitPilotJob (PilotJob *job, std::map< std::string, std::string > &service_specific_args) override
 Asynchronously submit a pilot job to the cloud service. More...
 
void submitStandardJob (StandardJob *job, std::map< std::string, std::string > &service_specific_args) override
 Submit a standard job to the cloud service. More...
 
virtual bool suspendVM (const std::string &vm_hostname)
 Suspend a running VM. More...
 
void terminatePilotJob (PilotJob *job) override
 Terminate a pilot job to the compute service (virtual) 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::vector< 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< double > getMemoryCapacity ()
 Get the RAM capacities for each of the compute service's hosts. More...
 
std::vector< 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::vector< unsigned long > getNumIdleCores ()
 Get idle core counts for each of the compute service's host. 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=false)
 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...
 
void join ()
 Join (i.e., wait for) the daemon.
 
void resume ()
 Resume the daemon/actor.
 
void setTerminated ()
 Set the terminated status of the daemon/actor.
 
void startDaemon (bool daemonized)
 Start the daemon. More...
 
void suspend ()
 Suspend the daemon/actor.
 

Protected Member Functions

int main () override
 Main method of the daemon. More...
 
virtual void processCreateVM (const std::string &answer_mailbox, const std::string &pm_hostname, const std::string &vm_name, unsigned long num_cores, double ram_memory, std::map< std::string, std::string > &property_list, std::map< std::string, std::string > &messagepayload_list)
 Create a MultihostMulticoreComputeService VM on a physical machine. More...
 
virtual void processGetExecutionHosts (const std::string &answer_mailbox)
 Process a execution host list request. More...
 
virtual void processGetResourceInformation (const std::string &answer_mailbox)
 Process a "get resource information message". More...
 
virtual bool processNextMessage ()
 Wait for and react to any incoming message. More...
 
virtual void processResumeVM (const std::string &answer_mailbox, const std::string &vm_hostname)
 : Process a VM resume request More...
 
virtual void processShutdownVM (const std::string &answer_mailbox, const std::string &vm_hostname)
 : Process a VM shutdown request More...
 
virtual void processStartVM (const std::string &answer_mailbox, const std::string &vm_name)
 : Process a VM start request More...
 
virtual void processSubmitPilotJob (const std::string &answer_mailbox, PilotJob *job, std::map< std::string, std::string > &service_specific_args)
 Process a submit pilot job request. More...
 
virtual void processSubmitStandardJob (const std::string &answer_mailbox, StandardJob *job, std::map< std::string, std::string > &service_specific_args)
 Process a submit standard job request. More...
 
virtual void processSuspendVM (const std::string &answer_mailbox, const std::string &vm_hostname)
 : Process a VM suspend request More...
 
std::unique_ptr
< SimulationMessage
sendRequest (std::string &answer_mailbox, ComputeServiceMessage *message)
 Send a message request. More...
 
void stopAllVMs ()
 Terminate all VMs.
 
- 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...
 
StorageServicegetScratch ()
 Get the compute service's scratch storage space. More...
 
std::shared_ptr< StorageServicegetScratchSharedPtr ()
 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.
 

Protected Attributes

std::map< std::string, double > cs_available_ram
 Map of available RAM at hosts.
 
std::vector< std::string > execution_hosts
 List of execution host names.
 
std::map< std::string,
unsigned long > 
used_cores_per_execution_host
 A map of the number of used cores (per VM) per execution host.
 
std::map< std::string,
std::tuple< std::shared_ptr
< S4U_VirtualMachine >
, std::shared_ptr
< ComputeService >, unsigned
long, unsigned long > > 
vm_list
 A map of VMs described by the VM actor, the actual compute service, the total number of cores, and RAM size.
 
- Protected Attributes inherited from wrench::ComputeService
StorageServicescratch_space_storage_service
 A scratch storage service associated to the compute service.
 
std::shared_ptr< StorageServicescratch_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.
 

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.
 
Simulationsimulation
 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 StorageServiceSCRATCH = (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.
 

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

wrench::CloudService::CloudService ( const std::string &  hostname,
std::vector< std::string > &  execution_hosts,
double  scratch_space_size,
std::map< std::string, std::string >  property_list = {},
std::map< std::string, std::string >  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_sizethe size for the scratch storage pace of the cloud service
property_lista property list ({} means "use all defaults")
messagepayload_lista message payload list ({} means "use all defaults")
Exceptions
std::runtime_error

Member Function Documentation

std::string wrench::CloudService::createVM ( unsigned long  num_cores = ComputeService::ALL_CORES,
double  ram_memory = ComputeService::ALL_RAM,
std::map< std::string, std::string >  property_list = {},
std::map< std::string, std::string >  messagepayload_list = {} 
)
virtual

Create a MultihostMulticoreComputeService VM (balances load on execution hosts)

Parameters
num_coresthe number of cores the service can use (use ComputeService::ALL_CORES to use all cores available on the host)
ram_memorythe VM's RAM memory capacity (use ComputeService::ALL_RAM to use all RAM available on the host, this can be lead to an out of memory issue)
property_lista property list ({} means "use all defaults")
messagepayload_lista message payload list ({} means "use all defaults")
Returns
Virtual machine name
Exceptions
WorkflowExecutionException
std::vector< std::string > wrench::CloudService::getExecutionHosts ( )

Get the list of execution hosts available to run VMs.

Returns
a list of hostnames
Exceptions
WorkflowExecutionException
int wrench::CloudService::main ( )
overrideprotectedvirtual

Main method of the daemon.

Returns
0 on termination

Main loop

Implements wrench::S4U_Daemon.

Reimplemented in wrench::VirtualizedClusterService.

void wrench::CloudService::processCreateVM ( const std::string &  answer_mailbox,
const std::string &  pm_hostname,
const std::string &  vm_name,
unsigned long  num_cores,
double  ram_memory,
std::map< std::string, std::string > &  property_list,
std::map< std::string, std::string > &  messagepayload_list 
)
protectedvirtual

Create a MultihostMulticoreComputeService VM on a physical machine.

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
pm_hostnamethe name of the physical machine host
vm_namethe name of the VM host
num_coresthe number of cores the service can use (use ComputeService::ALL_CORES to use all cores available on the host)
ram_memorythe VM's RAM memory capacity (use ComputeService::ALL_RAM to use all RAM available on the host, this can be lead to out of memory issue)
property_lista property list ({} means "use all defaults")
messagepayload_lista message payload list ({} means "use all defaults")
Exceptions
std::runtime_error
void wrench::CloudService::processGetExecutionHosts ( const std::string &  answer_mailbox)
protectedvirtual

Process a execution host list request.

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
void wrench::CloudService::processGetResourceInformation ( const std::string &  answer_mailbox)
protectedvirtual

Process a "get resource information message".

Parameters
answer_mailboxthe mailbox to which the description message should be sent
bool wrench::CloudService::processNextMessage ( )
protectedvirtual

Wait for and react to any incoming message.

Returns
false if the daemon should terminate, true otherwise
Exceptions
std::runtime_error

Reimplemented in wrench::VirtualizedClusterService.

void wrench::CloudService::processResumeVM ( const std::string &  answer_mailbox,
const std::string &  vm_hostname 
)
protectedvirtual

: Process a VM resume request

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
vm_hostnamethe name of the VM host
void wrench::CloudService::processShutdownVM ( const std::string &  answer_mailbox,
const std::string &  vm_hostname 
)
protectedvirtual

: Process a VM shutdown request

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
vm_hostnamethe name of the VM host
void wrench::CloudService::processStartVM ( const std::string &  answer_mailbox,
const std::string &  vm_name 
)
protectedvirtual

: Process a VM start request

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
vm_namethe name of the VM host
void wrench::CloudService::processSubmitPilotJob ( const std::string &  answer_mailbox,
PilotJob job,
std::map< std::string, std::string > &  service_specific_args 
)
protectedvirtual

Process a submit pilot job request.

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
jobthe job
service_specific_argsservice specific arguments
Exceptions
std::runtime_error
void wrench::CloudService::processSubmitStandardJob ( const std::string &  answer_mailbox,
StandardJob job,
std::map< std::string, std::string > &  service_specific_args 
)
protectedvirtual

Process a submit standard job request.

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
jobthe job
service_specific_argsservice specific arguments
Exceptions
std::runtime_error
void wrench::CloudService::processSuspendVM ( const std::string &  answer_mailbox,
const std::string &  vm_hostname 
)
protectedvirtual

: Process a VM suspend request

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
vm_hostnamethe name of the VM host
bool wrench::CloudService::resumeVM ( const std::string &  vm_hostname)
virtual

Resume a suspended VM.

Parameters
vm_hostnamethe name of the VM host
Returns
Whether the VM resume succeeded
Exceptions
WorkflowExecutionException
std::unique_ptr< SimulationMessage > wrench::CloudService::sendRequest ( std::string &  answer_mailbox,
ComputeServiceMessage message 
)
protected

Send a message request.

Parameters
answer_mailboxthe mailbox to which the answer message should be sent
messagemessage to be sent
Exceptions
std::runtime_error
bool wrench::CloudService::shutdownVM ( const std::string &  vm_hostname)
virtual

Shutdown an active VM.

Parameters
vm_hostnamethe name of the VM host
Returns
Whether the VM shutdown succeeded
Exceptions
WorkflowExecutionException
bool wrench::CloudService::startVM ( const std::string &  vm_hostname)
virtual

Start a VM.

Parameters
vm_hostnamethe name of the VM host
Returns
Whether the VM start succeeded
Exceptions
WorkflowExecutionException
void wrench::CloudService::submitPilotJob ( PilotJob job,
std::map< std::string, std::string > &  service_specific_args 
)
overridevirtual

Asynchronously submit a pilot job to the cloud service.

Parameters
joba pilot job
service_specific_argsservice specific arguments
  • optional: "-vm": name of vm on which to start the job (if not provided, the service will pick the vm)
Exceptions
WorkflowExecutionException
std::runtime_error

Implements wrench::ComputeService.

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

Submit a standard job to the cloud service.

Parameters
joba standard job
service_specific_argsbatch-specific arguments
  • optional: "-vm": name of vm on which to start the job (if not provided, the service will pick the vm)
Exceptions
WorkflowExecutionException
std::runtime_error

Implements wrench::ComputeService.

bool wrench::CloudService::suspendVM ( const std::string &  vm_hostname)
virtual

Suspend a running VM.

Parameters
vm_hostnamethe name of the VM host
Returns
Whether the VM suspend succeeded
Exceptions
WorkflowExecutionException
void wrench::CloudService::terminatePilotJob ( PilotJob job)
overridevirtual

Terminate a pilot job to the compute service (virtual)

Parameters
jobthe pilot job
Exceptions
std::runtime_error

Implements wrench::ComputeService.

void wrench::CloudService::terminateStandardJob ( StandardJob job)
overridevirtual

Terminate a standard job to the compute service (virtual)

Parameters
jobthe standard job
Exceptions
std::runtime_error

Implements wrench::ComputeService.


The documentation for this class was generated from the following files:
  • /home/wrench/wrench/include/wrench/services/compute/cloud/CloudService.h
  • /home/wrench/wrench/src/wrench/services/compute/cloud/CloudService.cpp