src/plugins/vm/VirtualMachineImpl.cpp

   1 /* Copyright (c) 2013-2021. 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/EngineImpl.hpp"
  11 #include "src/kernel/activity/ExecImpl.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_vm, ker_resource, "Virtual Machines, containing actors and mobile accross hosts");
  14
  15 void surf_vm_model_init_HL13()
  16 {
  17   auto vm_model = std::make_unique<simgrid::vm::VMModel>();
  18   simgrid::kernel::EngineImpl::get_instance()->add_model(simgrid::kernel::resource::Model::Type::VM,
  19                                                          std::move(vm_model), true);
  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   s4u::Host::on_state_change.connect(host_state_change);
 107   s4u::Exec::on_start.connect(add_active_exec);
 108   s4u::Exec::on_completion.connect(remove_active_exec);
 109   kernel::activity::ActivityImpl::on_resumed.connect(add_active_activity);
 110   kernel::activity::ActivityImpl::on_suspended.connect(remove_active_activity);
 111 }
 112
 113 double VMModel::next_occurring_event(double now)
 114 {
 115   /* TODO: update action's cost with the total cost of processes on the VM. */
 116
 117   /* 1. Now we know how many resource should be assigned to each virtual
 118    * machine. We update constraints of the virtual machine layer.
 119    *
 120    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
 121    *     X1 + X2 = C       (Equation 1)
 122    * where
 123    *    the resource share of VM1: X1
 124    *    the resource share of VM2: X2
 125    *    the capacity of PM1: C
 126    *
 127    * Then, if we have two process (P1 and P2) on VM1.
 128    *     X1_1 + X1_2 = X1  (Equation 2)
 129    * where
 130    *    the resource share of P1: X1_1
 131    *    the resource share of P2: X1_2
 132    *    the capacity of VM1: X1
 133    *
 134    * Equation 1 was solved in the physical machine layer.
 135    * Equation 2 is solved in the virtual machine layer (here).
 136    * X1 must be passed to the virtual machine layer as a constraint value.
 137    **/
 138
 139   /* iterate for all virtual machines */
 140   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
 141     if (ws_vm->get_state() == s4u::VirtualMachine::state::SUSPENDED) // Ignore suspended VMs
 142       continue;
 143
 144     const kernel::resource::Cpu* cpu = ws_vm->pimpl_cpu;
 145
 146     // solved_value below is X1 in comment above: what this VM got in the sharing on the PM
 147     double solved_value = ws_vm->get_impl()->get_action()->get_variable()->get_value();
 148     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
 149
 150     kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
 151     vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
 152   }
 153
 154   /* actual next occurring event is determined by VM CPU model at surf_solve */
 155   return -1.0;
 156 }
 157
 158 /************
 159  * Resource *
 160  ************/
 161
 162 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
 163                                        int core_amount, size_t ramsize)
 164     : HostImpl(piface), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
 165 {
 166   /* Register this VM to the list of all VMs */
 167   allVms_.push_back(piface);
 168
 169   /* We create cpu_action corresponding to a VM process on the host operating system. */
 170   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
 171    * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM.  It corresponds to
 172    * the cost of a VM running no tasks.
 173    */
 174   action_ = physical_host_->pimpl_cpu->execution_start(0, core_amount_);
 175
 176   // It's empty for now, so it should not request resources in the PM
 177   update_action_weight();
 178
 179   XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), physical_host_->get_cname());
 180   on_creation(*this);
 181 }
 182
 183 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 184 VirtualMachineImpl::~VirtualMachineImpl()
 185 {
 186   on_destruction(*this);
 187   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 188   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 189   if (iter != allVms_.end())
 190     allVms_.erase(iter);
 191
 192   /* Free the cpu_action of the VM. */
 193   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 194   xbt_assert(ret, "Bug: some resource still remains");
 195 }
 196
 197 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 198 {
 199   if (get_state() != s4u::VirtualMachine::state::RUNNING)
 200     throw VmFailureException(XBT_THROW_POINT,
 201                              xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
 202   if (issuer->get_host() == piface_)
 203     throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
 204                                                                  issuer->get_cname(), piface_->get_cname()));
 205
 206   XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
 207
 208   action_->suspend();
 209
 210   foreach_actor([](auto& actor) {
 211     XBT_DEBUG("suspend %s", actor.get_cname());
 212     actor.suspend();
 213   });
 214
 215   XBT_DEBUG("suspend all actors on the VM done done");
 216
 217   vm_state_ = s4u::VirtualMachine::state::SUSPENDED;
 218 }
 219
 220 void VirtualMachineImpl::resume()
 221 {
 222   if (get_state() != s4u::VirtualMachine::state::SUSPENDED)
 223     throw VmFailureException(XBT_THROW_POINT,
 224                              xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
 225
 226   XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
 227
 228   action_->resume();
 229
 230   foreach_actor([](auto& actor) {
 231     XBT_DEBUG("resume %s", actor.get_cname());
 232     actor.resume();
 233   });
 234
 235   vm_state_ = s4u::VirtualMachine::state::RUNNING;
 236 }
 237
 238 /** @brief Power off a VM.
 239  *
 240  * All hosted processes will be killed, but the VM state is preserved on memory.
 241  * It can later be restarted.
 242  *
 243  * @param issuer the actor requesting the shutdown
 244  */
 245 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 246 {
 247   if (get_state() != s4u::VirtualMachine::state::RUNNING) {
 248     const char* stateName;
 249     switch (get_state()) {
 250       case s4u::VirtualMachine::state::CREATED:
 251         stateName = "created, but not yet started";
 252         break;
 253       case s4u::VirtualMachine::state::SUSPENDED:
 254         stateName = "suspended";
 255         break;
 256       case s4u::VirtualMachine::state::DESTROYED:
 257         stateName = "destroyed";
 258         break;
 259       default: /* SURF_VM_STATE_RUNNING or unexpected values */
 260         THROW_IMPOSSIBLE;
 261     }
 262     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
 263   }
 264
 265   XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
 266
 267   foreach_actor([issuer](auto& actor) {
 268     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor.get_cname(), actor.get_host()->get_cname(),
 269               issuer->get_cname());
 270     issuer->kill(&actor);
 271   });
 272
 273   set_state(s4u::VirtualMachine::state::DESTROYED);
 274
 275   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 276 }
 277
 278 /** @brief Change the physical host on which the given VM is running
 279  *
 280  * This is an instantaneous migration.
 281  */
 282 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
 283 {
 284   std::string vm_name     = piface_->get_name();
 285   std::string pm_name_src = physical_host_->get_name();
 286   std::string pm_name_dst = destination->get_name();
 287
 288   /* update net_elm with that of the destination physical host */
 289   piface_->set_netpoint(destination->get_netpoint());
 290
 291   /* Adapt the speed, pstate and other physical characteristics to the one of our new physical CPU */
 292   piface_->pimpl_cpu->reset_vcpu(destination->pimpl_cpu);
 293
 294   physical_host_ = destination;
 295
 296   /* Update vcpu's action for the new pm */
 297   /* create a cpu action bound to the pm model at the destination. */
 298   kernel::resource::CpuAction* new_cpu_action = destination->pimpl_cpu->execution_start(0, this->core_amount_);
 299
 300   if (action_->get_remains_no_update() > 0)
 301     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
 302
 303   /* keep the bound value of the cpu action of the VM. */
 304   double old_bound = action_->get_bound();
 305   if (old_bound > 0) {
 306     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
 307     new_cpu_action->set_bound(old_bound);
 308   }
 309
 310   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 311   xbt_assert(ret, "Bug: some resource still remains");
 312
 313   action_ = new_cpu_action;
 314
 315   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
 316 }
 317
 318 void VirtualMachineImpl::set_bound(double bound)
 319 {
 320   user_bound_ = bound;
 321   action_->set_user_bound(user_bound_);
 322   update_action_weight();
 323 }
 324
 325 void VirtualMachineImpl::update_action_weight()
 326 {
 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 } // namespace vm
 341 } // namespace simgrid