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