CloudComputeService.h
1 
11 #ifndef WRENCH_CLOUDSERVICE_H
12 #define WRENCH_CLOUDSERVICE_H
13 
14 #include <map>
15 #include <simgrid/s4u/VirtualMachine.hpp>
16 
17 #include "wrench/simulation/Simulation.h"
18 #include "wrench/services/compute/ComputeServiceMessage.h"
19 //#include "wrench/services/compute/ComputeService.h"
20 #include "wrench/services/compute/cloud/CloudComputeServiceProperty.h"
21 #include "wrench/services/compute/cloud/CloudComputeServiceMessagePayload.h"
22 #include "wrench/simgrid_S4U_util/S4U_VirtualMachine.h"
23 #include "wrench/workflow/job/PilotJob.h"
24 
25 
26 namespace wrench {
27 
28  class Simulation;
29 
30  class BareMetalComputeService;
31 
38 
39  private:
40  std::map<std::string, std::string> default_property_values = {
45  };
46 
47  std::map<std::string, double> default_messagepayload_values = {
70  };
71 
72  public:
73  CloudComputeService(const std::string &hostname,
74  std::vector<std::string> &execution_hosts,
75  std::string scratch_space_mount_point,
76  std::map<std::string, std::string> property_list = {},
77  std::map<std::string, double> messagepayload_list = {});
78 
79  /***********************/
81  /***********************/
82 
83  virtual std::string createVM(unsigned long num_cores,
84  double ram_memory,
85  std::map<std::string, std::string> property_list = {},
86  std::map<std::string, double> messagepayload_list = {});
87 
88  virtual std::string createVM(unsigned long num_cores,
89  double ram_memory,
90  std::string desired_vm_name,
91  std::map<std::string, std::string> property_list = {},
92  std::map<std::string, double> messagepayload_list = {});
93 
94  virtual void shutdownVM(const std::string &vm_name);
95 
96  virtual std::shared_ptr<BareMetalComputeService> startVM(const std::string &vm_name);
97 
98  virtual void suspendVM(const std::string &vm_name);
99 
100  virtual void resumeVM(const std::string &vm_name);
101 
102  virtual void destroyVM(const std::string &vm_name);
103 
104  virtual bool isVMRunning(const std::string &vm_name);
105  virtual bool isVMSuspended(const std::string &vm_name);
106  virtual bool isVMDown(const std::string &vm_name);
107 
108 
109 
110  std::vector<std::string> getExecutionHosts();
111 
112  /***********************/
114  /***********************/
115 
116  /***********************/
118  /***********************/
119  void submitStandardJob(StandardJob *job, std::map<std::string, std::string> &service_specific_args) override;
120 
121  void submitPilotJob(PilotJob *job, std::map<std::string, std::string> &service_specific_args) override;
122 
123  void terminateStandardJob(StandardJob *job) override;
124  void terminatePilotJob(PilotJob *job) override;
125 
126  void validateProperties();
127 
129 
130  /***********************/
132  /***********************/
133 
134  protected:
135  /***********************/
137  /***********************/
138 
139  friend class Simulation;
140 
141  int main() override;
142 
143  std::shared_ptr<SimulationMessage> sendRequest(std::string &answer_mailbox, ComputeServiceMessage *message);
144 
145  virtual bool processNextMessage();
146 
147  virtual void processGetResourceInformation(const std::string &answer_mailbox);
148 
149  virtual void processGetExecutionHosts(const std::string &answer_mailbox);
150 
151  virtual void processCreateVM(const std::string &answer_mailbox,
152  unsigned long requested_num_cores,
153  double requested_ram,
154  std::string desired_vm_name,
155  std::map<std::string, std::string> property_list,
156  std::map<std::string, double> messagepayload_list
157  );
158 
159 
160  virtual void processStartVM(const std::string &answer_mailbox, const std::string &vm_name, const std::string &pm_name);
161 
162  virtual void processShutdownVM(const std::string &answer_mailbox, const std::string &vm_name);
163 
164  virtual void processSuspendVM(const std::string &answer_mailbox, const std::string &vm_name);
165 
166  virtual void processResumeVM(const std::string &answer_mailbox, const std::string &vm_name);
167 
168  virtual void processDestroyVM(const std::string &answer_mailbox, const std::string &vm_name);
169 
170  virtual void processSubmitStandardJob(const std::string &answer_mailbox, StandardJob *job,
171  std::map<std::string, std::string> &service_specific_args);
172 
173  virtual void processSubmitPilotJob(const std::string &answer_mailbox, PilotJob *job,
174  std::map<std::string, std::string> &service_specific_args);
175 
176  virtual void processBareMetalComputeServiceTermination(std::shared_ptr<BareMetalComputeService> cs, int exit_code);
177 
178  void stopAllVMs();
179 
181  static unsigned long VM_ID;
185  std::vector<std::string> execution_hosts;
186 
188  std::map<std::string, double> used_ram_per_execution_host;
189 
191  std::map<std::string, unsigned long> used_cores_per_execution_host;
192 
194  std::map<std::string, std::pair<std::shared_ptr<S4U_VirtualMachine>, std::shared_ptr<BareMetalComputeService>>> vm_list;
195 
196  /***********************/
198  /***********************/
199 
200  private:
201  std::string findHost(unsigned long desired_num_cores, double desired_ram, std::string desired_host);
202 
203  };
204 }
205 
206 #endif //WRENCH_CLOUDSERVICE_H
virtual bool isVMRunning(const std::string &vm_name)
Method to check whether a VM is currently running.
Definition: CloudComputeService.cpp:469
void terminatePilotJob(PilotJob *job) override
non-implemented
Definition: CloudComputeService.cpp:457
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.
Definition: CloudComputeService.cpp:1199
void stopAllVMs()
Terminate all VMs.
Definition: CloudComputeService.cpp:1289
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
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 BareMetalComputeService on a VM.
Definition: CloudComputeService.cpp:1324
virtual void suspendVM(const std::string &vm_name)
Suspend a running VM.
Definition: CloudComputeService.cpp:270
void submitStandardJob(StandardJob *job, std::map< std::string, std::string > &service_specific_args) override
Submit a standard job to the cloud service.
Definition: CloudComputeService.cpp:384
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:188
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 BareMetalComputeService VM on a physical machine.
Definition: CloudComputeService.cpp:697
std::map< std::string, unsigned long > used_cores_per_execution_host
Map of number of used cores at the hosts.
Definition: CloudComputeService.h:191
virtual void processShutdownVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM shutdown request
Definition: CloudComputeService.cpp:792
virtual void processResumeVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM resume request
Definition: CloudComputeService.cpp:1093
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:185
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:35
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:37
void submitPilotJob(PilotJob *job, std::map< std::string, std::string > &service_specific_args) override
Asynchronously submit a pilot job to the cloud service.
Definition: CloudComputeService.cpp:418
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
A standard (i.e., non-pilot) workflow job that can be submitted to a ComputeService by a WMS (via a J...
Definition: StandardJob.h:37
std::map< std::string, std::pair< std::shared_ptr< S4U_VirtualMachine >, std::shared_ptr< BareMetalComputeService > > > vm_list
A map of VMs.
Definition: CloudComputeService.h:194
Definition: Alarm.cpp:20
void validateProperties()
Validate the service's properties.
Definition: CloudComputeService.cpp:1357
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:552
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
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:488
virtual void processDestroyVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM destruction request
Definition: CloudComputeService.cpp:1134
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:507
virtual bool processNextMessage()
Wait for and react to any incoming message.
Definition: CloudComputeService.cpp:581
virtual std::shared_ptr< BareMetalComputeService > startVM(const std::string &vm_name)
Start a VM.
Definition: CloudComputeService.cpp:233
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
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.
Definition: CloudComputeService.cpp:1173
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:345
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:45
void terminateStandardJob(StandardJob *job) override
Terminate a standard job to the compute service (virtual)
Definition: CloudComputeService.cpp:449
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:307
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 BareMetalComputeService 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:675
static const std::string SUPPORTS_PILOT_JOBS
Whether the compute service supports pilot jobs (true or false)
Definition: ComputeServiceProperty.h:26
A pilot (i.e., non-standard) workflow job that can be submitted to a ComputeService by a WMS (via a J...
Definition: PilotJob.h:29
virtual void processGetResourceInformation(const std::string &answer_mailbox)
Process a "get resource information message".
Definition: CloudComputeService.cpp:1220
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:526
virtual void processSuspendVM(const std::string &answer_mailbox, const std::string &vm_name)
: Process a VM suspend request
Definition: CloudComputeService.cpp:1046
virtual void shutdownVM(const std::string &vm_name)
Shutdown an active VM.
Definition: CloudComputeService.cpp:194
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:940
std::map< std::string, std::string > property_list
The service's property list.
Definition: Service.h:109
static const std::string SUPPORTS_STANDARD_JOBS
Whether the compute service supports standard jobs (true or false)
Definition: ComputeServiceProperty.h:24