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 #include <xbt/asserts.h> // xbt_log_no_loc
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
  14
  15 simgrid::vm::VMModel* surf_vm_model = nullptr;
  16
  17 void surf_vm_model_init_HL13()
  18 {
  19   if (surf_cpu_model_vm) {
  20     surf_vm_model = new simgrid::vm::VMModel();
  21     all_existing_models->push_back(surf_vm_model);
  22   }
  23 }
  24
  25 namespace simgrid {
  26 namespace vm {
  27
  28 /*************
  29  * Callbacks *
  30  *************/
  31
  32 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmCreation;
  33 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmDestruction;
  34 simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> onVmStateChange;
  35
  36 /*********
  37  * Model *
  38  *********/
  39
  40 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  41
  42 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
  43  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
  44  * FIXME: add a configuration flag for this
  45  */
  46 const double virt_overhead = 1; // 0.95
  47
  48 static void hostStateChange(s4u::Host& host)
  49 {
  50   if (host.isOff()) { // just turned off.
  51     std::vector<s4u::VirtualMachine*> trash;
  52     /* Find all VMs living on that host */
  53     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
  54       if (vm->getPm() == &host)
  55         trash.push_back(vm);
  56     for (s4u::VirtualMachine* vm : trash)
  57       vm->pimpl_vm_->shutdown(SIMIX_process_self());
  58   }
  59 }
  60 VMModel::VMModel()
  61 {
  62   s4u::Host::onStateChange.connect(hostStateChange);
  63 }
  64
  65 double VMModel::nextOccuringEvent(double now)
  66 {
  67   /* TODO: update action's cost with the total cost of processes on the VM. */
  68
  69   /* 1. Now we know how many resource should be assigned to each virtual
  70    * machine. We update constraints of the virtual machine layer.
  71    *
  72    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
  73    *     X1 + X2 = C       (Equation 1)
  74    * where
  75    *    the resource share of VM1: X1
  76    *    the resource share of VM2: X2
  77    *    the capacity of PM1: C
  78    *
  79    * Then, if we have two process (P1 and P2) on VM1.
  80    *     X1_1 + X1_2 = X1  (Equation 2)
  81    * where
  82    *    the resource share of P1: X1_1
  83    *    the resource share of P2: X1_2
  84    *    the capacity of VM1: X1
  85    *
  86    * Equation 1 was solved in the physical machine layer.
  87    * Equation 2 is solved in the virtual machine layer (here).
  88    * X1 must be passed to the virtual machine layer as a constraint value.
  89    **/
  90
  91   /* iterate for all virtual machines */
  92   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
  93     surf::Cpu* cpu = ws_vm->pimpl_cpu;
  94     xbt_assert(cpu, "cpu-less host");
  95
  96     double solved_value = ws_vm->pimpl_vm_->action_->getVariable()->get_value(); // this is X1 in comment above, what
  97                                                                                  // this VM got in the sharing on the PM
  98     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->getCname(), ws_vm->pimpl_vm_->getPm()->getCname());
  99
 100     xbt_assert(cpu->model() == surf_cpu_model_vm);
 101     lmm_system_t vcpu_system = cpu->model()->getMaxminSystem();
 102     vcpu_system->update_constraint_bound(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, size_t ramsize)
 118     : HostImpl(piface), hostPM_(host_PM), coreAmount_(coreAmount), ramsize_(ramsize)
 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   XBT_VERB("Create VM(%s)@PM(%s)", piface->getCname(), hostPM_->getCname());
 128 }
 129
 130 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 131 VirtualMachineImpl::~VirtualMachineImpl()
 132 {
 133   onVmDestruction(this);
 134   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 135   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 136   if (iter != allVms_.end())
 137     allVms_.erase(iter);
 138
 139   /* dirty page tracking */
 140   unsigned int size          = dp_objs.size();
 141   static bool already_warned = false;
 142   if (size > 0 && not already_warned) {
 143     auto front = dp_objs.begin();
 144     XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
 145              "If you don't understand why your task was not properly removed, please report that bug.\n"
 146              "This is a known bug if you turned the host off during the VM execution.\n"
 147              "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
 148              "2016, sorry.",
 149              size, (xbt_log_no_loc ? "(name hidden)" : front->first.c_str()));
 150     already_warned = true;
 151   }
 152
 153   /* Free the cpu_action of the VM. */
 154   XBT_ATTRIB_UNUSED int ret = action_->unref();
 155   xbt_assert(ret == 1, "Bug: some resource still remains");
 156 }
 157
 158 e_surf_vm_state_t VirtualMachineImpl::getState()
 159 {
 160   return vmState_;
 161 }
 162
 163 void VirtualMachineImpl::setState(e_surf_vm_state_t state)
 164 {
 165   vmState_ = state;
 166 }
 167 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 168 {
 169   if (isMigrating)
 170     THROWF(vm_error, 0, "Cannot suspend VM '%s': it is migrating", piface_->getCname());
 171   if (getState() != SURF_VM_STATE_RUNNING)
 172     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->getCname());
 173   if (issuer->host == piface_)
 174     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->getCname(), piface_->getCname());
 175
 176   auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 177   XBT_DEBUG("suspend VM(%s), where %zu processes exist", piface_->getCname(), process_list.size());
 178
 179   action_->suspend();
 180
 181   for (auto& smx_process : process_list) {
 182     XBT_DEBUG("suspend %s", smx_process.name.c_str());
 183     smx_process.suspend(issuer);
 184   }
 185
 186   XBT_DEBUG("suspend all processes on the VM done done");
 187
 188   vmState_ = SURF_VM_STATE_SUSPENDED;
 189 }
 190
 191 void VirtualMachineImpl::resume()
 192 {
 193   if (getState() != SURF_VM_STATE_SUSPENDED)
 194     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->getCname());
 195
 196   auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 197   XBT_DEBUG("Resume VM %s, containing %zu processes.", piface_->getCname(), process_list.size());
 198
 199   action_->resume();
 200
 201   for (auto& smx_process : process_list) {
 202     XBT_DEBUG("resume %s", smx_process.getCname());
 203     smx_process.resume();
 204   }
 205
 206   vmState_ = SURF_VM_STATE_RUNNING;
 207 }
 208
 209 /** @brief Power off a VM.
 210  *
 211  * All hosted processes will be killed, but the VM state is preserved on memory.
 212  * It can later be restarted.
 213  *
 214  * @param issuer the actor requesting the shutdown
 215  */
 216 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 217 {
 218   if (getState() != SURF_VM_STATE_RUNNING) {
 219     const char* stateName = "(unknown state)";
 220     switch (getState()) {
 221       case SURF_VM_STATE_CREATED:
 222         stateName = "created, but not yet started";
 223         break;
 224       case SURF_VM_STATE_SUSPENDED:
 225         stateName = "suspended";
 226         break;
 227       case SURF_VM_STATE_DESTROYED:
 228         stateName = "destroyed";
 229         break;
 230       default: /* SURF_VM_STATE_RUNNING or unexpected values */
 231         THROW_IMPOSSIBLE;
 232         break;
 233     }
 234     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->getCname(), stateName);
 235   }
 236
 237   auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
 238   XBT_DEBUG("shutdown VM %s, that contains %zu processes", piface_->getCname(), process_list.size());
 239
 240   for (auto& smx_process : process_list) {
 241     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process.getCname(),
 242               smx_process.host->getCname(), issuer->getCname());
 243     SIMIX_process_kill(&smx_process, issuer);
 244   }
 245
 246   setState(SURF_VM_STATE_DESTROYED);
 247
 248   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 249 }
 250
 251 /** @brief returns the physical machine on which the VM is running **/
 252 s4u::Host* VirtualMachineImpl::getPm()
 253 {
 254   return hostPM_;
 255 }
 256
 257 /** @brief Change the physical host on which the given VM is running
 258  *
 259  * This is an instantaneous migration.
 260  */
 261 void VirtualMachineImpl::setPm(s4u::Host* destination)
 262 {
 263   const char* vm_name     = piface_->getCname();
 264   const char* pm_name_src = hostPM_->getCname();
 265   const char* pm_name_dst = destination->getCname();
 266
 267   /* update net_elm with that of the destination physical host */
 268   piface_->pimpl_netpoint = destination->pimpl_netpoint;
 269
 270   hostPM_ = destination;
 271
 272   /* Update vcpu's action for the new pm */
 273   /* create a cpu action bound to the pm model at the destination. */
 274   surf::CpuAction* new_cpu_action =
 275       static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->coreAmount_));
 276
 277   if (action_->getRemainsNoUpdate() > 0)
 278     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
 279
 280   /* keep the bound value of the cpu action of the VM. */
 281   double old_bound = action_->getBound();
 282   if (old_bound > 0) {
 283     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
 284     new_cpu_action->setBound(old_bound);
 285   }
 286
 287   XBT_ATTRIB_UNUSED int ret = action_->unref();
 288   xbt_assert(ret == 1, "Bug: some resource still remains");
 289
 290   action_ = new_cpu_action;
 291
 292   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
 293 }
 294
 295 void VirtualMachineImpl::setBound(double bound)
 296 {
 297   action_->setBound(bound);
 298 }
 299
 300 void VirtualMachineImpl::getParams(vm_params_t params)
 301 {
 302   *params = params_;
 303 }
 304
 305 void VirtualMachineImpl::setParams(vm_params_t params)
 306 {
 307   /* may check something here. */
 308   params_ = *params;
 309 }
 310 }
 311 }