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