src/plugins/vm/s4u_VirtualMachine.cpp

   1 /* Copyright (c) 2015-2021. 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/Exception.hpp"
   7 #include "simgrid/s4u/Actor.hpp"
   8 #include "simgrid/vm.h"
   9 #include "src/include/surf/surf.hpp"
  10 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  11 #include "src/plugins/vm/VmHostExt.hpp"
  12 #include "src/surf/cpu_cas01.hpp"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
  15
  16 namespace simgrid {
  17 namespace s4u {
  18 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_start;
  19 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_started;
  20 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_shutdown;
  21 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_suspend;
  22 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_resume;
  23 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_start;
  24 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_end;
  25
  26 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount)
  27     : VirtualMachine(name, physical_host, core_amount, 1024)
  28 {
  29 }
  30
  31 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount, size_t ramsize)
  32     : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, physical_host, core_amount, ramsize))
  33 {
  34   XBT_DEBUG("Create VM %s", get_cname());
  35
  36   /* Currently, a VM uses the network resource of its physical host */
  37   set_netpoint(physical_host->get_netpoint());
  38
  39   // Create a VCPU for this VM
  40   std::vector<double> speeds;
  41   for (int i = 0; i < physical_host->get_pstate_count(); i++)
  42     speeds.push_back(physical_host->get_pstate_speed(i));
  43
  44   surf_cpu_model_vm->create_cpu(this, speeds, core_amount);
  45   if (physical_host->get_pstate() != 0)
  46     set_pstate(physical_host->get_pstate());
  47
  48   // Real hosts are (only) created through NetZone::create_host(), and this where the on_creation signal is fired.
  49   // VMs are created directly, thus firing the signal here. The right solution is probably to separate Host and VM.
  50   simgrid::s4u::Host::on_creation(*this);
  51 }
  52
  53 VirtualMachine::~VirtualMachine()
  54 {
  55   on_destruction(*this);
  56
  57   XBT_DEBUG("destroy %s", get_cname());
  58
  59   /* Don't free these things twice: they are the ones of my physical host */
  60   set_netpoint(nullptr);
  61 }
  62
  63 void VirtualMachine::start()
  64 {
  65   on_start(*this);
  66
  67   kernel::actor::simcall([this]() {
  68     vm::VmHostExt::ensureVmExtInstalled();
  69
  70     Host* pm = this->pimpl_vm_->get_physical_host();
  71     if (pm->extension<vm::VmHostExt>() == nullptr)
  72       pm->extension_set(new vm::VmHostExt());
  73
  74     long pm_ramsize   = pm->extension<vm::VmHostExt>()->ramsize;
  75     int pm_overcommit = pm->extension<vm::VmHostExt>()->overcommit;
  76     long vm_ramsize   = this->get_ramsize();
  77
  78     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
  79       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
  80       long total_ramsize_of_vms = 0;
  81       for (VirtualMachine* const& ws_vm : vm::VirtualMachineImpl::allVms_)
  82         if (pm == ws_vm->get_pm())
  83           total_ramsize_of_vms += ws_vm->get_ramsize();
  84
  85       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  86         XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
  87                  this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  88         throw VmFailureException(XBT_THROW_POINT,
  89                                  xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
  90                                                     pm->get_cname(), this->get_cname()));
  91       }
  92     }
  93
  94     this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
  95   });
  96
  97   on_started(*this);
  98 }
  99
 100 void VirtualMachine::suspend()
 101 {
 102   on_suspend(*this);
 103   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 104   kernel::actor::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
 105 }
 106
 107 void VirtualMachine::resume()
 108 {
 109   pimpl_vm_->resume();
 110   on_resume(*this);
 111 }
 112
 113 void VirtualMachine::shutdown()
 114 {
 115   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 116   kernel::actor::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
 117   on_shutdown(*this);
 118 }
 119
 120 void VirtualMachine::destroy()
 121 {
 122   /* First, terminate all processes on the VM if necessary */
 123   shutdown();
 124
 125   /* Then, destroy the VM object */
 126   Host::destroy();
 127 }
 128
 129 simgrid::s4u::Host* VirtualMachine::get_pm() const
 130 {
 131   return pimpl_vm_->get_physical_host();
 132 }
 133
 134 VirtualMachine* VirtualMachine::set_pm(simgrid::s4u::Host* pm)
 135 {
 136   kernel::actor::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
 137   return this;
 138 }
 139
 140 VirtualMachine::state VirtualMachine::get_state() const
 141 {
 142   return kernel::actor::simcall([this]() { return pimpl_vm_->get_state(); });
 143 }
 144
 145 size_t VirtualMachine::get_ramsize() const
 146 {
 147   return pimpl_vm_->get_ramsize();
 148 }
 149
 150 VirtualMachine* VirtualMachine::set_ramsize(size_t ramsize)
 151 {
 152   pimpl_vm_->set_ramsize(ramsize);
 153   return this;
 154 }
 155 /** @brief Set a CPU bound for a given VM.
 156  *  @ingroup msg_VMs
 157  *
 158  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
 159  *
 160  * For example,
 161  *  On PM0, there are Task1 and VM0.
 162  *  On VM0, there is Task2.
 163  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
 164  * Then,
 165  *  Task1\@PM0 gets 50%.
 166  *  Task2\@VM0 gets 25%.
 167  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
 168  *
 169  * 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
 170  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
 171  *
 172  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
 173  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
 174  * on the VM in share_resource() or we have to trap both the start and end of task execution.
 175  *
 176  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
 177  *
 178  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
 179  *    computation task (or a VM) never exceeds the capacity of a CPU core.
 180  */
 181 VirtualMachine* VirtualMachine::set_bound(double bound)
 182 {
 183   kernel::actor::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
 184   return this;
 185 }
 186
 187 } // namespace simgrid
 188 } // namespace s4u
 189
 190 /* **************************** Public C interface *************************** */
 191
 192 /** @brief Create a new VM object with the default parameters
 193  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 194  */
 195 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
 196 {
 197   return sg_vm_create_multicore(pm, name, 1);
 198 }
 199 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
 200  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 201  */
 202 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
 203 {
 204   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
 205 }
 206
 207 const char* sg_vm_get_name(const_sg_vm_t vm)
 208 {
 209   return vm->get_cname();
 210 }
 211
 212 /** @brief Get the physical host of a given VM. */
 213 sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
 214 {
 215   return vm->get_pm();
 216 }
 217
 218 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
 219 {
 220   vm->set_ramsize(size);
 221 }
 222
 223 size_t sg_vm_get_ramsize(const_sg_vm_t vm)
 224 {
 225   return vm->get_ramsize();
 226 }
 227
 228 void sg_vm_set_bound(sg_vm_t vm, double bound)
 229 {
 230   vm->set_bound(bound);
 231 }
 232
 233 /** @brief Returns whether the given VM has just created, not running. */
 234 int sg_vm_is_created(const_sg_vm_t vm)
 235 {
 236   return vm->get_state() == simgrid::s4u::VirtualMachine::state::CREATED;
 237 }
 238
 239 /** @brief Returns whether the given VM is currently running */
 240 int sg_vm_is_running(const_sg_vm_t vm)
 241 {
 242   return vm->get_state() == simgrid::s4u::VirtualMachine::state::RUNNING;
 243 }
 244
 245 /** @brief Returns whether the given VM is currently suspended, not running. */
 246 int sg_vm_is_suspended(const_sg_vm_t vm)
 247 {
 248   return vm->get_state() == simgrid::s4u::VirtualMachine::state::SUSPENDED;
 249 }
 250
 251 /** @brief Start a vm (i.e., boot the guest operating system)
 252  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
 253  */
 254 void sg_vm_start(sg_vm_t vm)
 255 {
 256   vm->start();
 257 }
 258
 259 /** @brief Immediately suspend the execution of all processes within the given VM.
 260  *
 261  * This function stops the execution of the VM. All the processes on this VM
 262  * will pause. The state of the VM is preserved. We can later resume it again.
 263  *
 264  * No suspension cost occurs.
 265  */
 266 void sg_vm_suspend(sg_vm_t vm)
 267 {
 268   vm->suspend();
 269 }
 270
 271 /** @brief Resume the execution of the VM. All processes on the VM run again.
 272  * No resume cost occurs.
 273  */
 274 void sg_vm_resume(sg_vm_t vm)
 275 {
 276   vm->resume();
 277 }
 278
 279 /** @brief Immediately kills all processes within the given VM.
 280  *
 281  @beginrst
 282
 283  The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
 284
 285  @endrst
 286  *
 287  * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that you want.
 288  */
 289 void sg_vm_shutdown(sg_vm_t vm)
 290 {
 291   vm->shutdown();
 292 }
 293
 294 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
 295 void sg_vm_destroy(sg_vm_t vm)
 296 {
 297   vm->destroy();
 298 }