src/plugins/vm/dirty_page_tracking.cpp

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