hollow comments

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

diff --git a/src/surf/cpu_interface.hpp b/src/surf/cpu_interface.hpp
index e5c82bd..be93fb8 100644 (file)
--- a/src/surf/cpu_interface.hpp
+++ b/src/surf/cpu_interface.hpp
@@ -61,7 +61,6 @@ XBT_PUBLIC(void) cpu_add_traces();
  */
 XBT_PUBLIC_CLASS CpuModel : public Model {
 public:
-  /** @brief Constructor */
   CpuModel() : Model() {};
 
   /**
@@ -99,9 +98,6 @@ public:
 */
 XBT_PUBLIC_CLASS Cpu : public Resource {
 public:
-  /**
-   * @brief Cpu constructor
-   */
   Cpu();
 
   /**
@@ -116,7 +112,8 @@ public:
    * @param powerScale The power scale of this Cpu
    */
   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 powerPeak, double powerScale,
+    e_surf_resource_state_t stateInitial);
 
   /**
    * @brief Cpu constructor
@@ -128,12 +125,15 @@ public:
    * @param powerPeak The power peak of this Cpu in [TODO]
    * @param powerScale The power scale of this Cpu in [TODO]
    */
+  Cpu(Model *model, const char *name, xbt_dict_t props,
+         int core, double powerPeak, double powerScale,
+    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);
   Cpu(Model *model, const char *name, xbt_dict_t props,
          int core, double powerPeak, double powerScale);
 
-  /**
-   * @brief Cpu destructor
-   */
   ~Cpu();
 
   /**
@@ -152,43 +152,21 @@ public:
    */
   virtual CpuAction *sleep(double duration)=0;
 
-  /**
-   * @brief Get the number of cores of the current Cpu
-   *
-   * @return The number of cores of the current Cpu
-   */
+  /** @brief Get the number of cores of the current Cpu */
   virtual int getCore();
 
-  /**
-   * @brief Get the speed of the current Cpu
-   * @details [TODO] load * m_powerPeak
-   *
-   * @param load [TODO]
-   *
-   * @return The speed of the current Cpu
-   */
+  /** @brief Get the speed of the current Cpu */
   virtual double getSpeed(double load);
 
-  /**
-   * @brief Get the available speed of the current Cpu
-   * @details [TODO]
-   *
-   * @return The available speed of the current Cpu
-   */
+  /** @brief Get the available speed of the current Cpu */
   virtual double getAvailableSpeed();
 
-  /**
-   * @brief Get the current Cpu power peak
-   *
-   * @return The current Cpu power peak
-   */
+  /** @brief Get the current Cpu power peak */
   virtual double getCurrentPowerPeak();
 
-
   virtual double getPowerPeakAt(int pstate_index)=0;
 
   virtual int getNbPstates()=0;
-
   virtual void setPstate(int pstate_index)=0;
   virtual int  getPstate()=0;
 
@@ -197,38 +175,11 @@ public:
   void addTraces(void);
   int m_core;
   double m_powerPeak;            /*< CPU power peak */
-  double m_powerScale;           /*< Percentage of CPU disponible */
+  double m_powerScale;           /*< Percentage of CPU available */
 
   /* Note (hypervisor): */
   lmm_constraint_t *p_constraintCore;
   void **p_constraintCoreId;
-
-  // ////
-  // Adrien - Oct 2015. Additional code related to VM energy extensions
-  /* TODO: 
-     1./ create a VirtualCpuModel that inherits from CpuModel or create
-     a VirtualCpuCas01Model that inherit from CpuCas01Model
-         => Question: not sure which one is really useful :( The objective is to
-     be able to create a VirtualCpu instead of a Cpu (i.e. a CpuCas01 to be exact). 
-     2. create VirtualCpu class that inherits from Cpu or create
-     a VirtualCpuCas01 class that inherits from CpuCas01 (same issue as the one described above).      
-         Such modifications would enable us to remove the isVirtual method and
-     actually use the polymorphism feature of C++. It will also enable us 
-     to overwrite the cpu_energy hashmap in energyCpuCreateCallBack instead of invoking
-     setVirtual(). 
-     So to make a long story short, it will be cleaner from the software viewpoint 
-     and patches welcome ;) - Adrien October 20 2015 
-  */
-  Cpu *physCpu = NULL;
-
-       /** @brief Specify the physical CPU of the current CPU (which is a vCPU) */
-       void setPhysicalCPU(Cpu *physCpu);
-
-       /** @brief Get the physical if the current one is a vCPU, or NULL if it's already a physical CPU */
-       Cpu* getPhysicalCPU(void);
-   
-   // Adrien - Oct 2015. End of additional code related to VM energy extensions
-   // ////
 };
 
 /**********
@@ -242,33 +193,17 @@ public:
 XBT_PUBLIC_CLASS CpuAction : public Action {
 friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
 public:
-  /**
-   * @brief CpuAction constructor
-   *
-   * @param model The CpuModel associated to this CpuAction
-   * @param cost [TODO]
-   * @param failed [TODO]
-   */
+  /** @brief CpuAction constructor */
   CpuAction(Model *model, double cost, bool failed)
     : Action(model, cost, failed) {} //FIXME:REMOVE
 
-  /**
-   * @brief CpuAction constructor
-   *
-   * @param model The CpuModel associated to this CpuAction
-   * @param cost [TODO]
-   * @param failed [TODO]
-   * @param var The lmm variable associated to this CpuAction if it is part of a LMM component
-   */
+  /** @brief CpuAction constructor */
   CpuAction(Model *model, double cost, bool failed, lmm_variable_t var)
     : Action(model, cost, failed, var) {}
 
   /**
    * @brief Set the affinity of the current CpuAction
    * @details [TODO]
-   *
-   * @param cpu [TODO]
-   * @param mask [TODO]
    */
   virtual void setAffinity(Cpu *cpu, unsigned long mask);