11 #ifndef WRENCH_CLOUDSERVICE_H
12 #define WRENCH_CLOUDSERVICE_H
15 #include <simgrid/s4u/VirtualMachine.hpp>
17 #include "wrench/simulation/Simulation.h"
18 #include "wrench/services/compute/ComputeServiceMessage.h"
19 #include "wrench/services/compute/cloud/CloudComputeServiceProperty.h"
20 #include "wrench/services/compute/cloud/CloudComputeServiceMessagePayload.h"
21 #include "wrench/simgrid_S4U_util/S4U_VirtualMachine.h"
22 #include "wrench/workflow/job/PilotJob.h"
29 class BareMetalComputeService;
38 std::map<std::string, std::string> default_property_values = {
45 std::map<std::string, double> default_messagepayload_values = {
73 std::string scratch_space_mount_point,
81 virtual std::string
createVM(
unsigned long num_cores,
86 virtual std::string
createVM(
unsigned long num_cores,
88 std::string desired_vm_name,
92 virtual void shutdownVM(
const std::string &vm_name);
94 virtual std::shared_ptr<BareMetalComputeService>
startVM(
const std::string &vm_name);
96 virtual std::shared_ptr<BareMetalComputeService>
getVMComputeService(
const std::string &vm_name);
100 virtual void suspendVM(
const std::string &vm_name);
102 virtual void resumeVM(
const std::string &vm_name);
104 virtual void destroyVM(
const std::string &vm_name);
106 virtual bool isVMRunning(
const std::string &vm_name);
110 virtual bool isVMDown(
const std::string &vm_name);
123 const std::map<std::string, std::string> &service_specific_args)
override;
126 const std::map<std::string, std::string> &service_specific_args)
override;
158 unsigned long requested_num_cores,
159 double requested_ram,
160 std::string desired_vm_name,
166 processStartVM(
const std::string &answer_mailbox,
const std::string &vm_name,
const std::string &pm_name);
168 virtual void processShutdownVM(
const std::string &answer_mailbox,
const std::string &vm_name);
170 virtual void processSuspendVM(
const std::string &answer_mailbox,
const std::string &vm_name);
172 virtual void processResumeVM(
const std::string &answer_mailbox,
const std::string &vm_name);
174 virtual void processDestroyVM(
const std::string &answer_mailbox,
const std::string &vm_name);
177 std::map<std::string, std::string> &service_specific_args);
180 std::map<std::string, std::string> &service_specific_args);
188 static unsigned long VM_ID;
201 std::map<std::string, std::pair<std::shared_ptr<S4U_VirtualMachine>, std::shared_ptr<BareMetalComputeService>>>
vm_list;
208 std::string findHost(
unsigned long desired_num_cores,
double desired_ram, std::string desired_host);
213 #endif //WRENCH_CLOUDSERVICE_H
virtual bool isVMRunning(const std::string &vm_name)
Method to check whether a VM is currently running.
Definition: CloudComputeService.cpp:491
void stopAllVMs()
Terminate all VMs.
Definition: CloudComputeService.cpp:1284
static const std::string CREATE_VM_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the service in answer to a VM creation request.
Definition: CloudComputeServiceMessagePayload.h:30
static const std::string SUBMIT_STANDARD_JOB_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the daemon to submit a standard job.
Definition: ComputeServiceMessagePayload.h:26
void submitStandardJob(std::shared_ptr< StandardJob > job, const std::map< std::string, std::string > &service_specific_args) override
Submit a standard job to the cloud service.
Definition: CloudComputeService.cpp:408
static const std::string SHUTDOWN_VM_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the service in answer to a VM shutdown request.
Definition: CloudComputeServiceMessagePayload.h:34
Top-level class for messages received/sent by a ComputeService.
Definition: ComputeServiceMessage.h:32
static const std::string DAEMON_STOPPED_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the daemon to confirm it has terminated.
Definition: ServiceMessagePayload.h:33
CloudComputeService(const std::string &hostname, std::vector< std::string > &execution_hosts, std::string scratch_space_mount_point, std::map< std::string, std::string > property_list={}, std::map< std::string, double > messagepayload_list={})
Constructor.
Definition: CloudComputeService.cpp:43
virtual void processBareMetalComputeServiceTermination(std::shared_ptr< BareMetalComputeService > cs, int exit_code)
Process a termination by a previously started bare_metal on a VM.
Definition: CloudComputeService.cpp:1319
void terminateStandardJob(std::shared_ptr< StandardJob > job) override
Terminate a standard job to the compute service (virtual)
Definition: CloudComputeService.cpp:472
virtual void suspendVM(const std::string &vm_name)
Suspend a running VM.
Definition: CloudComputeService.cpp:300
static const std::string RESOURCE_DESCRIPTION_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the daemon to ask it for information on its resour...
Definition: ComputeServiceMessagePayload.h:56
static const std::string SHUTDOWN_VM_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the service to request a VM shutdown.
Definition: CloudComputeServiceMessagePayload.h:32
std::map< std::string, double > used_ram_per_execution_host
Map of used RAM at the hosts.
Definition: CloudComputeService.h:195
virtual void processCreateVM(const std::string &answer_mailbox, unsigned long requested_num_cores, double requested_ram, std::string desired_vm_name, std::map< std::string, std::string > property_list, std::map< std::string, double > messagepayload_list)
Create a bare_metal VM on a physical machine.
Definition: CloudComputeService.cpp:711
std::map< std::string, unsigned long > used_cores_per_execution_host
Map of number of used cores at the hosts.
Definition: CloudComputeService.h:198
virtual void processShutdownVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM shutdown request
Definition: CloudComputeService.cpp:806
virtual void processResumeVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM resume request
Definition: CloudComputeService.cpp:1096
static const std::string START_VM_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the service in answer to a VM start request.
Definition: CloudComputeServiceMessagePayload.h:38
std::vector< std::string > execution_hosts
List of execution host names.
Definition: CloudComputeService.h:192
static const std::string SUSPEND_VM_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the service in answer to a VM suspend request.
Definition: CloudComputeServiceMessagePayload.h:42
The compute service base class.
Definition: ComputeService.h:33
static const std::string RESUME_VM_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the service to request a VM resume.
Definition: CloudComputeServiceMessagePayload.h:44
A cloud-based compute service that manages a set of physical hosts and controls access to their resou...
Definition: CloudComputeService.h:36
static const std::string GET_EXECUTION_HOSTS_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the service to request a get execution hosts.
Definition: CloudComputeServiceMessagePayload.h:24
std::map< std::string, std::pair< std::shared_ptr< S4U_VirtualMachine >, std::shared_ptr< BareMetalComputeService > > > vm_list
A map of VMs.
Definition: CloudComputeService.h:201
void validateProperties()
Validate the service's properties.
Definition: CloudComputeService.cpp:1350
static const std::string GET_EXECUTION_HOSTS_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the service in answer to a get execution hosts req...
Definition: CloudComputeServiceMessagePayload.h:26
std::vector< std::string > getExecutionHosts()
Get the list of execution hosts available to run VMs.
Definition: CloudComputeService.cpp:88
std::shared_ptr< SimulationMessage > sendRequest(std::string &answer_mailbox, ComputeServiceMessage *message)
Send a message request.
Definition: CloudComputeService.cpp:570
static const std::string SUBMIT_PILOT_JOB_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent from the daemon to acknowledge a pilot job submission...
Definition: ComputeServiceMessagePayload.h:40
static const std::string VM_RESOURCE_ALLOCATION_ALGORITHM
The VM resource allocation algorithm by which VMs are started on physical hosts. Possible values are:
Definition: CloudComputeServiceProperty.h:33
virtual void processSubmitPilotJob(const std::string &answer_mailbox, std::shared_ptr< PilotJob > job, std::map< std::string, std::string > &service_specific_args)
Process a submit pilot job request.
Definition: CloudComputeService.cpp:1196
static const std::string VM_BOOT_OVERHEAD_IN_SECONDS
The overhead, in seconds, to boot a VM.
Definition: CloudComputeServiceProperty.h:24
~CloudComputeService()
Destructor.
Definition: CloudComputeService.cpp:76
virtual bool isVMDown(const std::string &vm_name)
Method to check whether a VM is currently down.
Definition: CloudComputeService.cpp:509
void 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.
Definition: CloudComputeService.cpp:441
virtual void processDestroyVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM destruction request
Definition: CloudComputeService.cpp:1133
virtual void processSubmitStandardJob(const std::string &answer_mailbox, std::shared_ptr< StandardJob > job, std::map< std::string, std::string > &service_specific_args)
Process a submit standard job request.
Definition: CloudComputeService.cpp:1172
static const std::string DESTROY_VM_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the service in answer to a VM destruction request.
Definition: CloudComputeServiceMessagePayload.h:50
virtual bool isVMSuspended(const std::string &vm_name)
Method to check whether a VM is currently running.
Definition: CloudComputeService.cpp:527
virtual bool processNextMessage()
Wait for and react to any incoming message.
Definition: CloudComputeService.cpp:598
virtual std::shared_ptr< BareMetalComputeService > startVM(const std::string &vm_name)
Start a VM.
Definition: CloudComputeService.cpp:229
std::map< std::string, double > messagepayload_list
The service's messagepayload list.
Definition: Service.h:112
static const std::string CREATE_VM_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the service to request a VM creation.
Definition: CloudComputeServiceMessagePayload.h:28
static const std::string RESOURCE_DESCRIPTION_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the daemon to state information on its resources.
Definition: ComputeServiceMessagePayload.h:58
static const std::string STOP_DAEMON_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the daemon to terminate it.
Definition: ServiceMessagePayload.h:31
virtual void destroyVM(const std::string &vm_name)
Destroy a VM.
Definition: CloudComputeService.cpp:371
std::string hostname
The name of the host on which the daemon is running.
Definition: S4U_Daemon.h:51
static const std::string SUBMIT_STANDARD_JOB_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the daemon to acknowledge a standard job submissio...
Definition: ComputeServiceMessagePayload.h:28
A class that provides basic simulation methods. Once the simulation object has been explicitly or imp...
Definition: Simulation.h:46
static const std::string START_VM_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the service to request a VM start.
Definition: CloudComputeServiceMessagePayload.h:36
virtual void resumeVM(const std::string &vm_name)
Resume a suspended VM.
Definition: CloudComputeService.cpp:335
virtual std::string createVM(unsigned long num_cores, double ram_memory, std::map< std::string, std::string > property_list={}, std::map< std::string, double > messagepayload_list={})
Create a bare_metal VM (balances load on execution hosts)
Definition: CloudComputeService.cpp:124
static const std::string DESTROY_VM_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the service to request a VM destruction.
Definition: CloudComputeServiceMessagePayload.h:48
static const std::string SUSPEND_VM_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the service to request a VM suspend.
Definition: CloudComputeServiceMessagePayload.h:40
static const std::string SUBMIT_PILOT_JOB_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the daemon to submit a pilot job.
Definition: ComputeServiceMessagePayload.h:38
virtual void processGetExecutionHosts(const std::string &answer_mailbox)
Process a execution host list request.
Definition: CloudComputeService.cpp:690
static const std::string SUPPORTS_PILOT_JOBS
Whether the compute service supports pilot jobs (true or false)
Definition: ComputeServiceProperty.h:26
virtual std::shared_ptr< BareMetalComputeService > getVMComputeService(const std::string &vm_name)
Get the compute service running on a VM, if any.
Definition: CloudComputeService.cpp:268
virtual void processGetResourceInformation(const std::string &answer_mailbox)
Process a "get resource information message".
Definition: CloudComputeService.cpp:1215
static const std::string RESUME_VM_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent by the service in answer to a VM resume request.
Definition: CloudComputeServiceMessagePayload.h:46
int main() override
Main method of the daemon.
Definition: CloudComputeService.cpp:544
virtual void processSuspendVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM suspend request
Definition: CloudComputeService.cpp:1051
virtual void shutdownVM(const std::string &vm_name)
Shutdown an active VM.
Definition: CloudComputeService.cpp:192
virtual std::string getVMPhysicalHostname(const std::string &vm_name)
Get the name of the physical host on which a VM is running.
Definition: CloudComputeService.cpp:285
virtual void processStartVM(const std::string &answer_mailbox, const std::string &vm_name, const std::string &pm_name)
: Process a VM start request by startibnng a VM on a host (using best fit for RAM first,...
Definition: CloudComputeService.cpp:949
std::map< std::string, std::string > property_list
The service's property list.
Definition: Service.h:109
void terminatePilotJob(std::shared_ptr< PilotJob > job) override
non-implemented
Definition: CloudComputeService.cpp:480
static const std::string SUPPORTS_STANDARD_JOBS
Whether the compute service supports standard jobs (true or false)
Definition: ComputeServiceProperty.h:24