Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Misc const qualifiers following yesterday's changes.
[simgrid.git] / src / plugins / vm / s4u_VirtualMachine.cpp
index acc61c3..43263fa 100644 (file)
-/* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2019. 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 "src/instr/instr_private.hpp"
+#include "simgrid/vm.h"
+#include "src/include/surf/surf.hpp"
 #include "src/plugins/vm/VirtualMachineImpl.hpp"
 #include "src/plugins/vm/VmHostExt.hpp"
-#include "src/simix/smx_host_private.hpp"
 #include "src/surf/cpu_cas01.hpp"
-#include <simgrid/vm.h>
-#include <src/plugins/vm/VmLiveMigration.hpp>
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_vm, "S4U virtual machines");
-
-simgrid::xbt::signal<void(simgrid::s4u::VirtualMachine*)> simgrid::s4u::VirtualMachine::onVmShutdown;
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_vm, s4u, "S4U virtual machines");
 
 namespace simgrid {
 namespace s4u {
-
-VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount)
-    : VirtualMachine(name, pm, coreAmount, 1024)
+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;
+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;
+
+VirtualMachine::VirtualMachine(const std::string& name, s4u::Host* physical_host, int core_amount)
+    : VirtualMachine(name, physical_host, core_amount, 1024)
 {
 }
 
-VirtualMachine::VirtualMachine(const char* name, s4u::Host* pm, int coreAmount, size_t ramsize)
-    : Host(name), pimpl_vm_(new vm::VirtualMachineImpl(this, pm, coreAmount, ramsize))
+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))
 {
-  XBT_DEBUG("Create VM %s", name);
+  XBT_DEBUG("Create VM %s", get_cname());
 
   /* Currently, a VM uses the network resource of its physical host */
-  pimpl_netpoint = pm->pimpl_netpoint;
-  // Create a VCPU for this VM
-  surf::CpuCas01* sub_cpu = dynamic_cast<surf::CpuCas01*>(pm->pimpl_cpu);
-
-  pimpl_cpu = surf_cpu_model_vm->createCpu(this, sub_cpu->getSpeedPeakList(), coreAmount);
-  if (sub_cpu->getPState() != 0)
-    pimpl_cpu->setPState(sub_cpu->getPState());
+  set_netpoint(physical_host->get_netpoint());
 
-  /* Make a process container */
-  extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
+  // Create a VCPU for this VM
+  std::vector<double> speeds;
+  for (int i = 0; i < physical_host->get_pstate_count(); i++)
+    speeds.push_back(physical_host->get_pstate_speed(i));
 
-  if (TRACE_msg_vm_is_enabled()) {
-    container_t host_container = instr::Container::byName(pm->getName());
-    new instr::Container(name, "MSG_VM", host_container);
-    instr::Container::byName(getName())->getState("MSG_VM_STATE")->addEntityValue("start", "0 0 1");   // start is blue
-    instr::Container::byName(getName())->getState("MSG_VM_STATE")->addEntityValue("suspend", "1 0 0"); // suspend is red
-  }
+  surf_cpu_model_vm->create_cpu(this, speeds, core_amount);
+  if (physical_host->get_pstate() != 0)
+    set_pstate(physical_host->get_pstate());
 }
 
 VirtualMachine::~VirtualMachine()
 {
-  onDestruction(*this);
-
-  XBT_DEBUG("destroy %s", getCname());
+  on_destruction(*this);
 
-  /* FIXME: this is really strange that everything fails if the next line is removed.
-   * This is as if we shared these data with the PM, which definitely should not be the case...
-   *
-   * We need to test that suspending a VM does not suspends the processes running on its PM, for example.
-   * Or we need to simplify this code enough to make it actually readable (but this sounds harder than testing)
-   */
-  extension_set<simgrid::simix::Host>(nullptr);
+  XBT_DEBUG("destroy %s", get_cname());
 
   /* Don't free these things twice: they are the ones of my physical host */
-  pimpl_netpoint = nullptr;
-
-  if (TRACE_msg_vm_is_enabled()) {
-    container_t container = simgrid::instr::Container::byName(getName());
-    container->removeFromParent();
-    delete container;
-  }
+  set_netpoint(nullptr);
 }
 
 void VirtualMachine::start()
 {
-  if (TRACE_msg_vm_is_enabled())
-    simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->pushEvent("start");
+  on_start(*this);
 
-  simgrid::simix::kernelImmediate([this]() {
-    simgrid::vm::VmHostExt::ensureVmExtInstalled();
+  kernel::actor::simcall([this]() {
+    vm::VmHostExt::ensureVmExtInstalled();
 
-    simgrid::s4u::Host* pm = this->pimpl_vm_->getPm();
-    if (pm->extension<simgrid::vm::VmHostExt>() == nullptr)
-      pm->extension_set(new simgrid::vm::VmHostExt());
+    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<simgrid::vm::VmHostExt>()->ramsize;
-    int pm_overcommit = pm->extension<simgrid::vm::VmHostExt>()->overcommit;
-    long vm_ramsize   = this->getRamsize();
+    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 */
       /* 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;
-      for (simgrid::s4u::VirtualMachine* const& ws_vm : simgrid::vm::VirtualMachineImpl::allVms_)
-        if (pm == ws_vm->getPm())
-          total_ramsize_of_vms += ws_vm->getRamsize();
+      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("cannnot start %s@%s due to memory shortage: vm_ramsize %ld, free %ld, pm_ramsize %ld (bytes).",
-                 this->getCname(), pm->getCname(), vm_ramsize, pm_ramsize - total_ramsize_of_vms, pm_ramsize);
-        THROWF(vm_error, 0, "Memory shortage on host '%s', VM '%s' cannot be started", pm->getCname(),
-               this->getCname());
+        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);
+        throw VmFailureException(XBT_THROW_POINT,
+                                 xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
+                                                    pm->get_cname(), this->get_cname()));
       }
     }
 
-    this->pimpl_vm_->setState(SURF_VM_STATE_RUNNING);
+    this->pimpl_vm_->set_state(VirtualMachine::state::RUNNING);
   });
 
-  if (TRACE_msg_vm_is_enabled())
-    simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->popEvent();
+  on_started(*this);
 }
 
 void VirtualMachine::suspend()
 {
-  smx_actor_t issuer = SIMIX_process_self();
-  simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->suspend(issuer); });
-  if (TRACE_msg_vm_is_enabled())
-    simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->pushEvent("suspend");
-  XBT_DEBUG("vm_suspend done");
+  on_suspend(*this);
+  kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+  kernel::actor::simcall([this, issuer]() { pimpl_vm_->suspend(issuer); });
 }
 
 void VirtualMachine::resume()
 {
   pimpl_vm_->resume();
-  if (TRACE_msg_vm_is_enabled())
-    simgrid::instr::Container::byName(getName())->getState("MSG_VM_STATE")->popEvent();
+  on_resume(*this);
 }
 
 void VirtualMachine::shutdown()
 {
-  smx_actor_t issuer = SIMIX_process_self();
-  simgrid::simix::kernelImmediate([this, issuer]() { pimpl_vm_->shutdown(issuer); });
-  onVmShutdown(this);
+  kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+  kernel::actor::simcall([this, issuer]() { pimpl_vm_->shutdown(issuer); });
+  on_shutdown(*this);
 }
 
 void VirtualMachine::destroy()
@@ -143,29 +122,29 @@ void VirtualMachine::destroy()
   Host::destroy();
 }
 
-simgrid::s4u::Host* VirtualMachine::getPm()
+simgrid::s4u::Host* VirtualMachine::get_pm() const
 {
-  return pimpl_vm_->getPm();
+  return pimpl_vm_->get_physical_host();
 }
 
-void VirtualMachine::setPm(simgrid::s4u::Host* pm)
+void VirtualMachine::set_pm(simgrid::s4u::Host* pm)
 {
-  simgrid::simix::kernelImmediate([this, pm]() { pimpl_vm_->setPm(pm); });
+  kernel::actor::simcall([this, pm]() { pimpl_vm_->set_physical_host(pm); });
 }
 
-e_surf_vm_state_t VirtualMachine::getState()
+VirtualMachine::state VirtualMachine::get_state()
 {
-  return simgrid::simix::kernelImmediate([this]() { return pimpl_vm_->getState(); });
+  return kernel::actor::simcall([this]() { return pimpl_vm_->get_state(); });
 }
 
-size_t VirtualMachine::getRamsize()
+size_t VirtualMachine::get_ramsize() const
 {
-  return pimpl_vm_->getRamsize();
+  return pimpl_vm_->get_ramsize();
 }
 
-void VirtualMachine::setRamsize(size_t ramsize)
+void VirtualMachine::set_ramsize(size_t ramsize)
 {
-  pimpl_vm_->setRamsize(ramsize);
+  pimpl_vm_->set_ramsize(ramsize);
 }
 /** @brief Set a CPU bound for a given VM.
  *  @ingroup msg_VMs
@@ -193,9 +172,9 @@ void VirtualMachine::setRamsize(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::setBound(double bound)
+void VirtualMachine::set_bound(double bound)
 {
-  simgrid::simix::kernelImmediate([this, bound]() { pimpl_vm_->setBound(bound); });
+  kernel::actor::simcall([this, bound]() { pimpl_vm_->set_bound(bound); });
 }
 
 } // namespace simgrid
@@ -203,7 +182,6 @@ void VirtualMachine::setBound(double bound)
 
 /* **************************** Public C interface *************************** */
 
-SG_BEGIN_DECL()
 /** @brief Create a new VM object with the default parameters
  * A VM is treated as a host. The name of the VM must be unique among all hosts.
  */
@@ -216,54 +194,51 @@ sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name)
  */
 sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount)
 {
-  xbt_assert(sg_host_by_name(name) == nullptr,
-             "Cannot create a VM named %s: this name is already used by an host or a VM", name);
-
   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->getCname();
+  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->getPm();
+  return vm->get_pm();
 }
 
 void sg_vm_set_ramsize(sg_vm_t vm, size_t size)
 {
-  vm->setRamsize(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->getRamsize();
+  return vm->get_ramsize();
 }
 
 void sg_vm_set_bound(sg_vm_t vm, double bound)
 {
-  vm->setBound(bound);
+  vm->set_bound(bound);
 }
 
 /** @brief Returns whether the given VM has just created, not running. */
 int sg_vm_is_created(sg_vm_t vm)
 {
-  return vm->getState() == SURF_VM_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)
 {
-  return vm->getState() == SURF_VM_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)
 {
-  return vm->getState() == SURF_VM_STATE_SUSPENDED;
+  return vm->get_state() == simgrid::s4u::VirtualMachine::state::SUSPENDED;
 }
 
 /** @brief Start a vm (i.e., boot the guest operating system)
@@ -295,9 +270,14 @@ 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)
 {
@@ -309,4 +289,3 @@ void sg_vm_destroy(sg_vm_t vm)
 {
   vm->destroy();
 }
-SG_END_DECL()