src/plugins/vm/VirtualMachineImpl.cpp

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