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   void turn_off() override;
  82
  83   bool is_used() const override { return true; }
  84
  85   void seal() override;
  86
  87   /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
  88    *
  89    * The provided load should encompasses both the application's activities and the external load that come from a
  90    * trace.
  91    *
  92    * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
  93    * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
  94    *
  95    * If you want to know the amount of flops currently delivered, use  load = get_load()*get_speed_ratio()
  96    */
  97   virtual double get_speed(double load) const { return load * speed_.peak; }
  98
  99   /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
 100   virtual double get_speed_ratio() { return speed_.scale; }
 101
 102   /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
 103   virtual double get_pstate_peak_speed(unsigned long pstate_index) const;
 104
 105   virtual unsigned long get_pstate_count() const { return speed_per_pstate_.size(); }
 106
 107   virtual unsigned long get_pstate() const { return pstate_; }
 108   virtual CpuImpl* set_pstate(unsigned long pstate_index);
 109
 110   /*< @brief Setup the profile file with availability events (peak speed changes due to external load).
 111    * Profile must contain relative values (ratio between 0 and 1)
 112    */
 113   virtual CpuImpl* set_speed_profile(profile::Profile* profile);
 114
 115   /**
 116    * @brief Set the CPU's speed
 117    *
 118    * @param speed_per_state list of powers for this processor (default power is at index 0)
 119    */
 120   CpuImpl* set_pstate_speed(const std::vector<double>& speed_per_state);
 121
 122   void set_sharing_policy(s4u::Host::SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
 123   s4u::Host::SharingPolicy get_sharing_policy() const { return sharing_policy_; }
 124
 125   /**
 126    * @brief Sets factor callback
 127    * Implemented only for cas01
 128    */
 129   virtual void set_factor_cb(const std::function<s4u::Host::CpuFactorCb>& cb) { THROW_UNIMPLEMENTED; }
 130
 131   /**
 132    * @brief Execute some quantity of computation
 133    *
 134    * @param size The value of the processing amount (in flop) needed to process
 135    * @param user_bound User's bound for execution speed
 136    * @return The CpuAction corresponding to the processing
 137    */
 138   virtual CpuAction* execution_start(double size, double user_bound) = 0;
 139
 140   /**
 141    * @brief Execute some quantity of computation on more than one core
 142    *
 143    * @param size The value of the processing amount (in flop) needed to process
 144    * @param requested_cores The desired amount of cores. Must be >= 1
 145    * @param user_bound User's bound for execution speed
 146    * @return The CpuAction corresponding to the processing
 147    */
 148   virtual CpuAction* execution_start(double size, int requested_cores, double user_bound) = 0;
 149
 150   /**
 151    * @brief Make a process sleep for duration (in seconds)
 152    *
 153    * @param duration The number of seconds to sleep
 154    * @return The CpuAction corresponding to the sleeping
 155    */
 156   virtual CpuAction* sleep(double duration) = 0;
 157
 158 protected:
 159   /** @brief Take speed changes (either load or max) into account */
 160   virtual void on_speed_change();
 161
 162   /** Reset most characteristics of this CPU to the one of that CPU.
 163    *
 164    * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
 165    *case.
 166    **/
 167   virtual void reset_vcpu(CpuImpl* that);
 168
 169   Metric speed_ = {1.0, 0, nullptr};
 170 };
 171
 172 /**********
 173  * Action *
 174  **********/
 175
 176 /** @ingroup Model_cpu_interface
 177  * @brief A CpuAction represents the execution of code on one or several Cpus
 178  */
 179 class XBT_PUBLIC CpuAction : public Action {
 180 public:
 181   using Action::Action;
 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 } // namespace simgrid::kernel::resource
 189
 190 #endif /* CPU_IMPL_HPP_ */