src/surf/cpu_interface.hpp

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