Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
clang asks for override here ...
[simgrid.git] / src / surf / cpu_interface.hpp
index 6e8e71a..82763d4 100644 (file)
@@ -20,16 +20,7 @@ namespace surf {
 class CpuModel;
 class Cpu;
 class CpuAction;
-class CpuPlugin;
-
-/*************
- * Callbacks *
- *************/
-XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
-
-/*********
- * Model *
- *********/
+class CpuPlugin;// FIXME:DEADCODE
 
  /** @ingroup SURF_cpu_interface
  * @brief SURF cpu model interface class
@@ -43,19 +34,10 @@ public:
    * @brief Create a Cpu
    *
    * @param host The host that will have this CPU
-   * @param speedPeak The peak spead (max speed in Flops)
-   * @param pstate [TODO]
-   * @param speedScale The speed scale (in [O;1] available speed from peak)
-   * @param speedTrace Trace variations
+   * @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
-   * @param initiallyOn [TODO]
-   * @param state_trace [TODO]
    */
-  virtual Cpu *createCpu(simgrid::s4u::Host *host, xbt_dynar_t speedPeak,
-                          int pstate, double speedScale,
-                          tmgr_trace_t speedTrace, int core,
-                          int initiallyOn,
-                          tmgr_trace_t state_trace)=0;
+  virtual Cpu *createCpu(simgrid::s4u::Host *host, xbt_dynar_t speedPerPstate, int core)=0;
 
   void updateActionsStateLazy(double now, double delta);
   void updateActionsStateFull(double now, double delta);
@@ -78,35 +60,20 @@ public:
    * @param model The CpuModel associated to this Cpu
    * @param host The host in which this Cpu should be plugged
    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
-   * @param speedPeakList [TODO]
-   * @param pstate [TODO]
+   * @param speedPerPstate Processor speed (in flop per second) for each pstate
    * @param core The number of core of this Cpu
-   * @param speedPeak The speed peak of this Cpu in flops (max speed)
-   * @param speedScale The speed scale of this Cpu in [0;1] (available amount)
-   * @param initiallyOn whether it is created running or crashed
    */
-  Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host,
-    lmm_constraint_t constraint,
-    xbt_dynar_t speedPeakList, int pstate,
-    int core, double speedPeak, double speedScale,
-    int initiallyOn);
+  Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint, xbt_dynar_t speedPerPstate, int core);
 
   /**
    * @brief Cpu constructor
    *
    * @param model The CpuModel associated to this Cpu
    * @param host The host in which this Cpu should be plugged
-   * @param speedPeakList [TODO]
-   * @param pstate
+   * @param speedPerPstate Processor speed (in flop per second) for each pstate
    * @param core The number of core of this Cpu
-   * @param speedPeak The speed peak of this Cpu in flops (max speed)
-   * @param speedScale The speed scale of this Cpu in [0;1] (available amount)
-   * @param initiallyOn whether it is created running or crashed
    */
-  Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host,
-      xbt_dynar_t speedPeakList, int pstate,
-    int core, double speedPeak, double speedScale,
-    int initiallyOn);
+  Cpu(simgrid::surf::Model *model, simgrid::s4u::Host *host, xbt_dynar_t speedPerPstate, int core);
 
   ~Cpu();
 
@@ -149,25 +116,25 @@ public:
   virtual void setPState(int pstate_index);
   virtual int  getPState();
 
-  simgrid::s4u::Host* getHost() { return m_host; }
+  simgrid::s4u::Host* getHost() { return host_; }
 
 public:
-  int m_core = 1;                /* Amount of cores */
-  simgrid::s4u::Host* m_host;
+  int coresAmount_ = 1;
+  simgrid::s4u::Host* host_;
 
-  xbt_dynar_t p_speedPeakList = NULL; /*< List of supported CPU capacities (pstate related) */
-  int m_pstate = 0;                   /*< Current pstate (index in the speedPeakList)*/
+  xbt_dynar_t speedPerPstate_ = NULL; /*< List of supported CPU capacities (pstate related) */
+  int pstate_ = 0;                   /*< Current pstate (index in the speedPeakList)*/
 
   /* Note (hypervisor): */
   lmm_constraint_t *p_constraintCore=NULL;
   void **p_constraintCoreId=NULL;
 
 public:
-  virtual void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain boolean values (0 or 1). */
-  virtual void set_speed_trace(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) */
+  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) */
 
-  tmgr_trace_iterator_t p_stateEvent = nullptr;
-  s_surf_metric_t p_speed = {1.0, 0, nullptr};
+  tmgr_trace_iterator_t stateEvent_ = nullptr;
+  s_surf_metric_t speed_ = {1.0, 0, nullptr};
 };
 
 /**********
@@ -175,35 +142,28 @@ public:
  **********/
 
  /** @ingroup SURF_cpu_interface
- * @brief SURF Cpu action interface class
- * @details A CpuAction represent the execution of code on a Cpu
+ * @brief A CpuAction represents the execution of code on one or several Cpus
  */
 XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::Action {
 friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
 public:
-/** @brief Callbacks handler which emit the callbacks after CpuAction State changed *
* @details Callback functions have the following signature: `void(CpuAction *action, e_surf_action_state_t previous)`
- */
-  static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, e_surf_action_state_t)> onStateChange;
+  /** @brief Callbacks handler which emit the callbacks after CpuAction State changed *
  * @details Callback functions have the following signature: `void(CpuAction *action, simgrid::surf::Action::State previous)`
  */
+  static simgrid::xbt::signal<void(simgrid::surf::CpuAction*, simgrid::surf::Action::State)> onStateChange;
 
-  /** @brief CpuAction constructor */
   CpuAction(simgrid::surf::Model *model, double cost, bool failed)
-    : Action(model, cost, failed) {} //FIXME:DEADCODE?
-
-  /** @brief CpuAction constructor */
+  : Action(model, cost, failed) {} //FIXME:DEADCODE?
   CpuAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
-    : Action(model, cost, failed, var) {}
+  : Action(model, cost, failed, var) {}
 
-  /**
-   * @brief Set the affinity of the current CpuAction
-   * @details [TODO]
-   */
+  /** @brief Set the affinity of the current CpuAction */
   virtual void setAffinity(Cpu *cpu, unsigned long mask);
 
-  void setState(e_surf_action_state_t state);
-
-  void updateRemainingLazy(double now);
+  void setState(simgrid::surf::Action::State state) override;
 
+  void updateRemainingLazy(double now) override;
+  std::list<Cpu*> cpus();
 };
 
 }