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 "src/simix/ActorImpl.hpp"
9 #include "src/simix/smx_host_private.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
13 simgrid::vm::VMModel* surf_vm_model = nullptr;
15 void surf_vm_model_init_HL13()
17 if (surf_cpu_model_vm) {
18 surf_vm_model = new simgrid::vm::VMModel();
19 all_existing_models->push_back(surf_vm_model);
30 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmCreation;
31 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmDestruction;
32 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmStateChange;
38 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
40 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
41 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system. */
42 // const double virt_overhead = 0.95;
43 const double virt_overhead = 1;
45 double VMModel::nextOccuringEvent(double now)
47 /* TODO: update action's cost with the total cost of processes on the VM. */
49 /* 1. Now we know how many resource should be assigned to each virtual
50 * machine. We update constraints of the virtual machine layer.
52 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
53 * X1 + X2 = C (Equation 1)
55 * the resource share of VM1: X1
56 * the resource share of VM2: X2
57 * the capacity of PM1: C
59 * Then, if we have two process (P1 and P2) on VM1.
60 * X1_1 + X1_2 = X1 (Equation 2)
62 * the resource share of P1: X1_1
63 * the resource share of P2: X1_2
64 * the capacity of VM1: X1
66 * Equation 1 was solved in the physical machine layer.
67 * Equation 2 is solved in the virtual machine layer (here).
68 * X1 must be passed to the virtual machine laye as a constraint value.
71 /* iterate for all virtual machines */
72 for (s4u::VirtualMachine* ws_vm : VirtualMachineImpl::allVms_) {
73 surf::Cpu* cpu = ws_vm->pimpl_cpu;
74 xbt_assert(cpu, "cpu-less host");
76 double solved_value = ws_vm->pimpl_vm_->action_->getVariable()->value;
77 XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->cname(), ws_vm->pimpl_vm_->getPm()->cname());
79 // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
80 // cpu_cas01->constraint->bound = solved_value;
81 xbt_assert(cpu->model() == surf_cpu_model_vm);
82 lmm_system_t vcpu_system = cpu->model()->getMaxminSystem();
83 lmm_update_constraint_bound(vcpu_system, cpu->constraint(), virt_overhead * solved_value);
86 /* 2. Calculate resource share at the virtual machine layer. */
87 adjustWeightOfDummyCpuActions();
89 /* 3. Ready. Get the next occuring event */
90 return surf_cpu_model_vm->nextOccuringEvent(now);
97 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM)
98 : HostImpl(piface), hostPM_(host_PM)
100 /* Register this VM to the list of all VMs */
101 allVms_.push_back(piface);
103 /* We create cpu_action corresponding to a VM process on the host operating system. */
104 /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
105 action_ = host_PM->pimpl_cpu->execution_start(0);
107 /* Initialize the VM parameters */
110 XBT_VERB("Create VM(%s)@PM(%s)", piface->cname(), hostPM_->cname());
114 xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
115 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
116 VirtualMachineImpl::~VirtualMachineImpl()
118 onVmDestruction(this);
119 /* I was already removed from the allVms set if the VM was destroyed cleanly */
120 auto iter = find(allVms_.begin(), allVms_.end(), piface_);
121 if (iter != allVms_.end())
124 /* dirty page tracking */
125 unsigned int size = xbt_dict_size(dp_objs);
126 static bool already_warned = false;
127 if (size > 0 && !already_warned) {
128 xbt_dict_cursor_t cursor = nullptr;
129 xbt_dict_cursor_first(dp_objs, &cursor);
130 XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
131 "If you don't understand why your task was not properly removed, please report that bug.\n"
132 "This is a known bug if you turned the host off during the VM execution.\n"
133 "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
135 size, (xbt_log_no_loc ? "(name hidden)" : xbt_dict_cursor_get_key(cursor)));
136 xbt_dict_cursor_free(&cursor);
137 already_warned = true;
139 xbt_dict_free(&dp_objs);
141 /* Free the cpu_action of the VM. */
142 XBT_ATTRIB_UNUSED int ret = action_->unref();
143 xbt_assert(ret == 1, "Bug: some resource still remains");
146 e_surf_vm_state_t VirtualMachineImpl::getState()
151 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
155 void VirtualMachineImpl::suspend(smx_actor_t issuer)
158 THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->cname());
159 if (getState() != SURF_VM_STATE_RUNNING)
160 THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->cname());
161 if (issuer->host == piface_)
162 THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->cname(), piface_->cname());
164 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
165 XBT_DEBUG("suspend VM(%s), where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
169 smx_actor_t smx_process;
170 smx_actor_t smx_process_safe;
171 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
172 XBT_DEBUG("suspend %s", smx_process->name.c_str());
173 SIMIX_process_suspend(smx_process, issuer);
176 XBT_DEBUG("suspend all processes on the VM done done");
178 vmState_ = SURF_VM_STATE_SUSPENDED;
181 void VirtualMachineImpl::resume()
183 if (getState() != SURF_VM_STATE_SUSPENDED)
184 THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->cname());
186 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
187 XBT_DEBUG("Resume VM %s, containing %d processes.", piface_->cname(), xbt_swag_size(process_list));
191 smx_actor_t smx_process;
192 smx_actor_t 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;
201 /** @brief Power off a VM.
203 * All hosted processes will be killed, but the VM state is preserved on memory.
204 * It can later be restarted.
206 * @param issuer the actor requesting the shutdown
208 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
210 if (getState() != SURF_VM_STATE_RUNNING)
211 THROWF(vm_error, 0, "Cannot shutdown VM %s: it is not running", piface_->cname());
213 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
214 XBT_DEBUG("shutdown VM %s, that contains %d processes", piface_->cname(), xbt_swag_size(process_list));
216 smx_actor_t smx_process;
217 smx_actor_t smx_process_safe;
218 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
219 XBT_DEBUG("kill %s", smx_process->cname());
220 SIMIX_process_kill(smx_process, issuer);
223 setState(SURF_VM_STATE_CREATED);
225 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
228 /** @brief returns the physical machine on which the VM is running **/
229 s4u::Host* VirtualMachineImpl::getPm()
234 /** @brief Change the physical host on which the given VM is running
236 * This is an instantaneous migration.
238 void VirtualMachineImpl::setPm(s4u::Host* destination)
240 const char* vm_name = piface_->cname();
241 const char* pm_name_src = hostPM_->cname();
242 const char* pm_name_dst = destination->cname();
244 /* update net_elm with that of the destination physical host */
245 piface_->pimpl_netpoint = destination->pimpl_netpoint;
247 hostPM_ = destination;
249 /* Update vcpu's action for the new pm */
250 /* create a cpu action bound to the pm model at the destination. */
251 surf::CpuAction* new_cpu_action = static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0));
253 surf::Action::State state = action_->getState();
254 if (state != surf::Action::State::done)
255 XBT_CRITICAL("FIXME: may need a proper handling, %d", static_cast<int>(state));
256 if (action_->getRemainsNoUpdate() > 0)
257 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
259 /* keep the bound value of the cpu action of the VM. */
260 double old_bound = action_->getBound();
262 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
263 new_cpu_action->setBound(old_bound);
266 XBT_ATTRIB_UNUSED int ret = action_->unref();
267 xbt_assert(ret == 1, "Bug: some resource still remains");
269 action_ = new_cpu_action;
271 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
274 sg_size_t VirtualMachineImpl::getRamsize()
276 return params_.ramsize;
279 void VirtualMachineImpl::setBound(double bound)
281 action_->setBound(bound);
284 void VirtualMachineImpl::getParams(vm_params_t params)
289 void VirtualMachineImpl::setParams(vm_params_t params)
291 /* may check something here. */