src/surf/cpu_interface.hpp

   1 /* Copyright (c) 2004-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "surf_interface.hpp"
   8 #include "maxmin_private.hpp"
   9
  10 #ifndef SURF_CPU_INTERFACE_HPP_
  11 #define SURF_CPU_INTERFACE_HPP_
  12
  13 /***********
  14  * Classes *
  15  ***********/
  16 class CpuModel;
  17 class Cpu;
  18 class CpuAction;
  19 class CpuPlugin;
  20
  21 /*************
  22  * Callbacks *
  23  *************/
  24 XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
  25
  26 /** @ingroup SURF_callbacks
  27  * @brief Callbacks handler which emit the callbacks after Cpu creation *
  28  * @details Callback functions have the following signature: `void(CpuPtr)`
  29  */
  30 XBT_PUBLIC_DATA( surf_callback(void, Cpu*)) cpuCreatedCallbacks;
  31
  32 /** @ingroup SURF_callbacks
  33  * @brief Callbacks handler which emit the callbacks after Cpu destruction *
  34  * @details Callback functions have the following signature: `void(CpuPtr)`
  35  */
  36 XBT_PUBLIC_DATA( surf_callback(void, Cpu*)) cpuDestructedCallbacks;
  37
  38 /** @ingroup SURF_callbacks
  39  * @brief Callbacks handler which emit the callbacks after Cpu State changed *
  40  * @details Callback functions have the following signature: `void(CpuAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
  41  */
  42 XBT_PUBLIC_DATA( surf_callback(void, Cpu*, e_surf_resource_state_t, e_surf_resource_state_t)) cpuStateChangedCallbacks;
  43
  44 /** @ingroup SURF_callbacks
  45  * @brief Callbacks handler which emit the callbacks after CpuAction State changed *
  46  * @details Callback functions have the following signature: `void(CpuAction *action, e_surf_action_state_t old, e_surf_action_state_t current)`
  47  */
  48 XBT_PUBLIC_DATA( surf_callback(void, CpuAction*, e_surf_action_state_t, e_surf_action_state_t)) cpuActionStateChangedCallbacks;
  49
  50 XBT_PUBLIC(void) cpu_parse_init(sg_platf_host_cbarg_t host);
  51
  52 XBT_PUBLIC(void) cpu_add_traces();
  53
  54 /*********
  55  * Model *
  56  *********/
  57
  58  /** @ingroup SURF_cpu_interface
  59  * @brief SURF cpu model interface class
  60  * @details A model is an object which handle the interactions between its Resources and its Actions
  61  */
  62 XBT_PUBLIC_CLASS CpuModel : public Model {
  63 public:
  64   /**
  65    * @brief CpuModel constructor
  66    *
  67    * @param name The name of the model
  68    */
  69   CpuModel(const char *name) : Model(name) {};
  70
  71   /**
  72    * @brief Create a Cpu
  73    *
  74    * @param name The name of the Cpu
  75    * @param power_peak The power peak of this Cpu
  76    * @param pstate [TODO]
  77    * @param power_scale The power scale of this Cpu
  78    * @param power_trace [TODO]
  79    * @param core The number of core of this Cpu
  80    * @param state_initial [TODO]
  81    * @param state_trace [TODO]
  82    * @param cpu_properties Dictionary of properties associated to this Cpu
  83    */
  84   virtual Cpu *createCpu(const char *name, xbt_dynar_t power_peak,
  85                       int pstate, double power_scale,
  86                           tmgr_trace_t power_trace, int core,
  87                           e_surf_resource_state_t state_initial,
  88                           tmgr_trace_t state_trace,
  89                           xbt_dict_t cpu_properties)=0;
  90
  91   void updateActionsStateLazy(double now, double delta);
  92   void updateActionsStateFull(double now, double delta);
  93 };
  94
  95 /************
  96  * Resource *
  97  ************/
  98
  99 /** @ingroup SURF_cpu_interface
 100 * @brief SURF cpu resource interface class
 101 * @details A Cpu represent a cpu associated to a host
 102 */
 103 XBT_PUBLIC_CLASS Cpu : public Resource {
 104 public:
 105   /**
 106    * @brief Cpu constructor
 107    */
 108   Cpu();
 109
 110   /**
 111    * @brief Cpu constructor
 112    *
 113    * @param model The CpuModel associated to this Cpu
 114    * @param name The name of the Cpu
 115    * @param props Dictionary of properties associated to this Cpu
 116    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
 117    * @param core The number of core of this Cpu
 118    * @param powerPeak The power peak of this Cpu
 119    * @param powerScale The power scale of this Cpu
 120    */
 121   Cpu(Model *model, const char *name, xbt_dict_t props,
 122           lmm_constraint_t constraint, int core, double powerPeak, double powerScale);
 123
 124   /**
 125    * @brief Cpu constructor
 126    *
 127    * @param model The CpuModel associated to this Cpu
 128    * @param name The name of the Cpu
 129    * @param props Dictionary of properties associated to this Cpu
 130    * @param core The number of core of this Cpu
 131    * @param powerPeak The power peak of this Cpu in [TODO]
 132    * @param powerScale The power scale of this Cpu in [TODO]
 133    */
 134   Cpu(Model *model, const char *name, xbt_dict_t props,
 135           int core, double powerPeak, double powerScale);
 136
 137   /**
 138    * @brief Cpu destructor
 139    */
 140   ~Cpu();
 141
 142   /**
 143    * @brief Execute some quantity of computation
 144    *
 145    * @param size The value of the processing amount (in flop) needed to process
 146    * @return The CpuAction corresponding to the processing
 147    */
 148   virtual CpuAction *execute(double size)=0;
 149
 150   /**
 151    * @brief Make a process sleep for duration (in seconds)
 152    *
 153    * @param duration The number of seconds to sleep
 154    * @return The CpuAction corresponding to the sleeping
 155    */
 156   virtual CpuAction *sleep(double duration)=0;
 157
 158   /**
 159    * @brief Get the number of cores of the current Cpu
 160    *
 161    * @return The number of cores of the current Cpu
 162    */
 163   virtual int getCore();
 164
 165   /**
 166    * @brief Get the speed of the current Cpu
 167    * @details [TODO] load * m_powerPeak
 168    *
 169    * @param load [TODO]
 170    *
 171    * @return The speed of the current Cpu
 172    */
 173   virtual double getSpeed(double load);
 174
 175   /**
 176    * @brief Get the available speed of the current Cpu
 177    * @details [TODO]
 178    *
 179    * @return The available speed of the current Cpu
 180    */
 181   virtual double getAvailableSpeed();
 182
 183   /**
 184    * @brief Get the current Cpu power peak
 185    *
 186    * @return The current Cpu power peak
 187    */
 188   virtual double getCurrentPowerPeak();
 189
 190
 191   virtual double getPowerPeakAt(int pstate_index)=0;
 192
 193   virtual int getNbPstates()=0;
 194
 195   virtual void setPstate(int pstate_index)=0;
 196   virtual int  getPstate()=0;
 197
 198   void setState(e_surf_resource_state_t state);
 199
 200   void addTraces(void);
 201   int m_core;
 202   double m_powerPeak;            /*< CPU power peak */
 203   double m_powerScale;           /*< Percentage of CPU disponible */
 204
 205   /* Note (hypervisor): */
 206   lmm_constraint_t *p_constraintCore;
 207   void **p_constraintCoreId;
 208 };
 209
 210 /**********
 211  * Action *
 212  **********/
 213
 214  /** @ingroup SURF_cpu_interface
 215  * @brief SURF Cpu action interface class
 216  * @details A CpuAction represent the execution of code on a Cpu
 217  */
 218 XBT_PUBLIC_CLASS CpuAction : public Action {
 219 friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
 220 public:
 221   /**
 222    * @brief CpuAction constructor
 223    *
 224    * @param model The CpuModel associated to this CpuAction
 225    * @param cost [TODO]
 226    * @param failed [TODO]
 227    */
 228   CpuAction(Model *model, double cost, bool failed)
 229     : Action(model, cost, failed) {} //FIXME:REMOVE
 230
 231   /**
 232    * @brief CpuAction constructor
 233    *
 234    * @param model The CpuModel associated to this CpuAction
 235    * @param cost [TODO]
 236    * @param failed [TODO]
 237    * @param var The lmm variable associated to this CpuAction if it is part of a LMM component
 238    */
 239   CpuAction(Model *model, double cost, bool failed, lmm_variable_t var)
 240     : Action(model, cost, failed, var) {}
 241
 242   /**
 243    * @brief Set the affinity of the current CpuAction
 244    * @details [TODO]
 245    *
 246    * @param cpu [TODO]
 247    * @param mask [TODO]
 248    */
 249   virtual void setAffinity(Cpu *cpu, unsigned long mask);
 250
 251   void setState(e_surf_action_state_t state);
 252
 253   void updateRemainingLazy(double now);
 254
 255 };
 256
 257 #endif /* SURF_CPU_INTERFACE_HPP_ */