some documentation fixes

[simgrid.git] / src / surf / cpu_interface.hpp

diff --git a/src/surf/cpu_interface.hpp b/src/surf/cpu_interface.hpp
index be93fb8..4e9e97f 100644 (file)
--- a/src/surf/cpu_interface.hpp
+++ b/src/surf/cpu_interface.hpp
@@ -47,8 +47,6 @@ XBT_PUBLIC_DATA( surf_callback(void, Cpu*, e_surf_resource_state_t, e_surf_resou
  */
 XBT_PUBLIC_DATA( surf_callback(void, CpuAction*, e_surf_action_state_t, e_surf_action_state_t)) cpuActionStateChangedCallbacks;
 
-XBT_PUBLIC(void) cpu_parse_init(sg_platf_host_cbarg_t host);
-
 XBT_PUBLIC(void) cpu_add_traces();
 
 /*********
@@ -67,18 +65,18 @@ public:
    * @brief Create a Cpu
    *
    * @param name The name of the Cpu
-   * @param power_peak The power peak of this Cpu
+   * @param speedPeak The peak spead (max speed in Flops)
    * @param pstate [TODO]
-   * @param power_scale The power scale of this Cpu
-   * @param power_trace [TODO]
+   * @param speedScale The speed scale (in [O;1] available speed from peak)
+   * @param speedTrace Trace variations
    * @param core The number of core of this Cpu
    * @param state_initial [TODO]
    * @param state_trace [TODO]
    * @param cpu_properties Dictionary of properties associated to this Cpu
    */
-  virtual Cpu *createCpu(const char *name, xbt_dynar_t power_peak,
-                      int pstate, double power_scale,
-                          tmgr_trace_t power_trace, int core,
+  virtual Cpu *createCpu(const char *name, xbt_dynar_t speedPeak,
+                      int pstate, double speedScale,
+                          tmgr_trace_t speedTrace, int core,
                           e_surf_resource_state_t state_initial,
                           tmgr_trace_t state_trace,
                           xbt_dict_t cpu_properties)=0;
@@ -108,12 +106,13 @@ public:
    * @param props Dictionary of properties associated to this Cpu
    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
    * @param core The number of core of this Cpu
-   * @param powerPeak The power peak of this Cpu
-   * @param powerScale The power scale 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 stateInitial whether it is created running or crashed
    */
   Cpu(Model *model, const char *name, xbt_dict_t props,
-         lmm_constraint_t constraint, int core, double powerPeak, double powerScale,
-    e_surf_resource_state_t stateInitial);
+         lmm_constraint_t constraint, int core, double speedPeak, double speedScale,
+         e_surf_resource_state_t stateInitial);
 
   /**
    * @brief Cpu constructor
@@ -122,17 +121,18 @@ public:
    * @param name The name of the Cpu
    * @param props Dictionary of properties associated to this Cpu
    * @param core The number of core of this Cpu
-   * @param powerPeak The power peak of this Cpu in [TODO]
-   * @param powerScale The power scale of this Cpu in [TODO]
+   * @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 stateInitial whether it is created running or crashed
    */
   Cpu(Model *model, const char *name, xbt_dict_t props,
-         int core, double powerPeak, double powerScale,
-    e_surf_resource_state_t stateInitial);
+         int core, double speedPeak, double speedScale,
+         e_surf_resource_state_t stateInitial);
 
   Cpu(Model *model, const char *name, xbt_dict_t props,
-         lmm_constraint_t constraint, int core, double powerPeak, double powerScale);
+         lmm_constraint_t constraint, int core, double speedPeak, double speedScale);
   Cpu(Model *model, const char *name, xbt_dict_t props,
-         int core, double powerPeak, double powerScale);
+         int core, double speedPeak, double speedScale);
 
   ~Cpu();
 
@@ -142,7 +142,7 @@ public:
    * @param size The value of the processing amount (in flop) needed to process
    * @return The CpuAction corresponding to the processing
    */
-  virtual CpuAction *execute(double size)=0;
+  virtual Action *execute(double size)=0;
 
   /**
    * @brief Make a process sleep for duration (in seconds)
@@ -150,12 +150,12 @@ public:
    * @param duration The number of seconds to sleep
    * @return The CpuAction corresponding to the sleeping
    */
-  virtual CpuAction *sleep(double duration)=0;
+  virtual Action *sleep(double duration)=0;
 
-  /** @brief Get the number of cores of the current Cpu */
+  /** @brief Get the amount of cores */
   virtual int getCore();
 
-  /** @brief Get the speed of the current Cpu */
+  /** @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 the available speed of the current Cpu */
@@ -173,9 +173,9 @@ public:
   void setState(e_surf_resource_state_t state);
 
   void addTraces(void);
-  int m_core;
-  double m_powerPeak;            /*< CPU power peak */
-  double m_powerScale;           /*< Percentage of CPU available */
+  int m_core = 1;                /* Amount of cores */
+  double m_speedPeak;            /*< CPU speed peak, ie max value */
+  double m_speedScale;           /*< Percentage of CPU available according to the trace, in [O,1] */
 
   /* Note (hypervisor): */
   lmm_constraint_t *p_constraintCore;