1 /* Copyright (c) 2013-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "src/plugins/vm/VirtualMachineImpl.hpp"
8 #include "simgrid/s4u/VirtualMachine.hpp"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_host_private.h"
12 #include <xbt/signal.hpp>
14 #include "src/surf/cpu_cas01.hpp"
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
18 simgrid::vm::VMModel* surf_vm_model = nullptr;
20 void surf_vm_model_init_HL13()
22 if (surf_cpu_model_vm) {
23 surf_vm_model = new simgrid::vm::VMModel();
24 all_existing_models->push_back(surf_vm_model);
35 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmCreation;
36 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmDestruction;
37 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmStateChange;
43 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
45 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
46 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system. */
47 // const double virt_overhead = 0.95;
48 const double virt_overhead = 1;
50 double VMModel::nextOccuringEvent(double now)
52 /* TODO: update action's cost with the total cost of processes on the VM. */
54 /* 1. Now we know how many resource should be assigned to each virtual
55 * machine. We update constraints of the virtual machine layer.
57 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
58 * X1 + X2 = C (Equation 1)
60 * the resource share of VM1: X1
61 * the resource share of VM2: X2
62 * the capacity of PM1: C
64 * Then, if we have two process (P1 and P2) on VM1.
65 * X1_1 + X1_2 = X1 (Equation 2)
67 * the resource share of P1: X1_1
68 * the resource share of P2: X1_2
69 * the capacity of VM1: X1
71 * Equation 1 was solved in the physical machine layer.
72 * Equation 2 is solved in the virtual machine layer (here).
73 * X1 must be passed to the virtual machine laye as a constraint value.
76 /* iterate for all virtual machines */
77 for (s4u::VirtualMachine* ws_vm : VirtualMachineImpl::allVms_) {
78 surf::Cpu* cpu = ws_vm->pimpl_cpu;
79 xbt_assert(cpu, "cpu-less host");
81 double solved_value = ws_vm->pimpl_vm_->action_->getVariable()->value;
82 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->cname(), ws_vm->pimpl_vm_->getPm()->cname());
84 // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
85 // cpu_cas01->constraint->bound = solved_value;
86 xbt_assert(cpu->getModel() == surf_cpu_model_vm);
87 lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
88 lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
91 /* 2. Calculate resource share at the virtual machine layer. */
92 adjustWeightOfDummyCpuActions();
94 /* 3. Ready. Get the next occuring event */
95 return surf_cpu_model_vm->nextOccuringEvent(now);
102 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM)
103 : HostImpl(piface, nullptr /*storage*/), hostPM_(host_PM)
105 /* Register this VM to the list of all VMs */
106 allVms_.push_back(piface);
108 /* We create cpu_action corresponding to a VM process on the host operating system. */
109 /* FIXME: TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
110 action_ = host_PM->pimpl_cpu->execution_start(0);
112 /* Initialize the VM parameters */
115 XBT_VERB("Create VM(%s)@PM(%s)", piface->cname(), hostPM_->cname());
119 xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
120 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
121 VirtualMachineImpl::~VirtualMachineImpl()
123 onVmDestruction(this);
124 allVms_.erase(find(allVms_.begin(), allVms_.end(), piface_));
126 /* dirty page tracking */
127 unsigned int size = xbt_dict_size(dp_objs);
128 static bool already_warned = false;
129 if (size > 0 && !already_warned) {
130 xbt_dict_cursor_t cursor = nullptr;
131 xbt_dict_cursor_first(dp_objs, &cursor);
132 XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
133 "If you don't understand why your task was not properly removed, please report that bug.\n"
134 "This is a known bug if you turned the host off during the VM execution.\n"
135 "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
137 size, (xbt_log_no_loc ? "(name hidden)" : xbt_dict_cursor_get_key(cursor)));
138 xbt_dict_cursor_free(&cursor);
139 already_warned = true;
141 xbt_dict_free(&dp_objs);
143 /* Free the cpu_action of the VM. */
144 XBT_ATTRIB_UNUSED int ret = action_->unref();
145 xbt_assert(ret == 1, "Bug: some resource still remains");
148 e_surf_vm_state_t VirtualMachineImpl::getState()
153 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
157 void VirtualMachineImpl::suspend(smx_actor_t issuer)
160 THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->cname());
161 if (getState() != SURF_VM_STATE_RUNNING)
162 THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->cname());
163 if (issuer->host == piface_)
164 THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->cname(), piface_->cname());
166 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
167 XBT_DEBUG("suspend VM(%s), where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
171 smx_actor_t smx_process, smx_process_safe;
172 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
173 XBT_DEBUG("suspend %s", smx_process->name.c_str());
174 SIMIX_process_suspend(smx_process, issuer);
177 XBT_DEBUG("suspend all processes on the VM done done");
179 vmState_ = SURF_VM_STATE_SUSPENDED;
182 void VirtualMachineImpl::resume()
184 if (getState() != SURF_VM_STATE_SUSPENDED)
185 THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->cname());
187 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
188 XBT_DEBUG("Resume VM %s, containing %d processes.", piface_->cname(), xbt_swag_size(process_list));
192 smx_actor_t smx_process, smx_process_safe;
193 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
194 XBT_DEBUG("resume %s", smx_process->cname());
195 SIMIX_process_resume(smx_process);
198 vmState_ = SURF_VM_STATE_RUNNING;
202 * @brief Function to save a VM.
203 * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved in memory.
204 * We can later restore it again.
206 * @param issuer the process requesting this operation
208 void VirtualMachineImpl::save(smx_actor_t issuer)
211 THROWF(vm_error, 0, "Cannot save VM %s: it is migrating.", piface_->cname());
213 if (getState() != SURF_VM_STATE_RUNNING)
214 THROWF(vm_error, 0, "Cannot save VM %s: it is not running.", piface_->cname());
216 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
217 XBT_DEBUG("Save VM %s, where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
219 vmState_ = SURF_VM_STATE_SAVING;
221 vmState_ = SURF_VM_STATE_SAVED;
223 smx_actor_t smx_process, smx_process_safe;
224 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
225 XBT_DEBUG("suspend %s", smx_process->cname());
226 SIMIX_process_suspend(smx_process, issuer);
230 void VirtualMachineImpl::restore()
232 if (getState() != SURF_VM_STATE_SAVED)
233 THROWF(vm_error, 0, "Cannot restore VM %s: it was not saved", piface_->cname());
235 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
236 XBT_DEBUG("Restore VM %s, where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
238 vmState_ = SURF_VM_STATE_RESTORING;
240 vmState_ = SURF_VM_STATE_RUNNING;
242 smx_actor_t smx_process, smx_process_safe;
243 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
244 XBT_DEBUG("resume %s", smx_process->cname());
245 SIMIX_process_resume(smx_process);
249 /** @brief returns the physical machine on which the VM is running **/
250 s4u::Host* VirtualMachineImpl::getPm()
255 /** @brief Change the physical host on which the given VM is running
257 * This is an instantaneous migration.
259 void VirtualMachineImpl::setPm(s4u::Host* destination)
261 const char* vm_name = piface_->cname();
262 const char* pm_name_src = hostPM_->cname();
263 const char* pm_name_dst = destination->cname();
265 /* update net_elm with that of the destination physical host */
266 piface_->pimpl_netcard = destination->pimpl_netcard;
268 hostPM_ = destination;
270 /* Update vcpu's action for the new pm */
271 /* create a cpu action bound to the pm model at the destination. */
272 surf::CpuAction* new_cpu_action = static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0));
274 surf::Action::State state = action_->getState();
275 if (state != surf::Action::State::done)
276 XBT_CRITICAL("FIXME: may need a proper handling, %d", static_cast<int>(state));
277 if (action_->getRemainsNoUpdate() > 0)
278 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
280 /* keep the bound value of the cpu action of the VM. */
281 double old_bound = action_->getBound();
282 if (old_bound != 0) {
283 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
284 new_cpu_action->setBound(old_bound);
287 XBT_ATTRIB_UNUSED int ret = action_->unref();
288 xbt_assert(ret == 1, "Bug: some resource still remains");
290 action_ = new_cpu_action;
292 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
295 sg_size_t VirtualMachineImpl::getRamsize()
297 return params_.ramsize;
300 void VirtualMachineImpl::setBound(double bound)
302 action_->setBound(bound);
305 void VirtualMachineImpl::getParams(vm_params_t params)
310 void VirtualMachineImpl::setParams(vm_params_t params)
312 /* may check something here. */