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 simgrid::xbt::signal<void(simgrid::s4u::VirtualMachine*)> simgrid::s4u::VirtualMachine::onVmShutdown;
  17
  18 namespace simgrid {
  19 namespace s4u {
  20
  21 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount)
  22     : VirtualMachine(name, pm, coreAmount, 1024)
  23 {
  24 }
  25
  26 VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount, size_t ramsize)
  27     : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, pm, coreAmount, ramsize))
  28 {
  29   XBT_DEBUG("Create VM %s", name);
  30
  31   /* Currently, a VM uses the network resource of its physical host */
  32   pimpl_netpoint = pm->pimpl_netpoint;
  33   // Create a VCPU for this VM
  34   surf::CpuCas01* sub_cpu = dynamic_cast<surf::CpuCas01*>(pm->pimpl_cpu);
  35
  36   pimpl_cpu = surf_cpu_model_vm->createCpu(this, sub_cpu->getSpeedPeakList(), coreAmount);
  37   if (sub_cpu->getPState() != 0)
  38     pimpl_cpu->setPState(sub_cpu->getPState());
  39
  40   /* Make a process container */
  41   extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
  42
  43   if (TRACE_msg_vm_is_enabled()) {
  44     container_t host_container = instr::Container::byName(pm->getName());
  45     new instr::Container(name, "MSG_VM", host_container);
  46     instr::Container::byName(getName())->getState("MSG_VM_STATE")->addEntityValue("start", "0 0 1");   // start is blue
  47     instr::Container::byName(getName())->getState("MSG_VM_STATE")->addEntityValue("suspend", "1 0 0"); // suspend is red
  48   }
  49 }
  50
  51 VirtualMachine::~VirtualMachine()
  52 {
  53   onDestruction(*this);
  54
  55   XBT_DEBUG("destroy %s", getCname());
  56
  57   /* FIXME: this is really strange that everything fails if the next line is removed.
  58    * This is as if we shared these data with the PM, which definitely should not be the case...
  59    *
  60    * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
  61    * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
  62    */
  63   extension_set<simgrid::simix::Host>(nullptr);
  64
  65   /* Don't free these things twice: they are the ones of my physical host */
  66   pimpl_netpoint = nullptr;
  67
  68   if (TRACE_msg_vm_is_enabled()) {
  69     container_t container = simgrid::instr::Container::byName(getName());
  70     container->removeFromParent();
  71     delete container;
  72   }
  73 }
  74
  75 void VirtualMachine::start()
  76 {
  77   if (TRACE_msg_vm_is_enabled())
  78     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->pushEvent("start");
  79
  80   simgrid::simix::kernelImmediate([this]() {
  81     simgrid::vm::VmHostExt::ensureVmExtInstalled();
  82
  83     simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
  84     if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
  85       pm->extension_set(new simgrid::vm::VmHostExt());
  86
  87     long pm_ramsize   = pm->extension<simgrid::vm::VmHostExt>()->ramsize;
  88     int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
  89     long vm_ramsize   = this->getRamsize();
  90
  91     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
  92       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
  93       long total_ramsize_of_vms = 0;
  94       for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
  95         if (pm == ws_vm->getPm())
  96           total_ramsize_of_vms += ws_vm->getRamsize();
  97
  98       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  99         XBT_WARN("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
 100                  this->getCname(), pm->getCname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
 101         THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->getCname(),
 102                this->getCname());
 103       }
 104     }
 105
 106     this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
 107   });
 108
 109   if (TRACE_msg_vm_is_enabled())
 110     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->popEvent();
 111 }
 112
 113 void VirtualMachine::suspend()
 114 {
 115   smx_actor_t issuer = SIMIX_process_self();
 116   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->suspend(issuer); });
 117   if (TRACE_msg_vm_is_enabled())
 118     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->pushEvent("suspend");
 119   XBT_DEBUG("vm_suspend done");
 120 }
 121
 122 void VirtualMachine::resume()
 123 {
 124   pimpl_vm_->resume();
 125   if (TRACE_msg_vm_is_enabled())
 126     simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->popEvent();
 127 }
 128
 129 void VirtualMachine::shutdown()
 130 {
 131   smx_actor_t issuer = SIMIX_process_self();
 132   simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->shutdown(issuer); });
 133   onVmShutdown(this);
 134 }
 135
 136 void VirtualMachine::destroy()
 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 simgrid::s4u::Host* VirtualMachine::getPm()
 146 {
 147   return pimpl_vm_->getPm();
 148 }
 149
 150 void VirtualMachine::setPm(simgrid::s4u::Host* pm)
 151 {
 152   simgrid::simix::kernelImmediate([this, pm]() { pimpl_vm_->setPm(pm); });
 153 }
 154
 155 e_surf_vm_state_t VirtualMachine::getState()
 156 {
 157   return simgrid::simix::kernelImmediate([this]() { return pimpl_vm_->getState(); });
 158 }
 159
 160 size_t VirtualMachine::getRamsize()
 161 {
 162   return pimpl_vm_->getRamsize();
 163 }
 164
 165 void VirtualMachine::setRamsize(size_t ramsize)
 166 {
 167   pimpl_vm_->setRamsize(ramsize);
 168 }
 169 /** @brief Set a CPU bound for a given VM.
 170  *  @ingroup msg_VMs
 171  *
 172  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
 173  *
 174  * For example,
 175  *  On PM0, there are Task1 and VM0.
 176  *  On VM0, there is Task2.
 177  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
 178  * Then,
 179  *  Task1\@PM0 gets 50%.
 180  *  Task2\@VM0 gets 25%.
 181  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
 182  *
 183  * 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
 184  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
 185  *
 186  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
 187  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
 188  * on the VM in share_resource() or we have to trap both the start and end of task execution.
 189  *
 190  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
 191  *
 192  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
 193  *    computation task (or a VM) never exceeds the capacity of a CPU core.
 194  */
 195 void VirtualMachine::setBound(double bound)
 196 {
 197   simgrid::simix::kernelImmediate([this, bound]() { pimpl_vm_->setBound(bound); });
 198 }
 199
 200 } // namespace simgrid
 201 } // namespace s4u
 202
 203 /* **************************** Public C interface *************************** */
 204
 205 SG_BEGIN_DECL()
 206 /** @brief Create a new VM object with the default parameters
 207  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 208  */
 209 msg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
 210 {
 211   return sg_vm_create_multicore(pm, name, 1);
 212 }
 213 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
 214  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 215  */
 216 msg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
 217 {
 218   xbt_assert(sg_host_by_name(name) == nullptr,
 219              "Cannot create a VM named %s: this name is already used by an host or a VM", name);
 220
 221   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
 222 }
 223
 224 const char* sg_vm_get_name(sg_vm_t vm)
 225 {
 226   return vm->getCname();
 227 }
 228
 229 /** @brief Get the physical host of a given VM. */
 230 sg_host_t sg_vm_get_pm(sg_vm_t vm)
 231 {
 232   return vm->getPm();
 233 }
 234
 235 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
 236 {
 237   vm->setRamsize(size);
 238 }
 239
 240 size_t sg_vm_get_ramsize(sg_vm_t vm)
 241 {
 242   return vm->getRamsize();
 243 }
 244
 245 void sg_vm_set_bound(sg_vm_t vm, double bound)
 246 {
 247   vm->setBound(bound);
 248 }
 249
 250 /** @brief Returns whether the given VM has just created, not running. */
 251 int sg_vm_is_created(sg_vm_t vm)
 252 {
 253   return vm->getState() == SURF_VM_STATE_CREATED;
 254 }
 255
 256 /** @brief Returns whether the given VM is currently running */
 257 int sg_vm_is_running(sg_vm_t vm)
 258 {
 259   return vm->getState() == SURF_VM_STATE_RUNNING;
 260 }
 261
 262 /** @brief Returns whether the given VM is currently suspended, not running. */
 263 int sg_vm_is_suspended(sg_vm_t vm)
 264 {
 265   return vm->getState() == SURF_VM_STATE_SUSPENDED;
 266 }
 267
 268 /** @brief Start a vm (i.e., boot the guest operating system)
 269  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
 270  */
 271 void sg_vm_start(sg_vm_t vm)
 272 {
 273   vm->start();
 274 }
 275
 276 /** @brief Immediately suspend the execution of all processes within the given VM.
 277  *
 278  * This function stops the execution of the VM. All the processes on this VM
 279  * will pause. The state of the VM is preserved. We can later resume it again.
 280  *
 281  * No suspension cost occurs.
 282  */
 283 void sg_vm_suspend(sg_vm_t vm)
 284 {
 285   vm->suspend();
 286 }
 287
 288 /** @brief Resume the execution of the VM. All processes on the VM run again.
 289  * No resume cost occurs.
 290  */
 291 void sg_vm_resume(sg_vm_t vm)
 292 {
 293   vm->resume();
 294 }
 295
 296 /** @brief Immediately kills all processes within the given VM.
 297  * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
 298  *
 299  * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
 300  */
 301 void sg_vm_shutdown(sg_vm_t vm)
 302 {
 303   vm->shutdown();
 304 }
 305
 306 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
 307 void sg_vm_destroy(sg_vm_t vm)
 308 {
 309   vm->destroy();
 310 }
 311 SG_END_DECL()