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