src/plugins/vm/s4u_VirtualMachine.cpp

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