src/plugins/vm/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/plugins/vm/VirtualMachineImpl.hpp"
   8 #include "src/simix/ActorImpl.hpp"
   9 #include "src/simix/smx_host_private.h"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
  12
  13 simgrid::vm::VMModel* surf_vm_model = nullptr;
  14
  15 void surf_vm_model_init_HL13()
  16 {
  17   if (surf_cpu_model_vm) {
  18     surf_vm_model = new simgrid::vm::VMModel();
  19     all_existing_models->push_back(surf_vm_model);
  20   }
  21 }
  22
  23 namespace simgrid {
  24 namespace vm {
  25
  26 /*************
  27  * Callbacks *
  28  *************/
  29
  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;
  33
  34 /*********
  35  * Model *
  36  *********/
  37
  38 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  39
  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  * FIXME: add a configuration flag for this
  43  */
  44 // const double virt_overhead = 0.95;
  45 const double virt_overhead = 1;
  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->pimpl_vm_->shutdown(SIMIX_process_self());
  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->pimpl_vm_->action_->getVariable()
  96                               ->value; // this is X1 in comment above, what 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->pimpl_vm_->getPm()->getCname());
  98
  99     // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
 100     // cpu_cas01->constraint->bound = solved_value;
 101     xbt_assert(cpu->model() == surf_cpu_model_vm);
 102     lmm_system_t vcpu_system = cpu->model()->getMaxminSystem();
 103     lmm_update_constraint_bound(vcpu_system, cpu->constraint(), virt_overhead * solved_value);
 104   }
 105
 106   /* 2. Calculate resource share at the virtual machine layer. */
 107   ignoreEmptyVmInPmLMM();
 108
 109   /* 3. Ready. Get the next occurring event */
 110   return surf_cpu_model_vm->nextOccuringEvent(now);
 111 }
 112
 113 /************
 114  * Resource *
 115  ************/
 116
 117 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
 118                                        int coreAmount)
 119     : HostImpl(piface), hostPM_(host_PM), coreAmount_(coreAmount)
 120 {
 121   /* Register this VM to the list of all VMs */
 122   allVms_.push_back(piface);
 123
 124   /* We create cpu_action corresponding to a VM process on the host operating system. */
 125   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
 126   action_ = host_PM->pimpl_cpu->execution_start(0, coreAmount);
 127
 128   /* Initialize the VM parameters */
 129   params_.ramsize = 0;
 130
 131   XBT_VERB("Create VM(%s)@PM(%s)", piface->getCname(), hostPM_->getCname());
 132 }
 133
 134 extern "C" int
 135     xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
 136 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 137 VirtualMachineImpl::~VirtualMachineImpl()
 138 {
 139   onVmDestruction(this);
 140   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 141   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 142   if (iter != allVms_.end())
 143     allVms_.erase(iter);
 144
 145   /* dirty page tracking */
 146   unsigned int size          = dp_objs.size();
 147   static bool already_warned = false;
 148   if (size > 0 && not already_warned) {
 149     auto front = dp_objs.begin();
 150     XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
 151              "If you don't understand why your task was not properly removed, please report that bug.\n"
 152              "This is a known bug if you turned the host off during the VM execution.\n"
 153              "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
 154              "2016, sorry.",
 155              size, (xbt_log_no_loc ? "(name hidden)" : front->first.c_str()));
 156     already_warned = true;
 157   }
 158
 159   /* Free the cpu_action of the VM. */
 160   XBT_ATTRIB_UNUSED int ret = action_->unref();
 161   xbt_assert(ret == 1, "Bug: some resource still remains");
 162 }
 163
 164 e_surf_vm_state_t VirtualMachineImpl::getState()
 165 {
 166   return vmState_;
 167 }
 168
 169 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
 170 {
 171   vmState_ = state;
 172 }
 173 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 174 {
 175   if (isMigrating)
 176     THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->getCname());
 177   if (getState() != SURF_VM_STATE_RUNNING)
 178     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->getCname());
 179   if (issuer->host == piface_)
 180     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->cname(), piface_->getCname());
 181
 182   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 183   XBT_DEBUG("suspend VM(%s), where %d processes exist", piface_->getCname(), xbt_swag_size(process_list));
 184
 185   action_->suspend();
 186
 187   smx_actor_t smx_process;
 188   smx_actor_t smx_process_safe;
 189   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 190     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 191     smx_process->suspend(issuer);
 192   }
 193
 194   XBT_DEBUG("suspend all processes on the VM done done");
 195
 196   vmState_ = SURF_VM_STATE_SUSPENDED;
 197 }
 198
 199 void VirtualMachineImpl::resume()
 200 {
 201   if (getState() != SURF_VM_STATE_SUSPENDED)
 202     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->getCname());
 203
 204   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 205   XBT_DEBUG("Resume VM %s, containing %d processes.", piface_->getCname(), xbt_swag_size(process_list));
 206
 207   action_->resume();
 208
 209   smx_actor_t smx_process;
 210   smx_actor_t smx_process_safe;
 211   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 212     XBT_DEBUG("resume %s", smx_process->cname());
 213     smx_process->resume();
 214   }
 215
 216   vmState_ = SURF_VM_STATE_RUNNING;
 217 }
 218
 219 /** @brief Power off a VM.
 220  *
 221  * All hosted processes will be killed, but the VM state is preserved on memory.
 222  * It can later be restarted.
 223  *
 224  * @param issuer the actor requesting the shutdown
 225  */
 226 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 227 {
 228   if (getState() != SURF_VM_STATE_RUNNING) {
 229     const char* stateName = "(unknown state)";
 230     switch (getState()) {
 231       case SURF_VM_STATE_CREATED:
 232         stateName = "created, but not yet started";
 233         break;
 234       case SURF_VM_STATE_SUSPENDED:
 235         stateName = "suspended";
 236         break;
 237       case SURF_VM_STATE_DESTROYED:
 238         stateName = "destroyed";
 239         break;
 240       default: /* SURF_VM_STATE_RUNNING or unexpected values */
 241         THROW_IMPOSSIBLE;
 242         break;
 243     }
 244     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->getCname(), stateName);
 245   }
 246
 247   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 248   XBT_DEBUG("shutdown VM %s, that contains %d processes", piface_->getCname(), xbt_swag_size(process_list));
 249
 250   smx_actor_t smx_process;
 251   smx_actor_t smx_process_safe;
 252   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 253     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process->cname(), smx_process->host->getCname(),
 254               issuer->cname());
 255     SIMIX_process_kill(smx_process, issuer);
 256   }
 257
 258   setState(SURF_VM_STATE_DESTROYED);
 259
 260   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 261 }
 262
 263 /** @brief returns the physical machine on which the VM is running **/
 264 s4u::Host* VirtualMachineImpl::getPm()
 265 {
 266   return hostPM_;
 267 }
 268
 269 /** @brief Change the physical host on which the given VM is running
 270  *
 271  * This is an instantaneous migration.
 272  */
 273 void VirtualMachineImpl::setPm(s4u::Host* destination)
 274 {
 275   const char* vm_name     = piface_->getCname();
 276   const char* pm_name_src = hostPM_->getCname();
 277   const char* pm_name_dst = destination->getCname();
 278
 279   /* update net_elm with that of the destination physical host */
 280   piface_->pimpl_netpoint = destination->pimpl_netpoint;
 281
 282   hostPM_ = destination;
 283
 284   /* Update vcpu's action for the new pm */
 285   /* create a cpu action bound to the pm model at the destination. */
 286   surf::CpuAction* new_cpu_action =
 287       static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->coreAmount_));
 288
 289   if (action_->getRemainsNoUpdate() > 0)
 290     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
 291
 292   /* keep the bound value of the cpu action of the VM. */
 293   double old_bound = action_->getBound();
 294   if (old_bound > 0) {
 295     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
 296     new_cpu_action->setBound(old_bound);
 297   }
 298
 299   XBT_ATTRIB_UNUSED int ret = action_->unref();
 300   xbt_assert(ret == 1, "Bug: some resource still remains");
 301
 302   action_ = new_cpu_action;
 303
 304   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
 305 }
 306
 307 sg_size_t VirtualMachineImpl::getRamsize()
 308 {
 309   return params_.ramsize;
 310 }
 311
 312 void VirtualMachineImpl::setBound(double bound)
 313 {
 314   action_->setBound(bound);
 315 }
 316
 317 void VirtualMachineImpl::getParams(vm_params_t params)
 318 {
 319   *params = params_;
 320 }
 321
 322 void VirtualMachineImpl::setParams(vm_params_t params)
 323 {
 324   /* may check something here. */
 325   params_ = *params;
 326 }
 327 }
 328 }