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