Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
include cleanups (mostly surf/surf.hpp)
[simgrid.git] / src / plugins / vm / s4u_VirtualMachine.cpp
index 5917ea2..a61da7c 100644 (file)
@@ -1,12 +1,13 @@
-/* Copyright (c) 2015-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "simgrid/Exception.hpp"
-#include "simgrid/s4u/Actor.hpp"
-#include "simgrid/vm.h"
-#include "src/include/surf/surf.hpp"
+#include <simgrid/Exception.hpp>
+#include <simgrid/kernel/routing/NetPoint.hpp>
+#include <simgrid/s4u/Actor.hpp>
+#include <simgrid/vm.h>
+
 #include "src/plugins/vm/VirtualMachineImpl.hpp"
 #include "src/plugins/vm/VmHostExt.hpp"
 #include "src/surf/cpu_cas01.hpp"
@@ -15,6 +16,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
 
 namespace simgrid {
 namespace s4u {
+simgrid::xbt::signal<void(VirtualMachine&)> VirtualMachine::on_creation;
 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_start;
 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_started;
 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_shutdown;
@@ -22,6 +24,7 @@ simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_suspend;
 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_resume;
 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_start;
 simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_migration_end;
+simgrid::xbt::signal<void(VirtualMachine const&)> VirtualMachine::on_destruction;
 
 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount)
     : VirtualMachine(name, physical_host, core_amount, 1024)
@@ -29,7 +32,8 @@ VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host
 }
 
 VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount, size_t ramsize)
-    : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, physical_host, core_amount, ramsize))
+    : Host(new vm::VirtualMachineImpl(name, this, physical_host, core_amount, ramsize))
+    , pimpl_vm_(dynamic_cast<vm::VirtualMachineImpl*>(Host::get_impl()))
 {
   XBT_DEBUG("Create VM %s", get_cname());
 
@@ -38,56 +42,51 @@ VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host
 
   // Create a VCPU for this VM
   std::vector<double> speeds;
-  for (int i = 0; i < physical_host->get_pstate_count(); i++)
+  for (unsigned long i = 0; i < physical_host->get_pstate_count(); i++)
     speeds.push_back(physical_host->get_pstate_speed(i));
 
-  surf_cpu_model_vm->create_cpu(this, speeds, core_amount);
+  physical_host->get_netpoint()
+      ->get_englobing_zone()
+      ->get_cpu_vm_model()
+      ->create_cpu(this, speeds)
+      ->set_core_count(core_amount)
+      ->seal();
+
   if (physical_host->get_pstate() != 0)
     set_pstate(physical_host->get_pstate());
-}
-
-VirtualMachine::~VirtualMachine()
-{
-  on_destruction(*this);
-
-  XBT_DEBUG("destroy %s", get_cname());
 
-  /* Don't free these things twice: they are the ones of my physical host */
-  set_netpoint(nullptr);
+  seal(); // seal this host
+  s4u::VirtualMachine::on_creation(*this);
 }
 
 void VirtualMachine::start()
 {
   on_start(*this);
 
-  kernel::actor::simcall([this]() {
-    vm::VmHostExt::ensureVmExtInstalled();
+  vm::VmHostExt::ensureVmExtInstalled();
 
+  kernel::actor::simcall([this]() {
     Host* pm = this->pimpl_vm_->get_physical_host();
     if (pm->extension<vm::VmHostExt>() == nullptr)
       pm->extension_set(new vm::VmHostExt());
 
-    long pm_ramsize   = pm->extension<vm::VmHostExt>()->ramsize;
-    int pm_overcommit = pm->extension<vm::VmHostExt>()->overcommit;
-    long vm_ramsize   = this->get_ramsize();
-
-    if (pm_ramsize && not pm_overcommit) { /* Only verify that we don't overcommit on need */
+    size_t pm_ramsize = pm->extension<vm::VmHostExt>()->ramsize;
+    if (pm_ramsize && not pm->extension<vm::VmHostExt>()->overcommit) { /* Need to verify that we don't overcommit */
       /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
-      long total_ramsize_of_vms = 0;
+      size_t total_ramsize_of_vms = 0;
       for (VirtualMachine* const& ws_vm : vm::VirtualMachineImpl::allVms_)
         if (pm == ws_vm->get_pm())
           total_ramsize_of_vms += ws_vm->get_ramsize();
 
-      if (vm_ramsize > pm_ramsize - total_ramsize_of_vms) {
-        XBT_WARN("cannot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
-                 this->get_cname(), pm->get_cname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
+      if (total_ramsize_of_vms + get_ramsize() > pm_ramsize) {
+        XBT_WARN("cannot start %s@%s due to memory shortage: get_ramsize() %zu, free %zu, pm_ramsize %zu (bytes).",
+                 get_cname(), pm->get_cname(), get_ramsize(), pm_ramsize - total_ramsize_of_vms, pm_ramsize);
         throw VmFailureException(XBT_THROW_POINT,
                                  xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
-                                                    pm->get_cname(), this->get_cname()));
+                                                    pm->get_cname(), get_cname()));
       }
     }
-
-    this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
+    this->pimpl_vm_->set_state(State::RUNNING);
   });
 
   on_started(*this);
@@ -115,36 +114,59 @@ void VirtualMachine::shutdown()
 
 void VirtualMachine::destroy()
 {
-  /* First, terminate all processes on the VM if necessary */
-  shutdown();
-
-  /* Then, destroy the VM object */
-  Host::destroy();
+  auto destroy_code = [this]() {
+    /* First, terminate all processes on the VM if necessary */
+    shutdown();
+
+    XBT_DEBUG("destroy %s", get_cname());
+
+    /* Then, destroy the VM object */
+    kernel::actor::simcall([this]() {
+      get_vm_impl()->vm_destroy();
+      get_impl()->destroy();
+
+      /* Don't free these things twice: they are the ones of my physical host */
+      set_netpoint(nullptr);
+      delete this;
+    });
+  };
+
+  if (not this_actor::is_maestro() && this_actor::get_host() == this) {
+    XBT_VERB("Launch another actor on physical host %s to destroy my own VM: %s", get_pm()->get_cname(), get_cname());
+    simgrid::s4u::Actor::create(get_cname() + std::string("-vm_destroy"), get_pm(), destroy_code);
+    simgrid::s4u::this_actor::yield();
+    XBT_CRITICAL("I should be dead now!");
+    DIE_IMPOSSIBLE;
+  }
+
+  destroy_code();
 }
 
-simgrid::s4u::Host* VirtualMachine::get_pm()
+simgrid::s4u::Host* VirtualMachine::get_pm() const
 {
   return pimpl_vm_->get_physical_host();
 }
 
-void VirtualMachine::set_pm(simgrid::s4u::Host* pm)
+VirtualMachine* VirtualMachine::set_pm(simgrid::s4u::Host* pm)
 {
   kernel::actor::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
+  return this;
 }
 
-VirtualMachine::state VirtualMachine::get_state()
+VirtualMachine::State VirtualMachine::get_state() const
 {
   return kernel::actor::simcall([this]() { return pimpl_vm_->get_state(); });
 }
 
-size_t VirtualMachine::get_ramsize()
+size_t VirtualMachine::get_ramsize() const
 {
   return pimpl_vm_->get_ramsize();
 }
 
-void VirtualMachine::set_ramsize(size_t ramsize)
+VirtualMachine* VirtualMachine::set_ramsize(size_t ramsize)
 {
   pimpl_vm_->set_ramsize(ramsize);
+  return this;
 }
 /** @brief Set a CPU bound for a given VM.
  *  @ingroup msg_VMs
@@ -172,13 +194,14 @@ void VirtualMachine::set_ramsize(size_t ramsize)
  * 2. Note that bound == 0 means no bound (i.e., unlimited). But, if a host has multiple CPU cores, the CPU share of a
  *    computation task (or a VM) never exceeds the capacity of a CPU core.
  */
-void VirtualMachine::set_bound(double bound)
+VirtualMachine* VirtualMachine::set_bound(double bound)
 {
   kernel::actor::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
+  return this;
 }
 
-} // namespace simgrid
 } // namespace s4u
+} // namespace simgrid
 
 /* **************************** Public C interface *************************** */
 
@@ -197,13 +220,13 @@ sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
   return new simgrid::s4u::VirtualMachine(name, pm, coreAmount);
 }
 
-const char* sg_vm_get_name(sg_vm_t vm)
+const char* sg_vm_get_name(const_sg_vm_t vm)
 {
   return vm->get_cname();
 }
 
 /** @brief Get the physical host of a given VM. */
-sg_host_t sg_vm_get_pm(sg_vm_t vm)
+sg_host_t sg_vm_get_pm(const_sg_vm_t vm)
 {
   return vm->get_pm();
 }
@@ -213,7 +236,7 @@ void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
   vm->set_ramsize(size);
 }
 
-size_t sg_vm_get_ramsize(sg_vm_t vm)
+size_t sg_vm_get_ramsize(const_sg_vm_t vm)
 {
   return vm->get_ramsize();
 }
@@ -224,21 +247,21 @@ void sg_vm_set_bound(sg_vm_t vm, double bound)
 }
 
 /** @brief Returns whether the given VM has just created, not running. */
-int sg_vm_is_created(sg_vm_t vm)
+int sg_vm_is_created(const_sg_vm_t vm)
 {
-  return vm->get_state() == simgrid::s4u::VirtualMachine::state::CREATED;
+  return vm->get_state() == simgrid::s4u::VirtualMachine::State::CREATED;
 }
 
 /** @brief Returns whether the given VM is currently running */
-int sg_vm_is_running(sg_vm_t vm)
+int sg_vm_is_running(const_sg_vm_t vm)
 {
-  return vm->get_state() == simgrid::s4u::VirtualMachine::state::RUNNING;
+  return vm->get_state() == simgrid::s4u::VirtualMachine::State::RUNNING;
 }
 
 /** @brief Returns whether the given VM is currently suspended, not running. */
-int sg_vm_is_suspended(sg_vm_t vm)
+int sg_vm_is_suspended(const_sg_vm_t vm)
 {
-  return vm->get_state() == simgrid::s4u::VirtualMachine::state::SUSPENDED;
+  return vm->get_state() == simgrid::s4u::VirtualMachine::State::SUSPENDED;
 }
 
 /** @brief Start a vm (i.e., boot the guest operating system)
@@ -270,9 +293,15 @@ void sg_vm_resume(sg_vm_t vm)
 }
 
 /** @brief Immediately kills all processes within the given VM.
- * Any memory that they allocated will be leaked, unless you used #MSG_process_on_exit().
  *
- * No extra delay occurs. If you want to simulate this too, you want to use a #MSG_process_sleep().
+ @beginrst
+
+ The memory allocated by these actors is leaked, unless you used :cpp:func:`simgrid::s4u::Actor::on_exit`.
+
+ @endrst
+ *
+ * No extra delay occurs by default. You may let your actor sleep by a specific amount to simulate any extra delay that
+ you want.
  */
 void sg_vm_shutdown(sg_vm_t vm)
 {