src/surf/cpu_interface.hpp

   1 /* Copyright (c) 2004-2015. 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   CpuModel() : Model() {};
  65
  66   /**
  67    * @brief Create a Cpu
  68    *
  69    * @param name The name of the Cpu
  70    * @param power_peak The power peak of this Cpu
  71    * @param pstate [TODO]
  72    * @param power_scale The power scale of this Cpu
  73    * @param power_trace [TODO]
  74    * @param core The number of core of this Cpu
  75    * @param state_initial [TODO]
  76    * @param state_trace [TODO]
  77    * @param cpu_properties Dictionary of properties associated to this Cpu
  78    */
  79   virtual Cpu *createCpu(const char *name, xbt_dynar_t power_peak,
  80                       int pstate, double power_scale,
  81                           tmgr_trace_t power_trace, int core,
  82                           e_surf_resource_state_t state_initial,
  83                           tmgr_trace_t state_trace,
  84                           xbt_dict_t cpu_properties)=0;
  85
  86   void updateActionsStateLazy(double now, double delta);
  87   void updateActionsStateFull(double now, double delta);
  88   bool shareResourcesIsIdempotent() {return true;}
  89 };
  90
  91 /************
  92  * Resource *
  93  ************/
  94
  95 /** @ingroup SURF_cpu_interface
  96 * @brief SURF cpu resource interface class
  97 * @details A Cpu represent a cpu associated to a host
  98 */
  99 XBT_PUBLIC_CLASS Cpu : public Resource {
 100 public:
 101   /**
 102    * @brief Cpu constructor
 103    */
 104   Cpu();
 105
 106   /**
 107    * @brief Cpu constructor
 108    *
 109    * @param model The CpuModel associated to this Cpu
 110    * @param name The name of the Cpu
 111    * @param props Dictionary of properties associated to this Cpu
 112    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
 113    * @param core The number of core of this Cpu
 114    * @param powerPeak The power peak of this Cpu
 115    * @param powerScale The power scale of this Cpu
 116    */
 117   Cpu(Model *model, const char *name, xbt_dict_t props,
 118           lmm_constraint_t constraint, int core, double powerPeak, double powerScale);
 119
 120   /**
 121    * @brief Cpu constructor
 122    *
 123    * @param model The CpuModel associated to this Cpu
 124    * @param name The name of the Cpu
 125    * @param props Dictionary of properties associated to this Cpu
 126    * @param core The number of core of this Cpu
 127    * @param powerPeak The power peak of this Cpu in [TODO]
 128    * @param powerScale The power scale of this Cpu in [TODO]
 129    */
 130   Cpu(Model *model, const char *name, xbt_dict_t props,
 131           int core, double powerPeak, double powerScale);
 132
 133   /**
 134    * @brief Cpu destructor
 135    */
 136   ~Cpu();
 137
 138   /**
 139    * @brief Execute some quantity of computation
 140    *
 141    * @param size The value of the processing amount (in flop) needed to process
 142    * @return The CpuAction corresponding to the processing
 143    */
 144   virtual CpuAction *execute(double size)=0;
 145
 146   /**
 147    * @brief Make a process sleep for duration (in seconds)
 148    *
 149    * @param duration The number of seconds to sleep
 150    * @return The CpuAction corresponding to the sleeping
 151    */
 152   virtual CpuAction *sleep(double duration)=0;
 153
 154   /**
 155    * @brief Get the number of cores of the current Cpu
 156    *
 157    * @return The number of cores of the current Cpu
 158    */
 159   virtual int getCore();
 160
 161   /**
 162    * @brief Get the speed of the current Cpu
 163    * @details [TODO] load * m_powerPeak
 164    *
 165    * @param load [TODO]
 166    *
 167    * @return The speed of the current Cpu
 168    */
 169   virtual double getSpeed(double load);
 170
 171   /**
 172    * @brief Get the available speed of the current Cpu
 173    * @details [TODO]
 174    *
 175    * @return The available speed of the current Cpu
 176    */
 177   virtual double getAvailableSpeed();
 178
 179   /**
 180    * @brief Get the current Cpu power peak
 181    *
 182    * @return The current Cpu power peak
 183    */
 184   virtual double getCurrentPowerPeak();
 185
 186
 187   virtual double getPowerPeakAt(int pstate_index)=0;
 188
 189   virtual int getNbPstates()=0;
 190
 191   virtual void setPstate(int pstate_index)=0;
 192   virtual int  getPstate()=0;
 193
 194   void setState(e_surf_resource_state_t state);
 195
 196   void addTraces(void);
 197   int m_core;
 198   double m_powerPeak;            /*< CPU power peak */
 199   double m_powerScale;           /*< Percentage of CPU available */
 200
 201   /* Note (hypervisor): */
 202   lmm_constraint_t *p_constraintCore;
 203   void **p_constraintCoreId;
 204 };
 205
 206 /**********
 207  * Action *
 208  **********/
 209
 210  /** @ingroup SURF_cpu_interface
 211  * @brief SURF Cpu action interface class
 212  * @details A CpuAction represent the execution of code on a Cpu
 213  */
 214 XBT_PUBLIC_CLASS CpuAction : public Action {
 215 friend XBT_PUBLIC(Cpu*) getActionCpu(CpuAction *action);
 216 public:
 217   /**
 218    * @brief CpuAction constructor
 219    *
 220    * @param model The CpuModel associated to this CpuAction
 221    * @param cost [TODO]
 222    * @param failed [TODO]
 223    */
 224   CpuAction(Model *model, double cost, bool failed)
 225     : Action(model, cost, failed) {} //FIXME:REMOVE
 226
 227   /**
 228    * @brief CpuAction constructor
 229    *
 230    * @param model The CpuModel associated to this CpuAction
 231    * @param cost [TODO]
 232    * @param failed [TODO]
 233    * @param var The lmm variable associated to this CpuAction if it is part of a LMM component
 234    */
 235   CpuAction(Model *model, double cost, bool failed, lmm_variable_t var)
 236     : Action(model, cost, failed, var) {}
 237
 238   /**
 239    * @brief Set the affinity of the current CpuAction
 240    * @details [TODO]
 241    *
 242    * @param cpu [TODO]
 243    * @param mask [TODO]
 244    */
 245   virtual void setAffinity(Cpu *cpu, unsigned long mask);
 246
 247   void setState(e_surf_action_state_t state);
 248
 249   void updateRemainingLazy(double now);
 250
 251 };
 252
 253 #endif /* SURF_CPU_INTERFACE_HPP_ */