src/plugins/vm/VirtualMachineImpl.cpp

   1 /* Copyright (c) 2013-2019. 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 "src/include/surf/surf.hpp"
   8 #include "src/simix/ActorImpl.hpp"
   9 #include "src/simix/smx_host_private.hpp"
  10 #include "src/kernel/activity/ExecImpl.hpp"
  11 #include "xbt/asserts.h" // xbt_log_no_loc
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_vm, surf, "Logging specific to the SURF VM module");
  14
  15 simgrid::vm::VMModel* surf_vm_model = nullptr;
  16
  17 void surf_vm_model_init_HL13()
  18 {
  19   if (surf_cpu_model_vm != nullptr)
  20     surf_vm_model = new simgrid::vm::VMModel();
  21 }
  22
  23 namespace simgrid {
  24 namespace vm {
  25 /*************
  26  * Callbacks *
  27  *************/
  28 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_creation;
  29 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_destruction;
  30 simgrid::xbt::signal<void(VirtualMachineImpl*)> VirtualMachineImpl::on_state_change;
  31 /*********
  32  * Model *
  33  *********/
  34
  35 std::deque<s4u::VirtualMachine*> VirtualMachineImpl::allVms_;
  36
  37 /* In the real world, processes on the guest operating system will be somewhat degraded due to virtualization overhead.
  38  * The total CPU share these processes get is smaller than that of the VM process gets on a host operating system.
  39  * FIXME: add a configuration flag for this
  40  */
  41 const double virt_overhead = 1; // 0.95
  42
  43 static void host_state_change(s4u::Host& host)
  44 {
  45   if (not host.is_on()) { // just turned off.
  46     std::vector<s4u::VirtualMachine*> trash;
  47     /* Find all VMs living on that host */
  48     for (s4u::VirtualMachine* const& vm : VirtualMachineImpl::allVms_)
  49       if (vm->get_pm() == &host)
  50         trash.push_back(vm);
  51     for (s4u::VirtualMachine* vm : trash)
  52       vm->shutdown();
  53   }
  54 }
  55
  56 static s4u::VirtualMachine* get_vm_from_task(kernel::activity::ActivityImplPtr task)
  57 {
  58   kernel::activity::ExecImpl* exec = dynamic_cast<kernel::activity::ExecImpl*>(task.get());
  59   return exec != nullptr ? dynamic_cast<s4u::VirtualMachine*>(exec->host_) : nullptr;
  60 }
  61
  62 static void add_active_task(kernel::activity::ActivityImplPtr task)
  63 {
  64   s4u::VirtualMachine* vm = get_vm_from_task(task);
  65   if (vm != nullptr) {
  66     VirtualMachineImpl *vm_impl = vm->get_impl();
  67     vm_impl->active_tasks_ = vm_impl->active_tasks_ + 1;
  68     vm_impl->update_action_weight();
  69   }
  70 }
  71
  72 static void remove_active_task(kernel::activity::ActivityImplPtr task)
  73 {
  74   s4u::VirtualMachine* vm = get_vm_from_task(task);
  75   if (vm != nullptr) {
  76     VirtualMachineImpl *vm_impl = vm->get_impl();
  77     vm_impl->active_tasks_ = vm_impl->active_tasks_ - 1;
  78     vm_impl->update_action_weight();
  79   }
  80 }
  81
  82 VMModel::VMModel()
  83 {
  84   all_existing_models.push_back(this);
  85   s4u::Host::on_state_change.connect(host_state_change);
  86   kernel::activity::ExecImpl::on_creation.connect(add_active_task);
  87   kernel::activity::ExecImpl::on_completion.connect(remove_active_task);
  88   kernel::activity::ActivityImpl::on_resumed.connect(add_active_task);
  89   kernel::activity::ActivityImpl::on_suspended.connect(remove_active_task);
  90 }
  91
  92 double VMModel::next_occuring_event(double now)
  93 {
  94   /* TODO: update action's cost with the total cost of processes on the VM. */
  95
  96   /* 1. Now we know how many resource should be assigned to each virtual
  97    * machine. We update constraints of the virtual machine layer.
  98    *
  99    * If we have two virtual machine (VM1 and VM2) on a physical machine (PM1).
 100    *     X1 + X2 = C       (Equation 1)
 101    * where
 102    *    the resource share of VM1: X1
 103    *    the resource share of VM2: X2
 104    *    the capacity of PM1: C
 105    *
 106    * Then, if we have two process (P1 and P2) on VM1.
 107    *     X1_1 + X1_2 = X1  (Equation 2)
 108    * where
 109    *    the resource share of P1: X1_1
 110    *    the resource share of P2: X1_2
 111    *    the capacity of VM1: X1
 112    *
 113    * Equation 1 was solved in the physical machine layer.
 114    * Equation 2 is solved in the virtual machine layer (here).
 115    * X1 must be passed to the virtual machine layer as a constraint value.
 116    **/
 117
 118   /* iterate for all virtual machines */
 119   for (s4u::VirtualMachine* const& ws_vm : VirtualMachineImpl::allVms_) {
 120     surf::Cpu* cpu = ws_vm->pimpl_cpu;
 121
 122     double solved_value =
 123         ws_vm->get_impl()->action_->get_variable()->get_value(); // this is X1 in comment above, what
 124                                                                  // this VM got in the sharing on the PM
 125     XBT_DEBUG("assign %f to vm %s @ pm %s", solved_value, ws_vm->get_cname(), ws_vm->get_pm()->get_cname());
 126
 127     xbt_assert(cpu->get_model() == surf_cpu_model_vm);
 128     kernel::lmm::System* vcpu_system = cpu->get_model()->get_maxmin_system();
 129     vcpu_system->update_constraint_bound(cpu->get_constraint(), virt_overhead * solved_value);
 130   }
 131
 132   /* 2. Ready. Get the next occurring event */
 133   return surf_cpu_model_vm->next_occuring_event(now);
 134 }
 135
 136 /************
 137  * Resource *
 138  ************/
 139
 140 VirtualMachineImpl::VirtualMachineImpl(simgrid::s4u::VirtualMachine* piface, simgrid::s4u::Host* host_PM,
 141                                        int core_amount, size_t ramsize)
 142     : HostImpl(piface), physical_host_(host_PM), core_amount_(core_amount), user_bound_(std::numeric_limits<double>::max()), ramsize_(ramsize)
 143 {
 144   /* Register this VM to the list of all VMs */
 145   allVms_.push_back(piface);
 146
 147   /* We create cpu_action corresponding to a VM process on the host operating system. */
 148   /* TODO: we have to periodically input GUESTOS_NOISE to the system? how ?
 149    * The value for GUESTOS_NOISE corresponds to the cost of the global action associated to the VM.  It corresponds to
 150    * the cost of a VM running no tasks.
 151    */
 152   action_ = host_PM->pimpl_cpu->execution_start(0, core_amount);
 153
 154   // It's empty for now, so it should not request resources in the PM
 155   update_action_weight();
 156
 157   XBT_VERB("Create VM(%s)@PM(%s)", piface->get_cname(), physical_host_->get_cname());
 158   on_creation(this);
 159 }
 160
 161 /** @brief A physical host does not disappear in the current SimGrid code, but a VM may disappear during a simulation */
 162 VirtualMachineImpl::~VirtualMachineImpl()
 163 {
 164   on_destruction(this);
 165   /* I was already removed from the allVms set if the VM was destroyed cleanly */
 166   auto iter = find(allVms_.begin(), allVms_.end(), piface_);
 167   if (iter != allVms_.end())
 168     allVms_.erase(iter);
 169
 170   /* Free the cpu_action of the VM. */
 171   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 172   xbt_assert(ret, "Bug: some resource still remains");
 173 }
 174
 175 void VirtualMachineImpl::suspend(smx_actor_t issuer)
 176 {
 177   if (get_state() != s4u::VirtualMachine::state::RUNNING)
 178     THROWF(vm_error, 0, "Cannot suspend VM %s: it is not running.", piface_->get_cname());
 179   if (issuer->get_host() == piface_)
 180     THROWF(vm_error, 0, "Actor %s cannot suspend the VM %s in which it runs", issuer->get_cname(),
 181            piface_->get_cname());
 182
 183   XBT_DEBUG("suspend VM(%s), where %zu processes exist", piface_->get_cname(), process_list_.size());
 184
 185   action_->suspend();
 186
 187   for (auto& smx_process : process_list_) {
 188     XBT_DEBUG("suspend %s", smx_process.get_cname());
 189     smx_process.suspend(issuer);
 190   }
 191
 192   XBT_DEBUG("suspend all processes on the VM done done");
 193
 194   vm_state_ = s4u::VirtualMachine::state::SUSPENDED;
 195 }
 196
 197 void VirtualMachineImpl::resume()
 198 {
 199   if (get_state() != s4u::VirtualMachine::state::SUSPENDED)
 200     THROWF(vm_error, 0, "Cannot resume VM %s: it was not suspended", piface_->get_cname());
 201
 202   XBT_DEBUG("Resume VM %s, containing %zu processes.", piface_->get_cname(), process_list_.size());
 203
 204   action_->resume();
 205
 206   for (auto& smx_process : process_list_) {
 207     XBT_DEBUG("resume %s", smx_process.get_cname());
 208     smx_process.resume();
 209   }
 210
 211   vm_state_ = s4u::VirtualMachine::state::RUNNING;
 212 }
 213
 214 /** @brief Power off a VM.
 215  *
 216  * All hosted processes will be killed, but the VM state is preserved on memory.
 217  * It can later be restarted.
 218  *
 219  * @param issuer the actor requesting the shutdown
 220  */
 221 void VirtualMachineImpl::shutdown(smx_actor_t issuer)
 222 {
 223   if (get_state() != s4u::VirtualMachine::state::RUNNING) {
 224     const char* stateName = "(unknown state)";
 225     switch (get_state()) {
 226       case s4u::VirtualMachine::state::CREATED:
 227         stateName = "created, but not yet started";
 228         break;
 229       case s4u::VirtualMachine::state::SUSPENDED:
 230         stateName = "suspended";
 231         break;
 232       case s4u::VirtualMachine::state::DESTROYED:
 233         stateName = "destroyed";
 234         break;
 235       default: /* SURF_VM_STATE_RUNNING or unexpected values */
 236         THROW_IMPOSSIBLE;
 237         break;
 238     }
 239     XBT_VERB("Shutting down the VM %s even if it's not running but %s", piface_->get_cname(), stateName);
 240   }
 241
 242   XBT_DEBUG("shutdown VM %s, that contains %zu processes", piface_->get_cname(), process_list_.size());
 243
 244   for (auto& smx_process : process_list_) {
 245     XBT_DEBUG("kill %s@%s on behalf of %s which shutdown that VM.", smx_process.get_cname(),
 246               smx_process.get_host()->get_cname(), issuer->get_cname());
 247     issuer->kill(&smx_process);
 248   }
 249
 250   set_state(s4u::VirtualMachine::state::DESTROYED);
 251
 252   /* FIXME: we may have to do something at the surf layer, e.g., vcpu action */
 253 }
 254
 255 /** @brief Change the physical host on which the given VM is running
 256  *
 257  * This is an instantaneous migration.
 258  */
 259 void VirtualMachineImpl::set_physical_host(s4u::Host* destination)
 260 {
 261   std::string vm_name     = piface_->get_name();
 262   std::string pm_name_src = physical_host_->get_name();
 263   std::string pm_name_dst = destination->get_name();
 264
 265   /* update net_elm with that of the destination physical host */
 266   piface_->pimpl_netpoint = destination->pimpl_netpoint;
 267
 268   physical_host_ = destination;
 269
 270   /* Update vcpu's action for the new pm */
 271   /* create a cpu action bound to the pm model at the destination. */
 272   surf::CpuAction* new_cpu_action =
 273       static_cast<surf::CpuAction*>(destination->pimpl_cpu->execution_start(0, this->core_amount_));
 274
 275   if (action_->get_remains_no_update() > 0)
 276     XBT_CRITICAL("FIXME: need copy the state(?), %f", action_->get_remains_no_update());
 277
 278   /* keep the bound value of the cpu action of the VM. */
 279   double old_bound = action_->get_bound();
 280   if (old_bound > 0) {
 281     XBT_DEBUG("migrate VM(%s): set bound (%f) at %s", vm_name.c_str(), old_bound, pm_name_dst.c_str());
 282     new_cpu_action->set_bound(old_bound);
 283   }
 284
 285   XBT_ATTRIB_UNUSED bool ret = action_->unref();
 286   xbt_assert(ret, "Bug: some resource still remains");
 287
 288   action_ = new_cpu_action;
 289
 290   XBT_DEBUG("migrate VM(%s): change PM (%s to %s)", vm_name.c_str(), pm_name_src.c_str(), pm_name_dst.c_str());
 291 }
 292
 293 void VirtualMachineImpl::set_bound(double bound)
 294 {
 295   user_bound_ = bound;
 296   update_action_weight();
 297 }
 298
 299 void VirtualMachineImpl::update_action_weight(){
 300   /* The impact of the VM over its PM is the min between its vCPU amount and the amount of tasks it contains */
 301   int impact = std::min(active_tasks_, get_core_amount());
 302
 303   XBT_DEBUG("set the weight of the dummy CPU action of VM%p on PM to %d (#tasks: %d)", this, impact, active_tasks_);
 304
 305   if (impact > 0)
 306     action_->set_priority(1. / impact);
 307   else
 308     action_->set_priority(0.);
 309
 310   action_->set_bound(std::min(impact * physical_host_->get_speed(), user_bound_));
 311 }
 312
 313 }
 314 }