Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add signals for VM live migration start/end
[simgrid.git] / src / plugins / vm / s4u_VirtualMachine.cpp
1 /* Copyright (c) 2015-2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "simgrid/s4u/Actor.hpp"
7 #include "simgrid/vm.h"
8 #include "src/include/surf/surf.hpp"
9 #include "src/plugins/vm/VirtualMachineImpl.hpp"
10 #include "src/plugins/vm/VmHostExt.hpp"
11 #include "src/simix/smx_host_private.hpp"
12 #include "src/surf/cpu_cas01.hpp"
13
14 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_vm, "S4U virtual machines");
15
16
17 namespace simgrid {
18 namespace s4u {
19 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_start;
20 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_started;
21 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_shutdown;
22 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_suspend;
23 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_resume;
24 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_migration_start;
25 simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_migration_end;
26
27 VirtualMachine::VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount)
28     : VirtualMachine(name, physical_host, core_amount, 1024)
29 {
30 }
31
32 VirtualMachine::VirtualMachine(const char* name, s4u::Host* physical_host, int core_amount, size_t ramsize)
33     : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, physical_host, core_amount, ramsize))
34 {
35   XBT_DEBUG("Create VM %s", name);
36
37   /* Currently, a VM uses the network resource of its physical host */
38   pimpl_netpoint = physical_host->pimpl_netpoint;
39
40   // Create a VCPU for this VM
41   std::vector<double> speeds;
42   for (int i = 0; i < physical_host->get_pstate_count(); i++)
43     speeds.push_back(physical_host->get_pstate_speed(i));
44
45   surf_cpu_model_vm->create_cpu(this, &speeds, physical_host->get_core_count());
46   if (physical_host->get_pstate() != 0)
47     set_pstate(physical_host->get_pstate());
48 }
49
50 VirtualMachine::~VirtualMachine()
51 {
52   on_destruction(*this);
53
54   XBT_DEBUG("destroy %s", get_cname());
55
56   /* Don't free these things twice: they are the ones of my physical host */
57   pimpl_netpoint = nullptr;
58 }
59
60 void VirtualMachine::start()
61 {
62   on_start(*this);
63
64   simgrid::simix::simcall([this]() {
65     simgrid::vm::VmHostExt::ensureVmExtInstalled();
66
67     simgrid::s4u::Host* pm = this->pimpl_vm_->get_physical_host();
68     if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
69       pm->extension_set(new simgrid::vm::VmHostExt());
70
71     long pm_ramsize   = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
72     int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
73     long vm_ramsize   = this->get_ramsize();
74
75     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
76       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
77       long total_ramsize_of_vms = 0;
78       for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
79         if (pm == ws_vm->get_pm())
80           total_ramsize_of_vms += ws_vm->get_ramsize();
81
82       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
83         XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
84                  this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
85         THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->get_cname(),
86                this->get_cname());
87       }
88     }
89
90     this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
91   });
92
93   on_started(*this);
94 }
95
96 void VirtualMachine::suspend()
97 {
98   on_suspend(*this);
99   smx_actor_t issuer = SIMIX_process_self();
100   simgrid::simix::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
101 }
102
103 void VirtualMachine::resume()
104 {
105   pimpl_vm_->resume();
106   on_resume(*this);
107 }
108
109 void VirtualMachine::shutdown()
110 {
111   smx_actor_t issuer = SIMIX_process_self();
112   simgrid::simix::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
113   on_shutdown(*this);
114 }
115
116 void VirtualMachine::destroy()
117 {
118   /* First, terminate all processes on the VM if necessary */
119   shutdown();
120
121   /* Then, destroy the VM object */
122   Host::destroy();
123 }
124
125 simgrid::s4u::Host* VirtualMachine::get_pm()
126 {
127   return pimpl_vm_->get_physical_host();
128 }
129
130 void VirtualMachine::set_pm(simgrid::s4u::Host* pm)
131 {
132   simgrid::simix::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
133 }
134
135 VirtualMachine::state VirtualMachine::get_state()
136 {
137   return simgrid::simix::simcall([this]() { return pimpl_vm_->get_state(); });
138 }
139
140 size_t VirtualMachine::get_ramsize()
141 {
142   return pimpl_vm_->get_ramsize();
143 }
144
145 void VirtualMachine::set_ramsize(size_t ramsize)
146 {
147   pimpl_vm_->set_ramsize(ramsize);
148 }
149 /** @brief Set a CPU bound for a given VM.
150  *  @ingroup msg_VMs
151  *
152  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
153  *
154  * For example,
155  *  On PM0, there are Task1 and VM0.
156  *  On VM0, there is Task2.
157  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
158  * Then,
159  *  Task1\@PM0 gets 50%.
160  *  Task2\@VM0 gets 25%.
161  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
162  *
163  * This is because a VM has the dummy CPU action in the PM layer. Putting a task on the VM does not affect the bound of
164  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
165  *
166  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
167  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
168  * on the VM in share_resource() or we have to trap both the start and end of task execution.
169  *
170  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
171  *
172  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
173  *    computation task (or a VM) never exceeds the capacity of a CPU core.
174  */
175 void VirtualMachine::set_bound(double bound)
176 {
177   simgrid::simix::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
178 }
179
180 } // namespace simgrid
181 } // namespace s4u
182
183 /* **************************** Public C interface *************************** */
184
185 /** @brief Create a new VM object with the default parameters
186  * A VM is treated as a host. The name of the VM must be unique among all hosts.
187  */
188 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
189 {
190   return sg_vm_create_multicore(pm, name, 1);
191 }
192 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
193  * A VM is treated as a host. The name of the VM must be unique among all hosts.
194  */
195 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
196 {
197   xbt_assert(sg_host_by_name(name) == nullptr,
198              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
199
200   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
201 }
202
203 const char* sg_vm_get_name(sg_vm_t vm)
204 {
205   return vm->get_cname();
206 }
207
208 /** @brief Get the physical host of a given VM. */
209 sg_host_t sg_vm_get_pm(sg_vm_t vm)
210 {
211   return vm->get_pm();
212 }
213
214 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
215 {
216   vm->set_ramsize(size);
217 }
218
219 size_t sg_vm_get_ramsize(sg_vm_t vm)
220 {
221   return vm->get_ramsize();
222 }
223
224 void sg_vm_set_bound(sg_vm_t vm, double bound)
225 {
226   vm->set_bound(bound);
227 }
228
229 /** @brief Returns whether the given VM has just created, not running. */
230 int sg_vm_is_created(sg_vm_t vm)
231 {
232   return vm->get_state() == simgrid::s4u::VirtualMachine::state::CREATED;
233 }
234
235 /** @brief Returns whether the given VM is currently running */
236 int sg_vm_is_running(sg_vm_t vm)
237 {
238   return vm->get_state() == simgrid::s4u::VirtualMachine::state::RUNNING;
239 }
240
241 /** @brief Returns whether the given VM is currently suspended, not running. */
242 int sg_vm_is_suspended(sg_vm_t vm)
243 {
244   return vm->get_state() == simgrid::s4u::VirtualMachine::state::SUSPENDED;
245 }
246
247 /** @brief Start a vm (i.e., boot the guest operating system)
248  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
249  */
250 void sg_vm_start(sg_vm_t vm)
251 {
252   vm->start();
253 }
254
255 /** @brief Immediately suspend the execution of all processes within the given VM.
256  *
257  * This function stops the execution of the VM. All the processes on this VM
258  * will pause. The state of the VM is preserved. We can later resume it again.
259  *
260  * No suspension cost occurs.
261  */
262 void sg_vm_suspend(sg_vm_t vm)
263 {
264   vm->suspend();
265 }
266
267 /** @brief Resume the execution of the VM. All processes on the VM run again.
268  * No resume cost occurs.
269  */
270 void sg_vm_resume(sg_vm_t vm)
271 {
272   vm->resume();
273 }
274
275 /** @brief Immediately kills all processes within the given VM.
276  * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
277  *
278  * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
279  */
280 void sg_vm_shutdown(sg_vm_t vm)
281 {
282   vm->shutdown();
283 }
284
285 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
286 void sg_vm_destroy(sg_vm_t vm)
287 {
288   vm->destroy();
289 }