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