src/plugins/vm/VirtualMachineImpl.cpp

   1 /* Copyright (c) 2013-2017. 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 = 1; // 0.95
  45
  46 static void hostStateChange(s4u::Host& host)
  47 {
  48   if (host.isOff()) { // just turned off.
  49     std::vector<s4u::VirtualMachine*> trash;
  50     /* Find all VMs living on that host */
  51     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
  52       if (vm->getPm() == &host)
  53         trash.push_back(vm);
  54     for (s4u::VirtualMachine* vm : trash)
  55       vm->pimpl_vm_->shutdown(SIMIX_process_self());
  56   }
  57 }
  58 VMModel::VMModel()
  59 {
  60   s4u::Host::onStateChange.connect(hostStateChange);
  61 }
  62
  63 double VMModel::nextOccuringEvent(double now)
  64 {
  65   /* TODO: update action's cost with the total cost of processes on the VM. */
  66
  67   /* 1. Now we know how many resource should be assigned to each virtual
  68    * machine. We update constraints of the virtual machine layer.
  69    *
  70    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
  71    *     X1 + X2 = C       (Equation 1)
  72    * where
  73    *    the resource share of VM1: X1
  74    *    the resource share of VM2: X2
  75    *    the capacity of PM1: C
  76    *
  77    * Then, if we have two process (P1 and P2) on VM1.
  78    *     X1_1 + X1_2 = X1  (Equation 2)
  79    * where
  80    *    the resource share of P1: X1_1
  81    *    the resource share of P2: X1_2
  82    *    the capacity of VM1: X1
  83    *
  84    * Equation 1 was solved in the physical machine layer.
  85    * Equation 2 is solved in the virtual machine layer (here).
  86    * X1 must be passed to the virtual machine layer as a constraint value.
  87    **/
  88
  89   /* iterate for all virtual machines */
  90   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
  91     surf::Cpu* cpu = ws_vm->pimpl_cpu;
  92     xbt_assert(cpu, "cpu-less host");
  93
  94     double solved_value = ws_vm->pimpl_vm_->action_->getVariable()
  95                               ->value; // this is X1 in comment above, what this VM got in the sharing on the PM
  96     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->getCname(), ws_vm->pimpl_vm_->getPm()->getCname());
  97
  98     // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
  99     // cpu_cas01->constraint->bound = solved_value;
 100     xbt_assert(cpu->model() == surf_cpu_model_vm);
 101     lmm_system_t vcpu_system = cpu->model()->getMaxminSystem();
 102     lmm_update_constraint_bound(vcpu_system, cpu->constraint(), virt_overhead * solved_value);
 103   }
 104
 105   /* 2. Calculate resource share at the virtual machine layer. */
 106   ignoreEmptyVmInPmLMM();
 107
 108   /* 3. Ready. Get the next occurring event */
 109   return surf_cpu_model_vm->nextOccuringEvent(now);
 110 }
 111
 112 /************
 113  * Resource *
 114  ************/
 115
 116 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
 117                                        int coreAmount)
 118     : HostImpl(piface), hostPM_(host_PM), coreAmount_(coreAmount)
 119 {
 120   /* Register this VM to the list of all VMs */
 121   allVms_.push_back(piface);
 122
 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);
 126
 127   /* Initialize the VM parameters */
 128   params_.ramsize = 0;
 129
 130   XBT_VERB("Create VM(%s)@PM(%s)", piface->getCname(), hostPM_->getCname());
 131 }
 132
 133 extern "C" int
 134     xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
 135 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 136 VirtualMachineImpl::~VirtualMachineImpl()
 137 {
 138   onVmDestruction(this);
 139   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 140   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 141   if (iter != allVms_.end())
 142     allVms_.erase(iter);
 143
 144   /* dirty page tracking */
 145   unsigned int size          = dp_objs.size();
 146   static bool already_warned = false;
 147   if (size > 0 && not already_warned) {
 148     auto front = dp_objs.begin();
 149     XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
 150              "If you don't understand why your task was not properly removed, please report that bug.\n"
 151              "This is a known bug if you turned the host off during the VM execution.\n"
 152              "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
 153              "2016, sorry.",
 154              size, (xbt_log_no_loc ? "(name hidden)" : front->first.c_str()));
 155     already_warned = true;
 156   }
 157
 158   /* Free the cpu_action of the VM. */
 159   XBT_ATTRIB_UNUSED int ret = action_->unref();
 160   xbt_assert(ret == 1, "Bug: some resource still remains");
 161 }
 162
 163 e_surf_vm_state_t VirtualMachineImpl::getState()
 164 {
 165   return vmState_;
 166 }
 167
 168 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
 169 {
 170   vmState_ = state;
 171 }
 172 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 173 {
 174   if (isMigrating)
 175     THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->getCname());
 176   if (getState() != SURF_VM_STATE_RUNNING)
 177     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->getCname());
 178   if (issuer->host == piface_)
 179     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->cname(), piface_->getCname());
 180
 181   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 182   XBT_DEBUG("suspend VM(%s), where %d processes exist", piface_->getCname(), xbt_swag_size(process_list));
 183
 184   action_->suspend();
 185
 186   smx_actor_t smx_process;
 187   smx_actor_t smx_process_safe;
 188   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 189     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 190     smx_process->suspend(issuer);
 191   }
 192
 193   XBT_DEBUG("suspend all processes on the VM done done");
 194
 195   vmState_ = SURF_VM_STATE_SUSPENDED;
 196 }
 197
 198 void VirtualMachineImpl::resume()
 199 {
 200   if (getState() != SURF_VM_STATE_SUSPENDED)
 201     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->getCname());
 202
 203   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 204   XBT_DEBUG("Resume VM %s, containing %d processes.", piface_->getCname(), xbt_swag_size(process_list));
 205
 206   action_->resume();
 207
 208   smx_actor_t smx_process;
 209   smx_actor_t smx_process_safe;
 210   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 211     XBT_DEBUG("resume %s", smx_process->cname());
 212     smx_process->resume();
 213   }
 214
 215   vmState_ = SURF_VM_STATE_RUNNING;
 216 }
 217
 218 /** @brief Power off a VM.
 219  *
 220  * All hosted processes will be killed, but the VM state is preserved on memory.
 221  * It can later be restarted.
 222  *
 223  * @param issuer the actor requesting the shutdown
 224  */
 225 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 226 {
 227   if (getState() != SURF_VM_STATE_RUNNING) {
 228     const char* stateName = "(unknown state)";
 229     switch (getState()) {
 230       case SURF_VM_STATE_CREATED:
 231         stateName = "created, but not yet started";
 232         break;
 233       case SURF_VM_STATE_SUSPENDED:
 234         stateName = "suspended";
 235         break;
 236       case SURF_VM_STATE_DESTROYED:
 237         stateName = "destroyed";
 238         break;
 239       default: /* SURF_VM_STATE_RUNNING or unexpected values */
 240         THROW_IMPOSSIBLE;
 241         break;
 242     }
 243     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->getCname(), stateName);
 244   }
 245
 246   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 247   XBT_DEBUG("shutdown VM %s, that contains %d processes", piface_->getCname(), xbt_swag_size(process_list));
 248
 249   smx_actor_t smx_process;
 250   smx_actor_t smx_process_safe;
 251   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 252     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process->cname(), smx_process->host->getCname(),
 253               issuer->cname());
 254     SIMIX_process_kill(smx_process, issuer);
 255   }
 256
 257   setState(SURF_VM_STATE_DESTROYED);
 258
 259   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 260 }
 261
 262 /** @brief returns the physical machine on which the VM is running **/
 263 s4u::Host* VirtualMachineImpl::getPm()
 264 {
 265   return hostPM_;
 266 }
 267
 268 /** @brief Change the physical host on which the given VM is running
 269  *
 270  * This is an instantaneous migration.
 271  */
 272 void VirtualMachineImpl::setPm(s4u::Host* destination)
 273 {
 274   const char* vm_name     = piface_->getCname();
 275   const char* pm_name_src = hostPM_->getCname();
 276   const char* pm_name_dst = destination->getCname();
 277
 278   /* update net_elm with that of the destination physical host */
 279   piface_->pimpl_netpoint = destination->pimpl_netpoint;
 280
 281   hostPM_ = destination;
 282
 283   /* Update vcpu's action for the new pm */
 284   /* create a cpu action bound to the pm model at the destination. */
 285   surf::CpuAction* new_cpu_action =
 286       static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->coreAmount_));
 287
 288   if (action_->getRemainsNoUpdate() > 0)
 289     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
 290
 291   /* keep the bound value of the cpu action of the VM. */
 292   double old_bound = action_->getBound();
 293   if (old_bound > 0) {
 294     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
 295     new_cpu_action->setBound(old_bound);
 296   }
 297
 298   XBT_ATTRIB_UNUSED int ret = action_->unref();
 299   xbt_assert(ret == 1, "Bug: some resource still remains");
 300
 301   action_ = new_cpu_action;
 302
 303   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
 304 }
 305
 306 sg_size_t VirtualMachineImpl::getRamsize()
 307 {
 308   return params_.ramsize;
 309 }
 310
 311 void VirtualMachineImpl::setBound(double bound)
 312 {
 313   action_->setBound(bound);
 314 }
 315
 316 void VirtualMachineImpl::getParams(vm_params_t params)
 317 {
 318   *params = params_;
 319 }
 320
 321 void VirtualMachineImpl::setParams(vm_params_t params)
 322 {
 323   /* may check something here. */
 324   params_ = *params;
 325 }
 326 }
 327 }