Logo AND Algorithmique Numérique Distribuée

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