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