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