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), pimpl_vm_(new vm::VirtualMachineImpl(this, physical_host, core_amount, ramsize))
  34 {
  35   XBT_DEBUG("Create VM %s", get_cname());
  36
  37   /* Currently, a VM uses the network resource of its physical host */
  38   set_netpoint(physical_host->get_netpoint());
  39
  40   // Create a VCPU for this VM
  41   std::vector<double> speeds;
  42   for (int i = 0; i < physical_host->get_pstate_count(); i++)
  43     speeds.push_back(physical_host->get_pstate_speed(i));
  44
  45   physical_host->get_netpoint()->get_englobing_zone()->get_cpu_vm_model()->create_cpu(this, speeds)->set_core_count(core_amount)->seal();
  46   if (physical_host->get_pstate() != 0)
  47     set_pstate(physical_host->get_pstate());
  48
  49   // Real hosts are (only) created through NetZone::create_host(), and this where the on_creation signal is fired.
  50   // VMs are created directly, thus firing the signal here. The right solution is probably to separate Host and VM.
  51   simgrid::s4u::Host::on_creation(*this);
  52 }
  53
  54 VirtualMachine::~VirtualMachine()
  55 {
  56   on_destruction(*this);
  57
  58   XBT_DEBUG("destroy %s", get_cname());
  59
  60   /* Don't free these things twice: they are the ones of my physical host */
  61   set_netpoint(nullptr);
  62 }
  63
  64 void VirtualMachine::start()
  65 {
  66   on_start(*this);
  67
  68   kernel::actor::simcall([this]() {
  69     vm::VmHostExt::ensureVmExtInstalled();
  70
  71     Host* pm = this->pimpl_vm_->get_physical_host();
  72     if (pm->extension<vm::VmHostExt>() == nullptr)
  73       pm->extension_set(new vm::VmHostExt());
  74
  75     long pm_ramsize   = pm->extension<vm::VmHostExt>()->ramsize;
  76     int pm_overcommit = pm->extension<vm::VmHostExt>()->overcommit;
  77     long vm_ramsize   = this->get_ramsize();
  78
  79     if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
  80       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
  81       long total_ramsize_of_vms = 0;
  82       for (VirtualMachine* const& ws_vm : vm::VirtualMachineImpl::allVms_)
  83         if (pm == ws_vm->get_pm())
  84           total_ramsize_of_vms += ws_vm->get_ramsize();
  85
  86       if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
  87         XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
  88                  this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  89         throw VmFailureException(XBT_THROW_POINT,
  90                                  xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
  91                                                     pm->get_cname(), this->get_cname()));
  92       }
  93     }
  94
  95     this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
  96   });
  97
  98   on_started(*this);
  99 }
 100
 101 void VirtualMachine::suspend()
 102 {
 103   on_suspend(*this);
 104   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 105   kernel::actor::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   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 117   kernel::actor::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::get_pm() const
 131 {
 132   return pimpl_vm_->get_physical_host();
 133 }
 134
 135 VirtualMachine* VirtualMachine::set_pm(simgrid::s4u::Host* pm)
 136 {
 137   kernel::actor::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
 138   return this;
 139 }
 140
 141 VirtualMachine::state VirtualMachine::get_state() const
 142 {
 143   return kernel::actor::simcall([this]() { return pimpl_vm_->get_state(); });
 144 }
 145
 146 size_t VirtualMachine::get_ramsize() const
 147 {
 148   return pimpl_vm_->get_ramsize();
 149 }
 150
 151 VirtualMachine* VirtualMachine::set_ramsize(size_t ramsize)
 152 {
 153   pimpl_vm_->set_ramsize(ramsize);
 154   return this;
 155 }
 156 /** @brief Set a CPU bound for a given VM.
 157  *  @ingroup msg_VMs
 158  *
 159  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
 160  *
 161  * For example,
 162  *  On PM0, there are Task1 and VM0.
 163  *  On VM0, there is Task2.
 164  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
 165  * Then,
 166  *  Task1\@PM0 gets 50%.
 167  *  Task2\@VM0 gets 25%.
 168  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
 169  *
 170  * 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
 171  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
 172  *
 173  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
 174  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
 175  * on the VM in share_resource() or we have to trap both the start and end of task execution.
 176  *
 177  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
 178  *
 179  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
 180  *    computation task (or a VM) never exceeds the capacity of a CPU core.
 181  */
 182 VirtualMachine* VirtualMachine::set_bound(double bound)
 183 {
 184   kernel::actor::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
 185   return this;
 186 }
 187
 188 } // namespace simgrid
 189 } // namespace s4u
 190
 191 /* **************************** Public C interface *************************** */
 192
 193 /** @brief Create a new VM object with the default parameters
 194  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 195  */
 196 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
 197 {
 198   return sg_vm_create_multicore(pm, name, 1);
 199 }
 200 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
 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_multicore(sg_host_t pm, const char* name, int coreAmount)
 204 {
 205   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
 206 }
 207
 208 const char* sg_vm_get_name(const_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(const_sg_vm_t vm)
 215 {
 216   return vm->get_pm();
 217 }
 218
 219 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
 220 {
 221   vm->set_ramsize(size);
 222 }
 223
 224 size_t sg_vm_get_ramsize(const_sg_vm_t vm)
 225 {
 226   return vm->get_ramsize();
 227 }
 228
 229 void sg_vm_set_bound(sg_vm_t vm, double bound)
 230 {
 231   vm->set_bound(bound);
 232 }
 233
 234 /** @brief Returns whether the given VM has just created, not running. */
 235 int sg_vm_is_created(const_sg_vm_t vm)
 236 {
 237   return vm->get_state() == simgrid::s4u::VirtualMachine::state::CREATED;
 238 }
 239
 240 /** @brief Returns whether the given VM is currently running */
 241 int sg_vm_is_running(const_sg_vm_t vm)
 242 {
 243   return vm->get_state() == simgrid::s4u::VirtualMachine::state::RUNNING;
 244 }
 245
 246 /** @brief Returns whether the given VM is currently suspended, not running. */
 247 int sg_vm_is_suspended(const_sg_vm_t vm)
 248 {
 249   return vm->get_state() == simgrid::s4u::VirtualMachine::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  *
 282  @beginrst
 283
 284  The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
 285
 286  @endrst
 287  *
 288  * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that you want.
 289  */
 290 void sg_vm_shutdown(sg_vm_t vm)
 291 {
 292   vm->shutdown();
 293 }
 294
 295 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
 296 void sg_vm_destroy(sg_vm_t vm)
 297 {
 298   vm->destroy();
 299 }