src/kernel/resource/CpuImpl.hpp

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