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/NetPoint.hpp>
   8 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
   9 #include <simgrid/s4u/Exec.hpp>
  10
  11 #include "simgrid/sg_config.hpp"
  12 #include "src/kernel/EngineImpl.hpp"
  13 #include "src/kernel/activity/ExecImpl.hpp"
  14 #include "src/kernel/resource/VirtualMachineImpl.hpp"
  15 #include "src/surf/cpu_cas01.hpp"
  16 #include "src/surf/cpu_ti.hpp"
  17
  18 #include <numeric>
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_vm, ker_resource, "Virtual Machines, containing actors and mobile across hosts");
  21
  22 void surf_vm_model_init_HL13(simgrid::kernel::resource::CpuModel* cpu_pm_model)
  23 {
  24   auto vm_model = std::make_shared<simgrid::kernel::resource::VMModel>("VM_HL13");
  25   auto* engine  = simgrid::kernel::EngineImpl::get_instance();
  26
  27   engine->add_model(vm_model, {cpu_pm_model});
  28   std::shared_ptr<simgrid::kernel::resource::CpuModel> cpu_model_vm;
  29
  30   auto cpu_optim = simgrid::config::get_value<std::string>("cpu/optim");
  31   if (cpu_optim == "TI") {
  32     cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuTiModel>("VmCpu_TI");
  33   } else {
  34     cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuCas01Model>("VmCpu_Cas01");
  35   }
  36   engine->add_model(cpu_model_vm, {cpu_pm_model, vm_model.get()});
  37   engine->get_netzone_root()->set_cpu_vm_model(cpu_model_vm);
  38 }
  39
  40 namespace simgrid {
  41 template class xbt::Extendable<kernel::resource::VirtualMachineImpl>;
  42
  43 namespace kernel {
  44 namespace resource {
  45
  46 /*********
  47  * Model *
  48  *********/
  49
  50 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  51
  52 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
  53  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
  54  * FIXME: add a configuration flag for this
  55  */
  56 const double virt_overhead = 1; // 0.95
  57
  58 static void host_state_change(s4u::Host const& host)
  59 {
  60   if (not host.is_on()) { // just turned off.
  61     std::vector<s4u::VirtualMachine*> trash;
  62     /* Find all VMs living on that host */
  63     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
  64       if (vm->get_pm() == &host)
  65         trash.push_back(vm);
  66     for (s4u::VirtualMachine* vm : trash)
  67       vm->shutdown();
  68   }
  69 }
  70
  71 static void add_active_exec(s4u::Exec const& task)
  72 {
  73   const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
  74   if (vm != nullptr) {
  75     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
  76     vm_impl->add_active_exec();
  77     vm_impl->update_action_weight();
  78   }
  79 }
  80
  81 static void remove_active_exec(s4u::Activity const& task)
  82 {
  83   const auto* exec = dynamic_cast<s4u::Exec const*>(&task);
  84   if (exec == nullptr)
  85     return;
  86   if (not exec->is_assigned())
  87     return;
  88   const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(exec->get_host());
  89   if (vm != nullptr) {
  90     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
  91     vm_impl->remove_active_exec();
  92     vm_impl->update_action_weight();
  93   }
  94 }
  95
  96 static s4u::VirtualMachine* get_vm_from_activity(s4u::Activity const& act)
  97 {
  98   auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(act.get_impl());
  99   return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
 100 }
 101
 102 static void add_active_activity(s4u::Activity const& act)
 103 {
 104   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 105   if (vm != nullptr) {
 106     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 107     vm_impl->add_active_exec();
 108     vm_impl->update_action_weight();
 109   }
 110 }
 111
 112 static void remove_active_activity(s4u::Activity const& act)
 113 {
 114   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 115   if (vm != nullptr) {
 116     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 117     vm_impl->remove_active_exec();
 118     vm_impl->update_action_weight();
 119   }
 120 }
 121
 122 VMModel::VMModel(const std::string& name) : HostModel(name)
 123 {
 124   s4u::Host::on_state_change_cb(host_state_change);
 125   s4u::Exec::on_start_cb(add_active_exec);
 126   s4u::Activity::on_completion_cb(remove_active_exec);
 127   s4u::Activity::on_resumed_cb(add_active_activity);
 128   s4u::Activity::on_suspended_cb(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::CpuImpl* cpu = ws_vm->get_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_vm_impl()->get_action()->get_rate();
 166     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
 167
 168     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 EngineImpl::solve */
 172   return -1.0;
 173 }
 174
 175 Action* VMModel::execute_thread(const s4u::Host* host, double flops_amount, int thread_count)
 176 {
 177   auto cpu = host->get_cpu();
 178   return cpu->execution_start(thread_count * flops_amount, thread_count, -1);
 179 }
 180
 181 /************
 182  * Resource *
 183  ************/
 184
 185 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, s4u::VirtualMachine* piface,
 186                                        simgrid::s4u::Host* host_PM, int core_amount, size_t ramsize)
 187     : HostImpl(name), piface_(piface), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
 188 {
 189   /* Register this VM to the list of all VMs */
 190   allVms_.push_back(piface);
 191   /* We create cpu_action corresponding to a VM process on the host operating system. */
 192   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
 193    * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM.  It corresponds to
 194    * the cost of a VM running no tasks.
 195    */
 196   action_ = physical_host_->get_cpu()->execution_start(0, core_amount_, 0);
 197
 198   // It's empty for now, so it should not request resources in the PM
 199   update_action_weight();
 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   // VM uses the host's netpoint, clean but don't destroy it
 216   get_iface()->set_netpoint(nullptr);
 217   // Take a temporary copy to delete iface safely after impl is destroy'ed
 218   const auto* iface = get_iface();
 219   // calls the HostImpl() destroy, it'll delete the impl object
 220   destroy();
 221
 222   delete iface;
 223 }
 224
 225 void VirtualMachineImpl::start()
 226 {
 227   s4u::VirtualMachine::on_start(*get_iface());
 228   s4u::VmHostExt::ensureVmExtInstalled();
 229
 230   if (physical_host_->extension<s4u::VmHostExt>() == nullptr)
 231     physical_host_->extension_set(new s4u::VmHostExt());
 232
 233   size_t pm_ramsize = physical_host_->extension<s4u::VmHostExt>()->ramsize;
 234   if (pm_ramsize &&
 235       not physical_host_->extension<s4u::VmHostExt>()->overcommit) { /* Need to verify that we don't overcommit */
 236     /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
 237     size_t total_ramsize_of_vms = 0;
 238     for (auto* const& ws_vm : allVms_)
 239       if (physical_host_ == ws_vm->get_pm())
 240         total_ramsize_of_vms += ws_vm->get_ramsize();
 241
 242     if (total_ramsize_of_vms + get_ramsize() > pm_ramsize) {
 243       XBT_WARN("cannot start %s@%s due to memory shortage: get_ramsize() %zu, free %zu, pm_ramsize %zu (bytes).",
 244                get_cname(), physical_host_->get_cname(), get_ramsize(), pm_ramsize - total_ramsize_of_vms, pm_ramsize);
 245       throw VmFailureException(XBT_THROW_POINT,
 246                                xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
 247                                                   physical_host_->get_cname(), get_cname()));
 248     }
 249   }
 250   vm_state_ = s4u::VirtualMachine::State::RUNNING;
 251
 252   s4u::VirtualMachine::on_started(*get_iface());
 253 }
 254
 255 void VirtualMachineImpl::suspend(const actor::ActorImpl* issuer)
 256 {
 257   s4u::VirtualMachine::on_suspend(*get_iface());
 258
 259   if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
 260     throw VmFailureException(XBT_THROW_POINT,
 261                              xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
 262   if (issuer->get_host() == piface_)
 263     throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
 264                                                                  issuer->get_cname(), piface_->get_cname()));
 265
 266   XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
 267
 268   action_->suspend();
 269
 270   foreach_actor([](auto& actor) {
 271     XBT_DEBUG("suspend %s", actor.get_cname());
 272     actor.suspend();
 273   });
 274
 275   XBT_DEBUG("suspend all actors on the VM done done");
 276
 277   vm_state_ = s4u::VirtualMachine::State::SUSPENDED;
 278 }
 279
 280 void VirtualMachineImpl::resume()
 281 {
 282   if (vm_state_ != s4u::VirtualMachine::State::SUSPENDED)
 283     throw VmFailureException(XBT_THROW_POINT,
 284                              xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
 285
 286   XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
 287
 288   action_->resume();
 289
 290   foreach_actor([](auto& actor) {
 291     XBT_DEBUG("resume %s", actor.get_cname());
 292     actor.resume();
 293   });
 294
 295   vm_state_ = s4u::VirtualMachine::State::RUNNING;
 296   s4u::VirtualMachine::on_resume(*get_iface());
 297 }
 298
 299 /** @brief Power off a VM.
 300  *
 301  * All hosted processes will be killed, but the VM state is preserved on memory.
 302  * It can later be restarted.
 303  *
 304  * @param issuer the actor requesting the shutdown
 305  */
 306 void VirtualMachineImpl::shutdown(actor::ActorImpl* issuer)
 307 {
 308   if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
 309     XBT_VERB("Shutting down the VM %s even if it's not running but in state %s", piface_->get_cname(),
 310              s4u::VirtualMachine::to_c_str(get_state()));
 311
 312   XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
 313
 314   foreach_actor([issuer](auto& actor) {
 315     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor.get_cname(), actor.get_host()->get_cname(),
 316               issuer->get_cname());
 317     issuer->kill(&actor);
 318   });
 319
 320   set_state(s4u::VirtualMachine::State::DESTROYED);
 321
 322   s4u::VirtualMachine::on_shutdown(*get_iface());
 323   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 324 }
 325
 326 /** @brief Change the physical host on which the given VM is running
 327  *
 328  * This is an instantaneous migration.
 329  */
 330 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
 331 {
 332   std::string vm_name     = piface_->get_name();
 333   std::string pm_name_src = physical_host_->get_name();
 334   std::string pm_name_dst = destination->get_name();
 335
 336   /* update net_elm with that of the destination physical host */
 337   piface_->set_netpoint(destination->get_netpoint());
 338   physical_host_->get_impl()->move_vm(this, destination->get_impl());
 339
 340   /* Adapt the speed, pstate and other physical characteristics to the one of our new physical CPU */
 341   piface_->get_cpu()->reset_vcpu(destination->get_cpu());
 342
 343   physical_host_ = destination;
 344
 345   /* Update vcpu's action for the new pm */
 346   /* create a cpu action bound to the pm model at the destination. */
 347   CpuAction* new_cpu_action = destination->get_cpu()->execution_start(0, this->core_amount_);
 348
 349   if (action_->get_remains_no_update() > 0)
 350     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
 351
 352   /* keep the bound value of the cpu action of the VM. */
 353   double old_bound = action_->get_bound();
 354   if (old_bound > 0) {
 355     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
 356     new_cpu_action->set_bound(old_bound);
 357   }
 358
 359   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 360   xbt_assert(ret, "Bug: some resource still remains");
 361
 362   action_ = new_cpu_action;
 363
 364   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
 365 }
 366
 367 void VirtualMachineImpl::set_bound(double bound)
 368 {
 369   user_bound_ = bound;
 370   action_->set_user_bound(user_bound_);
 371   update_action_weight();
 372 }
 373
 374 void VirtualMachineImpl::update_action_weight()
 375 {
 376   /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
 377   int impact = std::min(active_execs_, get_core_amount());
 378
 379   XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %u)", this, impact, active_execs_);
 380
 381   if (impact > 0)
 382     action_->set_sharing_penalty(1. / impact);
 383   else
 384     action_->set_sharing_penalty(0.);
 385
 386   action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
 387 }
 388
 389 void VirtualMachineImpl::start_migration()
 390 {
 391   is_migrating_ = true;
 392   s4u::VirtualMachine::on_migration_start(*get_iface());
 393 }
 394
 395 void VirtualMachineImpl::end_migration()
 396 {
 397   is_migrating_ = false;
 398   s4u::VirtualMachine::on_migration_end(*get_iface());
 399 }
 400
 401 void VirtualMachineImpl::seal()
 402 {
 403   HostImpl::seal();
 404   s4u::VirtualMachine::on_creation(*get_iface());
 405 }
 406
 407 } // namespace resource
 408 } // namespace kernel
 409 } // namespace simgrid