Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of framagit.org:simgrid/simgrid
[simgrid.git] / src / plugins / vm / VirtualMachineImpl.cpp
1 /* Copyright (c) 2013-2019. 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 "src/plugins/vm/VirtualMachineImpl.hpp"
7 #include "src/include/surf/surf.hpp"
8 #include "src/simix/ActorImpl.hpp"
9 #include "src/simix/smx_host_private.hpp"
10 #include "src/kernel/activity/ExecImpl.hpp"
11 #include "xbt/asserts.h" // xbt_log_no_loc
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
14
15 simgrid::vm::VMModel* surf_vm_model = nullptr;
16
17 void surf_vm_model_init_HL13()
18 {
19   if (surf_cpu_model_vm != nullptr)
20     surf_vm_model = new simgrid::vm::VMModel();
21 }
22
23 namespace simgrid {
24 namespace vm {
25 /*************
26  * Callbacks *
27  *************/
28 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_creation;
29 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_destruction;
30 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_state_change;
31 /*********
32  * Model *
33  *********/
34
35 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
36
37 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
38  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
39  * FIXME: add a configuration flag for this
40  */
41 const double virt_overhead = 1; // 0.95
42
43 static void hostStateChange(s4u::Host& host)
44 {
45   if (host.is_off()) { // just turned off.
46     std::vector<s4u::VirtualMachine*> trash;
47     /* Find all VMs living on that host */
48     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
49       if (vm->get_pm() == &host)
50         trash.push_back(vm);
51     for (s4u::VirtualMachine* vm : trash)
52       vm->shutdown();
53   }
54 }
55
56 static void addActiveTask(kernel::activity::ExecImplPtr exec)
57 {
58   s4u::VirtualMachine *vm = dynamic_cast<s4u::VirtualMachine*>(exec->host_);
59   if (vm != nullptr) {
60     VirtualMachineImpl *vm_impl = vm->get_impl();
61     vm_impl->active_tasks_ = vm_impl->active_tasks_ + 1;
62     vm_impl->update_action_weight(); 
63   }
64 }
65
66 static void removeActiveTask(kernel::activity::ExecImplPtr exec)
67 {
68   s4u::VirtualMachine *vm = dynamic_cast<s4u::VirtualMachine*>(exec->host_);
69   if (vm != nullptr) {
70     VirtualMachineImpl *vm_impl = vm->get_impl();
71     vm_impl->active_tasks_ = vm_impl->active_tasks_ - 1;
72     vm_impl->update_action_weight();
73   }
74 }
75
76 VMModel::VMModel()
77 {
78   all_existing_models.push_back(this);
79   s4u::Host::on_state_change.connect(hostStateChange);
80   kernel::activity::ExecImpl::on_creation.connect(addActiveTask);
81   kernel::activity::ExecImpl::on_completion.connect(removeActiveTask);
82   kernel::activity::ExecImpl::on_resumed.connect(addActiveTask);
83   kernel::activity::ExecImpl::on_suspended.connect(removeActiveTask);  
84 }
85
86 double VMModel::next_occuring_event(double now)
87 {
88   /* TODO: update action's cost with the total cost of processes on the VM. */
89
90   /* 1. Now we know how many resource should be assigned to each virtual
91    * machine. We update constraints of the virtual machine layer.
92    *
93    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
94    *     X1 + X2 = C       (Equation 1)
95    * where
96    *    the resource share of VM1: X1
97    *    the resource share of VM2: X2
98    *    the capacity of PM1: C
99    *
100    * Then, if we have two process (P1 and P2) on VM1.
101    *     X1_1 + X1_2 = X1  (Equation 2)
102    * where
103    *    the resource share of P1: X1_1
104    *    the resource share of P2: X1_2
105    *    the capacity of VM1: X1
106    *
107    * Equation 1 was solved in the physical machine layer.
108    * Equation 2 is solved in the virtual machine layer (here).
109    * X1 must be passed to the virtual machine layer as a constraint value.
110    **/
111
112   /* iterate for all virtual machines */
113   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
114     surf::Cpu* cpu = ws_vm->pimpl_cpu;
115
116     double solved_value =
117         ws_vm->get_impl()->action_->get_variable()->get_value(); // this is X1 in comment above, what
118                                                                  // this VM got in the sharing on the PM
119     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
120
121     xbt_assert(cpu->get_model() == surf_cpu_model_vm);
122     kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
123     vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
124   }
125
126   /* 2. Ready. Get the next occurring event */
127   return surf_cpu_model_vm->next_occuring_event(now);
128 }
129
130 /************
131  * Resource *
132  ************/
133
134 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
135                                        int core_amount, size_t ramsize)
136     : HostImpl(piface), physical_host_(host_PM), core_amount_(core_amount), user_bound_(std::numeric_limits<double>::max()), ramsize_(ramsize)
137 {
138   /* Register this VM to the list of all VMs */
139   allVms_.push_back(piface);
140
141   /* We create cpu_action corresponding to a VM process on the host operating system. */
142   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
143   action_ = host_PM->pimpl_cpu->execution_start(0, core_amount);
144
145   // It's empty for now, so it should not request resources in the PM
146   update_action_weight();
147
148   XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), physical_host_->get_cname());
149   on_creation(this);
150 }
151
152 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
153 VirtualMachineImpl::~VirtualMachineImpl()
154 {
155   on_destruction(this);
156   /* I was already removed from the allVms set if the VM was destroyed cleanly */
157   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
158   if (iter != allVms_.end())
159     allVms_.erase(iter);
160
161   /* Free the cpu_action of the VM. */
162   XBT_ATTRIB_UNUSED bool ret = action_->unref();
163   xbt_assert(ret, "Bug: some resource still remains");
164 }
165
166 void VirtualMachineImpl::suspend(smx_actor_t issuer)
167 {
168   if (get_state() != s4u::VirtualMachine::state::RUNNING)
169     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->get_cname());
170   if (issuer->host_ == piface_)
171     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->get_cname(),
172            piface_->get_cname());
173
174   XBT_DEBUG("suspend VM(%s), where %zu processes exist", piface_->get_cname(), process_list_.size());
175
176   action_->suspend();
177
178   for (auto& smx_process : process_list_) {
179     XBT_DEBUG("suspend %s", smx_process.get_cname());
180     smx_process.suspend(issuer);
181   }
182
183   XBT_DEBUG("suspend all processes on the VM done done");
184
185   vm_state_ = s4u::VirtualMachine::state::SUSPENDED;
186 }
187
188 void VirtualMachineImpl::resume()
189 {
190   if (get_state() != s4u::VirtualMachine::state::SUSPENDED)
191     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->get_cname());
192
193   XBT_DEBUG("Resume VM %s, containing %zu processes.", piface_->get_cname(), process_list_.size());
194
195   action_->resume();
196
197   for (auto& smx_process : process_list_) {
198     XBT_DEBUG("resume %s", smx_process.get_cname());
199     smx_process.resume();
200   }
201
202   vm_state_ = s4u::VirtualMachine::state::RUNNING;
203 }
204
205 /** @brief Power off a VM.
206  *
207  * All hosted processes will be killed, but the VM state is preserved on memory.
208  * It can later be restarted.
209  *
210  * @param issuer the actor requesting the shutdown
211  */
212 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
213 {
214   if (get_state() != s4u::VirtualMachine::state::RUNNING) {
215     const char* stateName = "(unknown state)";
216     switch (get_state()) {
217       case s4u::VirtualMachine::state::CREATED:
218         stateName = "created, but not yet started";
219         break;
220       case s4u::VirtualMachine::state::SUSPENDED:
221         stateName = "suspended";
222         break;
223       case s4u::VirtualMachine::state::DESTROYED:
224         stateName = "destroyed";
225         break;
226       default: /* SURF_VM_STATE_RUNNING or unexpected values */
227         THROW_IMPOSSIBLE;
228         break;
229     }
230     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
231   }
232
233   XBT_DEBUG("shutdown VM %s, that contains %zu processes", piface_->get_cname(), process_list_.size());
234
235   for (auto& smx_process : process_list_) {
236     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process.get_cname(),
237               smx_process.host_->get_cname(), issuer->get_cname());
238     SIMIX_process_kill(&smx_process, issuer);
239   }
240
241   set_state(s4u::VirtualMachine::state::DESTROYED);
242
243   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
244 }
245
246 /** @brief Change the physical host on which the given VM is running
247  *
248  * This is an instantaneous migration.
249  */
250 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
251 {
252   std::string vm_name     = piface_->get_name();
253   std::string pm_name_src = physical_host_->get_name();
254   std::string pm_name_dst = destination->get_name();
255
256   /* update net_elm with that of the destination physical host */
257   piface_->pimpl_netpoint = destination->pimpl_netpoint;
258
259   physical_host_ = destination;
260
261   /* Update vcpu's action for the new pm */
262   /* create a cpu action bound to the pm model at the destination. */
263   surf::CpuAction* new_cpu_action =
264       static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->core_amount_));
265
266   if (action_->get_remains_no_update() > 0)
267     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
268
269   /* keep the bound value of the cpu action of the VM. */
270   double old_bound = action_->get_bound();
271   if (old_bound > 0) {
272     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
273     new_cpu_action->set_bound(old_bound);
274   }
275
276   XBT_ATTRIB_UNUSED bool ret = action_->unref();
277   xbt_assert(ret, "Bug: some resource still remains");
278
279   action_ = new_cpu_action;
280
281   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
282 }
283
284 void VirtualMachineImpl::set_bound(double bound)
285 {
286   user_bound_ = bound;
287   update_action_weight();
288 }
289
290 void VirtualMachineImpl::update_action_weight(){
291   /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
292   int impact = std::min(active_tasks_, get_core_amount());
293
294   XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %d)", this, impact, active_tasks_);
295
296   if (impact > 0)
297     action_->set_priority(1. / impact);
298   else
299     action_->set_priority(0.);
300
301   action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
302 }
303
304 }
305 }