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