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