src/kernel/resource/VirtualMachineImpl.cpp

   1 /* Copyright (c) 2013-2023. 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/kernel/resource/models/cpu_cas01.hpp"
  16 #include "src/kernel/resource/models/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 simgrid_vm_model_init_HL13()
  23 {
  24   auto* cpu_pm_model = simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->get_cpu_pm_model().get();
  25   auto vm_model = std::make_shared<simgrid::kernel::resource::VMModel>("VM_HL13");
  26   auto* engine  = simgrid::kernel::EngineImpl::get_instance();
  27
  28   engine->add_model(vm_model, {cpu_pm_model});
  29   std::shared_ptr<simgrid::kernel::resource::CpuModel> cpu_model_vm;
  30
  31   if (simgrid::config::get_value<std::string>("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::resource {
  44
  45 /*********
  46  * Model *
  47  *********/
  48
  49 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  50
  51 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
  52  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
  53  * FIXME: add a configuration flag for this
  54  */
  55 const double virt_overhead = 1; // 0.95
  56
  57 static void host_state_change(s4u::Host const& host)
  58 {
  59   if (not host.is_on()) { // just turned off.
  60     std::vector<s4u::VirtualMachine*> trash;
  61     /* Find all VMs living on that host */
  62     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
  63       if (vm->get_pm() == &host)
  64         trash.push_back(vm);
  65     for (s4u::VirtualMachine* vm : trash)
  66       vm->shutdown();
  67   }
  68 }
  69
  70 static void add_active_exec(s4u::Exec const& task)
  71 {
  72   const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(task.get_host());
  73   if (vm != nullptr) {
  74     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
  75     for (int i = 1; i <= task.get_thread_count(); i++)
  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     for (int i = 1; i <= exec->get_thread_count(); i++)
  92       vm_impl->remove_active_exec();
  93     vm_impl->update_action_weight();
  94   }
  95 }
  96
  97 static s4u::VirtualMachine* get_vm_from_activity(s4u::Activity const& act)
  98 {
  99   auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(act.get_impl());
 100   return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
 101 }
 102
 103 static void add_active_activity(s4u::Activity const& act)
 104 {
 105   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 106   if (vm != nullptr) {
 107     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 108     vm_impl->add_active_exec();
 109     vm_impl->update_action_weight();
 110   }
 111 }
 112
 113 static void remove_active_activity(s4u::Activity const& act)
 114 {
 115   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 116   if (vm != nullptr) {
 117     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 118     vm_impl->remove_active_exec();
 119     vm_impl->update_action_weight();
 120   }
 121 }
 122
 123 VMModel::VMModel(const std::string& name) : HostModel(name)
 124 {
 125   s4u::Host::on_state_change_cb(host_state_change);
 126   s4u::Exec::on_start_cb(add_active_exec);
 127   s4u::Activity::on_completion_cb(remove_active_exec);
 128   s4u::Activity::on_resumed_cb(add_active_activity);
 129   s4u::Activity::on_suspended_cb(remove_active_activity);
 130 }
 131
 132 double VMModel::next_occurring_event(double now)
 133 {
 134   /* TODO: update action's cost with the total cost of processes on the VM. */
 135
 136   /* 1. Now we know how many resource should be assigned to each virtual
 137    * machine. We update constraints of the virtual machine layer.
 138    *
 139    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
 140    *     X1 + X2 = C       (Equation 1)
 141    * where
 142    *    the resource share of VM1: X1
 143    *    the resource share of VM2: X2
 144    *    the capacity of PM1: C
 145    *
 146    * Then, if we have two process (P1 and P2) on VM1.
 147    *     X1_1 + X1_2 = X1  (Equation 2)
 148    * where
 149    *    the resource share of P1: X1_1
 150    *    the resource share of P2: X1_2
 151    *    the capacity of VM1: X1
 152    *
 153    * Equation 1 was solved in the physical machine layer.
 154    * Equation 2 is solved in the virtual machine layer (here).
 155    * X1 must be passed to the virtual machine layer as a constraint value.
 156    **/
 157
 158   /* iterate for all virtual machines */
 159   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
 160     if (ws_vm->get_state() == s4u::VirtualMachine::State::SUSPENDED) // Ignore suspended VMs
 161       continue;
 162
 163     const kernel::resource::CpuImpl* cpu = ws_vm->get_cpu();
 164
 165     // solved_value below is X1 in comment above: what this VM got in the sharing on the PM
 166     double solved_value = ws_vm->get_vm_impl()->get_action()->get_rate();
 167     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
 168
 169     lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
 170     vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
 171   }
 172   /* actual next occurring event is determined by VM CPU model at EngineImpl::solve */
 173   return -1.0;
 174 }
 175
 176 Action* VMModel::execute_thread(const s4u::Host* host, double flops_amount, int thread_count)
 177 {
 178   auto cpu = host->get_cpu();
 179   return cpu->execution_start(thread_count * flops_amount, thread_count, -1);
 180 }
 181
 182 /************
 183  * Resource *
 184  ************/
 185
 186 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, s4u::VirtualMachine* piface,
 187                                        simgrid::s4u::Host* host_PM, int core_amount, size_t ramsize)
 188     : VirtualMachineImpl(name, host_PM, core_amount, ramsize)
 189 {
 190   set_piface(piface);
 191 }
 192
 193 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, simgrid::s4u::Host* host_PM, int core_amount,
 194                                        size_t ramsize)
 195     : HostImpl(name), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
 196 {
 197   /* We create cpu_action corresponding to a VM process on the host operating system. */
 198   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
 199    * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM.  It corresponds to
 200    * the cost of a VM running no tasks.
 201    */
 202   action_ = physical_host_->get_cpu()->execution_start(0, core_amount_, 0);
 203
 204   // It's empty for now, so it should not request resources in the PM
 205   update_action_weight();
 206   XBT_VERB("Create VM(%s)@PM(%s)", name.c_str(), physical_host_->get_cname());
 207 }
 208
 209 void VirtualMachineImpl::set_piface(s4u::VirtualMachine* piface)
 210 {
 211   xbt_assert(not piface_, "Pointer to interface already configured for this VM (%s)", get_cname());
 212   piface_ = piface;
 213   /* Register this VM to the list of all VMs */
 214   allVms_.push_back(piface);
 215 }
 216
 217 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 218 void VirtualMachineImpl::vm_destroy()
 219 {
 220   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 221   if (auto iter = find(allVms_.begin(), allVms_.end(), piface_); iter != allVms_.end())
 222     allVms_.erase(iter);
 223
 224   /* Free the cpu_action of the VM. */
 225   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 226   xbt_assert(ret, "Bug: some resource still remains");
 227
 228   // VM uses the host's netpoint, clean but don't destroy it
 229   get_iface()->set_netpoint(nullptr);
 230   // Take a temporary copy to delete iface safely after impl is destroy'ed
 231   const auto* iface = get_iface();
 232   // calls the HostImpl() destroy, it'll delete the impl object
 233   destroy();
 234
 235   delete iface;
 236 }
 237
 238 void VirtualMachineImpl::start()
 239 {
 240   s4u::VirtualMachine::on_start(*get_iface());
 241   s4u::VmHostExt::ensureVmExtInstalled();
 242
 243   if (physical_host_->extension<s4u::VmHostExt>() == nullptr)
 244     physical_host_->extension_set(new s4u::VmHostExt());
 245
 246   if (size_t pm_ramsize = physical_host_->extension<s4u::VmHostExt>()->ramsize;
 247       pm_ramsize &&
 248       not physical_host_->extension<s4u::VmHostExt>()->overcommit) { /* Need to verify that we don't overcommit */
 249     /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
 250     size_t total_ramsize_of_vms = 0;
 251     for (auto* const& ws_vm : allVms_)
 252       if (physical_host_ == ws_vm->get_pm())
 253         total_ramsize_of_vms += ws_vm->get_ramsize();
 254
 255     if (total_ramsize_of_vms + get_ramsize() > pm_ramsize) {
 256       XBT_WARN("cannot start %s@%s due to memory shortage: get_ramsize() %zu, free %zu, pm_ramsize %zu (bytes).",
 257                get_cname(), physical_host_->get_cname(), get_ramsize(), pm_ramsize - total_ramsize_of_vms, pm_ramsize);
 258       throw VmFailureException(XBT_THROW_POINT,
 259                                xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
 260                                                   physical_host_->get_cname(), get_cname()));
 261     }
 262   }
 263   vm_state_ = s4u::VirtualMachine::State::RUNNING;
 264
 265   s4u::VirtualMachine::on_started(*get_iface());
 266 }
 267
 268 void VirtualMachineImpl::suspend(const actor::ActorImpl* issuer)
 269 {
 270   s4u::VirtualMachine::on_suspend(*get_iface());
 271
 272   if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
 273     throw VmFailureException(XBT_THROW_POINT,
 274                              xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
 275   if (issuer->get_host() == piface_)
 276     throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
 277                                                                  issuer->get_cname(), piface_->get_cname()));
 278
 279   XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
 280
 281   action_->suspend();
 282
 283   foreach_actor([](auto& actor) {
 284     XBT_DEBUG("suspend %s", actor.get_cname());
 285     actor.suspend();
 286   });
 287
 288   XBT_DEBUG("suspend all actors on the VM done done");
 289
 290   vm_state_ = s4u::VirtualMachine::State::SUSPENDED;
 291 }
 292
 293 void VirtualMachineImpl::resume()
 294 {
 295   if (vm_state_ != s4u::VirtualMachine::State::SUSPENDED)
 296     throw VmFailureException(XBT_THROW_POINT,
 297                              xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
 298
 299   XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
 300
 301   action_->resume();
 302
 303   foreach_actor([](auto& actor) {
 304     XBT_DEBUG("resume %s", actor.get_cname());
 305     actor.resume();
 306   });
 307
 308   vm_state_ = s4u::VirtualMachine::State::RUNNING;
 309   s4u::VirtualMachine::on_resume(*get_iface());
 310 }
 311
 312 /** @brief Power off a VM.
 313  *
 314  * All hosted processes will be killed, but the VM state is preserved on memory.
 315  * It can later be restarted.
 316  *
 317  * @param issuer the actor requesting the shutdown
 318  */
 319 void VirtualMachineImpl::shutdown(actor::ActorImpl* issuer)
 320 {
 321   if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
 322     XBT_VERB("Shutting down the VM %s even if it's not running but in state %s", piface_->get_cname(),
 323              s4u::VirtualMachine::to_c_str(get_state()));
 324
 325   XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
 326
 327   foreach_actor([issuer](auto& actor) {
 328     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor.get_cname(), actor.get_host()->get_cname(),
 329               issuer->get_cname());
 330     issuer->kill(&actor);
 331   });
 332
 333   set_state(s4u::VirtualMachine::State::DESTROYED);
 334
 335   s4u::VirtualMachine::on_shutdown(*get_iface());
 336 }
 337
 338 /** @brief Change the physical host on which the given VM is running
 339  *
 340  * This is an instantaneous migration.
 341  */
 342 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
 343 {
 344   std::string vm_name     = piface_->get_name();
 345   std::string pm_name_src = physical_host_->get_name();
 346   std::string pm_name_dst = destination->get_name();
 347
 348   /* update net_elm with that of the destination physical host */
 349   piface_->set_netpoint(destination->get_netpoint());
 350   physical_host_->get_impl()->move_vm(this, destination->get_impl());
 351
 352   /* Adapt the speed, pstate and other physical characteristics to the one of our new physical CPU */
 353   piface_->get_cpu()->reset_vcpu(destination->get_cpu());
 354
 355   physical_host_ = destination;
 356
 357   /* Update vcpu's action for the new pm */
 358   /* create a cpu action bound to the pm model at the destination. */
 359   CpuAction* new_cpu_action = destination->get_cpu()->execution_start(0, this->core_amount_);
 360
 361   if (action_->get_remains_no_update() > 0)
 362     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
 363
 364   /* keep the bound value of the cpu action of the VM. */
 365   if (double old_bound = action_->get_bound(); old_bound > 0) {
 366     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
 367     new_cpu_action->set_bound(old_bound);
 368   }
 369
 370   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 371   xbt_assert(ret, "Bug: some resource still remains");
 372
 373   action_ = new_cpu_action;
 374
 375   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
 376 }
 377
 378 void VirtualMachineImpl::set_bound(double bound)
 379 {
 380   user_bound_ = bound;
 381   action_->set_user_bound(user_bound_);
 382   update_action_weight();
 383 }
 384
 385 void VirtualMachineImpl::update_action_weight()
 386 {
 387   /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
 388   int impact = std::min(active_execs_, get_core_amount());
 389
 390   XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %u)", this, impact, active_execs_);
 391
 392   if (impact > 0)
 393     action_->set_sharing_penalty(1. / impact);
 394   else
 395     action_->set_sharing_penalty(0.);
 396
 397   action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
 398 }
 399
 400 void VirtualMachineImpl::start_migration()
 401 {
 402   is_migrating_ = true;
 403   s4u::VirtualMachine::on_migration_start(*get_iface());
 404 }
 405
 406 void VirtualMachineImpl::end_migration()
 407 {
 408   is_migrating_ = false;
 409   s4u::VirtualMachine::on_migration_end(*get_iface());
 410 }
 411
 412 void VirtualMachineImpl::seal()
 413 {
 414   HostImpl::seal();
 415   s4u::VirtualMachine::on_vm_creation(*get_iface());
 416 }
 417
 418 } // namespace kernel::resource
 419 } // namespace simgrid