src/plugins/vm/s4u_VirtualMachine.cpp

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