Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
snake_case some resource::Action fields and cleanups
[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::nextOccuringEvent(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 = ws_vm->getImpl()->action_->getVariable()->get_value(); // this is X1 in comment above, what
96                                                                                  // this VM got in the sharing on the PM
97     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->getCname(), ws_vm->getPm()->getCname());
98
99     xbt_assert(cpu->model() == surf_cpu_model_vm);
100     kernel::lmm::System* vcpu_system = cpu->model()->getMaxminSystem();
101     vcpu_system->update_constraint_bound(cpu->constraint(), virt_overhead * solved_value);
102   }
103
104   /* 2. Calculate resource share at the virtual machine layer. */
105   ignoreEmptyVmInPmLMM();
106
107   /* 3. Ready. Get the next occurring event */
108   return surf_cpu_model_vm->nextOccuringEvent(now);
109 }
110
111 /************
112  * Resource *
113  ************/
114
115 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
116                                        int coreAmount, size_t ramsize)
117     : HostImpl(piface), hostPM_(host_PM), coreAmount_(coreAmount), ramsize_(ramsize)
118 {
119   /* Register this VM to the list of all VMs */
120   allVms_.push_back(piface);
121
122   /* We create cpu_action corresponding to a VM process on the host operating system. */
123   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
124   action_ = host_PM->pimpl_cpu->execution_start(0, coreAmount);
125
126   XBT_VERB("Create VM(%s)@PM(%s)", piface->getCname(), hostPM_->getCname());
127   onVmCreation(this);
128 }
129
130 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
131 VirtualMachineImpl::~VirtualMachineImpl()
132 {
133   onVmDestruction(this);
134   /* I was already removed from the allVms set if the VM was destroyed cleanly */
135   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
136   if (iter != allVms_.end())
137     allVms_.erase(iter);
138
139   /* Free the cpu_action of the VM. */
140   XBT_ATTRIB_UNUSED int ret = action_->unref();
141   xbt_assert(ret == 1, "Bug: some resource still remains");
142 }
143
144 e_surf_vm_state_t VirtualMachineImpl::getState()
145 {
146   return vmState_;
147 }
148
149 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
150 {
151   vmState_ = state;
152 }
153
154 void VirtualMachineImpl::suspend(smx_actor_t issuer)
155 {
156   if (getState() != SURF_VM_STATE_RUNNING)
157     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->getCname());
158   if (issuer->host == piface_)
159     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->getCname(), piface_->getCname());
160
161   auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
162   XBT_DEBUG("suspend VM(%s), where %zu processes exist", piface_->getCname(), process_list.size());
163
164   action_->suspend();
165
166   for (auto& smx_process : process_list) {
167     XBT_DEBUG("suspend %s", smx_process.name.c_str());
168     smx_process.suspend(issuer);
169   }
170
171   XBT_DEBUG("suspend all processes on the VM done done");
172
173   vmState_ = SURF_VM_STATE_SUSPENDED;
174 }
175
176 void VirtualMachineImpl::resume()
177 {
178   if (getState() != SURF_VM_STATE_SUSPENDED)
179     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->getCname());
180
181   auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
182   XBT_DEBUG("Resume VM %s, containing %zu processes.", piface_->getCname(), process_list.size());
183
184   action_->resume();
185
186   for (auto& smx_process : process_list) {
187     XBT_DEBUG("resume %s", smx_process.getCname());
188     smx_process.resume();
189   }
190
191   vmState_ = SURF_VM_STATE_RUNNING;
192 }
193
194 /** @brief Power off a VM.
195  *
196  * All hosted processes will be killed, but the VM state is preserved on memory.
197  * It can later be restarted.
198  *
199  * @param issuer the actor requesting the shutdown
200  */
201 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
202 {
203   if (getState() != SURF_VM_STATE_RUNNING) {
204     const char* stateName = "(unknown state)";
205     switch (getState()) {
206       case SURF_VM_STATE_CREATED:
207         stateName = "created, but not yet started";
208         break;
209       case SURF_VM_STATE_SUSPENDED:
210         stateName = "suspended";
211         break;
212       case SURF_VM_STATE_DESTROYED:
213         stateName = "destroyed";
214         break;
215       default: /* SURF_VM_STATE_RUNNING or unexpected values */
216         THROW_IMPOSSIBLE;
217         break;
218     }
219     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->getCname(), stateName);
220   }
221
222   auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
223   XBT_DEBUG("shutdown VM %s, that contains %zu processes", piface_->getCname(), process_list.size());
224
225   for (auto& smx_process : process_list) {
226     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process.getCname(),
227               smx_process.host->getCname(), issuer->getCname());
228     SIMIX_process_kill(&smx_process, issuer);
229   }
230
231   setState(SURF_VM_STATE_DESTROYED);
232
233   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
234 }
235
236 /** @brief returns the physical machine on which the VM is running **/
237 s4u::Host* VirtualMachineImpl::getPm()
238 {
239   return hostPM_;
240 }
241
242 /** @brief Change the physical host on which the given VM is running
243  *
244  * This is an instantaneous migration.
245  */
246 void VirtualMachineImpl::setPm(s4u::Host* destination)
247 {
248   const char* vm_name     = piface_->getCname();
249   const char* pm_name_src = hostPM_->getCname();
250   const char* pm_name_dst = destination->getCname();
251
252   /* update net_elm with that of the destination physical host */
253   piface_->pimpl_netpoint = destination->pimpl_netpoint;
254
255   hostPM_ = destination;
256
257   /* Update vcpu's action for the new pm */
258   /* create a cpu action bound to the pm model at the destination. */
259   surf::CpuAction* new_cpu_action =
260       static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->coreAmount_));
261
262   if (action_->getRemainsNoUpdate() > 0)
263     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
264
265   /* keep the bound value of the cpu action of the VM. */
266   double old_bound = action_->get_bound();
267   if (old_bound > 0) {
268     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
269     new_cpu_action->set_bound(old_bound);
270   }
271
272   XBT_ATTRIB_UNUSED int ret = action_->unref();
273   xbt_assert(ret == 1, "Bug: some resource still remains");
274
275   action_ = new_cpu_action;
276
277   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
278 }
279
280 void VirtualMachineImpl::setBound(double bound)
281 {
282   action_->set_bound(bound);
283 }
284
285 }
286 }