Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6f436a545925d44eaa81147324758ee0e0377a50
[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 "src/instr/instr_private.hpp"
8 #include "src/plugins/vm/VirtualMachineImpl.hpp"
9 #include "src/plugins/vm/VmHostExt.hpp"
10 #include "src/simix/smx_host_private.hpp"
11 #include "src/surf/cpu_cas01.hpp"
12
13 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_vm, "S4U virtual machines");
14
15 simgrid::xbt::signal<void(simgrid::s4u::VirtualMachine*)> simgrid::s4u::VirtualMachine::onVmShutdown;
16
17 namespace simgrid {
18 namespace s4u {
19
20 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount)
21     : VirtualMachine(name, pm, coreAmount, 1024)
22 {
23 }
24
25 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount, size_t ramsize)
26     : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, pm, coreAmount, ramsize))
27 {
28   XBT_DEBUG("Create VM %s", name);
29
30   /* Currently, a VM uses the network resource of its physical host */
31   pimpl_netpoint = pm->pimpl_netpoint;
32   // Create a VCPU for this VM
33   surf::CpuCas01* sub_cpu = dynamic_cast<surf::CpuCas01*>(pm->pimpl_cpu);
34
35   pimpl_cpu = surf_cpu_model_vm->createCpu(this, sub_cpu->getSpeedPeakList(), coreAmount);
36   if (sub_cpu->getPState() != 0)
37     pimpl_cpu->setPState(sub_cpu->getPState());
38
39   /* Make a process container */
40   extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
41
42   if (TRACE_vm_is_enabled()) {
43     container_t host_container = instr::Container::byName(pm->get_name());
44     new instr::Container(name, "MSG_VM", host_container);
45     instr::Container::byName(get_name())->getState("MSG_VM_STATE")->addEntityValue("start", "0 0 1"); // start is blue
46     instr::Container::byName(get_name())
47         ->getState("MSG_VM_STATE")
48         ->addEntityValue("suspend", "1 0 0"); // suspend is red
49   }
50 }
51
52 VirtualMachine::~VirtualMachine()
53 {
54   onDestruction(*this);
55
56   XBT_DEBUG("destroy %s", get_cname());
57
58   /* FIXME: this is really strange that everything fails if the next line is removed.
59    * This is as if we shared these data with the PM, which definitely should not be the case...
60    *
61    * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
62    * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
63    */
64   extension_set<simgrid::simix::Host>(nullptr);
65
66   /* Don't free these things twice: they are the ones of my physical host */
67   pimpl_netpoint = nullptr;
68
69   if (TRACE_vm_is_enabled())
70     simgrid::instr::Container::byName(get_name())->removeFromParent();
71 }
72
73 void VirtualMachine::start()
74 {
75   if (TRACE_vm_is_enabled())
76     simgrid::instr::Container::byName(get_name())->getState("MSG_VM_STATE")->pushEvent("start");
77
78   simgrid::simix::kernelImmediate([this]() {
79     simgrid::vm::VmHostExt::ensureVmExtInstalled();
80
81     simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
82     if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
83       pm->extension_set(new simgrid::vm::VmHostExt());
84
85     long pm_ramsize   = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
86     int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
87     long vm_ramsize   = this->getRamsize();
88
89     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
90       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
91       long total_ramsize_of_vms = 0;
92       for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
93         if (pm == ws_vm->getPm())
94           total_ramsize_of_vms += ws_vm->getRamsize();
95
96       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
97         XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
98                  this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
99         THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->get_cname(),
100                this->get_cname());
101       }
102     }
103
104     this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
105   });
106
107   if (TRACE_vm_is_enabled())
108     simgrid::instr::Container::byName(get_name())->getState("MSG_VM_STATE")->popEvent();
109 }
110
111 void VirtualMachine::suspend()
112 {
113   smx_actor_t issuer = SIMIX_process_self();
114   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->suspend(issuer); });
115   if (TRACE_vm_is_enabled())
116     simgrid::instr::Container::byName(get_name())->getState("MSG_VM_STATE")->pushEvent("suspend");
117   XBT_DEBUG("vm_suspend done");
118 }
119
120 void VirtualMachine::resume()
121 {
122   pimpl_vm_->resume();
123   if (TRACE_vm_is_enabled())
124     simgrid::instr::Container::byName(get_name())->getState("MSG_VM_STATE")->popEvent();
125 }
126
127 void VirtualMachine::shutdown()
128 {
129   smx_actor_t issuer = SIMIX_process_self();
130   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->shutdown(issuer); });
131   onVmShutdown(this);
132 }
133
134 void VirtualMachine::destroy()
135 {
136   /* First, terminate all processes on the VM if necessary */
137   shutdown();
138
139   /* Then, destroy the VM object */
140   Host::destroy();
141 }
142
143 simgrid::s4u::Host* VirtualMachine::getPm()
144 {
145   return pimpl_vm_->getPm();
146 }
147
148 void VirtualMachine::setPm(simgrid::s4u::Host* pm)
149 {
150   simgrid::simix::kernelImmediate([this, pm]() { pimpl_vm_->setPm(pm); });
151 }
152
153 e_surf_vm_state_t VirtualMachine::getState()
154 {
155   return simgrid::simix::kernelImmediate([this]() { return pimpl_vm_->getState(); });
156 }
157
158 size_t VirtualMachine::getRamsize()
159 {
160   return pimpl_vm_->getRamsize();
161 }
162
163 void VirtualMachine::setRamsize(size_t ramsize)
164 {
165   pimpl_vm_->setRamsize(ramsize);
166 }
167 /** @brief Set a CPU bound for a given VM.
168  *  @ingroup msg_VMs
169  *
170  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
171  *
172  * For example,
173  *  On PM0, there are Task1 and VM0.
174  *  On VM0, there is Task2.
175  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
176  * Then,
177  *  Task1\@PM0 gets 50%.
178  *  Task2\@VM0 gets 25%.
179  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
180  *
181  * 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
182  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
183  *
184  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
185  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
186  * on the VM in share_resource() or we have to trap both the start and end of task execution.
187  *
188  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
189  *
190  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
191  *    computation task (or a VM) never exceeds the capacity of a CPU core.
192  */
193 void VirtualMachine::setBound(double bound)
194 {
195   simgrid::simix::kernelImmediate([this, bound]() { pimpl_vm_->setBound(bound); });
196 }
197
198 } // namespace simgrid
199 } // namespace s4u
200
201 /* **************************** Public C interface *************************** */
202
203 /** @brief Create a new VM object with the default parameters
204  * A VM is treated as a host. The name of the VM must be unique among all hosts.
205  */
206 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
207 {
208   return sg_vm_create_multicore(pm, name, 1);
209 }
210 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
211  * A VM is treated as a host. The name of the VM must be unique among all hosts.
212  */
213 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
214 {
215   xbt_assert(sg_host_by_name(name) == nullptr,
216              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
217
218   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
219 }
220
221 const char* sg_vm_get_name(sg_vm_t vm)
222 {
223   return vm->get_cname();
224 }
225
226 /** @brief Get the physical host of a given VM. */
227 sg_host_t sg_vm_get_pm(sg_vm_t vm)
228 {
229   return vm->getPm();
230 }
231
232 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
233 {
234   vm->setRamsize(size);
235 }
236
237 size_t sg_vm_get_ramsize(sg_vm_t vm)
238 {
239   return vm->getRamsize();
240 }
241
242 void sg_vm_set_bound(sg_vm_t vm, double bound)
243 {
244   vm->setBound(bound);
245 }
246
247 /** @brief Returns whether the given VM has just created, not running. */
248 int sg_vm_is_created(sg_vm_t vm)
249 {
250   return vm->getState() == SURF_VM_STATE_CREATED;
251 }
252
253 /** @brief Returns whether the given VM is currently running */
254 int sg_vm_is_running(sg_vm_t vm)
255 {
256   return vm->getState() == SURF_VM_STATE_RUNNING;
257 }
258
259 /** @brief Returns whether the given VM is currently suspended, not running. */
260 int sg_vm_is_suspended(sg_vm_t vm)
261 {
262   return vm->getState() == SURF_VM_STATE_SUSPENDED;
263 }
264
265 /** @brief Start a vm (i.e., boot the guest operating system)
266  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
267  */
268 void sg_vm_start(sg_vm_t vm)
269 {
270   vm->start();
271 }
272
273 /** @brief Immediately suspend the execution of all processes within the given VM.
274  *
275  * This function stops the execution of the VM. All the processes on this VM
276  * will pause. The state of the VM is preserved. We can later resume it again.
277  *
278  * No suspension cost occurs.
279  */
280 void sg_vm_suspend(sg_vm_t vm)
281 {
282   vm->suspend();
283 }
284
285 /** @brief Resume the execution of the VM. All processes on the VM run again.
286  * No resume cost occurs.
287  */
288 void sg_vm_resume(sg_vm_t vm)
289 {
290   vm->resume();
291 }
292
293 /** @brief Immediately kills all processes within the given VM.
294  * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
295  *
296  * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
297  */
298 void sg_vm_shutdown(sg_vm_t vm)
299 {
300   vm->shutdown();
301 }
302
303 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
304 void sg_vm_destroy(sg_vm_t vm)
305 {
306   vm->destroy();
307 }