src/plugins/vm/s4u_VirtualMachine.cpp

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