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/job/PilotJob.h"
29 class BareMetalComputeService;
38 WRENCH_PROPERTY_COLLECTION_TYPE default_property_values = {
43 WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE default_messagepayload_values = {
73 std::string scratch_space_mount_point,
74 WRENCH_PROPERTY_COLLECTION_TYPE property_list = {},
75 WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list = {});
85 virtual std::string
createVM(
unsigned long num_cores,
87 WRENCH_PROPERTY_COLLECTION_TYPE property_list = {},
88 WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list = {});
90 virtual std::string
createVM(
unsigned long num_cores,
92 std::string desired_vm_name,
93 WRENCH_PROPERTY_COLLECTION_TYPE property_list = {},
94 WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list = {});
96 virtual void shutdownVM(
const std::string &vm_name);
100 virtual std::shared_ptr<BareMetalComputeService>
startVM(
const std::string &vm_name);
102 virtual std::shared_ptr<BareMetalComputeService>
getVMComputeService(
const std::string &vm_name);
106 virtual void suspendVM(
const std::string &vm_name);
108 virtual void resumeVM(
const std::string &vm_name);
110 virtual void destroyVM(
const std::string &vm_name);
112 virtual bool isVMRunning(
const std::string &vm_name);
116 virtual bool isVMDown(
const std::string &vm_name);
129 void submitCompoundJob(std::shared_ptr<CompoundJob> job,
130 const std::map<std::string, std::string> &service_specific_args)
override {};
132 void terminateCompoundJob(std::shared_ptr<CompoundJob> job)
override {};
134 void validateProperties();
151 std::shared_ptr<SimulationMessage> sendRequest(simgrid::s4u::Mailbox *answer_mailbox, ComputeServiceMessage *message);
153 virtual bool processNextMessage();
155 virtual void processGetResourceInformation(simgrid::s4u::Mailbox *answer_mailbox,
156 const std::string &key);
158 virtual void processGetExecutionHosts(simgrid::s4u::Mailbox *answer_mailbox);
160 virtual void processCreateVM(simgrid::s4u::Mailbox *answer_mailbox,
161 unsigned long requested_num_cores,
162 double requested_ram,
163 std::string desired_vm_name,
164 WRENCH_PROPERTY_COLLECTION_TYPE property_list,
165 WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list
169 processStartVM(simgrid::s4u::Mailbox *answer_mailbox,
const std::string &vm_name,
const std::string &pm_name);
171 virtual void processShutdownVM(simgrid::s4u::Mailbox *answer_mailbox,
172 const std::string &vm_name,
173 bool send_failure_notifications,
176 virtual void processSuspendVM(simgrid::s4u::Mailbox *answer_mailbox,
const std::string &vm_name);
178 virtual void processResumeVM(simgrid::s4u::Mailbox *answer_mailbox,
const std::string &vm_name);
180 virtual void processDestroyVM(simgrid::s4u::Mailbox *answer_mailbox,
const std::string &vm_name);
189 processBareMetalComputeServiceTermination(std::shared_ptr<BareMetalComputeService> cs,
int exit_code);
191 virtual void processIsThereAtLeastOneHostWithAvailableResources(
192 simgrid::s4u::Mailbox *answer_mailbox,
unsigned long num_cores,
double ram);
198 static unsigned long VM_ID;
211 std::map<std::string, std::pair<std::shared_ptr<S4U_VirtualMachine>, std::shared_ptr<BareMetalComputeService>>>
vm_list;
218 std::string findHost(
unsigned long desired_num_cores,
double desired_ram, std::string desired_host);
223 #endif //WRENCH_CLOUDSERVICE_H
virtual bool isVMRunning(const std::string &vm_name)
Method to check whether a VM is currently running.
Definition: CloudComputeService.cpp:415
static const std::string IS_THERE_AT_LEAST_ONE_HOST_WITH_AVAILABLE_RESOURCES_ANSWER_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the daemon to ask is one host has some resources a...
Definition: ComputeServiceMessagePayload.h:78
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:27
TerminationCause
Job termination cause enum.
Definition: ComputeService.h:67
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
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:37
virtual void suspendVM(const std::string &vm_name)
Suspend a running VM.
Definition: CloudComputeService.cpp:311
static const std::string RESOURCE_DESCRIPTION_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message sent to the daemon to request information on its resources...
Definition: ComputeServiceMessagePayload.h:74
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:205
virtual bool supportsStandardJobs() override
Returns true if the service supports standard jobs.
Definition: CloudComputeService.cpp:1288
std::map< std::string, unsigned long > used_cores_per_execution_host
Map of number of used cores at the hosts.
Definition: CloudComputeService.h:208
static const std::string IS_THERE_AT_LEAST_ONE_HOST_WITH_AVAILABLE_RESOURCES_REQUEST_MESSAGE_PAYLOAD
The number of bytes in the control message by the the daemon to state whether one host has some resou...
Definition: ComputeServiceMessagePayload.h:80
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:202
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:34
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
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)
Definition: CloudComputeService.cpp:120
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:211
Definition: Action.cpp:28
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:85
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:56
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 bool supportsPilotJobs() override
Returns true if the service supports pilot jobs.
Definition: CloudComputeService.cpp:1304
static const std::string VM_BOOT_OVERHEAD_IN_SECONDS
The overhead, in seconds, to boot a VM.
Definition: CloudComputeServiceProperty.h:24
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.
Definition: CloudComputeService.cpp:41
virtual bool isVMDown(const std::string &vm_name)
Method to check whether a VM is currently down.
Definition: CloudComputeService.cpp:433
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:451
virtual std::shared_ptr< BareMetalComputeService > startVM(const std::string &vm_name)
Start a VM.
Definition: CloudComputeService.cpp:242
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:76
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:35
virtual void destroyVM(const std::string &vm_name)
Destroy a VM.
Definition: CloudComputeService.cpp:382
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:29
A class that provides basic simulation methods. Once the simulation object has been explicitly or imp...
Definition: Simulation.h:48
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:346
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:54
virtual std::shared_ptr< BareMetalComputeService > getVMComputeService(const std::string &vm_name)
Get the compute service running on a VM, if any.
Definition: CloudComputeService.cpp:279
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
virtual bool supportsCompoundJobs() override
Returns true if the service supports compound jobs.
Definition: CloudComputeService.cpp:1296
virtual void shutdownVM(const std::string &vm_name)
Shutdown an active VM.
Definition: CloudComputeService.cpp:189
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:296