Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / src / plugins / vm / VirtualMachineImpl.cpp
1 /* Copyright (c) 2013-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "src/plugins/vm/VirtualMachineImpl.hpp"
8 #include "src/simix/ActorImpl.hpp"
9 #include "src/simix/smx_host_private.h"
10
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
12
13 simgrid::vm::VMModel* surf_vm_model = nullptr;
14
15 void surf_vm_model_init_HL13()
16 {
17   if (surf_cpu_model_vm) {
18     surf_vm_model = new simgrid::vm::VMModel();
19     all_existing_models->push_back(surf_vm_model);
20   }
21 }
22
23 namespace simgrid {
24 namespace vm {
25
26 /*************
27  * Callbacks *
28  *************/
29
30 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmCreation;
31 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmDestruction;
32 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmStateChange;
33
34 /*********
35  * Model *
36  *********/
37
38 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
39
40 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
41  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system. */
42 // const double virt_overhead = 0.95;
43 const double virt_overhead = 1;
44
45 double VMModel::nextOccuringEvent(double now)
46 {
47   /* TODO: update action's cost with the total cost of processes on the VM. */
48
49   /* 1. Now we know how many resource should be assigned to each virtual
50    * machine. We update constraints of the virtual machine layer.
51    *
52    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
53    *     X1 + X2 = C       (Equation 1)
54    * where
55    *    the resource share of VM1: X1
56    *    the resource share of VM2: X2
57    *    the capacity of PM1: C
58    *
59    * Then, if we have two process (P1 and P2) on VM1.
60    *     X1_1 + X1_2 = X1  (Equation 2)
61    * where
62    *    the resource share of P1: X1_1
63    *    the resource share of P2: X1_2
64    *    the capacity of VM1: X1
65    *
66    * Equation 1 was solved in the physical machine layer.
67    * Equation 2 is solved in the virtual machine layer (here).
68    * X1 must be passed to the virtual machine laye as a constraint value.
69    **/
70
71   /* iterate for all virtual machines */
72   for (s4u::VirtualMachine* ws_vm : VirtualMachineImpl::allVms_) {
73     surf::Cpu* cpu = ws_vm->pimpl_cpu;
74     xbt_assert(cpu, "cpu-less host");
75
76     double solved_value = ws_vm->pimpl_vm_->action_->getVariable()->value;
77     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->cname(), ws_vm->pimpl_vm_->getPm()->cname());
78
79     // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
80     // cpu_cas01->constraint->bound = solved_value;
81     xbt_assert(cpu->getModel() == surf_cpu_model_vm);
82     lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
83     lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
84   }
85
86   /* 2. Calculate resource share at the virtual machine layer. */
87   adjustWeightOfDummyCpuActions();
88
89   /* 3. Ready. Get the next occuring event */
90   return surf_cpu_model_vm->nextOccuringEvent(now);
91 }
92
93 /************
94  * Resource *
95  ************/
96
97 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM)
98     : HostImpl(piface), hostPM_(host_PM)
99 {
100   /* Register this VM to the list of all VMs */
101   allVms_.push_back(piface);
102
103   /* We create cpu_action corresponding to a VM process on the host operating system. */
104   /* FIXME: TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
105   action_ = host_PM->pimpl_cpu->execution_start(0);
106
107   /* Initialize the VM parameters */
108   params_.ramsize = 0;
109
110   XBT_VERB("Create VM(%s)@PM(%s)", piface->cname(), hostPM_->cname());
111 }
112
113 extern "C" int
114     xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
115 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
116 VirtualMachineImpl::~VirtualMachineImpl()
117 {
118   onVmDestruction(this);
119   allVms_.erase(find(allVms_.begin(), allVms_.end(), piface_));
120
121   /* dirty page tracking */
122   unsigned int size          = xbt_dict_size(dp_objs);
123   static bool already_warned = false;
124   if (size > 0 && !already_warned) {
125     xbt_dict_cursor_t cursor = nullptr;
126     xbt_dict_cursor_first(dp_objs, &cursor);
127     XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
128              "If you don't understand why your task was not properly removed, please report that bug.\n"
129              "This is a known bug if you turned the host off during the VM execution.\n"
130              "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
131              "2016, sorry.",
132              size, (xbt_log_no_loc ? "(name hidden)" : xbt_dict_cursor_get_key(cursor)));
133     xbt_dict_cursor_free(&cursor);
134     already_warned = true;
135   }
136   xbt_dict_free(&dp_objs);
137
138   /* Free the cpu_action of the VM. */
139   XBT_ATTRIB_UNUSED int ret = action_->unref();
140   xbt_assert(ret == 1, "Bug: some resource still remains");
141 }
142
143 e_surf_vm_state_t VirtualMachineImpl::getState()
144 {
145   return vmState_;
146 }
147
148 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
149 {
150   vmState_ = state;
151 }
152 void VirtualMachineImpl::suspend(smx_actor_t issuer)
153 {
154   if (isMigrating)
155     THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->cname());
156   if (getState() != SURF_VM_STATE_RUNNING)
157     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->cname());
158   if (issuer->host == piface_)
159     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->cname(), piface_->cname());
160
161   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
162   XBT_DEBUG("suspend VM(%s), where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
163
164   action_->suspend();
165
166   smx_actor_t smx_process, smx_process_safe;
167   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
168     XBT_DEBUG("suspend %s", smx_process->name.c_str());
169     SIMIX_process_suspend(smx_process, issuer);
170   }
171
172   XBT_DEBUG("suspend all processes on the VM done done");
173
174   vmState_ = SURF_VM_STATE_SUSPENDED;
175 }
176
177 void VirtualMachineImpl::resume()
178 {
179   if (getState() != SURF_VM_STATE_SUSPENDED)
180     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->cname());
181
182   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
183   XBT_DEBUG("Resume VM %s, containing %d processes.", piface_->cname(), xbt_swag_size(process_list));
184
185   action_->resume();
186
187   smx_actor_t smx_process, smx_process_safe;
188   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
189     XBT_DEBUG("resume %s", smx_process->cname());
190     SIMIX_process_resume(smx_process);
191   }
192
193   vmState_ = SURF_VM_STATE_RUNNING;
194 }
195
196 /** @brief Power off a VM.
197  *
198  * All hosted processes will be killed, but the VM state is preserved on memory.
199  * It can later be restarted.
200  *
201  * @param issuer the actor requesting the shutdown
202  */
203 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
204 {
205   if (getState() != SURF_VM_STATE_RUNNING)
206     THROWF(vm_error, 0, "Cannot shutdown VM %s: it is not running", piface_->cname());
207
208   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
209   XBT_DEBUG("shutdown VM %s, that contains %d processes", piface_->cname(), xbt_swag_size(process_list));
210
211   smx_actor_t smx_process, smx_process_safe;
212   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
213     XBT_DEBUG("kill %s", smx_process->cname());
214     SIMIX_process_kill(smx_process, issuer);
215   }
216
217   setState(SURF_VM_STATE_CREATED);
218
219   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
220 }
221
222 /** @brief returns the physical machine on which the VM is running **/
223 s4u::Host* VirtualMachineImpl::getPm()
224 {
225   return hostPM_;
226 }
227
228 /** @brief Change the physical host on which the given VM is running
229  *
230  * This is an instantaneous migration.
231  */
232 void VirtualMachineImpl::setPm(s4u::Host* destination)
233 {
234   const char* vm_name     = piface_->cname();
235   const char* pm_name_src = hostPM_->cname();
236   const char* pm_name_dst = destination->cname();
237
238   /* update net_elm with that of the destination physical host */
239   piface_->pimpl_netpoint = destination->pimpl_netpoint;
240
241   hostPM_ = destination;
242
243   /* Update vcpu's action for the new pm */
244   /* create a cpu action bound to the pm model at the destination. */
245   surf::CpuAction* new_cpu_action = static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0));
246
247   surf::Action::State state = action_->getState();
248   if (state != surf::Action::State::done)
249     XBT_CRITICAL("FIXME: may need a proper handling, %d", static_cast<int>(state));
250   if (action_->getRemainsNoUpdate() > 0)
251     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
252
253   /* keep the bound value of the cpu action of the VM. */
254   double old_bound = action_->getBound();
255   if (old_bound != 0) {
256     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
257     new_cpu_action->setBound(old_bound);
258   }
259
260   XBT_ATTRIB_UNUSED int ret = action_->unref();
261   xbt_assert(ret == 1, "Bug: some resource still remains");
262
263   action_ = new_cpu_action;
264
265   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
266 }
267
268 sg_size_t VirtualMachineImpl::getRamsize()
269 {
270   return params_.ramsize;
271 }
272
273 void VirtualMachineImpl::setBound(double bound)
274 {
275   action_->setBound(bound);
276 }
277
278 void VirtualMachineImpl::getParams(vm_params_t params)
279 {
280   *params = params_;
281 }
282
283 void VirtualMachineImpl::setParams(vm_params_t params)
284 {
285   /* may check something here. */
286   params_ = *params;
287 }
288 }
289 }