Logo AND Algorithmique Numérique Distribuée

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