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/kernel/routing/NetZoneImpl.hpp"
   9 #include "simgrid/s4u/Engine.hpp"
  10 #include "simgrid/s4u/Exec.hpp"
  11 #include "simgrid/sg_config.hpp"
  12 #include "src/include/surf/surf.hpp"
  13 #include "src/kernel/EngineImpl.hpp"
  14 #include "src/kernel/activity/ExecImpl.hpp"
  15 #include "src/surf/cpu_cas01.hpp"
  16 #include "src/surf/cpu_ti.hpp"
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_vm, ker_resource, "Virtual Machines, containing actors and mobile across hosts");
  19
  20 void surf_vm_model_init_HL13(simgrid::kernel::resource::CpuModel* cpu_pm_model)
  21 {
  22   auto vm_model = std::make_shared<simgrid::vm::VMModel>("VM_HL13");
  23   auto* engine  = simgrid::kernel::EngineImpl::get_instance();
  24
  25   engine->add_model(vm_model, {cpu_pm_model});
  26   std::shared_ptr<simgrid::kernel::resource::CpuModel> cpu_model_vm;
  27
  28   auto cpu_optim = simgrid::config::get_value<std::string>("cpu/optim");
  29   if (cpu_optim == "TI") {
  30     cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuTiModel>("VmCpu_TI");
  31   } else {
  32     cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuCas01Model>("VmCpu_Cas01");
  33   }
  34   engine->add_model(cpu_model_vm, {cpu_pm_model, vm_model.get()});
  35   engine->get_netzone_root()->set_cpu_vm_model(cpu_model_vm);
  36 }
  37
  38 namespace simgrid {
  39
  40 template class xbt::Extendable<vm::VirtualMachineImpl>;
  41
  42 namespace vm {
  43 /*************
  44  * Callbacks *
  45  *************/
  46 xbt::signal<void(VirtualMachineImpl&)> VirtualMachineImpl::on_creation;
  47 xbt::signal<void(VirtualMachineImpl const&)> VirtualMachineImpl::on_destruction;
  48
  49 /*********
  50  * Model *
  51  *********/
  52
  53 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  54
  55 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
  56  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
  57  * FIXME: add a configuration flag for this
  58  */
  59 const double virt_overhead = 1; // 0.95
  60
  61 static void host_state_change(s4u::Host const& host)
  62 {
  63   if (not host.is_on()) { // just turned off.
  64     std::vector<s4u::VirtualMachine*> trash;
  65     /* Find all VMs living on that host */
  66     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
  67       if (vm->get_pm() == &host)
  68         trash.push_back(vm);
  69     for (s4u::VirtualMachine* vm : trash)
  70       vm->shutdown();
  71   }
  72 }
  73
  74 static void add_active_exec(s4u::Exec const& task)
  75 {
  76   const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
  77   if (vm != nullptr) {
  78     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
  79     vm_impl->add_active_exec();
  80     vm_impl->update_action_weight();
  81   }
  82 }
  83
  84 static void remove_active_exec(s4u::Exec const& task)
  85 {
  86   const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
  87   if (vm != nullptr) {
  88     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
  89     vm_impl->remove_active_exec();
  90     vm_impl->update_action_weight();
  91   }
  92 }
  93
  94 static s4u::VirtualMachine* get_vm_from_activity(kernel::activity::ActivityImpl const& act)
  95 {
  96   auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(&act);
  97   return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
  98 }
  99
 100 static void add_active_activity(kernel::activity::ActivityImpl const& act)
 101 {
 102   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 103   if (vm != nullptr) {
 104     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 105     vm_impl->add_active_exec();
 106     vm_impl->update_action_weight();
 107   }
 108 }
 109
 110 static void remove_active_activity(kernel::activity::ActivityImpl const& act)
 111 {
 112   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 113   if (vm != nullptr) {
 114     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 115     vm_impl->remove_active_exec();
 116     vm_impl->update_action_weight();
 117   }
 118 }
 119
 120 VMModel::VMModel(const std::string& name) : HostModel(name)
 121 {
 122   s4u::Host::on_state_change.connect(host_state_change);
 123   s4u::Exec::on_start.connect(add_active_exec);
 124   s4u::Exec::on_completion.connect(remove_active_exec);
 125   kernel::activity::ActivityImpl::on_resumed.connect(add_active_activity);
 126   kernel::activity::ActivityImpl::on_suspended.connect(remove_active_activity);
 127 }
 128
 129 double VMModel::next_occurring_event(double now)
 130 {
 131   /* TODO: update action's cost with the total cost of processes on the VM. */
 132
 133   /* 1. Now we know how many resource should be assigned to each virtual
 134    * machine. We update constraints of the virtual machine layer.
 135    *
 136    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
 137    *     X1 + X2 = C       (Equation 1)
 138    * where
 139    *    the resource share of VM1: X1
 140    *    the resource share of VM2: X2
 141    *    the capacity of PM1: C
 142    *
 143    * Then, if we have two process (P1 and P2) on VM1.
 144    *     X1_1 + X1_2 = X1  (Equation 2)
 145    * where
 146    *    the resource share of P1: X1_1
 147    *    the resource share of P2: X1_2
 148    *    the capacity of VM1: X1
 149    *
 150    * Equation 1 was solved in the physical machine layer.
 151    * Equation 2 is solved in the virtual machine layer (here).
 152    * X1 must be passed to the virtual machine layer as a constraint value.
 153    **/
 154
 155   /* iterate for all virtual machines */
 156   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
 157     if (ws_vm->get_state() == s4u::VirtualMachine::State::SUSPENDED) // Ignore suspended VMs
 158       continue;
 159
 160     const kernel::resource::CpuImpl* cpu = ws_vm->get_cpu();
 161
 162     // solved_value below is X1 in comment above: what this VM got in the sharing on the PM
 163     double solved_value = ws_vm->get_vm_impl()->get_action()->get_rate();
 164     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
 165
 166     kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
 167     vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
 168   }
 169   /* actual next occurring event is determined by VM CPU model at surf_solve */
 170   return -1.0;
 171 }
 172
 173 /************
 174  * Resource *
 175  ************/
 176
 177 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, s4u::VirtualMachine* piface,
 178                                        simgrid::s4u::Host* host_PM, int core_amount, size_t ramsize)
 179     : HostImpl(name, piface), piface_(piface), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
 180 {
 181   /* Register this VM to the list of all VMs */
 182   allVms_.push_back(piface);
 183   /* We create cpu_action corresponding to a VM process on the host operating system. */
 184   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
 185    * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM.  It corresponds to
 186    * the cost of a VM running no tasks.
 187    */
 188   action_ = physical_host_->get_cpu()->execution_start(0, core_amount_);
 189
 190   // It's empty for now, so it should not request resources in the PM
 191   update_action_weight();
 192
 193   XBT_VERB("Create VM(%s)@PM(%s)", name.c_str(), physical_host_->get_cname());
 194   on_creation(*this);
 195 }
 196
 197 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 198 VirtualMachineImpl::~VirtualMachineImpl()
 199 {
 200   on_destruction(*this);
 201   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 202   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 203   if (iter != allVms_.end())
 204     allVms_.erase(iter);
 205
 206   /* Free the cpu_action of the VM. */
 207   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 208   xbt_assert(ret, "Bug: some resource still remains");
 209 }
 210
 211 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 212 {
 213   if (get_state() != s4u::VirtualMachine::State::RUNNING)
 214     throw VmFailureException(XBT_THROW_POINT,
 215                              xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
 216   if (issuer->get_host() == piface_)
 217     throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
 218                                                                  issuer->get_cname(), piface_->get_cname()));
 219
 220   XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
 221
 222   action_->suspend();
 223
 224   foreach_actor([](auto& actor) {
 225     XBT_DEBUG("suspend %s", actor.get_cname());
 226     actor.suspend();
 227   });
 228
 229   XBT_DEBUG("suspend all actors on the VM done done");
 230
 231   vm_state_ = s4u::VirtualMachine::State::SUSPENDED;
 232 }
 233
 234 void VirtualMachineImpl::resume()
 235 {
 236   if (get_state() != s4u::VirtualMachine::State::SUSPENDED)
 237     throw VmFailureException(XBT_THROW_POINT,
 238                              xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
 239
 240   XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
 241
 242   action_->resume();
 243
 244   foreach_actor([](auto& actor) {
 245     XBT_DEBUG("resume %s", actor.get_cname());
 246     actor.resume();
 247   });
 248
 249   vm_state_ = s4u::VirtualMachine::State::RUNNING;
 250 }
 251
 252 /** @brief Power off a VM.
 253  *
 254  * All hosted processes will be killed, but the VM state is preserved on memory.
 255  * It can later be restarted.
 256  *
 257  * @param issuer the actor requesting the shutdown
 258  */
 259 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 260 {
 261   if (get_state() != s4u::VirtualMachine::State::RUNNING)
 262     XBT_VERB("Shutting down the VM %s even if it's not running but in state %s", piface_->get_cname(),
 263              s4u::VirtualMachine::to_c_str(get_state()));
 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_->get_cpu()->reset_vcpu(destination->get_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->get_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