src/plugins/vm/s4u_VirtualMachine.cpp

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