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.hpp"
  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     xbt_assert(cpu->model() == surf_cpu_model_vm);
  99     lmm_system_t vcpu_system = cpu->model()->getMaxminSystem();
 100     lmm_update_constraint_bound(vcpu_system, cpu->constraint(), virt_overhead * solved_value);
 101   }
 102
 103   /* 2. Calculate resource share at the virtual machine layer. */
 104   ignoreEmptyVmInPmLMM();
 105
 106   /* 3. Ready. Get the next occurring event */
 107   return surf_cpu_model_vm->nextOccuringEvent(now);
 108 }
 109
 110 /************
 111  * Resource *
 112  ************/
 113
 114 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
 115                                        int coreAmount)
 116     : HostImpl(piface), hostPM_(host_PM), coreAmount_(coreAmount)
 117 {
 118   /* Register this VM to the list of all VMs */
 119   allVms_.push_back(piface);
 120
 121   /* We create cpu_action corresponding to a VM process on the host operating system. */
 122   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
 123   action_ = host_PM->pimpl_cpu->execution_start(0, coreAmount);
 124
 125   /* Initialize the VM parameters */
 126   params_.ramsize = 0;
 127
 128   XBT_VERB("Create VM(%s)@PM(%s)", piface->getCname(), hostPM_->getCname());
 129 }
 130
 131 extern "C" int
 132     xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
 133 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 134 VirtualMachineImpl::~VirtualMachineImpl()
 135 {
 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())
 140     allVms_.erase(iter);
 141
 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 "
 151              "2016, sorry.",
 152              size, (xbt_log_no_loc ? "(name hidden)" : front->first.c_str()));
 153     already_warned = true;
 154   }
 155
 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");
 159 }
 160
 161 e_surf_vm_state_t VirtualMachineImpl::getState()
 162 {
 163   return vmState_;
 164 }
 165
 166 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
 167 {
 168   vmState_ = state;
 169 }
 170 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 171 {
 172   if (isMigrating)
 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());
 178
 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));
 181
 182   action_->suspend();
 183
 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);
 189   }
 190
 191   XBT_DEBUG("suspend all processes on the VM done done");
 192
 193   vmState_ = SURF_VM_STATE_SUSPENDED;
 194 }
 195
 196 void VirtualMachineImpl::resume()
 197 {
 198   if (getState() != SURF_VM_STATE_SUSPENDED)
 199     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->getCname());
 200
 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));
 203
 204   action_->resume();
 205
 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();
 211   }
 212
 213   vmState_ = SURF_VM_STATE_RUNNING;
 214 }
 215
 216 /** @brief Power off a VM.
 217  *
 218  * All hosted processes will be killed, but the VM state is preserved on memory.
 219  * It can later be restarted.
 220  *
 221  * @param issuer the actor requesting the shutdown
 222  */
 223 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 224 {
 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";
 230         break;
 231       case SURF_VM_STATE_SUSPENDED:
 232         stateName = "suspended";
 233         break;
 234       case SURF_VM_STATE_DESTROYED:
 235         stateName = "destroyed";
 236         break;
 237       default: /* SURF_VM_STATE_RUNNING or unexpected values */
 238         THROW_IMPOSSIBLE;
 239         break;
 240     }
 241     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->getCname(), stateName);
 242   }
 243
 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));
 246
 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);
 253   }
 254
 255   setState(SURF_VM_STATE_DESTROYED);
 256
 257   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 258 }
 259
 260 /** @brief returns the physical machine on which the VM is running **/
 261 s4u::Host* VirtualMachineImpl::getPm()
 262 {
 263   return hostPM_;
 264 }
 265
 266 /** @brief Change the physical host on which the given VM is running
 267  *
 268  * This is an instantaneous migration.
 269  */
 270 void VirtualMachineImpl::setPm(s4u::Host* destination)
 271 {
 272   const char* vm_name     = piface_->getCname();
 273   const char* pm_name_src = hostPM_->getCname();
 274   const char* pm_name_dst = destination->getCname();
 275
 276   /* update net_elm with that of the destination physical host */
 277   piface_->pimpl_netpoint = destination->pimpl_netpoint;
 278
 279   hostPM_ = destination;
 280
 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_));
 285
 286   if (action_->getRemainsNoUpdate() > 0)
 287     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
 288
 289   /* keep the bound value of the cpu action of the VM. */
 290   double old_bound = action_->getBound();
 291   if (old_bound > 0) {
 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);
 294   }
 295
 296   XBT_ATTRIB_UNUSED int ret = action_->unref();
 297   xbt_assert(ret == 1, "Bug: some resource still remains");
 298
 299   action_ = new_cpu_action;
 300
 301   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
 302 }
 303
 304 sg_size_t VirtualMachineImpl::getRamsize()
 305 {
 306   return params_.ramsize;
 307 }
 308
 309 void VirtualMachineImpl::setBound(double bound)
 310 {
 311   action_->setBound(bound);
 312 }
 313
 314 void VirtualMachineImpl::getParams(vm_params_t params)
 315 {
 316   *params = params_;
 317 }
 318
 319 void VirtualMachineImpl::setParams(vm_params_t params)
 320 {
 321   /* may check something here. */
 322   params_ = *params;
 323 }
 324 }
 325 }