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