src/s4u/s4u_VirtualMachine.cpp

   1 /* Copyright (c) 2015-2022. 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/Exception.hpp>
   7 #include <simgrid/kernel/routing/NetPoint.hpp>
   8 #include <simgrid/vm.h>
   9
  10 #include "src/kernel/resource/VirtualMachineImpl.hpp"
  11 #include "src/surf/cpu_cas01.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
  14
  15 namespace simgrid {
  16 namespace s4u {
  17 xbt::signal<void(VirtualMachine&)> VirtualMachine::on_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_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   XBT_DEBUG("Create VM %s", get_cname());
  40
  41   /* Currently, a VM uses the network resource of its physical host */
  42   set_netpoint(physical_host->get_netpoint());
  43
  44   // Create a VCPU for this VM
  45   std::vector<double> speeds;
  46   for (unsigned long i = 0; i < physical_host->get_pstate_count(); i++)
  47     speeds.push_back(physical_host->get_pstate_speed(i));
  48
  49   physical_host->get_netpoint()
  50       ->get_englobing_zone()
  51       ->get_cpu_vm_model()
  52       ->create_cpu(this, speeds)
  53       ->set_core_count(core_amount)
  54       ->seal();
  55
  56   if (physical_host->get_pstate() != 0)
  57     set_pstate(physical_host->get_pstate());
  58
  59   seal(); // seal this host
  60   s4u::VirtualMachine::on_creation(*this);
  61 }
  62
  63 void VirtualMachine::start()
  64 {
  65   on_start(*this);
  66
  67   VmHostExt::ensureVmExtInstalled();
  68
  69   kernel::actor::simcall([this]() {
  70     Host* pm = this->pimpl_vm_->get_physical_host();
  71     if (pm->extension<VmHostExt>() == nullptr)
  72       pm->extension_set(new VmHostExt());
  73
  74     size_t pm_ramsize = pm->extension<VmHostExt>()->ramsize;
  75     if (pm_ramsize && not pm->extension<VmHostExt>()->overcommit) { /* Need to verify that we don't overcommit */
  76       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
  77       size_t total_ramsize_of_vms = 0;
  78       for (VirtualMachine* const& ws_vm : kernel::resource::VirtualMachineImpl::allVms_)
  79         if (pm == ws_vm->get_pm())
  80           total_ramsize_of_vms += ws_vm->get_ramsize();
  81
  82       if (total_ramsize_of_vms + get_ramsize() > pm_ramsize) {
  83         XBT_WARN("cannot start %s@%s due to memory shortage: get_ramsize() %zu, free %zu, pm_ramsize %zu (bytes).",
  84                  get_cname(), pm->get_cname(), get_ramsize(), pm_ramsize - total_ramsize_of_vms, pm_ramsize);
  85         throw VmFailureException(XBT_THROW_POINT,
  86                                  xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
  87                                                     pm->get_cname(), get_cname()));
  88       }
  89     }
  90     this->pimpl_vm_->set_state(State::RUNNING);
  91   });
  92
  93   on_started(*this);
  94 }
  95
  96 void VirtualMachine::suspend()
  97 {
  98   on_suspend(*this);
  99   const kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 100   kernel::actor::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
 101 }
 102
 103 void VirtualMachine::resume()
 104 {
 105   pimpl_vm_->resume();
 106   on_resume(*this);
 107 }
 108
 109 void VirtualMachine::shutdown()
 110 {
 111   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
 112   kernel::actor::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
 113   on_shutdown(*this);
 114 }
 115
 116 void VirtualMachine::destroy()
 117 {
 118   auto destroy_code = [this]() {
 119     /* First, terminate all processes on the VM if necessary */
 120     shutdown();
 121
 122     XBT_DEBUG("destroy %s", get_cname());
 123     on_destruction(*this);
 124     /* Then, destroy the VM object */
 125     kernel::actor::simcall([this]() {
 126       get_vm_impl()->vm_destroy();
 127       get_impl()->destroy();
 128
 129       /* Don't free these things twice: they are the ones of my physical host */
 130       set_netpoint(nullptr);
 131       delete this;
 132     });
 133   };
 134
 135   if (not this_actor::is_maestro() && this_actor::get_host() == this) {
 136     XBT_VERB("Launch another actor on physical host %s to destroy my own VM: %s", get_pm()->get_cname(), get_cname());
 137     simgrid::s4u::Actor::create(get_cname() + std::string("-vm_destroy"), get_pm(), destroy_code);
 138     simgrid::s4u::this_actor::yield();
 139     XBT_CRITICAL("I should be dead now!");
 140     DIE_IMPOSSIBLE;
 141   }
 142
 143   destroy_code();
 144 }
 145
 146 simgrid::s4u::Host* VirtualMachine::get_pm() const
 147 {
 148   return pimpl_vm_->get_physical_host();
 149 }
 150
 151 VirtualMachine* VirtualMachine::set_pm(simgrid::s4u::Host* pm)
 152 {
 153   kernel::actor::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
 154   return this;
 155 }
 156
 157 VirtualMachine::State VirtualMachine::get_state() const
 158 {
 159   return kernel::actor::simcall([this]() { return pimpl_vm_->get_state(); });
 160 }
 161
 162 size_t VirtualMachine::get_ramsize() const
 163 {
 164   return pimpl_vm_->get_ramsize();
 165 }
 166
 167 VirtualMachine* VirtualMachine::set_ramsize(size_t ramsize)
 168 {
 169   pimpl_vm_->set_ramsize(ramsize);
 170   return this;
 171 }
 172 /** @brief Set a CPU bound for a given VM.
 173  *  @ingroup msg_VMs
 174  *
 175  * 1. Note that in some cases MSG_task_set_bound() may not intuitively work for VMs.
 176  *
 177  * For example,
 178  *  On PM0, there are Task1 and VM0.
 179  *  On VM0, there is Task2.
 180  * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0.
 181  * Then,
 182  *  Task1\@PM0 gets 50%.
 183  *  Task2\@VM0 gets 25%.
 184  * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively.
 185  *
 186  * 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
 187  * the dummy CPU action. The bound of the dummy CPU action is unlimited.
 188  *
 189  * There are some solutions for this problem. One option is to update the bound of the dummy CPU action automatically.
 190  * It should be the sum of all tasks on the VM. But, this solution might be costly, because we have to scan all tasks
 191  * on the VM in share_resource() or we have to trap both the start and end of task execution.
 192  *
 193  * The current solution is to use setBound(), which allows us to directly set the bound of the dummy CPU action.
 194  *
 195  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
 196  *    computation task (or a VM) never exceeds the capacity of a CPU core.
 197  */
 198 VirtualMachine* VirtualMachine::set_bound(double bound)
 199 {
 200   kernel::actor::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
 201   return this;
 202 }
 203
 204 void VirtualMachine::start_migration() const
 205 {
 206   pimpl_vm_->start_migration();
 207   on_migration_start(*this);
 208 }
 209
 210 void VirtualMachine::end_migration() const
 211 {
 212   pimpl_vm_->end_migration();
 213   on_migration_end(*this);
 214 }
 215
 216 } // namespace s4u
 217 } // namespace simgrid
 218
 219 /* **************************** Public C interface *************************** */
 220
 221 /** @brief Create a new VM object with the default parameters
 222  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 223  */
 224 sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
 225 {
 226   return sg_vm_create_multicore(pm, name, 1);
 227 }
 228 /** @brief Create a new VM object with the default parameters, but with a specified amount of cores
 229  * A VM is treated as a host. The name of the VM must be unique among all hosts.
 230  */
 231 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
 232 {
 233   return pm->create_vm(name, coreAmount);
 234 }
 235
 236 const char* sg_vm_get_name(const_sg_vm_t vm)
 237 {
 238   return vm->get_cname();
 239 }
 240
 241 /** @brief Get the physical host of a given VM. */
 242 sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
 243 {
 244   return vm->get_pm();
 245 }
 246
 247 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
 248 {
 249   vm->set_ramsize(size);
 250 }
 251
 252 size_t sg_vm_get_ramsize(const_sg_vm_t vm)
 253 {
 254   return vm->get_ramsize();
 255 }
 256
 257 void sg_vm_set_bound(sg_vm_t vm, double bound)
 258 {
 259   vm->set_bound(bound);
 260 }
 261
 262 /** @brief Returns whether the given VM has just created, not running. */
 263 int sg_vm_is_created(const_sg_vm_t vm)
 264 {
 265   return vm->get_state() == simgrid::s4u::VirtualMachine::State::CREATED;
 266 }
 267
 268 /** @brief Returns whether the given VM is currently running */
 269 int sg_vm_is_running(const_sg_vm_t vm)
 270 {
 271   return vm->get_state() == simgrid::s4u::VirtualMachine::State::RUNNING;
 272 }
 273
 274 /** @brief Returns whether the given VM is currently suspended, not running. */
 275 int sg_vm_is_suspended(const_sg_vm_t vm)
 276 {
 277   return vm->get_state() == simgrid::s4u::VirtualMachine::State::SUSPENDED;
 278 }
 279
 280 /** @brief Start a vm (i.e., boot the guest operating system)
 281  *  If the VM cannot be started (because of memory over-provisioning), an exception is generated.
 282  */
 283 void sg_vm_start(sg_vm_t vm)
 284 {
 285   vm->start();
 286 }
 287
 288 /** @brief Immediately suspend the execution of all processes within the given VM.
 289  *
 290  * This function stops the execution of the VM. All the processes on this VM
 291  * will pause. The state of the VM is preserved. We can later resume it again.
 292  *
 293  * No suspension cost occurs.
 294  */
 295 void sg_vm_suspend(sg_vm_t vm)
 296 {
 297   vm->suspend();
 298 }
 299
 300 /** @brief Resume the execution of the VM. All processes on the VM run again.
 301  * No resume cost occurs.
 302  */
 303 void sg_vm_resume(sg_vm_t vm)
 304 {
 305   vm->resume();
 306 }
 307
 308 /** @brief Immediately kills all processes within the given VM.
 309  *
 310  @beginrst
 311
 312  The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
 313
 314  @endrst
 315  *
 316  * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that
 317  you want.
 318  */
 319 void sg_vm_shutdown(sg_vm_t vm)
 320 {
 321   vm->shutdown();
 322 }
 323
 324 /** @brief Destroy a VM. Destroy the VM object from the simulation. */
 325 void sg_vm_destroy(sg_vm_t vm)
 326 {
 327   vm->destroy();
 328 }