src/plugins/vm/s4u_VirtualMachine.cpp

   1 /* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/s4u/Actor.hpp"
   7 #include "src/instr/instr_private.hpp"
   8 #include "src/plugins/vm/VirtualMachineImpl.hpp"
   9 #include "src/plugins/vm/VmHostExt.hpp"
  10 #include "src/simix/smx_host_private.hpp"
  11 #include "src/surf/cpu_cas01.hpp"
  12 #include <src/plugins/vm/VmLiveMigration.hpp>
  13
  14 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_vm, "S4U virtual machines");
  15
  16 namespace simgrid {
  17 namespace s4u {
  18
  19 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount)
  20     : VirtualMachine(name, pm, coreAmount, 1024)
  21 {
  22 }
  23
  24 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount, size_t ramsize)
  25     : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, pm, coreAmount, ramsize))
  26 {
  27   XBT_DEBUG("Create VM %s", name);
  28
  29   /* Currently, a VM uses the network resource of its physical host */
  30   pimpl_netpoint = pm->pimpl_netpoint;
  31   // Create a VCPU for this VM
  32   surf::CpuCas01* sub_cpu = dynamic_cast<surf::CpuCas01*>(pm->pimpl_cpu);
  33
  34   pimpl_cpu = surf_cpu_model_vm->createCpu(this, sub_cpu->getSpeedPeakList(), coreAmount);
  35   if (sub_cpu->getPState() != 0)
  36     pimpl_cpu->setPState(sub_cpu->getPState());
  37
  38   /* Make a process container */
  39   extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
  40
  41   if (TRACE_msg_vm_is_enabled()) {
  42     container_t host_container = instr::Container::byName(pm->getName());
  43     new instr::Container(name, "MSG_VM", host_container);
  44     instr::Container::byName(getName())->getState("MSG_VM_STATE")->addEntityValue("start", "0 0 1");   // start is blue
  45     instr::Container::byName(getName())->getState("MSG_VM_STATE")->addEntityValue("suspend", "1 0 0"); // suspend is red
  46   }
  47 }
  48
  49 VirtualMachine::~VirtualMachine()
  50 {
  51   onDestruction(*this);
  52
  53   XBT_DEBUG("destroy %s", getCname());
  54
  55   /* FIXME: this is really strange that everything fails if the next line is removed.
  56    * This is as if we shared these data with the PM, which definitely should not be the case...
  57    *
  58    * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
  59    * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
  60    */
  61   extension_set<simgrid::simix::Host>(nullptr);
  62
  63   /* Don't free these things twice: they are the ones of my physical host */
  64   pimpl_netpoint = nullptr;
  65
  66   if (TRACE_msg_vm_is_enabled()) {
  67     container_t container = simgrid::instr::Container::byName(getName());
  68     container->removeFromParent();
  69     delete container;
  70   }
  71 }
  72
  73 void VirtualMachine::start()
  74 {
  75   if (TRACE_msg_vm_is_enabled())
  76     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->pushEvent("start");
  77
  78   simgrid::simix::kernelImmediate([this]() {
  79     simgrid::vm::VmHostExt::ensureVmExtInstalled();
  80
  81     simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
  82     if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
  83       pm->extension_set(new simgrid::vm::VmHostExt());
  84
  85     long pm_ramsize   = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
  86     int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
  87     long vm_ramsize   = this->getRamsize();
  88
  89     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
  90       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
  91       long total_ramsize_of_vms = 0;
  92       for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
  93         if (pm == ws_vm->getPm())
  94           total_ramsize_of_vms += ws_vm->getRamsize();
  95
  96       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  97         XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
  98                  this->getCname(), pm->getCname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  99         THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->getCname(),
 100                this->getCname());
 101       }
 102     }
 103
 104     this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
 105   });
 106
 107   if (TRACE_msg_vm_is_enabled())
 108     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->popEvent();
 109 }
 110
 111 void VirtualMachine::suspend()
 112 {
 113   smx_actor_t issuer = SIMIX_process_self();
 114   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->suspend(issuer); });
 115   if (TRACE_msg_vm_is_enabled())
 116     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->pushEvent("suspend");
 117   XBT_DEBUG("vm_suspend done");
 118 }
 119
 120 void VirtualMachine::resume()
 121 {
 122   pimpl_vm_->resume();
 123   if (TRACE_msg_vm_is_enabled())
 124     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->popEvent();
 125 }
 126
 127 void VirtualMachine::shutdown()
 128 {
 129   smx_actor_t issuer = SIMIX_process_self();
 130   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->shutdown(issuer); });
 131 }
 132
 133 void VirtualMachine::destroy()
 134 {
 135   if (isMigrating())
 136     THROWF(vm_error, 0, "Cannot destroy VM '%s', which is migrating.", getCname());
 137
 138   /* First, terminate all processes on the VM if necessary */
 139   shutdown();
 140
 141   /* Then, destroy the VM object */
 142   Host::destroy();
 143 }
 144
 145 bool VirtualMachine::isMigrating()
 146 {
 147   return pimpl_vm_ && pimpl_vm_->isMigrating;
 148 }
 149
 150 simgrid::s4u::Host* VirtualMachine::getPm()
 151 {
 152   return pimpl_vm_->getPm();
 153 }
 154
 155 void VirtualMachine::setPm(simgrid::s4u::Host* pm)
 156 {
 157   simgrid::simix::kernelImmediate([this, pm]() { pimpl_vm_->setPm(pm); });
 158 }
 159
 160 e_surf_vm_state_t VirtualMachine::getState()
 161 {
 162   return simgrid::simix::kernelImmediate([this]() { return pimpl_vm_->getState(); });
 163 }
 164
 165 size_t VirtualMachine::getRamsize()
 166 {
 167   return pimpl_vm_->getRamsize();
 168 }
 169
 170 void VirtualMachine::setRamsize(size_t ramsize)
 171 {
 172   pimpl_vm_->setRamsize(ramsize);
 173 }
 174 /** @brief Set a CPU bound for a given VM.
 175  *  @ingroup msg_VMs
 176  *
 177  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
 178  *
 179  * For example,
 180  *  On PM0, there are Task1 and VM0.
 181  *  On VM0, there is Task2.
 182  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
 183  * Then,
 184  *  Task1\@PM0 gets 50%.
 185  *  Task2\@VM0 gets 25%.
 186  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
 187  *
 188  * This is because a VM has the dummy CPU action in the PM layer. Putting a task on the VM does not affect the bound of
 189  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
 190  *
 191  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
 192  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
 193  * on the VM in share_resource() or we have to trap both the start and end of task execution.
 194  *
 195  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
 196  *
 197  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
 198  *    computation task (or a VM) never exceeds the capacity of a CPU core.
 199  */
 200 void VirtualMachine::setBound(double bound)
 201 {
 202   simgrid::simix::kernelImmediate([this, bound]() { pimpl_vm_->setBound(bound); });
 203 }
 204
 205 } // namespace simgrid
 206 } // namespace s4u