src/kernel/resource/VirtualMachineImpl.cpp

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