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   if (simgrid::config::get_value<std::string>("cpu/optim") == "TI") {
  31     cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuTiModel>("VmCpu_TI");
  32   } else {
  33     cpu_model_vm = std::make_shared<simgrid::kernel::resource::CpuCas01Model>("VmCpu_Cas01");
  34   }
  35   engine->add_model(cpu_model_vm, {cpu_pm_model, vm_model.get()});
  36   engine->get_netzone_root()->set_cpu_vm_model(cpu_model_vm);
  37 }
  38
  39 namespace simgrid {
  40 template class xbt::Extendable<kernel::resource::VirtualMachineImpl>;
  41
  42 namespace kernel {
  43 namespace 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     vm_impl->add_active_exec();
  76     vm_impl->update_action_weight();
  77   }
  78 }
  79
  80 static void remove_active_exec(s4u::Activity const& task)
  81 {
  82   const auto* exec = dynamic_cast<s4u::Exec const*>(&task);
  83   if (exec == nullptr)
  84     return;
  85   if (not exec->is_assigned())
  86     return;
  87   const s4u::VirtualMachine* vm = dynamic_cast<s4u::VirtualMachine*>(exec->get_host());
  88   if (vm != nullptr) {
  89     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
  90     vm_impl->remove_active_exec();
  91     vm_impl->update_action_weight();
  92   }
  93 }
  94
  95 static s4u::VirtualMachine* get_vm_from_activity(s4u::Activity const& act)
  96 {
  97   auto* exec = dynamic_cast<kernel::activity::ExecImpl const*>(act.get_impl());
  98   return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->get_host()) : nullptr;
  99 }
 100
 101 static void add_active_activity(s4u::Activity const& act)
 102 {
 103   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 104   if (vm != nullptr) {
 105     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 106     vm_impl->add_active_exec();
 107     vm_impl->update_action_weight();
 108   }
 109 }
 110
 111 static void remove_active_activity(s4u::Activity const& act)
 112 {
 113   const s4u::VirtualMachine* vm = get_vm_from_activity(act);
 114   if (vm != nullptr) {
 115     VirtualMachineImpl* vm_impl = vm->get_vm_impl();
 116     vm_impl->remove_active_exec();
 117     vm_impl->update_action_weight();
 118   }
 119 }
 120
 121 VMModel::VMModel(const std::string& name) : HostModel(name)
 122 {
 123   s4u::Host::on_state_change_cb(host_state_change);
 124   s4u::Exec::on_start_cb(add_active_exec);
 125   s4u::Activity::on_completion_cb(remove_active_exec);
 126   s4u::Activity::on_resumed_cb(add_active_activity);
 127   s4u::Activity::on_suspended_cb(remove_active_activity);
 128 }
 129
 130 double VMModel::next_occurring_event(double now)
 131 {
 132   /* TODO: update action's cost with the total cost of processes on the VM. */
 133
 134   /* 1. Now we know how many resource should be assigned to each virtual
 135    * machine. We update constraints of the virtual machine layer.
 136    *
 137    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
 138    *     X1 + X2 = C       (Equation 1)
 139    * where
 140    *    the resource share of VM1: X1
 141    *    the resource share of VM2: X2
 142    *    the capacity of PM1: C
 143    *
 144    * Then, if we have two process (P1 and P2) on VM1.
 145    *     X1_1 + X1_2 = X1  (Equation 2)
 146    * where
 147    *    the resource share of P1: X1_1
 148    *    the resource share of P2: X1_2
 149    *    the capacity of VM1: X1
 150    *
 151    * Equation 1 was solved in the physical machine layer.
 152    * Equation 2 is solved in the virtual machine layer (here).
 153    * X1 must be passed to the virtual machine layer as a constraint value.
 154    **/
 155
 156   /* iterate for all virtual machines */
 157   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
 158     if (ws_vm->get_state() == s4u::VirtualMachine::State::SUSPENDED) // Ignore suspended VMs
 159       continue;
 160
 161     const kernel::resource::CpuImpl* cpu = ws_vm->get_cpu();
 162
 163     // solved_value below is X1 in comment above: what this VM got in the sharing on the PM
 164     double solved_value = ws_vm->get_vm_impl()->get_action()->get_rate();
 165     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
 166
 167     lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
 168     vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
 169   }
 170   /* actual next occurring event is determined by VM CPU model at EngineImpl::solve */
 171   return -1.0;
 172 }
 173
 174 Action* VMModel::execute_thread(const s4u::Host* host, double flops_amount, int thread_count)
 175 {
 176   auto cpu = host->get_cpu();
 177   return cpu->execution_start(thread_count * flops_amount, thread_count, -1);
 178 }
 179
 180 /************
 181  * Resource *
 182  ************/
 183
 184 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, s4u::VirtualMachine* piface,
 185                                        simgrid::s4u::Host* host_PM, int core_amount, size_t ramsize)
 186     : VirtualMachineImpl(name, host_PM, core_amount, ramsize)
 187 {
 188   set_piface(piface);
 189 }
 190
 191 VirtualMachineImpl::VirtualMachineImpl(const std::string& name, simgrid::s4u::Host* host_PM, int core_amount,
 192                                        size_t ramsize)
 193     : HostImpl(name), physical_host_(host_PM), core_amount_(core_amount), ramsize_(ramsize)
 194 {
 195   /* We create cpu_action corresponding to a VM process on the host operating system. */
 196   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
 197    * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM.  It corresponds to
 198    * the cost of a VM running no tasks.
 199    */
 200   action_ = physical_host_->get_cpu()->execution_start(0, core_amount_, 0);
 201
 202   // It's empty for now, so it should not request resources in the PM
 203   update_action_weight();
 204   XBT_VERB("Create VM(%s)@PM(%s)", name.c_str(), physical_host_->get_cname());
 205 }
 206
 207 void VirtualMachineImpl::set_piface(s4u::VirtualMachine* piface)
 208 {
 209   xbt_assert(not piface_, "Pointer to interface already configured for this VM (%s)", get_cname());
 210   piface_ = piface;
 211   /* Register this VM to the list of all VMs */
 212   allVms_.push_back(piface);
 213 }
 214
 215 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 216 void VirtualMachineImpl::vm_destroy()
 217 {
 218   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 219   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 220   if (iter != allVms_.end())
 221     allVms_.erase(iter);
 222
 223   /* Free the cpu_action of the VM. */
 224   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 225   xbt_assert(ret, "Bug: some resource still remains");
 226
 227   // VM uses the host's netpoint, clean but don't destroy it
 228   get_iface()->set_netpoint(nullptr);
 229   // Take a temporary copy to delete iface safely after impl is destroy'ed
 230   const auto* iface = get_iface();
 231   // calls the HostImpl() destroy, it'll delete the impl object
 232   destroy();
 233
 234   delete iface;
 235 }
 236
 237 void VirtualMachineImpl::start()
 238 {
 239   s4u::VirtualMachine::on_start(*get_iface());
 240   s4u::VmHostExt::ensureVmExtInstalled();
 241
 242   if (physical_host_->extension<s4u::VmHostExt>() == nullptr)
 243     physical_host_->extension_set(new s4u::VmHostExt());
 244
 245   size_t pm_ramsize = physical_host_->extension<s4u::VmHostExt>()->ramsize;
 246   if (pm_ramsize &&
 247       not physical_host_->extension<s4u::VmHostExt>()->overcommit) { /* Need to verify that we don't overcommit */
 248     /* Retrieve the memory occupied by the VMs on that host. Yep, we have to traverse all VMs of all hosts for that */
 249     size_t total_ramsize_of_vms = 0;
 250     for (auto* const& ws_vm : allVms_)
 251       if (physical_host_ == ws_vm->get_pm())
 252         total_ramsize_of_vms += ws_vm->get_ramsize();
 253
 254     if (total_ramsize_of_vms + get_ramsize() > pm_ramsize) {
 255       XBT_WARN("cannot start %s@%s due to memory shortage: get_ramsize() %zu, free %zu, pm_ramsize %zu (bytes).",
 256                get_cname(), physical_host_->get_cname(), get_ramsize(), pm_ramsize - total_ramsize_of_vms, pm_ramsize);
 257       throw VmFailureException(XBT_THROW_POINT,
 258                                xbt::string_printf("Memory shortage on host '%s', VM '%s' cannot be started",
 259                                                   physical_host_->get_cname(), get_cname()));
 260     }
 261   }
 262   vm_state_ = s4u::VirtualMachine::State::RUNNING;
 263
 264   s4u::VirtualMachine::on_started(*get_iface());
 265 }
 266
 267 void VirtualMachineImpl::suspend(const actor::ActorImpl* issuer)
 268 {
 269   s4u::VirtualMachine::on_suspend(*get_iface());
 270
 271   if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
 272     throw VmFailureException(XBT_THROW_POINT,
 273                              xbt::string_printf("Cannot suspend VM %s: it is not running.", piface_->get_cname()));
 274   if (issuer->get_host() == piface_)
 275     throw VmFailureException(XBT_THROW_POINT, xbt::string_printf("Actor %s cannot suspend the VM %s in which it runs",
 276                                                                  issuer->get_cname(), piface_->get_cname()));
 277
 278   XBT_DEBUG("suspend VM(%s), where %zu actors exist", piface_->get_cname(), get_actor_count());
 279
 280   action_->suspend();
 281
 282   foreach_actor([](auto& actor) {
 283     XBT_DEBUG("suspend %s", actor.get_cname());
 284     actor.suspend();
 285   });
 286
 287   XBT_DEBUG("suspend all actors on the VM done done");
 288
 289   vm_state_ = s4u::VirtualMachine::State::SUSPENDED;
 290 }
 291
 292 void VirtualMachineImpl::resume()
 293 {
 294   if (vm_state_ != s4u::VirtualMachine::State::SUSPENDED)
 295     throw VmFailureException(XBT_THROW_POINT,
 296                              xbt::string_printf("Cannot resume VM %s: it was not suspended", piface_->get_cname()));
 297
 298   XBT_DEBUG("Resume VM %s, containing %zu actors.", piface_->get_cname(), get_actor_count());
 299
 300   action_->resume();
 301
 302   foreach_actor([](auto& actor) {
 303     XBT_DEBUG("resume %s", actor.get_cname());
 304     actor.resume();
 305   });
 306
 307   vm_state_ = s4u::VirtualMachine::State::RUNNING;
 308   s4u::VirtualMachine::on_resume(*get_iface());
 309 }
 310
 311 /** @brief Power off a VM.
 312  *
 313  * All hosted processes will be killed, but the VM state is preserved on memory.
 314  * It can later be restarted.
 315  *
 316  * @param issuer the actor requesting the shutdown
 317  */
 318 void VirtualMachineImpl::shutdown(actor::ActorImpl* issuer)
 319 {
 320   if (vm_state_ != s4u::VirtualMachine::State::RUNNING)
 321     XBT_VERB("Shutting down the VM %s even if it's not running but in state %s", piface_->get_cname(),
 322              s4u::VirtualMachine::to_c_str(get_state()));
 323
 324   XBT_DEBUG("shutdown VM %s, that contains %zu actors", piface_->get_cname(), get_actor_count());
 325
 326   foreach_actor([issuer](auto& actor) {
 327     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", actor.get_cname(), actor.get_host()->get_cname(),
 328               issuer->get_cname());
 329     issuer->kill(&actor);
 330   });
 331
 332   set_state(s4u::VirtualMachine::State::DESTROYED);
 333
 334   s4u::VirtualMachine::on_shutdown(*get_iface());
 335   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 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   double old_bound = action_->get_bound();
 366   if (old_bound > 0) {
 367     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
 368     new_cpu_action->set_bound(old_bound);
 369   }
 370
 371   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 372   xbt_assert(ret, "Bug: some resource still remains");
 373
 374   action_ = new_cpu_action;
 375
 376   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
 377 }
 378
 379 void VirtualMachineImpl::set_bound(double bound)
 380 {
 381   user_bound_ = bound;
 382   action_->set_user_bound(user_bound_);
 383   update_action_weight();
 384 }
 385
 386 void VirtualMachineImpl::update_action_weight()
 387 {
 388   /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
 389   int impact = std::min(active_execs_, get_core_amount());
 390
 391   XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %u)", this, impact, active_execs_);
 392
 393   if (impact > 0)
 394     action_->set_sharing_penalty(1. / impact);
 395   else
 396     action_->set_sharing_penalty(0.);
 397
 398   action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
 399 }
 400
 401 void VirtualMachineImpl::start_migration()
 402 {
 403   is_migrating_ = true;
 404   s4u::VirtualMachine::on_migration_start(*get_iface());
 405 }
 406
 407 void VirtualMachineImpl::end_migration()
 408 {
 409   is_migrating_ = false;
 410   s4u::VirtualMachine::on_migration_end(*get_iface());
 411 }
 412
 413 void VirtualMachineImpl::seal()
 414 {
 415   HostImpl::seal();
 416   s4u::VirtualMachine::on_creation(*get_iface());
 417 }
 418
 419 } // namespace resource
 420 } // namespace kernel
 421 } // namespace simgrid