src/surf/cpu_interface.hpp

   1 /* Copyright (c) 2004-2019. 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 #include "src/kernel/resource/profile/trace_mgr.hpp"
  14
  15 #include <list>
  16
  17 /***********
  18  * Classes *
  19  ***********/
  20
  21 namespace simgrid {
  22 namespace surf {
  23
  24  /** @ingroup SURF_cpu_interface
  25  * @brief SURF cpu model interface class
  26  * @details A model is an object which handle the interactions between its Resources and its Actions
  27  */
  28 class XBT_PUBLIC CpuModel : public kernel::resource::Model {
  29 public:
  30   explicit CpuModel(kernel::resource::Model::UpdateAlgo algo) : Model(algo) {}
  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 Cpu* create_cpu(simgrid::s4u::Host* host, std::vector<double>* speed_per_pstate, int core) = 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 /** @ingroup SURF_cpu_interface
  51 * @brief SURF cpu resource interface class
  52 * @details A Cpu represent a cpu associated to a host
  53 */
  54 class XBT_PUBLIC Cpu : public simgrid::kernel::resource::Resource {
  55 public:
  56   /**
  57    * @brief Cpu constructor
  58    *
  59    * @param model The CpuModel associated to this Cpu
  60    * @param host The host in which this Cpu should be plugged
  61    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
  62    * @param speedPerPstate Processor speed (in flop per second) for each pstate
  63    * @param core The number of core of this Cpu
  64    */
  65   Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, kernel::lmm::Constraint * constraint,
  66       std::vector<double> * speedPerPstate, int core);
  67
  68   /**
  69    * @brief Cpu constructor
  70    *
  71    * @param model The CpuModel associated to this Cpu
  72    * @param host The host in which this Cpu should be plugged
  73    * @param speedPerPstate Processor speed (in flop per second) for each pstate
  74    * @param core The number of core of this Cpu
  75    */
  76   Cpu(simgrid::kernel::resource::Model * model, simgrid::s4u::Host * host, std::vector<double> * speedPerPstate,
  77       int core);
  78
  79   Cpu(const Cpu&) = delete;
  80   Cpu& operator=(const Cpu&) = delete;
  81   ~Cpu();
  82
  83   /**
  84    * @brief Execute some quantity of computation
  85    *
  86    * @param size The value of the processing amount (in flop) needed to process
  87    * @return The CpuAction corresponding to the processing
  88    */
  89   virtual simgrid::kernel::resource::Action* execution_start(double size) = 0;
  90
  91   /**
  92    * @brief Execute some quantity of computation on more than one core
  93    *
  94    * @param size The value of the processing amount (in flop) needed to process
  95    * @param requested_cores The desired amount of cores. Must be >= 1
  96    * @return The CpuAction corresponding to the processing
  97    */
  98   virtual simgrid::kernel::resource::Action* execution_start(double size, int requested_cores) = 0;
  99
 100   /**
 101    * @brief Make a process sleep for duration (in seconds)
 102    *
 103    * @param duration The number of seconds to sleep
 104    * @return The CpuAction corresponding to the sleeping
 105    */
 106   virtual simgrid::kernel::resource::Action* sleep(double duration) = 0;
 107
 108   /** @brief Get the amount of cores */
 109   virtual int get_core_count();
 110
 111   /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
 112    *
 113    * The provided load should encompasses both the application's activities and the external load that come from a trace.
 114    *
 115    * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
 116    * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
 117    *
 118    * If you want to know the amount of flops currently delivered, use  load = get_load()*get_speed_ratio()
 119    */
 120   virtual double get_speed(double load);
 121
 122 protected:
 123   /** @brief Take speed changes (either load or max) into account */
 124   virtual void on_speed_change();
 125
 126 public:
 127   /** @brief Get the available speed ratio, between 0 and 1.
 128    *
 129    * This accounts for external load (see @ref set_speed_trace()).
 130    */
 131   virtual double get_speed_ratio();
 132
 133   /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
 134   virtual double get_pstate_peak_speed(int pstate_index);
 135
 136   virtual int get_pstate_count();
 137   virtual void set_pstate(int pstate_index);
 138   virtual int get_pstate();
 139
 140   simgrid::s4u::Host* get_host() { return host_; }
 141
 142 private:
 143   int core_count_ = 1;
 144   simgrid::s4u::Host* host_;
 145
 146   int pstate_ = 0;                       /*< Current pstate (index in the speed_per_pstate_)*/
 147   std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related) */
 148
 149 public:
 150   /*< @brief Setup the trace file with availability events (peak speed changes due to external load).
 151    * Trace must contain relative values (ratio between 0 and 1)
 152    */
 153   virtual void set_speed_profile(kernel::profile::Profile* profile);
 154
 155 protected:
 156   Metric speed_                  = {1.0, 0, nullptr};
 157 };
 158
 159 /**********
 160  * Action *
 161  **********/
 162
 163  /** @ingroup SURF_cpu_interface
 164  * @brief A CpuAction represents the execution of code on one or several Cpus
 165  */
 166 class XBT_PUBLIC CpuAction : public simgrid::kernel::resource::Action {
 167 public:
 168   /** @brief Signal emitted when the action state changes (ready/running/done, etc)
 169    *  Signature: `void(CpuAction *action, simgrid::kernel::resource::Action::State previous)`
 170    */
 171   static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, simgrid::kernel::resource::Action::State)> on_state_change;
 172
 173   CpuAction(simgrid::kernel::resource::Model * model, double cost, bool failed) : Action(model, cost, failed) {}
 174   CpuAction(simgrid::kernel::resource::Model * model, double cost, bool failed, kernel::lmm::Variable* var)
 175       : Action(model, cost, failed, var)
 176   {
 177   }
 178
 179   void set_state(simgrid::kernel::resource::Action::State state) override;
 180
 181   void update_remains_lazy(double now) override;
 182   std::list<Cpu*> cpus() const;
 183
 184   void suspend() override;
 185   void resume() override;
 186 };
 187
 188 }
 189 }
 190
 191 #endif /* SURF_CPU_INTERFACE_HPP_ */