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