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