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