Logo AND Algorithmique Numérique Distribuée

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