1 /* Copyright (c) 2013-2017. 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.hpp"
11 #include <xbt/asserts.h> // xbt_log_no_loc
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
15 simgrid::vm::VMModel* surf_vm_model = nullptr;
17 void surf_vm_model_init_HL13()
19 if (surf_cpu_model_vm) {
20 surf_vm_model = new simgrid::vm::VMModel();
21 all_existing_models->push_back(surf_vm_model);
32 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmCreation;
33 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmDestruction;
34 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmStateChange;
40 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
42 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
43 * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
44 * FIXME: add a configuration flag for this
46 const double virt_overhead = 1; // 0.95
48 static void hostStateChange(s4u::Host& host)
50 if (host.isOff()) { // just turned off.
51 std::vector<s4u::VirtualMachine*> trash;
52 /* Find all VMs living on that host */
53 for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
54 if (vm->getPm() == &host)
56 for (s4u::VirtualMachine* vm : trash)
57 vm->pimpl_vm_->shutdown(SIMIX_process_self());
62 s4u::Host::onStateChange.connect(hostStateChange);
65 double VMModel::nextOccuringEvent(double now)
67 /* TODO: update action's cost with the total cost of processes on the VM. */
69 /* 1. Now we know how many resource should be assigned to each virtual
70 * machine. We update constraints of the virtual machine layer.
72 * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
73 * X1 + X2 = C (Equation 1)
75 * the resource share of VM1: X1
76 * the resource share of VM2: X2
77 * the capacity of PM1: C
79 * Then, if we have two process (P1 and P2) on VM1.
80 * X1_1 + X1_2 = X1 (Equation 2)
82 * the resource share of P1: X1_1
83 * the resource share of P2: X1_2
84 * the capacity of VM1: X1
86 * Equation 1 was solved in the physical machine layer.
87 * Equation 2 is solved in the virtual machine layer (here).
88 * X1 must be passed to the virtual machine layer as a constraint value.
91 /* iterate for all virtual machines */
92 for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
93 surf::Cpu* cpu = ws_vm->pimpl_cpu;
94 xbt_assert(cpu, "cpu-less host");
96 double solved_value = ws_vm->pimpl_vm_->action_->getVariable()->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->pimpl_vm_->getPm()->getCname());
100 xbt_assert(cpu->model() == surf_cpu_model_vm);
101 lmm_system_t vcpu_system = cpu->model()->getMaxminSystem();
102 vcpu_system->update_constraint_bound(cpu->constraint(), virt_overhead * solved_value);
105 /* 2. Calculate resource share at the virtual machine layer. */
106 ignoreEmptyVmInPmLMM();
108 /* 3. Ready. Get the next occurring event */
109 return surf_cpu_model_vm->nextOccuringEvent(now);
116 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
118 : HostImpl(piface), hostPM_(host_PM), coreAmount_(coreAmount)
120 /* Register this VM to the list of all VMs */
121 allVms_.push_back(piface);
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);
127 /* Initialize the VM parameters */
130 XBT_VERB("Create VM(%s)@PM(%s)", piface->getCname(), hostPM_->getCname());
133 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
134 VirtualMachineImpl::~VirtualMachineImpl()
136 onVmDestruction(this);
137 /* I was already removed from the allVms set if the VM was destroyed cleanly */
138 auto iter = find(allVms_.begin(), allVms_.end(), piface_);
139 if (iter != allVms_.end())
142 /* dirty page tracking */
143 unsigned int size = dp_objs.size();
144 static bool already_warned = false;
145 if (size > 0 && not already_warned) {
146 auto front = dp_objs.begin();
147 XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
148 "If you don't understand why your task was not properly removed, please report that bug.\n"
149 "This is a known bug if you turned the host off during the VM execution.\n"
150 "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
152 size, (xbt_log_no_loc ? "(name hidden)" : front->first.c_str()));
153 already_warned = true;
156 /* Free the cpu_action of the VM. */
157 XBT_ATTRIB_UNUSED int ret = action_->unref();
158 xbt_assert(ret == 1, "Bug: some resource still remains");
161 e_surf_vm_state_t VirtualMachineImpl::getState()
166 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
170 void VirtualMachineImpl::suspend(smx_actor_t issuer)
173 THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->getCname());
174 if (getState() != SURF_VM_STATE_RUNNING)
175 THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->getCname());
176 if (issuer->host == piface_)
177 THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->getCname(), piface_->getCname());
179 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
180 XBT_DEBUG("suspend VM(%s), where %d processes exist", piface_->getCname(), xbt_swag_size(process_list));
184 smx_actor_t smx_process;
185 smx_actor_t smx_process_safe;
186 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
187 XBT_DEBUG("suspend %s", smx_process->name.c_str());
188 smx_process->suspend(issuer);
191 XBT_DEBUG("suspend all processes on the VM done done");
193 vmState_ = SURF_VM_STATE_SUSPENDED;
196 void VirtualMachineImpl::resume()
198 if (getState() != SURF_VM_STATE_SUSPENDED)
199 THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->getCname());
201 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
202 XBT_DEBUG("Resume VM %s, containing %d processes.", piface_->getCname(), xbt_swag_size(process_list));
206 smx_actor_t smx_process;
207 smx_actor_t smx_process_safe;
208 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
209 XBT_DEBUG("resume %s", smx_process->getCname());
210 smx_process->resume();
213 vmState_ = SURF_VM_STATE_RUNNING;
216 /** @brief Power off a VM.
218 * All hosted processes will be killed, but the VM state is preserved on memory.
219 * It can later be restarted.
221 * @param issuer the actor requesting the shutdown
223 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
225 if (getState() != SURF_VM_STATE_RUNNING) {
226 const char* stateName = "(unknown state)";
227 switch (getState()) {
228 case SURF_VM_STATE_CREATED:
229 stateName = "created, but not yet started";
231 case SURF_VM_STATE_SUSPENDED:
232 stateName = "suspended";
234 case SURF_VM_STATE_DESTROYED:
235 stateName = "destroyed";
237 default: /* SURF_VM_STATE_RUNNING or unexpected values */
241 XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->getCname(), stateName);
244 xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
245 XBT_DEBUG("shutdown VM %s, that contains %d processes", piface_->getCname(), xbt_swag_size(process_list));
247 smx_actor_t smx_process;
248 smx_actor_t smx_process_safe;
249 xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
250 XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process->getCname(),
251 smx_process->host->getCname(), issuer->getCname());
252 SIMIX_process_kill(smx_process, issuer);
255 setState(SURF_VM_STATE_DESTROYED);
257 /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
260 /** @brief returns the physical machine on which the VM is running **/
261 s4u::Host* VirtualMachineImpl::getPm()
266 /** @brief Change the physical host on which the given VM is running
268 * This is an instantaneous migration.
270 void VirtualMachineImpl::setPm(s4u::Host* destination)
272 const char* vm_name = piface_->getCname();
273 const char* pm_name_src = hostPM_->getCname();
274 const char* pm_name_dst = destination->getCname();
276 /* update net_elm with that of the destination physical host */
277 piface_->pimpl_netpoint = destination->pimpl_netpoint;
279 hostPM_ = destination;
281 /* Update vcpu's action for the new pm */
282 /* create a cpu action bound to the pm model at the destination. */
283 surf::CpuAction* new_cpu_action =
284 static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->coreAmount_));
286 if (action_->getRemainsNoUpdate() > 0)
287 XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
289 /* keep the bound value of the cpu action of the VM. */
290 double old_bound = action_->getBound();
292 XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
293 new_cpu_action->setBound(old_bound);
296 XBT_ATTRIB_UNUSED int ret = action_->unref();
297 xbt_assert(ret == 1, "Bug: some resource still remains");
299 action_ = new_cpu_action;
301 XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
304 sg_size_t VirtualMachineImpl::getRamsize()
306 return params_.ramsize;
309 void VirtualMachineImpl::setBound(double bound)
311 action_->setBound(bound);
314 void VirtualMachineImpl::getParams(vm_params_t params)
319 void VirtualMachineImpl::setParams(vm_params_t params)
321 /* may check something here. */