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