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