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