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