Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Reduce the foreign usages of s4u::Host::pimpl_cpu, which should be private
[simgrid.git] / src / plugins / vm / VirtualMachineImpl.cpp
index 51e42ef..326fde5 100644 (file)
@@ -1,51 +1,67 @@
-/* Copyright (c) 2013-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2013-2018. 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 "src/plugins/vm/VirtualMachineImpl.hpp"
-#include "simgrid/s4u/VirtualMachine.hpp"
+#include "src/simix/ActorImpl.hpp"
+#include "src/simix/smx_host_private.hpp"
 
-#include <xbt/signal.hpp>
-
-#include "src/surf/cpu_cas01.hpp"
+#include <xbt/asserts.h> // xbt_log_no_loc
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
 
-simgrid::surf::VMModel* surf_vm_model = nullptr;
+simgrid::vm::VMModel* surf_vm_model = nullptr;
 
 void surf_vm_model_init_HL13()
 {
   if (surf_cpu_model_vm) {
-    surf_vm_model = new simgrid::surf::VMModel();
+    surf_vm_model = new simgrid::vm::VMModel();
     all_existing_models->push_back(surf_vm_model);
   }
 }
 
-namespace simgrid {
-namespace surf {
 
 /*************
  * Callbacks *
  *************/
 
-simgrid::xbt::signal<void(simgrid::surf::VirtualMachineImpl*)> onVmCreation;
-simgrid::xbt::signal<void(simgrid::surf::VirtualMachineImpl*)> onVmDestruction;
-simgrid::xbt::signal<void(simgrid::surf::VirtualMachineImpl*)> onVmStateChange;
+simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> simgrid::vm::VirtualMachineImpl::onVmCreation;
+simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> simgrid::vm::VirtualMachineImpl::onVmDestruction;
+simgrid::xbt::signal<void(simgrid::vm::VirtualMachineImpl*)> simgrid::vm::VirtualMachineImpl::onVmStateChange;
 
+namespace simgrid {
+namespace vm {
 /*********
  * Model *
  *********/
 
-std::deque<VirtualMachineImpl*> VirtualMachineImpl::allVms_;
+std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
 
 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
- * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system. */
-// const double virt_overhead = 0.95;
-const double virt_overhead = 1;
+ * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
+ * FIXME: add a configuration flag for this
+ */
+const double virt_overhead = 1; // 0.95
+
+static void hostStateChange(s4u::Host& host)
+{
+  if (host.isOff()) { // just turned off.
+    std::vector<s4u::VirtualMachine*> trash;
+    /* Find all VMs living on that host */
+    for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
+      if (vm->getPm() == &host)
+        trash.push_back(vm);
+    for (s4u::VirtualMachine* vm : trash)
+      vm->shutdown();
+  }
+}
+VMModel::VMModel()
+{
+  s4u::Host::on_state_change.connect(hostStateChange);
+}
 
-double VMModel::nextOccuringEvent(double now)
+double VMModel::next_occuring_event(double now)
 {
   /* TODO: update action's cost with the total cost of processes on the VM. */
 
@@ -68,99 +84,61 @@ double VMModel::nextOccuringEvent(double now)
    *
    * Equation 1 was solved in the physical machine layer.
    * Equation 2 is solved in the virtual machine layer (here).
-   * X1 must be passed to the virtual machine laye as a constraint value.
+   * X1 must be passed to the virtual machine layer as a constraint value.
    **/
 
   /* iterate for all virtual machines */
-  for (VirtualMachineImpl* ws_vm : VirtualMachineImpl::allVms_) {
-    Cpu* cpu = ws_vm->piface_->pimpl_cpu;
-    xbt_assert(cpu, "cpu-less host");
-
-    double solved_value = ws_vm->action_->getVariable()->value;
-    XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->piface_->name().c_str(),
-              ws_vm->getPm()->name().c_str());
-
-    // TODO: check lmm_update_constraint_bound() works fine instead of the below manual substitution.
-    // cpu_cas01->constraint->bound = solved_value;
-    xbt_assert(cpu->getModel() == surf_cpu_model_vm);
-    lmm_system_t vcpu_system = cpu->getModel()->getMaxminSystem();
-    lmm_update_constraint_bound(vcpu_system, cpu->getConstraint(), virt_overhead * solved_value);
+  for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
+    surf::Cpu* cpu = ws_vm->pimpl_cpu;
+
+    double solved_value =
+        ws_vm->getImpl()->action_->get_variable()->get_value(); // this is X1 in comment above, what
+                                                                // this VM got in the sharing on the PM
+    XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->getPm()->get_cname());
+
+    xbt_assert(cpu->get_model() == surf_cpu_model_vm);
+    kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
+    vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
   }
 
   /* 2. Calculate resource share at the virtual machine layer. */
-  adjustWeightOfDummyCpuActions();
+  ignore_empty_vm_in_pm_LMM();
 
-  /* 3. Ready. Get the next occuring event */
-  return surf_cpu_model_vm->nextOccuringEvent(now);
+  /* 3. Ready. Get the next occurring event */
+  return surf_cpu_model_vm->next_occuring_event(now);
 }
 
 /************
  * Resource *
  ************/
 
-VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::Host* piface, simgrid::s4u::Host* host_PM)
-    : HostImpl(piface, nullptr /*storage*/), hostPM_(host_PM)
+VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
+                                       int coreAmount, size_t ramsize)
+    : HostImpl(piface), hostPM_(host_PM), coreAmount_(coreAmount), ramsize_(ramsize)
 {
   /* Register this VM to the list of all VMs */
-  allVms_.push_back(this);
-
-  /* Currently, a VM uses the network resource of its physical host. In
-   * host_lib, this network resource object is referred from two different keys.
-   * When deregistering the reference that points the network resource object
-   * from the VM name, we have to make sure that the system does not call the
-   * free callback for the network resource object. The network resource object
-   * is still used by the physical machine. */
-  piface_->pimpl_netcard = host_PM->pimpl_netcard;
-
-  // //// CPU  RELATED STUFF ////
-  // Roughly, create a vcpu resource by using the values of the sub_cpu one.
-  CpuCas01* sub_cpu = dynamic_cast<CpuCas01*>(host_PM->pimpl_cpu);
-
-  piface_->pimpl_cpu = surf_cpu_model_vm->createCpu(piface_, sub_cpu->getSpeedPeakList(), 1 /*cores*/);
-  if (sub_cpu->getPState() != 0)
-    piface_->pimpl_cpu->setPState(sub_cpu->getPState());
+  allVms_.push_back(piface);
 
   /* We create cpu_action corresponding to a VM process on the host operating system. */
-  /* FIXME: TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
-  action_ = sub_cpu->execution_start(0);
-
-  /* Initialize the VM parameters */
-  params_.ramsize = 0;
+  /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ? */
+  action_ = host_PM->pimpl_cpu->execution_start(0, coreAmount);
 
-  XBT_VERB("Create VM(%s)@PM(%s) with %ld mounted disks", piface->name().c_str(), hostPM_->name().c_str(),
-           xbt_dynar_length(storage_));
+  XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), hostPM_->get_cname());
+  onVmCreation(this);
 }
 
-extern "C" int
-    xbt_log_no_loc; /* ugly pimpl to ensure that the debug info in the known issue below don't break the test */
 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 VirtualMachineImpl::~VirtualMachineImpl()
 {
   onVmDestruction(this);
-  allVms_.erase(find(allVms_.begin(), allVms_.end(), this));
-
-  /* dirty page tracking */
-  unsigned int size          = xbt_dict_size(dp_objs);
-  static bool already_warned = false;
-  if (size > 0 && !already_warned) {
-    xbt_dict_cursor_t cursor = nullptr;
-    xbt_dict_cursor_first(dp_objs, &cursor);
-    XBT_WARN("Dirty page tracking: %u pending task(s) on a destroyed VM (first one is %s).\n"
-             "If you don't understand why your task was not properly removed, please report that bug.\n"
-             "This is a known bug if you turned the host off during the VM execution.\n"
-             "Please remind us of that problem at some point: our code base is not ready to fix this harmless issue in "
-             "2016, sorry.",
-             size, (xbt_log_no_loc ? "(name hidden)" : xbt_dict_cursor_get_key(cursor)));
-    xbt_dict_cursor_free(&cursor);
-    already_warned = true;
-  }
-  xbt_dict_free(&dp_objs);
+  /* I was already removed from the allVms set if the VM was destroyed cleanly */
+  auto iter = find(allVms_.begin(), allVms_.end(), piface_);
+  if (iter != allVms_.end())
+    allVms_.erase(iter);
 
   /* Free the cpu_action of the VM. */
   XBT_ATTRIB_UNUSED int ret = action_->unref();
   xbt_assert(ret == 1, "Bug: some resource still remains");
-
-  delete piface_->pimpl_cpu;
 }
 
 e_surf_vm_state_t VirtualMachineImpl::getState()
@@ -172,30 +150,88 @@ void VirtualMachineImpl::setState(e_surf_vm_state_t state)
 {
   vmState_ = state;
 }
-void VirtualMachineImpl::suspend()
+
+void VirtualMachineImpl::suspend(smx_actor_t issuer)
 {
+  if (getState() != SURF_VM_STATE_RUNNING)
+    THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->get_cname());
+  if (issuer->host == piface_)
+    THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->get_cname(),
+           piface_->get_cname());
+
+  auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
+  XBT_DEBUG("suspend VM(%s), where %zu processes exist", piface_->get_cname(), process_list.size());
+
   action_->suspend();
+
+  for (auto& smx_process : process_list) {
+    XBT_DEBUG("suspend %s", smx_process.name.c_str());
+    smx_process.suspend(issuer);
+  }
+
+  XBT_DEBUG("suspend all processes on the VM done done");
+
   vmState_ = SURF_VM_STATE_SUSPENDED;
 }
 
 void VirtualMachineImpl::resume()
 {
+  if (getState() != SURF_VM_STATE_SUSPENDED)
+    THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->get_cname());
+
+  auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
+  XBT_DEBUG("Resume VM %s, containing %zu processes.", piface_->get_cname(), process_list.size());
+
   action_->resume();
+
+  for (auto& smx_process : process_list) {
+    XBT_DEBUG("resume %s", smx_process.get_cname());
+    smx_process.resume();
+  }
+
   vmState_ = SURF_VM_STATE_RUNNING;
 }
 
-void VirtualMachineImpl::save()
+/** @brief Power off a VM.
+ *
+ * All hosted processes will be killed, but the VM state is preserved on memory.
+ * It can later be restarted.
+ *
+ * @param issuer the actor requesting the shutdown
+ */
+void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 {
-  vmState_ = SURF_VM_STATE_SAVING;
-  action_->suspend();
-  vmState_ = SURF_VM_STATE_SAVED;
-}
+  if (getState() != SURF_VM_STATE_RUNNING) {
+    const char* stateName = "(unknown state)";
+    switch (getState()) {
+      case SURF_VM_STATE_CREATED:
+        stateName = "created, but not yet started";
+        break;
+      case SURF_VM_STATE_SUSPENDED:
+        stateName = "suspended";
+        break;
+      case SURF_VM_STATE_DESTROYED:
+        stateName = "destroyed";
+        break;
+      default: /* SURF_VM_STATE_RUNNING or unexpected values */
+        THROW_IMPOSSIBLE;
+        break;
+    }
+    XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
+  }
 
-void VirtualMachineImpl::restore()
-{
-  vmState_ = SURF_VM_STATE_RESTORING;
-  action_->resume();
-  vmState_ = SURF_VM_STATE_RUNNING;
+  auto& process_list = piface_->extension<simgrid::simix::Host>()->process_list;
+  XBT_DEBUG("shutdown VM %s, that contains %zu processes", piface_->get_cname(), process_list.size());
+
+  for (auto& smx_process : process_list) {
+    XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process.get_cname(),
+              smx_process.host->get_cname(), issuer->get_cname());
+    SIMIX_process_kill(&smx_process, issuer);
+  }
+
+  setState(SURF_VM_STATE_DESTROYED);
+
+  /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 }
 
 /** @brief returns the physical machine on which the VM is running **/
@@ -204,33 +240,34 @@ s4u::Host* VirtualMachineImpl::getPm()
   return hostPM_;
 }
 
-/* Update the physical host of the given VM */
-void VirtualMachineImpl::migrate(s4u::Host* host_dest)
+/** @brief Change the physical host on which the given VM is running
+ *
+ * This is an instantaneous migration.
+ */
+void VirtualMachineImpl::setPm(s4u::Host* destination)
 {
-  const char* vm_name     = piface_->name().c_str();
-  const char* pm_name_src = hostPM_->name().c_str();
-  const char* pm_name_dst = host_dest->name().c_str();
+  const char* vm_name     = piface_->get_cname();
+  const char* pm_name_src = hostPM_->get_cname();
+  const char* pm_name_dst = destination->get_cname();
 
   /* update net_elm with that of the destination physical host */
-  piface_->pimpl_netcard = host_dest->pimpl_netcard;
+  piface_->pimpl_netpoint = destination->pimpl_netpoint;
 
-  hostPM_ = host_dest;
+  hostPM_ = destination;
 
   /* Update vcpu's action for the new pm */
   /* create a cpu action bound to the pm model at the destination. */
-  CpuAction* new_cpu_action = static_cast<CpuAction*>(host_dest->pimpl_cpu->execution_start(0));
+  surf::CpuAction* new_cpu_action =
+      static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->coreAmount_));
 
-  Action::State state = action_->getState();
-  if (state != Action::State::done)
-    XBT_CRITICAL("FIXME: may need a proper handling, %d", static_cast<int>(state));
-  if (action_->getRemainsNoUpdate() > 0)
-    XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->getRemainsNoUpdate());
+  if (action_->get_remains_no_update() > 0)
+    XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
 
   /* keep the bound value of the cpu action of the VM. */
-  double old_bound = action_->getBound();
-  if (old_bound != 0) {
+  double old_bound = action_->get_bound();
+  if (old_bound > 0) {
     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name, old_bound, pm_name_dst);
-    new_cpu_action->setBound(old_bound);
+    new_cpu_action->set_bound(old_bound);
   }
 
   XBT_ATTRIB_UNUSED int ret = action_->unref();
@@ -241,25 +278,10 @@ void VirtualMachineImpl::migrate(s4u::Host* host_dest)
   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name, pm_name_src, pm_name_dst);
 }
 
-sg_size_t VirtualMachineImpl::getRamsize()
-{
-  return params_.ramsize;
-}
-
 void VirtualMachineImpl::setBound(double bound)
 {
-  action_->setBound(bound);
+  action_->set_bound(bound);
 }
 
-void VirtualMachineImpl::getParams(vm_params_t params)
-{
-  *params = params_;
-}
-
-void VirtualMachineImpl::setParams(vm_params_t params)
-{
-  /* may check something here. */
-  params_ = *params;
-}
 }
 }