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