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