Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
initialize fields at declaration, not everywhere in code
[simgrid.git] / src / surf / cpu_interface.hpp
index 595ff81..c74e737 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2014. The SimGrid Team.
+/* Copyright (c) 2004-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 /***********
  * Classes *
  ***********/
+
+namespace simgrid {
+namespace surf {
+
 class CpuModel;
 class Cpu;
 class CpuAction;
@@ -47,8 +51,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();
 
 /*********
@@ -61,25 +63,24 @@ XBT_PUBLIC(void) cpu_add_traces();
  */
 XBT_PUBLIC_CLASS CpuModel : public Model {
 public:
-  /** @brief Constructor */
   CpuModel() : Model() {};
 
   /**
    * @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;
@@ -97,11 +98,8 @@ public:
 * @brief SURF cpu resource interface class
 * @details A Cpu represent a cpu associated to a host
 */
-XBT_PUBLIC_CLASS Cpu : public Resource {
+XBT_PUBLIC_CLASS Cpu : public simgrid::surf::Resource {
 public:
-  /**
-   * @brief Cpu constructor
-   */
   Cpu();
 
   /**
@@ -112,11 +110,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);
+  Cpu(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+         lmm_constraint_t constraint, int core, double speedPeak, double speedScale,
+         e_surf_resource_state_t stateInitial);
 
   /**
    * @brief Cpu constructor
@@ -125,15 +125,19 @@ 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);
+  Cpu(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+         int core, double speedPeak, double speedScale,
+         e_surf_resource_state_t stateInitial);
+
+  Cpu(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+         lmm_constraint_t constraint, int core, double speedPeak, double speedScale);
+  Cpu(simgrid::surf::Model *model, const char *name, xbt_dict_t props,
+         int core, double speedPeak, double speedScale);
 
-  /**
-   * @brief Cpu destructor
-   */
   ~Cpu();
 
   /**
@@ -142,7 +146,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 simgrid::surf::Action *execute(double size)=0;
 
   /**
    * @brief Make a process sleep for duration (in seconds)
@@ -150,58 +154,36 @@ public:
    * @param duration The number of seconds to sleep
    * @return The CpuAction corresponding to the sleeping
    */
-  virtual CpuAction *sleep(double duration)=0;
+  virtual simgrid::surf::Action *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 amount of cores */
   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, 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
-   * @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;
 
   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 disponible */
+  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;
-  void **p_constraintCoreId;
+  lmm_constraint_t *p_constraintCore=NULL;
+  void **p_constraintCoreId=NULL;
 };
 
 /**********
@@ -212,36 +194,20 @@ public:
  * @brief SURF Cpu action interface class
  * @details A CpuAction represent the execution of code on a Cpu
  */
-XBT_PUBLIC_CLASS CpuAction : public Action {
+XBT_PUBLIC_CLASS CpuAction : public simgrid::surf::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]
-   */
-  CpuAction(Model *model, double cost, bool failed)
+  /** @brief CpuAction constructor */
+  CpuAction(simgrid::surf::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
-   */
-  CpuAction(Model *model, double cost, bool failed, lmm_variable_t var)
+  /** @brief CpuAction constructor */
+  CpuAction(simgrid::surf::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);
 
@@ -251,4 +217,7 @@ public:
 
 };
 
+}
+}
+
 #endif /* SURF_CPU_INTERFACE_HPP_ */