src/s4u/s4u_VirtualMachine.cpp

   1 /* Copyright (c) 2015-2023. 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/simix.hpp"
   7 #include <simgrid/Exception.hpp>
   8 #include <simgrid/kernel/routing/NetPoint.hpp>
   9 #include <simgrid/vm.h>
  10
  11 #include "src/kernel/resource/VirtualMachineImpl.hpp"
  12 #include "src/kernel/resource/models/cpu_cas01.hpp"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
  15
  16 namespace simgrid::s4u {
  17 xbt::signal<void(VirtualMachine&)> VirtualMachine::on_vm_creation;
  18 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_start;
  19 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_started;
  20 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_shutdown;
  21 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_suspend;
  22 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_resume;
  23 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_start;
  24 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_end;
  25 xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_vm_destruction;
  26
  27 xbt::Extension<Host, VmHostExt> VmHostExt::EXTENSION_ID;
  28
  29 void VmHostExt::ensureVmExtInstalled()
  30 {
  31   if (not EXTENSION_ID.valid())
  32     EXTENSION_ID = Host::extension_create<VmHostExt>();
  33 }
  34
  35 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount, size_t ramsize)
  36     : Host(new kernel::resource::VirtualMachineImpl(name, this, physical_host, core_amount, ramsize))
  37     , pimpl_vm_(dynamic_cast<kernel::resource::VirtualMachineImpl*>(Host::get_impl()))
  38 {
  39   physical_host->get_impl()->create_vm(name, this);
  40 }
  41
  42 VirtualMachine::VirtualMachine(kernel::resource::VirtualMachineImpl* impl)
  43     : Host(impl), pimpl_vm_(dynamic_cast<kernel::resource::VirtualMachineImpl*>(Host::get_impl()))
  44 {
  45 }
  46
  47 void VirtualMachine::start()
  48 {
  49   kernel::actor::simcall_answered([this]() { pimpl_vm_->start(); });
  50 }
  51
  52 void VirtualMachine::suspend()
  53 {
  54   const kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  55   kernel::actor::simcall_answered([this, issuer]() { pimpl_vm_->suspend(issuer); });
  56 }
  57
  58 void VirtualMachine::resume()
  59 {
  60   pimpl_vm_->resume();
  61 }
  62
  63 void VirtualMachine::shutdown()
  64 {
  65   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  66   kernel::actor::simcall_answered([this, issuer]() { pimpl_vm_->shutdown(issuer); });
  67 }
  68
  69 void VirtualMachine::destroy()
  70 {
  71   auto destroy_code = [this]() {
  72     /* First, terminate all processes on the VM if necessary */
  73     shutdown();
  74
  75     XBT_DEBUG("destroy %s", get_cname());
  76     on_vm_destruction(*this);
  77     on_this_vm_destruction(*this);
  78     /* Then, destroy the VM object */
  79     kernel::actor::simcall_answered(
  80         [this]() { get_vm_impl()->get_physical_host()->get_impl()->destroy_vm(get_name()); });
  81   };
  82
  83   if (not this_actor::is_maestro() && this_actor::get_host() == this) {
  84     XBT_VERB("Launch another actor on physical host %s to destroy my own VM: %s", get_pm()->get_cname(), get_cname());
  85     simgrid::s4u::Actor::create(get_name() + "-vm_destroy", get_pm(), destroy_code);
  86     simgrid::s4u::this_actor::yield();
  87     XBT_CRITICAL("I should be dead now!");
  88     DIE_IMPOSSIBLE;
  89   }
  90
  91   destroy_code();
  92 }
  93
  94 simgrid::s4u::Host* VirtualMachine::get_pm() const
  95 {
  96   return pimpl_vm_->get_physical_host();
  97 }
  98
  99 VirtualMachine* VirtualMachine::set_pm(simgrid::s4u::Host* pm)
 100 {
 101   kernel::actor::simcall_answered([this, pm]() { pimpl_vm_->set_physical_host(pm); });
 102   return this;
 103 }
 104
 105 VirtualMachine::State VirtualMachine::get_state() const
 106 {
 107   return kernel::actor::simcall_answered([this]() { return pimpl_vm_->get_state(); });
 108 }
 109
 110 size_t VirtualMachine::get_ramsize() const
 111 {
 112   return pimpl_vm_->get_ramsize();
 113 }
 114
 115 VirtualMachine* VirtualMachine::set_ramsize(size_t ramsize)
 116 {
 117   pimpl_vm_->set_ramsize(ramsize);
 118   return this;
 119 }
 120 /** @brief Set a CPU bound for a given VM.
 121  *  @ingroup msg_VMs
 122  *
 123  * 1. Note that in some cases sg_exec_set_bound() may not intuitively work for VMs.
 124  *
 125  * For example,
 126  *  On PM0, there are Task1 and VM0.
 127  *  On VM0, there is Task2.
 128  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
 129  * Then,
 130  *  Task1\@PM0 gets 50%.
 131  *  Task2\@VM0 gets 25%.
 132  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
 133  *
 134  * 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
 135  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
 136  *
 137  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
 138  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
 139  * on the VM in share_resource() or we have to trap both the start and end of task execution.
 140  *
 141  * The current solution is to use set_bound(), which allows us to directly set the bound of the dummy CPU action.
 142  *
 143  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
 144  *    computation task (or a VM) never exceeds the capacity of a CPU core.
 145  */
 146 VirtualMachine* VirtualMachine::set_bound(double bound)
 147 {
 148   kernel::actor::simcall_answered([this, bound]() { pimpl_vm_->set_bound(bound); });
 149   return this;
 150 }
 151
 152 void VirtualMachine::start_migration() const
 153 {
 154   pimpl_vm_->start_migration();
 155 }
 156
 157 void VirtualMachine::end_migration() const
 158 {
 159   pimpl_vm_->end_migration();
 160 }
 161
 162 } // namespace simgrid::s4u
 163
 164 /* **************************** Public C interface *************************** */
 165
 166 /** @brief Create a new VM object with the default parameters
 167  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 168  */
 169 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
 170 {
 171   return sg_vm_create_multicore(pm, name, 1);
 172 }
 173 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
 174  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 175  */
 176 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
 177 {
 178   return pm->create_vm(name, coreAmount);
 179 }
 180
 181 const char* sg_vm_get_name(const_sg_vm_t vm)
 182 {
 183   return vm->get_cname();
 184 }
 185
 186 /** @brief Get the physical host of a given VM. */
 187 sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
 188 {
 189   return vm->get_pm();
 190 }
 191
 192 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
 193 {
 194   vm->set_ramsize(size);
 195 }
 196
 197 size_t sg_vm_get_ramsize(const_sg_vm_t vm)
 198 {
 199   return vm->get_ramsize();
 200 }
 201
 202 void sg_vm_set_bound(sg_vm_t vm, double bound)
 203 {
 204   vm->set_bound(bound);
 205 }
 206
 207 /** @brief Returns whether the given VM has just created, not running. */
 208 int sg_vm_is_created(const_sg_vm_t vm)
 209 {
 210   return vm->get_state() == simgrid::s4u::VirtualMachine::State::CREATED;
 211 }
 212
 213 /** @brief Returns whether the given VM is currently running */
 214 int sg_vm_is_running(const_sg_vm_t vm)
 215 {
 216   return vm->get_state() == simgrid::s4u::VirtualMachine::State::RUNNING;
 217 }
 218
 219 /** @brief Returns whether the given VM is currently suspended, not running. */
 220 int sg_vm_is_suspended(const_sg_vm_t vm)
 221 {
 222   return vm->get_state() == simgrid::s4u::VirtualMachine::State::SUSPENDED;
 223 }
 224
 225 /** @brief Start a vm (i.e., boot the guest operating system)
 226  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
 227  */
 228 void sg_vm_start(sg_vm_t vm)
 229 {
 230   vm->start();
 231 }
 232
 233 /** @brief Immediately suspend the execution of all processes within the given VM.
 234  *
 235  * This function stops the execution of the VM. All the processes on this VM
 236  * will pause. The state of the VM is preserved. We can later resume it again.
 237  *
 238  * No suspension cost occurs.
 239  */
 240 void sg_vm_suspend(sg_vm_t vm)
 241 {
 242   vm->suspend();
 243 }
 244
 245 /** @brief Resume the execution of the VM. All processes on the VM run again.
 246  * No resume cost occurs.
 247  */
 248 void sg_vm_resume(sg_vm_t vm)
 249 {
 250   vm->resume();
 251 }
 252
 253 /** @brief Immediately kills all processes within the given VM.
 254  *
 255  @beginrst
 256
 257  The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
 258
 259  @endrst
 260  *
 261  * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that
 262  you want.
 263  */
 264 void sg_vm_shutdown(sg_vm_t vm)
 265 {
 266   vm->shutdown();
 267 }
 268
 269 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
 270 void sg_vm_destroy(sg_vm_t vm)
 271 {
 272   vm->destroy();
 273 }