src/kernel/resource/CpuImpl.hpp

   1 /* Copyright (c) 2004-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 #ifndef CPU_IMPL_HPP_
   7 #define CPU_IMPL_HPP_
   8
   9 #include "simgrid/kernel/resource/Model.hpp"
  10 #include "simgrid/s4u/Host.hpp"
  11 #include "src/kernel/lmm/maxmin.hpp"
  12 #include "src/kernel/resource/Resource.hpp"
  13
  14 #include <list>
  15
  16 namespace simgrid::kernel::resource {
  17
  18 /***********
  19  * Classes *
  20  ***********/
  21
  22 class CpuAction;
  23
  24 /*********
  25  * Model *
  26  *********/
  27 class XBT_PUBLIC CpuModel : public Model {
  28 public:
  29   using Model::Model;
  30
  31   /**
  32    * @brief Create a Cpu
  33    *
  34    * @param host The host that will have this CPU
  35    * @param speed_per_pstate Processor speed (in Flops) of each pstate.
  36    *                         This ignores any potential external load coming from a trace.
  37    * @param core The number of core of this Cpu
  38    */
  39   virtual CpuImpl* create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate) = 0;
  40
  41   void update_actions_state_lazy(double now, double delta) override;
  42   void update_actions_state_full(double now, double delta) override;
  43 };
  44
  45 /************
  46  * Resource *
  47  ************/
  48
  49 class XBT_PUBLIC CpuImpl : public Resource_T<CpuImpl> {
  50   friend VirtualMachineImpl; // Resets the VCPU
  51
  52   s4u::Host* piface_;
  53   int core_count_       = 1;
  54   unsigned long pstate_ = 0;             /*< Current pstate (index in the speed_per_pstate_)*/
  55   std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related). Not 'const' because VCPU
  56                                             get modified on migration */
  57   s4u::Host::SharingPolicy sharing_policy_ = s4u::Host::SharingPolicy::LINEAR;
  58   s4u::NonLinearResourceCb sharing_policy_cb_;
  59
  60   void apply_sharing_policy_cfg() const;
  61
  62 public:
  63   /**
  64    * @brief Cpu constructor
  65    *
  66    * @param host The host in which this Cpu should be plugged
  67    * @param speed_per_pstate Processor speed (in flop per second) for each pstate
  68    */
  69   CpuImpl(s4u::Host* host, const std::vector<double>& speed_per_pstate);
  70
  71   CpuImpl(const CpuImpl&) = delete;
  72   CpuImpl& operator=(const CpuImpl&) = delete;
  73
  74   /** @brief Public interface */
  75   s4u::Host* get_iface() const { return piface_; }
  76
  77   CpuImpl* set_core_count(int core_count);
  78   virtual int get_core_count() const { return core_count_; }
  79
  80   void seal() override;
  81
  82   /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
  83    *
  84    * The provided load should encompasses both the application's activities and the external load that come from a
  85    * trace.
  86    *
  87    * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
  88    * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
  89    *
  90    * If you want to know the amount of flops currently delivered, use  load = get_load()*get_speed_ratio()
  91    */
  92   virtual double get_speed(double load) const { return load * speed_.peak; }
  93
  94   /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
  95   virtual double get_speed_ratio() { return speed_.scale; }
  96
  97   /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
  98   virtual double get_pstate_peak_speed(unsigned long pstate_index) const;
  99
 100   virtual unsigned long get_pstate_count() const { return speed_per_pstate_.size(); }
 101
 102   virtual unsigned long get_pstate() const { return pstate_; }
 103   virtual CpuImpl* set_pstate(unsigned long pstate_index);
 104
 105   /*< @brief Setup the profile file with availability events (peak speed changes due to external load).
 106    * Profile must contain relative values (ratio between 0 and 1)
 107    */
 108   virtual CpuImpl* set_speed_profile(profile::Profile* profile);
 109
 110   /**
 111    * @brief Set the CPU's speed
 112    *
 113    * @param speed_per_state list of powers for this processor (default power is at index 0)
 114    */
 115   CpuImpl* set_pstate_speed(const std::vector<double>& speed_per_state);
 116
 117   void set_sharing_policy(s4u::Host::SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
 118   s4u::Host::SharingPolicy get_sharing_policy() const { return sharing_policy_; }
 119
 120   /**
 121    * @brief Sets factor callback
 122    * Implemented only for cas01
 123    */
 124   virtual void set_factor_cb(const std::function<s4u::Host::CpuFactorCb>& cb) { THROW_UNIMPLEMENTED; }
 125
 126   /**
 127    * @brief Execute some quantity of computation
 128    *
 129    * @param size The value of the processing amount (in flop) needed to process
 130    * @param user_bound User's bound for execution speed
 131    * @return The CpuAction corresponding to the processing
 132    */
 133   virtual CpuAction* execution_start(double size, double user_bound) = 0;
 134
 135   /**
 136    * @brief Execute some quantity of computation on more than one core
 137    *
 138    * @param size The value of the processing amount (in flop) needed to process
 139    * @param requested_cores The desired amount of cores. Must be >= 1
 140    * @param user_bound User's bound for execution speed
 141    * @return The CpuAction corresponding to the processing
 142    */
 143   virtual CpuAction* execution_start(double size, int requested_cores, double user_bound) = 0;
 144
 145   /**
 146    * @brief Make a process sleep for duration (in seconds)
 147    *
 148    * @param duration The number of seconds to sleep
 149    * @return The CpuAction corresponding to the sleeping
 150    */
 151   virtual CpuAction* sleep(double duration) = 0;
 152
 153 protected:
 154   /** @brief Take speed changes (either load or max) into account */
 155   virtual void on_speed_change();
 156
 157   /** Reset most characteristics of this CPU to the one of that CPU.
 158    *
 159    * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
 160    *case.
 161    **/
 162   virtual void reset_vcpu(CpuImpl* that);
 163
 164   Metric speed_ = {1.0, 0, nullptr};
 165 };
 166
 167 /**********
 168  * Action *
 169  **********/
 170
 171 /** @ingroup SURF_cpu_interface
 172  * @brief A CpuAction represents the execution of code on one or several Cpus
 173  */
 174 class XBT_PUBLIC CpuAction : public Action {
 175 public:
 176   using Action::Action;
 177
 178   /** @brief Signal emitted when the action state changes (ready/running/done, etc)
 179    *  Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
 180    */
 181   static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
 182
 183   void set_state(Action::State state) override;
 184
 185   void update_remains_lazy(double now) override;
 186   std::list<CpuImpl*> cpus() const;
 187
 188   void suspend() override;
 189   void resume() override;
 190 };
 191 } // namespace simgrid::kernel::resource
 192
 193 #endif /* CPU_IMPL_HPP_ */