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