Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
unspecialize the trace setup for CPUs
[simgrid.git] / src / surf / cpu_interface.hpp
index 6ac0ad9..27bcee0 100644 (file)
 /***********
  * Classes *
  ***********/
+
+namespace simgrid {
+namespace surf {
+
 class CpuModel;
 class Cpu;
 class CpuAction;
@@ -23,34 +27,6 @@ class CpuPlugin;
  *************/
 XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu creation *
- * @details Callback functions have the following signature: `void(CpuPtr)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, Cpu*)) cpuCreatedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu destruction *
- * @details Callback functions have the following signature: `void(CpuPtr)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, Cpu*)) cpuDestructedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Cpu State changed *
- * @details Callback functions have the following signature: `void(CpuAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, Cpu*, e_surf_resource_state_t, e_surf_resource_state_t)) cpuStateChangedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @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 old, e_surf_action_state_t current)`
- */
-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();
-
 /*********
  * Model *
  *********/
@@ -61,28 +37,25 @@ 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 host The host that will have 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 initiallyOn [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,
-                          e_surf_resource_state_t state_initial,
-                          tmgr_trace_t state_trace,
-                          xbt_dict_t cpu_properties)=0;
+  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;
 
   void updateActionsStateLazy(double now, double delta);
   void updateActionsStateFull(double now, double delta);
@@ -97,43 +70,44 @@ 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();
-
   /**
    * @brief Cpu constructor
    *
    * @param model The CpuModel associated to this Cpu
-   * @param name The name of the Cpu
-   * @param props Dictionary of properties 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 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 initiallyOn 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, simgrid::s4u::Host *host,
+    lmm_constraint_t constraint,
+         xbt_dynar_t speedPeakList, int pstate,
+         int core, double speedPeak, double speedScale,
+         int initiallyOn);
 
   /**
    * @brief Cpu constructor
    *
    * @param model The CpuModel associated to this Cpu
-   * @param name The name of the Cpu
-   * @param props Dictionary of properties associated to this Cpu
+   * @param host The host in which this Cpu should be plugged
+   * @param speedPeakList [TODO]
+   * @param pstate
    * @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 initiallyOn 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, simgrid::s4u::Host *host,
+      xbt_dynar_t speedPeakList, int pstate,
+         int core, double speedPeak, double speedScale,
+         int initiallyOn);
 
-  /**
-   * @brief Cpu destructor
-   */
   ~Cpu();
 
   /**
@@ -142,7 +116,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 *execution_start(double size)=0;
 
   /**
    * @brief Make a process sleep for duration (in seconds)
@@ -150,93 +124,52 @@ 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
-   */
+protected:
+  /** @brief Take speed changes (either load or max) into account */
+  virtual void onSpeedChange();
+
+public:
+  /** @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);
 
-  virtual double getPowerPeakAt(int pstate_index)=0;
-
-  virtual int getNbPstates()=0;
+  virtual int getNbPStates();
+  virtual void setPState(int pstate_index);
+  virtual int  getPState();
 
-  virtual void setPstate(int pstate_index)=0;
-  virtual int  getPstate()=0;
+  simgrid::s4u::Host* getHost() { return m_host; }
 
-  void setState(e_surf_resource_state_t state);
+public:
+  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] */
+  simgrid::s4u::Host* m_host;
 
-  void addTraces(void);
-  int m_core;
-  double m_powerPeak;            /*< CPU power peak */
-  double m_powerScale;           /*< Percentage of CPU disponible */
+  xbt_dynar_t p_speedPeakList = NULL; /*< List of supported CPU capacities (pstate related) */
+  int m_pstate = 0;                   /*< Current pstate (index in the speedPeakList)*/
 
   /* 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 inherist from CpuCas01Model
-         => Question: not sure which one is really usefull :( 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 Set the current Cpu as virtual or physical
-        *
-        * @param isVirtual true to indicate this Cpu is virtual, false otherwise
-        */
-       void setVirtual(Cpu *physCpu);
-
-       /**
-        * @brief Learn if this Cpu is physical or virtual
-        *
-        * @return phys CPU  if the current Cpu is a VM, null otherwise
-        */
-       Cpu* isVirtual(void);
-   
-   // Adrien - Oct 2015. End of additional code related to VM energy extensions
-   // ////
+  lmm_constraint_t *p_constraintCore=NULL;
+  void **p_constraintCoreId=NULL;
+
+public:
+  void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF) */
+  void set_speed_trace(tmgr_trace_t trace); /*< setup the trace file with availability events (peak speed changes due to external load) */
+protected:
+  tmgr_trace_iterator_t p_stateEvent = nullptr;
+  tmgr_trace_iterator_t p_speedEvent = nullptr;
 };
 
 /**********
@@ -247,36 +180,25 @@ 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)
-    : Action(model, cost, failed) {} //FIXME:REMOVE
+/** @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 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)
+    : Action(model, cost, failed) {} //FIXME:DEADCODE?
+
+  /** @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);
 
@@ -286,4 +208,7 @@ public:
 
 };
 
+}
+}
+
 #endif /* SURF_CPU_INTERFACE_HPP_ */