Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Create a s4u::VirtualMachine to clean things out.
[simgrid.git] / src / surf / 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/surf/VirtualMachineImpl.hpp"
8 #include "simgrid/s4u/VirtualMachine.hpp"
9
10 #include <xbt/signal.hpp>
11
12 #include "cpu_cas01.hpp"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
15
16 simgrid::surf::VMModel* surf_vm_model = nullptr;
17
18 void surf_vm_model_init_HL13()
19 {
20   if (surf_cpu_model_vm) {
21     surf_vm_model = new simgrid::surf::VMModel();
22     all_existing_models->push_back(surf_vm_model);
23   }
24 }
25
26 namespace simgrid {
27 namespace surf {
28
29 /*************
30  * Callbacks *
31  *************/
32
33 simgrid::xbt::signal<void(simgrid::surf::VirtualMachineImpl*)> onVmCreation;
34 simgrid::xbt::signal<void(simgrid::surf::VirtualMachineImpl*)> onVmDestruction;
35 simgrid::xbt::signal<void(simgrid::surf::VirtualMachineImpl*)> onVmStateChange;
36
37 /*********
38  * Model *
39  *********/
40
41 std::deque<VirtualMachineImpl*> VirtualMachineImpl::allVms_;
42
43 s4u::Host* VMModel::createVM(const char* name, sg_host_t host_PM)
44 {
45   return new s4u::VirtualMachine(name, host_PM);
46 }
47
48 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
49  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system. */
50 // const double virt_overhead = 0.95;
51 const double virt_overhead = 1;
52
53 double VMModel::nextOccuringEvent(double now)
54 {
55   /* TODO: update action's cost with the total cost of processes on the VM. */
56
57   /* 1. Now we know how many resource should be assigned to each virtual
58    * machine. We update constraints of the virtual machine layer.
59    *
60    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
61    *     X1 + X2 = C       (Equation 1)
62    * where
63    *    the resource share of VM1: X1
64    *    the resource share of VM2: X2
65    *    the capacity of PM1: C
66    *
67    * Then, if we have two process (P1 and P2) on VM1.
68    *     X1_1 + X1_2 = X1  (Equation 2)
69    * where
70    *    the resource share of P1: X1_1
71    *    the resource share of P2: X1_2
72    *    the capacity of VM1: X1
73    *
74    * Equation 1 was solved in the physical machine layer.
75    * Equation 2 is solved in the virtual machine layer (here).
76    * X1 must be passed to the virtual machine laye as a constraint value.
77    **/
78
79   /* iterate for all virtual machines */
80   for (VirtualMachineImpl* ws_vm : VirtualMachineImpl::allVms_) {
81     Cpu* cpu = ws_vm->piface_->pimpl_cpu;
82     xbt_assert(cpu, "cpu-less host");
83
84     double solved_value = ws_vm->action_->getVariable()->value;
85     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->piface_->name().c_str(),
86               ws_vm->getPm()->name().c_str());
87
88     // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
89     // cpu_cas01->constraint->bound = solved_value;
90     xbt_assert(cpu->getModel() == surf_cpu_model_vm);
91     lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
92     lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
93   }
94
95   /* 2. Calculate resource share at the virtual machine layer. */
96   adjustWeightOfDummyCpuActions();
97
98   /* 3. Ready. Get the next occuring event */
99   return surf_cpu_model_vm->nextOccuringEvent(now);
100 }
101
102 /************
103  * Resource *
104  ************/
105
106 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::Host* piface, simgrid::s4u::Host* host_PM)
107     : HostImpl(piface, nullptr /*storage*/), hostPM_(host_PM)
108 {
109   /* Register this VM to the list of all VMs */
110   allVms_.push_back(this);
111
112   /* Currently, a VM uses the network resource of its physical host. In
113    * host_lib, this network resource object is referred from two different keys.
114    * When deregistering the reference that points the network resource object
115    * from the VM name, we have to make sure that the system does not call the
116    * free callback for the network resource object. The network resource object
117    * is still used by the physical machine. */
118   piface_->pimpl_netcard = host_PM->pimpl_netcard;
119
120   // //// CPU  RELATED STUFF ////
121   // Roughly, create a vcpu resource by using the values of the sub_cpu one.
122   CpuCas01* sub_cpu = dynamic_cast<CpuCas01*>(host_PM->pimpl_cpu);
123
124   piface_->pimpl_cpu = surf_cpu_model_vm->createCpu(piface_, sub_cpu->getSpeedPeakList(), 1 /*cores*/);
125   if (sub_cpu->getPState() != 0)
126     piface_->pimpl_cpu->setPState(sub_cpu->getPState());
127
128   /* We create cpu_action corresponding to a VM process on the host operating system. */
129   /* FIXME: TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
130   action_ = sub_cpu->execution_start(0);
131
132   XBT_VERB("Create VM(%s)@PM(%s) with %ld mounted disks", piface->name().c_str(), hostPM_->name().c_str(),
133            xbt_dynar_length(storage_));
134 }
135
136 /*
137  * A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation.
138  */
139 VirtualMachineImpl::~VirtualMachineImpl()
140 {
141   onVmDestruction(this);
142   allVms_.erase(find(allVms_.begin(), allVms_.end(), this));
143
144   /* Free the cpu_action of the VM. */
145   XBT_ATTRIB_UNUSED int ret = action_->unref();
146   xbt_assert(ret == 1, "Bug: some resource still remains");
147 }
148
149 e_surf_vm_state_t VirtualMachineImpl::getState()
150 {
151   return vmState_;
152 }
153
154 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
155 {
156   vmState_ = state;
157 }
158 void VirtualMachineImpl::suspend()
159 {
160   action_->suspend();
161   vmState_ = SURF_VM_STATE_SUSPENDED;
162 }
163
164 void VirtualMachineImpl::resume()
165 {
166   action_->resume();
167   vmState_ = SURF_VM_STATE_RUNNING;
168 }
169
170 void VirtualMachineImpl::save()
171 {
172   vmState_ = SURF_VM_STATE_SAVING;
173   action_->suspend();
174   vmState_ = SURF_VM_STATE_SAVED;
175 }
176
177 void VirtualMachineImpl::restore()
178 {
179   vmState_ = SURF_VM_STATE_RESTORING;
180   action_->resume();
181   vmState_ = SURF_VM_STATE_RUNNING;
182 }
183
184 /** @brief returns the physical machine on which the VM is running **/
185 sg_host_t VirtualMachineImpl::getPm()
186 {
187   return hostPM_;
188 }
189
190 /* Update the physical host of the given VM */
191 void VirtualMachineImpl::migrate(sg_host_t host_dest)
192 {
193   const char* vm_name     = piface_->name().c_str();
194   const char* pm_name_src = hostPM_->name().c_str();
195   const char* pm_name_dst = host_dest->name().c_str();
196
197   /* update net_elm with that of the destination physical host */
198   piface_->pimpl_netcard = host_dest->pimpl_netcard;
199
200   hostPM_ = host_dest;
201
202   /* Update vcpu's action for the new pm */
203   /* create a cpu action bound to the pm model at the destination. */
204   CpuAction* new_cpu_action = static_cast<CpuAction*>(host_dest->pimpl_cpu->execution_start(0));
205
206   Action::State state = action_->getState();
207   if (state != Action::State::done)
208     XBT_CRITICAL("FIXME: may need a proper handling, %d", static_cast<int>(state));
209   if (action_->getRemainsNoUpdate() > 0)
210     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
211
212   /* keep the bound value of the cpu action of the VM. */
213   double old_bound = action_->getBound();
214   if (old_bound != 0) {
215     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
216     new_cpu_action->setBound(old_bound);
217   }
218
219   XBT_ATTRIB_UNUSED int ret = action_->unref();
220   xbt_assert(ret == 1, "Bug: some resource still remains");
221
222   action_ = new_cpu_action;
223
224   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
225 }
226
227 void VirtualMachineImpl::setBound(double bound)
228 {
229   action_->setBound(bound);
230 }
231 }
232 }