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 Cpu* create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core) = 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 Cpu : public Resource_T<Cpu> {
  52   friend vm::VirtualMachineImpl; // Resets the VCPU
  53
  54   s4u::Host* piface_;
  55   int core_count_ = 1;
  56   int 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
  60 public:
  61   /**
  62    * @brief Cpu constructor
  63    *
  64    * @param host The host in which this Cpu should be plugged
  65    * @param speed_per_pstate Processor speed (in flop per second) for each pstate
  66    */
  67   Cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate);
  68
  69   Cpu(const Cpu&) = delete;
  70   Cpu& operator=(const Cpu&) = delete;
  71
  72   /** @brief Public interface */
  73   s4u::Host* get_iface() { return piface_; }
  74
  75   Cpu* set_core_count(int core_count);
  76   virtual int get_core_count();
  77
  78   void seal();
  79
  80   /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
  81    *
  82    * The provided load should encompasses both the application's activities and the external load that come from a
  83    * trace.
  84    *
  85    * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
  86    * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
  87    *
  88    * If you want to know the amount of flops currently delivered, use  load = get_load()*get_speed_ratio()
  89    */
  90   virtual double get_speed(double load) const { return load * speed_.peak; }
  91
  92   /** @brief Get the available speed ratio, in [0:1]. This accounts for external load (see @ref set_speed_profile()). */
  93   virtual double get_speed_ratio() { return speed_.scale; }
  94
  95   /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
  96   virtual double get_pstate_peak_speed(int pstate_index) const;
  97
  98   virtual int get_pstate_count() const { return speed_per_pstate_.size(); }
  99
 100   virtual void set_pstate(int pstate_index);
 101   virtual int get_pstate() const { return pstate_; }
 102
 103   /*< @brief Setup the trace file with availability events (peak speed changes due to external load).
 104    * Trace must contain relative values (ratio between 0 and 1)
 105    */
 106   virtual void set_speed_profile(profile::Profile* profile);
 107
 108   /**
 109    * @brief Execute some quantity of computation
 110    *
 111    * @param size The value of the processing amount (in flop) needed to process
 112    * @return The CpuAction corresponding to the processing
 113    */
 114   virtual CpuAction* execution_start(double size) = 0;
 115
 116   /**
 117    * @brief Execute some quantity of computation on more than one core
 118    *
 119    * @param size The value of the processing amount (in flop) needed to process
 120    * @param requested_cores The desired amount of cores. Must be >= 1
 121    * @return The CpuAction corresponding to the processing
 122    */
 123   virtual CpuAction* execution_start(double size, int requested_cores) = 0;
 124
 125   /**
 126    * @brief Make a process sleep for duration (in seconds)
 127    *
 128    * @param duration The number of seconds to sleep
 129    * @return The CpuAction corresponding to the sleeping
 130    */
 131   virtual CpuAction* sleep(double duration) = 0;
 132
 133 protected:
 134   /** @brief Take speed changes (either load or max) into account */
 135   virtual void on_speed_change();
 136
 137   /** Reset most characteristics of this CPU to the one of that CPU.
 138    *
 139    * Used to reset a VCPU when its VM migrates to another host, so it only resets the fields that should be in this
 140    *case.
 141    **/
 142   virtual void reset_vcpu(Cpu* that);
 143
 144   Metric speed_                  = {1.0, 0, nullptr};
 145 };
 146
 147 /**********
 148  * Action *
 149  **********/
 150
 151  /** @ingroup SURF_cpu_interface
 152  * @brief A CpuAction represents the execution of code on one or several Cpus
 153  */
 154 class XBT_PUBLIC CpuAction : public Action {
 155 public:
 156   /** @brief Signal emitted when the action state changes (ready/running/done, etc)
 157    *  Signature: `void(CpuAction const& action, simgrid::kernel::resource::Action::State previous)`
 158    */
 159   static xbt::signal<void(CpuAction const&, Action::State)> on_state_change;
 160
 161   using Action::Action;
 162
 163   void set_state(Action::State state) override;
 164
 165   void update_remains_lazy(double now) override;
 166   std::list<Cpu*> cpus() const;
 167
 168   void suspend() override;
 169   void resume() override;
 170 };
 171 } // namespace resource
 172 } // namespace kernel
 173 } // namespace simgrid
 174
 175 #endif /* SURF_CPU_INTERFACE_HPP_ */