X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/22a45a8d97ef0f1211ee05f9c16d7d90b37cf33b..1c7dbc7e7255bc670c53414593e9fbdf5b366c1d:/src/surf/cpu_interface.hpp

diff --git a/src/surf/cpu_interface.hpp b/src/surf/cpu_interface.hpp
index 72a99af01e..2b0b3ec36e 100644
--- a/src/surf/cpu_interface.hpp
+++ b/src/surf/cpu_interface.hpp
@@ -10,6 +10,7 @@
 #include "simgrid/kernel/resource/Resource.hpp"
 #include "simgrid/s4u/Host.hpp"
 #include "src/kernel/lmm/maxmin.hpp"
+#include "src/surf/trace_mgr.hpp"
 
 #include <list>
 
@@ -26,8 +27,7 @@ namespace surf {
  */
 class XBT_PUBLIC CpuModel : public kernel::resource::Model {
 public:
-  CpuModel(kernel::resource::Model::UpdateAlgo algo) : Model(algo) {}
-  CpuModel() : Model() {}
+  explicit CpuModel(kernel::resource::Model::UpdateAlgo algo) : Model(algo) {}
 
   /**
    * @brief Create a Cpu
@@ -36,7 +36,7 @@ public:
    * @param speedPerPstate Processor speed (in Flops) of each pstate. This ignores any potential external load coming from a trace.
    * @param core The number of core of this Cpu
    */
-  virtual Cpu *createCpu(simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)=0;
+  virtual Cpu* create_cpu(simgrid::s4u::Host* host, std::vector<double>* speedPerPstate, int core) = 0;
 
   void update_actions_state_lazy(double now, double delta) override;
   void update_actions_state_full(double now, double delta) override;
@@ -103,38 +103,58 @@ public:
   virtual simgrid::kernel::resource::Action* sleep(double duration) = 0;
 
   /** @brief Get the amount of cores */
-  virtual int coreCount();
+  virtual int get_cores_count();
 
-  /** @brief Get the speed, accounting for the trace load and provided process load instead of the real current one */
-  virtual double getSpeed(double load);
+  /** @brief Get a forecast of the speed (in flops/s) if the load were as provided.
+   *
+   * The provided load should encompasses both the application's activities and the external load that come from a trace.
+   *
+   * Use a load of 1.0 to compute the amount of flops that the Cpu would deliver with one CPU-bound task.
+   * If you use a load of 0, this function will return 0: when nobody is using the Cpu, it delivers nothing.
+   *
+   * If you want to know the amount of flops currently delivered, use  load = get_load()*get_speed_ratio()
+   */
+  virtual double get_speed(double load);
 
 protected:
   /** @brief Take speed changes (either load or max) into account */
-  virtual void onSpeedChange();
+  virtual void on_speed_change();
 
 public:
-  /** @brief Get the available speed of the current Cpu */
-  virtual double getAvailableSpeed();
+  /** @brief Get the available speed ratio, between 0 and 1.
+   *
+   * This accounts for external load (see @ref set_speed_trace()).
+   */
+  virtual double get_speed_ratio();
 
-  /** @brief Get the current Cpu computational speed */
-  virtual double getPstateSpeed(int pstate_index);
+  /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
+  virtual double get_pstate_peak_speed(int pstate_index);
 
-  virtual int getNbPStates();
-  virtual void setPState(int pstate_index);
-  virtual int  getPState();
+  virtual int get_pstates_count();
+  virtual void set_pstate(int pstate_index);
+  virtual int get_pstate();
 
-  simgrid::s4u::Host* getHost() { return host_; }
+  simgrid::s4u::Host* get_host() { return host_; }
 
-  int coresAmount_ = 1;
+private:
+  int cores_count_ = 1;
   simgrid::s4u::Host* host_;
 
-  std::vector<double> speedPerPstate_; /*< List of supported CPU capacities (pstate related) */
-  int pstate_ = 0;                     /*< Current pstate (index in the speedPeakList)*/
+  int pstate_ = 0;                       /*< Current pstate (index in the speed_per_pstate_)*/
+  std::vector<double> speed_per_pstate_; /*< List of supported CPU capacities (pstate related) */
 
-  virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain boolean values (0 or 1). */
-  virtual void setSpeedTrace(tmgr_trace_t trace); /*< setup the trace file with availability events (peak speed changes due to external load). Trace must contain relative values (ratio between 0 and 1) */
+public:
+  /** @brief Setup the trace file with states events (ON or OFF).
+   * Trace must contain boolean values (0 or 1).
+   */
+  virtual void set_state_trace(tmgr_trace_t trace);
+  /*< @brief Setup the trace file with availability events (peak speed changes due to external load).
+   * Trace must contain relative values (ratio between 0 and 1)
+   */
+  virtual void set_speed_trace(tmgr_trace_t trace);
 
-  tmgr_trace_event_t stateEvent_ = nullptr;
+protected:
+  tmgr_trace_event_t state_event_ = nullptr;
   Metric speed_                  = {1.0, 0, nullptr};
 };
 
@@ -146,8 +166,6 @@ public:
  * @brief A CpuAction represents the execution of code on one or several Cpus
  */
 class XBT_PUBLIC CpuAction : public simgrid::kernel::resource::Action {
-  friend XBT_PUBLIC Cpu* getActionCpu(CpuAction * action);
-
 public:
   /** @brief Signal emitted when the action state changes (ready/running/done, etc)
    *  Signature: `void(CpuAction *action, simgrid::kernel::resource::Action::State previous)`
@@ -168,7 +186,7 @@ public:
 
   void update_remains_lazy(double now) override;
   std::list<Cpu*> cpus();
-  
+
   void suspend() override;
   void resume() override;
 };