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