src/plugins/vm/s4u_VirtualMachine.cpp

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