src/plugins/vm/VirtualMachineImpl.cpp

   1 /* Copyright (c) 2013-2019. 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 "src/plugins/vm/VirtualMachineImpl.hpp"
   7 #include "simgrid/Exception.hpp"
   8 #include "simgrid/s4u/Exec.hpp"
   9 #include "src/include/surf/surf.hpp"
  10 #include "src/kernel/activity/ExecImpl.hpp"
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
  13
  14 simgrid::vm::VMModel* surf_vm_model = nullptr;
  15
  16 void surf_vm_model_init_HL13()
  17 {
  18   if (surf_cpu_model_vm != nullptr)
  19     surf_vm_model = new simgrid::vm::VMModel();
  20 }
  21
  22 namespace simgrid {
  23 namespace vm {
  24 /*************
  25  * Callbacks *
  26  *************/
  27 xbt::signal<void(VirtualMachineImpl&)> VirtualMachineImpl::on_creation;
  28 xbt::signal<void(VirtualMachineImpl const&)> VirtualMachineImpl::on_destruction;
  29
  30 /*********
  31  * Model *
  32  *********/
  33
  34 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  35
  36 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
  37  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
  38  * FIXME: add a configuration flag for this
  39  */
  40 const double virt_overhead = 1; // 0.95
  41
  42 static void host_state_change(s4u::Host const& host)
  43 {
  44   if (not host.is_on()) { // just turned off.
  45     std::vector<s4u::VirtualMachine*> trash;
  46     /* Find all VMs living on that host */
  47     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
  48       if (vm->get_pm() == &host)
  49         trash.push_back(vm);
  50     for (s4u::VirtualMachine* vm : trash)
  51       vm->shutdown();
  52   }
  53 }
  54
  55 static void add_active_exec(s4u::Actor const&, s4u::Exec const& task)
  56 {
  57   s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
  58   if (vm != nullptr) {
  59     VirtualMachineImpl* vm_impl = vm->get_impl();
  60     vm_impl->active_tasks_      = vm_impl->active_tasks_ + 1;
  61     vm_impl->update_action_weight();
  62   }
  63 }
  64
  65 static void remove_active_exec(s4u::Actor const&, s4u::Exec const& task)
  66 {
  67   s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
  68   if (vm != nullptr) {
  69     VirtualMachineImpl* vm_impl = vm->get_impl();
  70     vm_impl->active_tasks_      = vm_impl->active_tasks_ - 1;
  71     vm_impl->update_action_weight();
  72   }
  73 }
  74
  75 static s4u::VirtualMachine* get_vm_from_activity(kernel::activity::ActivityImpl const& act)
  76 {
  77   auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(&act);
  78   return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
  79 }
  80
  81 static void add_active_activity(kernel::activity::ActivityImpl const& act)
  82 {
  83   s4u::VirtualMachine* vm = get_vm_from_activity(act);
  84   if (vm != nullptr) {
  85     VirtualMachineImpl *vm_impl = vm->get_impl();
  86     vm_impl->active_tasks_ = vm_impl->active_tasks_ + 1;
  87     vm_impl->update_action_weight();
  88   }
  89 }
  90
  91 static void remove_active_activity(kernel::activity::ActivityImpl const& act)
  92 {
  93   s4u::VirtualMachine* vm = get_vm_from_activity(act);
  94   if (vm != nullptr) {
  95     VirtualMachineImpl *vm_impl = vm->get_impl();
  96     vm_impl->active_tasks_ = vm_impl->active_tasks_ - 1;
  97     vm_impl->update_action_weight();
  98   }
  99 }
 100
 101 VMModel::VMModel()
 102 {
 103   all_existing_models.push_back(this);
 104   s4u::Host::on_state_change.connect(host_state_change);
 105   s4u::Exec::on_start.connect(add_active_exec);
 106   s4u::Exec::on_completion.connect(remove_active_exec);
 107   kernel::activity::ActivityImpl::on_resumed.connect(add_active_activity);
 108   kernel::activity::ActivityImpl::on_suspended.connect(remove_active_activity);
 109 }
 110
 111 double VMModel::next_occurring_event(double now)
 112 {
 113   /* TODO: update action's cost with the total cost of processes on the VM. */
 114
 115   /* 1. Now we know how many resource should be assigned to each virtual
 116    * machine. We update constraints of the virtual machine layer.
 117    *
 118    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
 119    *     X1 + X2 = C       (Equation 1)
 120    * where
 121    *    the resource share of VM1: X1
 122    *    the resource share of VM2: X2
 123    *    the capacity of PM1: C
 124    *
 125    * Then, if we have two process (P1 and P2) on VM1.
 126    *     X1_1 + X1_2 = X1  (Equation 2)
 127    * where
 128    *    the resource share of P1: X1_1
 129    *    the resource share of P2: X1_2
 130    *    the capacity of VM1: X1
 131    *
 132    * Equation 1 was solved in the physical machine layer.
 133    * Equation 2 is solved in the virtual machine layer (here).
 134    * X1 must be passed to the virtual machine layer as a constraint value.
 135    **/
 136
 137   /* iterate for all virtual machines */
 138   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
 139     kernel::resource::Cpu* cpu = ws_vm->pimpl_cpu;
 140
 141     double solved_value =
 142         ws_vm->get_impl()->action_->get_variable()->get_value(); // this is X1 in comment above, what
 143                                                                  // this VM got in the sharing on the PM
 144     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
 145
 146     xbt_assert(cpu->get_model() == surf_cpu_model_vm);
 147     kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
 148     vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
 149   }
 150
 151   /* 2. Ready. Get the next occurring event */
 152   return surf_cpu_model_vm->next_occurring_event(now);
 153 }
 154
 155 /************
 156  * Resource *
 157  ************/
 158
 159 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
 160                                        int core_amount, size_t ramsize)
 161     : HostImpl(piface), physical_host_(host_PM), core_amount_(core_amount), user_bound_(std::numeric_limits<double>::max()), ramsize_(ramsize)
 162 {
 163   /* Register this VM to the list of all VMs */
 164   allVms_.push_back(piface);
 165
 166   /* We create cpu_action corresponding to a VM process on the host operating system. */
 167   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
 168    * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM.  It corresponds to
 169    * the cost of a VM running no tasks.
 170    */
 171   action_ = host_PM->pimpl_cpu->execution_start(0, core_amount);
 172
 173   // It's empty for now, so it should not request resources in the PM
 174   update_action_weight();
 175
 176   XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), physical_host_->get_cname());
 177   on_creation(*this);
 178 }
 179
 180 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 181 VirtualMachineImpl::~VirtualMachineImpl()
 182 {
 183   on_destruction(*this);
 184   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 185   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 186   if (iter != allVms_.end())
 187     allVms_.erase(iter);
 188
 189   /* Free the cpu_action of the VM. */
 190   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 191   xbt_assert(ret, "Bug: some resource still remains");
 192 }
 193
 194 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 195 {
 196   if (get_state() != s4u::VirtualMachine::state::RUNNING)
 197     throw VmFailureException(XBT_THROW_POINT,
 198                              xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
 199   if (issuer->get_host() == piface_)
 200     throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
 201                                                                  issuer->get_cname(), piface_->get_cname()));
 202
 203   XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
 204
 205   action_->suspend();
 206
 207   for (auto& actor : get_all_actors()) {
 208     XBT_DEBUG("suspend %s", actor->get_cname());
 209     actor->suspend();
 210   }
 211
 212   XBT_DEBUG("suspend all actors on the VM done done");
 213
 214   vm_state_ = s4u::VirtualMachine::state::SUSPENDED;
 215 }
 216
 217 void VirtualMachineImpl::resume()
 218 {
 219   if (get_state() != s4u::VirtualMachine::state::SUSPENDED)
 220     throw VmFailureException(XBT_THROW_POINT,
 221                              xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
 222
 223   XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
 224
 225   action_->resume();
 226
 227   for (auto& actor : get_all_actors()) {
 228     XBT_DEBUG("resume %s", actor->get_cname());
 229     actor->resume();
 230   }
 231
 232   vm_state_ = s4u::VirtualMachine::state::RUNNING;
 233 }
 234
 235 /** @brief Power off a VM.
 236  *
 237  * All hosted processes will be killed, but the VM state is preserved on memory.
 238  * It can later be restarted.
 239  *
 240  * @param issuer the actor requesting the shutdown
 241  */
 242 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 243 {
 244   if (get_state() != s4u::VirtualMachine::state::RUNNING) {
 245     const char* stateName = "(unknown state)";
 246     switch (get_state()) {
 247       case s4u::VirtualMachine::state::CREATED:
 248         stateName = "created, but not yet started";
 249         break;
 250       case s4u::VirtualMachine::state::SUSPENDED:
 251         stateName = "suspended";
 252         break;
 253       case s4u::VirtualMachine::state::DESTROYED:
 254         stateName = "destroyed";
 255         break;
 256       default: /* SURF_VM_STATE_RUNNING or unexpected values */
 257         THROW_IMPOSSIBLE;
 258     }
 259     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
 260   }
 261
 262   XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
 263
 264   for (auto& actor : get_all_actors()) {
 265     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor->get_cname(), actor->get_host()->get_cname(),
 266               issuer->get_cname());
 267     issuer->kill(actor->get_impl());
 268   }
 269
 270   set_state(s4u::VirtualMachine::state::DESTROYED);
 271
 272   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 273 }
 274
 275 /** @brief Change the physical host on which the given VM is running
 276  *
 277  * This is an instantaneous migration.
 278  */
 279 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
 280 {
 281   std::string vm_name     = piface_->get_name();
 282   std::string pm_name_src = physical_host_->get_name();
 283   std::string pm_name_dst = destination->get_name();
 284
 285   /* update net_elm with that of the destination physical host */
 286   piface_->set_netpoint(destination->get_netpoint());
 287
 288   physical_host_ = destination;
 289
 290   /* Update vcpu's action for the new pm */
 291   /* create a cpu action bound to the pm model at the destination. */
 292   kernel::resource::CpuAction* new_cpu_action =
 293       static_cast<kernel::resource::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->core_amount_));
 294
 295   if (action_->get_remains_no_update() > 0)
 296     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
 297
 298   /* keep the bound value of the cpu action of the VM. */
 299   double old_bound = action_->get_bound();
 300   if (old_bound > 0) {
 301     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
 302     new_cpu_action->set_bound(old_bound);
 303   }
 304
 305   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 306   xbt_assert(ret, "Bug: some resource still remains");
 307
 308   action_ = new_cpu_action;
 309
 310   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
 311 }
 312
 313 void VirtualMachineImpl::set_bound(double bound)
 314 {
 315   user_bound_ = bound;
 316   update_action_weight();
 317 }
 318
 319 void VirtualMachineImpl::update_action_weight(){
 320   /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
 321   int impact = std::min(active_tasks_, get_core_amount());
 322
 323   XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %d)", this, impact, active_tasks_);
 324
 325   if (impact > 0)
 326     action_->set_sharing_penalty(1. / impact);
 327   else
 328     action_->set_sharing_penalty(0.);
 329
 330   action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
 331 }
 332
 333 }
 334 }