src/plugins/vm/dirty_page_tracking.cpp

   1 /* Copyright (c) 2017-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/plugins/live_migration.h>
   7 #include <simgrid/s4u/Exec.hpp>
   8 #include <simgrid/s4u/VirtualMachine.hpp>
   9
  10 #include "src/kernel/activity/ExecImpl.hpp"
  11 #include "src/kernel/resource/VirtualMachineImpl.hpp"
  12
  13 namespace simgrid::plugin::vm {
  14 class DirtyPageTrackingExt {
  15   bool dp_tracking_ = false;
  16   std::map<kernel::activity::ExecImpl const*, double> dp_objs_;
  17   double dp_updated_by_deleted_tasks_ = 0.0;
  18   // Percentage of pages that get dirty compared to netspeed [0;1] bytes per 1 flop execution
  19   double dp_intensity_          = 0.0;
  20   sg_size_t working_set_memory_ = 0.0;
  21   double max_downtime_          = 0.03;
  22   double mig_speed_             = 0.0;
  23
  24 public:
  25   void start_tracking();
  26   void stop_tracking() { dp_tracking_ = false; }
  27   bool is_tracking() const { return dp_tracking_; }
  28   void track(kernel::activity::ExecImpl const* exec, double amount) { dp_objs_.insert({exec, amount}); }
  29   void untrack(kernel::activity::ExecImpl const* exec) { dp_objs_.erase(exec); }
  30   double get_stored_remains(kernel::activity::ExecImpl const* exec) { return dp_objs_.at(exec); }
  31   void update_dirty_page_count(double delta) { dp_updated_by_deleted_tasks_ += delta; }
  32   double computed_flops_lookup();
  33   double get_intensity() const { return dp_intensity_; }
  34   void set_intensity(double intensity) { dp_intensity_ = intensity; }
  35   sg_size_t get_working_set_memory() const { return working_set_memory_; }
  36   void set_working_set_memory(sg_size_t size) { working_set_memory_ = size; }
  37   void set_migration_speed(double speed) { mig_speed_ = speed; }
  38   double get_migration_speed() const { return mig_speed_; }
  39   double get_max_downtime() const { return max_downtime_; }
  40
  41   static simgrid::xbt::Extension<kernel::resource::VirtualMachineImpl, DirtyPageTrackingExt> EXTENSION_ID;
  42   DirtyPageTrackingExt() = default;
  43 };
  44
  45 simgrid::xbt::Extension<kernel::resource::VirtualMachineImpl, DirtyPageTrackingExt> DirtyPageTrackingExt::EXTENSION_ID;
  46
  47 void DirtyPageTrackingExt::start_tracking()
  48 {
  49   dp_tracking_ = true;
  50   for (auto const& [exec, _] : dp_objs_)
  51     dp_objs_[exec] = exec->get_remaining();
  52 }
  53
  54 double DirtyPageTrackingExt::computed_flops_lookup()
  55 {
  56   double total = 0;
  57
  58   for (auto const& [exec, flops] : dp_objs_) {
  59     total += flops - exec->get_remaining();
  60     dp_objs_[exec] = exec->get_remaining();
  61   }
  62   total += dp_updated_by_deleted_tasks_;
  63
  64   dp_updated_by_deleted_tasks_ = 0;
  65
  66   return total;
  67 }
  68 } // namespace simgrid::plugin::vm
  69
  70 using simgrid::plugin::vm::DirtyPageTrackingExt;
  71
  72 static void on_virtual_machine_creation(const simgrid::s4u::VirtualMachine& vm)
  73 {
  74   vm.get_vm_impl()->extension_set<DirtyPageTrackingExt>(new DirtyPageTrackingExt());
  75 }
  76
  77 static void on_exec_creation(simgrid::s4u::Exec const& e)
  78 {
  79   auto exec                              = static_cast<simgrid::kernel::activity::ExecImpl*>(e.get_impl());
  80   const simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(exec->get_host());
  81   if (vm == nullptr)
  82     return;
  83
  84   if (vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->is_tracking()) {
  85     vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->track(exec, exec->get_remaining());
  86   } else {
  87     vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->track(exec, 0.0);
  88   }
  89 }
  90
  91 static void on_exec_completion(const simgrid::s4u::Exec& e)
  92 {
  93   const auto* exec = dynamic_cast<simgrid::kernel::activity::ExecImpl*>(e.get_impl());
  94   if (exec == nullptr)
  95     return;
  96   const simgrid::s4u::VirtualMachine* vm = dynamic_cast<simgrid::s4u::VirtualMachine*>(exec->get_host());
  97   if (vm == nullptr)
  98     return;
  99
 100   /* If we are in the middle of dirty page tracking, we record how much computation has been done until now, and keep
 101    * the information for the lookup_() function that will called soon. */
 102   if (vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->is_tracking()) {
 103     double delta = vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->get_stored_remains(exec);
 104     vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->update_dirty_page_count(delta);
 105   }
 106   vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->untrack(exec);
 107 }
 108
 109 void sg_vm_dirty_page_tracking_init()
 110 {
 111   if (not DirtyPageTrackingExt::EXTENSION_ID.valid()) {
 112     DirtyPageTrackingExt::EXTENSION_ID =
 113         simgrid::kernel::resource::VirtualMachineImpl::extension_create<DirtyPageTrackingExt>();
 114     simgrid::s4u::VirtualMachine::on_creation_cb(&on_virtual_machine_creation);
 115     simgrid::s4u::Exec::on_start_cb(&on_exec_creation);
 116     simgrid::s4u::Exec::on_completion_cb(&on_exec_completion);
 117   }
 118 }
 119
 120 void sg_vm_start_dirty_page_tracking(const_sg_vm_t vm)
 121 {
 122   vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->start_tracking();
 123 }
 124
 125 void sg_vm_stop_dirty_page_tracking(const_sg_vm_t vm)
 126 {
 127   vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->stop_tracking();
 128 }
 129
 130 double sg_vm_lookup_computed_flops(const_sg_vm_t vm)
 131 {
 132   return vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->computed_flops_lookup();
 133 }
 134
 135 void sg_vm_set_dirty_page_intensity(const_sg_vm_t vm, double intensity)
 136 {
 137   vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->set_intensity(intensity);
 138 }
 139
 140 double sg_vm_get_dirty_page_intensity(const_sg_vm_t vm)
 141 {
 142   return vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->get_intensity();
 143 }
 144
 145 void sg_vm_set_working_set_memory(const_sg_vm_t vm, sg_size_t size)
 146 {
 147   vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->set_working_set_memory(size);
 148 }
 149
 150 sg_size_t sg_vm_get_working_set_memory(const_sg_vm_t vm)
 151 {
 152   return vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->get_working_set_memory();
 153 }
 154
 155 void sg_vm_set_migration_speed(const_sg_vm_t vm, double speed)
 156 {
 157   vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->set_migration_speed(speed);
 158 }
 159
 160 double sg_vm_get_migration_speed(const_sg_vm_t vm)
 161 {
 162   return vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->get_migration_speed();
 163 }
 164
 165 double sg_vm_get_max_downtime(const_sg_vm_t vm)
 166 {
 167   return vm->get_vm_impl()->extension<DirtyPageTrackingExt>()->get_max_downtime();
 168 }