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