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 "simgrid/s4u/VirtualMachine.hpp"
   9 #include "src/simix/ActorImpl.hpp"
  10 #include "src/simix/smx_host_private.h"
  11
  12 #include <xbt/signal.hpp>
  13
  14 #include "src/surf/cpu_cas01.hpp"
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
  17
  18 simgrid::vm::VMModel* surf_vm_model = nullptr;
  19
  20 void surf_vm_model_init_HL13()
  21 {
  22   if (surf_cpu_model_vm) {
  23     surf_vm_model = new simgrid::vm::VMModel();
  24     all_existing_models->push_back(surf_vm_model);
  25   }
  26 }
  27
  28 namespace simgrid {
  29 namespace vm {
  30
  31 /*************
  32  * Callbacks *
  33  *************/
  34
  35 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmCreation;
  36 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmDestruction;
  37 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmStateChange;
  38
  39 /*********
  40  * Model *
  41  *********/
  42
  43 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  44
  45 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
  46  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system. */
  47 // const double virt_overhead = 0.95;
  48 const double virt_overhead = 1;
  49
  50 double VMModel::nextOccuringEvent(double now)
  51 {
  52   /* TODO: update action's cost with the total cost of processes on the VM. */
  53
  54   /* 1. Now we know how many resource should be assigned to each virtual
  55    * machine. We update constraints of the virtual machine layer.
  56    *
  57    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
  58    *     X1 + X2 = C       (Equation 1)
  59    * where
  60    *    the resource share of VM1: X1
  61    *    the resource share of VM2: X2
  62    *    the capacity of PM1: C
  63    *
  64    * Then, if we have two process (P1 and P2) on VM1.
  65    *     X1_1 + X1_2 = X1  (Equation 2)
  66    * where
  67    *    the resource share of P1: X1_1
  68    *    the resource share of P2: X1_2
  69    *    the capacity of VM1: X1
  70    *
  71    * Equation 1 was solved in the physical machine layer.
  72    * Equation 2 is solved in the virtual machine layer (here).
  73    * X1 must be passed to the virtual machine laye as a constraint value.
  74    **/
  75
  76   /* iterate for all virtual machines */
  77   for (s4u::VirtualMachine* ws_vm : VirtualMachineImpl::allVms_) {
  78     surf::Cpu* cpu = ws_vm->pimpl_cpu;
  79     xbt_assert(cpu, "cpu-less host");
  80
  81     double solved_value = ws_vm->pimpl_vm_->action_->getVariable()->value;
  82     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->cname(), ws_vm->pimpl_vm_->getPm()->cname());
  83
  84     // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
  85     // cpu_cas01->constraint->bound = solved_value;
  86     xbt_assert(cpu->getModel() == surf_cpu_model_vm);
  87     lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
  88     lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
  89   }
  90
  91   /* 2. Calculate resource share at the virtual machine layer. */
  92   adjustWeightOfDummyCpuActions();
  93
  94   /* 3. Ready. Get the next occuring event */
  95   return surf_cpu_model_vm->nextOccuringEvent(now);
  96 }
  97
  98 /************
  99  * Resource *
 100  ************/
 101
 102 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM)
 103     : HostImpl(piface, nullptr /*storage*/), hostPM_(host_PM)
 104 {
 105   /* Register this VM to the list of all VMs */
 106   allVms_.push_back(piface);
 107
 108   /* We create cpu_action corresponding to a VM process on the host operating system. */
 109   /* FIXME: TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
 110   action_ = host_PM->pimpl_cpu->execution_start(0);
 111
 112   /* Initialize the VM parameters */
 113   params_.ramsize = 0;
 114
 115   XBT_VERB("Create VM(%s)@PM(%s)", piface->cname(), hostPM_->cname());
 116 }
 117
 118 extern "C" int
 119     xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
 120 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 121 VirtualMachineImpl::~VirtualMachineImpl()
 122 {
 123   onVmDestruction(this);
 124   allVms_.erase(find(allVms_.begin(), allVms_.end(), piface_));
 125
 126   /* dirty page tracking */
 127   unsigned int size          = xbt_dict_size(dp_objs);
 128   static bool already_warned = false;
 129   if (size > 0 && !already_warned) {
 130     xbt_dict_cursor_t cursor = nullptr;
 131     xbt_dict_cursor_first(dp_objs, &cursor);
 132     XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
 133              "If you don't understand why your task was not properly removed, please report that bug.\n"
 134              "This is a known bug if you turned the host off during the VM execution.\n"
 135              "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
 136              "2016, sorry.",
 137              size, (xbt_log_no_loc ? "(name hidden)" : xbt_dict_cursor_get_key(cursor)));
 138     xbt_dict_cursor_free(&cursor);
 139     already_warned = true;
 140   }
 141   xbt_dict_free(&dp_objs);
 142
 143   /* Free the cpu_action of the VM. */
 144   XBT_ATTRIB_UNUSED int ret = action_->unref();
 145   xbt_assert(ret == 1, "Bug: some resource still remains");
 146 }
 147
 148 e_surf_vm_state_t VirtualMachineImpl::getState()
 149 {
 150   return vmState_;
 151 }
 152
 153 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
 154 {
 155   vmState_ = state;
 156 }
 157 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 158 {
 159   if (isMigrating)
 160     THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->cname());
 161   if (getState() != SURF_VM_STATE_RUNNING)
 162     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->cname());
 163   if (issuer->host == piface_)
 164     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->cname(), piface_->cname());
 165
 166   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 167   XBT_DEBUG("suspend VM(%s), where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
 168
 169   action_->suspend();
 170
 171   smx_actor_t smx_process, smx_process_safe;
 172   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 173     XBT_DEBUG("suspend %s", smx_process->name.c_str());
 174     SIMIX_process_suspend(smx_process, issuer);
 175   }
 176
 177   XBT_DEBUG("suspend all processes on the VM done done");
 178
 179   vmState_ = SURF_VM_STATE_SUSPENDED;
 180 }
 181
 182 void VirtualMachineImpl::resume()
 183 {
 184   if (getState() != SURF_VM_STATE_SUSPENDED)
 185     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->cname());
 186
 187   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 188   XBT_DEBUG("Resume VM %s, containing %d processes.", piface_->cname(), xbt_swag_size(process_list));
 189
 190   action_->resume();
 191
 192   smx_actor_t smx_process, 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);
 196   }
 197
 198   vmState_ = SURF_VM_STATE_RUNNING;
 199 }
 200
 201 /**
 202  * @brief Function to save a VM.
 203  * This function is the same as vm_suspend, but the state of the VM is saved to the disk, and not preserved in memory.
 204  * We can later restore it again.
 205  *
 206  * @param issuer the process requesting this operation
 207  */
 208 void VirtualMachineImpl::save(smx_actor_t issuer)
 209 {
 210   if (isMigrating)
 211     THROWF(vm_error, 0, "Cannot save VM %s: it is migrating.", piface_->cname());
 212
 213   if (getState() != SURF_VM_STATE_RUNNING)
 214     THROWF(vm_error, 0, "Cannot save VM %s: it is not running.", piface_->cname());
 215
 216   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 217   XBT_DEBUG("Save VM %s, where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
 218
 219   vmState_ = SURF_VM_STATE_SAVING;
 220   action_->suspend();
 221   vmState_ = SURF_VM_STATE_SAVED;
 222
 223   smx_actor_t smx_process, smx_process_safe;
 224   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 225     XBT_DEBUG("suspend %s", smx_process->cname());
 226     SIMIX_process_suspend(smx_process, issuer);
 227   }
 228 }
 229
 230 void VirtualMachineImpl::restore()
 231 {
 232   if (getState() != SURF_VM_STATE_SAVED)
 233     THROWF(vm_error, 0, "Cannot restore VM %s: it was not saved", piface_->cname());
 234
 235   xbt_swag_t process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 236   XBT_DEBUG("Restore VM %s, where %d processes exist", piface_->cname(), xbt_swag_size(process_list));
 237
 238   vmState_ = SURF_VM_STATE_RESTORING;
 239   action_->resume();
 240   vmState_ = SURF_VM_STATE_RUNNING;
 241
 242   smx_actor_t smx_process, smx_process_safe;
 243   xbt_swag_foreach_safe(smx_process, smx_process_safe, process_list) {
 244     XBT_DEBUG("resume %s", smx_process->cname());
 245     SIMIX_process_resume(smx_process);
 246   }
 247 }
 248
 249 /** @brief returns the physical machine on which the VM is running **/
 250 s4u::Host* VirtualMachineImpl::getPm()
 251 {
 252   return hostPM_;
 253 }
 254
 255 /* Update the physical host of the given VM */
 256 void VirtualMachineImpl::migrate(s4u::Host* host_dest)
 257 {
 258   const char* vm_name     = piface_->cname();
 259   const char* pm_name_src = hostPM_->cname();
 260   const char* pm_name_dst = host_dest->cname();
 261
 262   /* update net_elm with that of the destination physical host */
 263   piface_->pimpl_netcard = host_dest->pimpl_netcard;
 264
 265   hostPM_ = host_dest;
 266
 267   /* Update vcpu's action for the new pm */
 268   /* create a cpu action bound to the pm model at the destination. */
 269   surf::CpuAction* new_cpu_action = static_cast<surf::CpuAction*>(host_dest->pimpl_cpu->execution_start(0));
 270
 271   surf::Action::State state = action_->getState();
 272   if (state != surf::Action::State::done)
 273     XBT_CRITICAL("FIXME: may need a proper handling, %d", static_cast<int>(state));
 274   if (action_->getRemainsNoUpdate() > 0)
 275     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
 276
 277   /* keep the bound value of the cpu action of the VM. */
 278   double old_bound = action_->getBound();
 279   if (old_bound != 0) {
 280     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
 281     new_cpu_action->setBound(old_bound);
 282   }
 283
 284   XBT_ATTRIB_UNUSED int ret = action_->unref();
 285   xbt_assert(ret == 1, "Bug: some resource still remains");
 286
 287   action_ = new_cpu_action;
 288
 289   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
 290 }
 291
 292 sg_size_t VirtualMachineImpl::getRamsize()
 293 {
 294   return params_.ramsize;
 295 }
 296
 297 void VirtualMachineImpl::setBound(double bound)
 298 {
 299   action_->setBound(bound);
 300 }
 301
 302 void VirtualMachineImpl::getParams(vm_params_t params)
 303 {
 304   *params = params_;
 305 }
 306
 307 void VirtualMachineImpl::setParams(vm_params_t params)
 308 {
 309   /* may check something here. */
 310   params_ = *params;
 311 }
 312 }
 313 }