Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
simplify the prototype of CpuAction::onStateChange
[simgrid.git] / src / surf / cpu_interface.cpp
1 /* Copyright (c) 2013-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 <xbt/dynar.h>
8 #include "cpu_interface.hpp"
9 #include "plugins/energy.hpp"
10
11 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu, surf,
13                                 "Logging specific to the SURF cpu module");
14
15 int autoload_surf_cpu_model = 1;
16 void_f_void_t surf_cpu_model_init_preparse = NULL;
17
18 simgrid::surf::CpuModel *surf_cpu_model_pm;
19 simgrid::surf::CpuModel *surf_cpu_model_vm;
20
21 namespace simgrid {
22 namespace surf {
23
24 /*************
25  * Callbacks *
26  *************/
27
28 Cpu *getActionCpu(CpuAction *action) {
29   return static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var
30                                          (action->getModel()->getMaxminSystem(),
31                                          action->getVariable(), 0)));
32 }
33
34 simgrid::xbt::signal<void(CpuAction*, e_surf_action_state_t, e_surf_action_state_t)> cpuActionStateChangedCallbacks;
35
36 /*********
37  * Model *
38  *********/
39
40 void CpuModel::updateActionsStateLazy(double now, double /*delta*/)
41 {
42   CpuAction *action;
43   while ((xbt_heap_size(getActionHeap()) > 0)
44          && (double_equals(xbt_heap_maxkey(getActionHeap()), now, sg_surf_precision))) {
45     action = static_cast<CpuAction*>(xbt_heap_pop(getActionHeap()));
46     XBT_CDEBUG(surf_kernel, "Something happened to action %p", action);
47     if (TRACE_is_enabled()) {
48       Cpu *cpu = static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)));
49       TRACE_surf_host_set_utilization(cpu->getName(), action->getCategory(),
50                                       lmm_variable_getvalue(action->getVariable()),
51                                       action->getLastUpdate(),
52                                       now - action->getLastUpdate());
53     }
54
55     action->finish();
56     XBT_CDEBUG(surf_kernel, "Action %p finished", action);
57
58     /* set the remains to 0 due to precision problems when updating the remaining amount */
59     action->setRemains(0);
60     action->setState(SURF_ACTION_DONE);
61     action->heapRemove(getActionHeap()); //FIXME: strange call since action was already popped
62   }
63   if (TRACE_is_enabled()) {
64     //defining the last timestamp that we can safely dump to trace file
65     //without losing the event ascending order (considering all CPU's)
66     double smaller = -1;
67     ActionList *actionSet = getRunningActionSet();
68     for(ActionList::iterator it(actionSet->begin()), itend(actionSet->end())
69        ; it != itend ; ++it) {
70       action = static_cast<CpuAction*>(&*it);
71         if (smaller < 0) {
72           smaller = action->getLastUpdate();
73           continue;
74         }
75         if (action->getLastUpdate() < smaller) {
76           smaller = action->getLastUpdate();
77         }
78     }
79     if (smaller > 0) {
80       TRACE_last_timestamp_to_dump = smaller;
81     }
82   }
83   return;
84 }
85
86 void CpuModel::updateActionsStateFull(double now, double delta)
87 {
88   CpuAction *action = NULL;
89   ActionList *running_actions = getRunningActionSet();
90
91   for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
92      ; it != itend ; it=itNext) {
93         ++itNext;
94     action = static_cast<CpuAction*>(&*it);
95     if (TRACE_is_enabled()) {
96       Cpu *x = static_cast<Cpu*> (lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)) );
97
98       TRACE_surf_host_set_utilization(x->getName(),
99                                       action->getCategory(),
100                                       lmm_variable_getvalue(action->getVariable()),
101                                       now - delta,
102                                       delta);
103       TRACE_last_timestamp_to_dump = now - delta;
104     }
105
106     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
107
108
109     if (action->getMaxDuration() != NO_MAX_DURATION)
110       action->updateMaxDuration(delta);
111
112
113     if ((action->getRemainsNoUpdate() <= 0) &&
114         (lmm_get_variable_weight(action->getVariable()) > 0)) {
115       action->finish();
116       action->setState(SURF_ACTION_DONE);
117     } else if ((action->getMaxDuration() != NO_MAX_DURATION) &&
118                (action->getMaxDuration() <= 0)) {
119       action->finish();
120       action->setState(SURF_ACTION_DONE);
121     }
122   }
123
124   return;
125 }
126
127 /************
128  * Resource *
129  ************/
130 Cpu::Cpu(Model *model, simgrid::s4u::Host *host,
131              xbt_dynar_t speedPeakList, int pstate,
132                  int core, double speedPeak, double speedScale,
133                  int initiallyOn)
134  : Cpu(model, host, NULL/*constraint*/, speedPeakList, pstate, core, speedPeak, speedScale, initiallyOn)
135 {
136 }
137
138 Cpu::Cpu(Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint,
139               xbt_dynar_t speedPeakList, int pstate,
140                   int core, double speedPeak,
141         double speedScale, int initiallyOn)
142  : Resource(model, host->name().c_str(), constraint, initiallyOn)
143  , m_core(core)
144  , m_speedPeak(speedPeak)
145  , m_speedScale(speedScale)
146  , m_host(host)
147 {
148   host->pimpl_cpu = this;
149   xbt_assert(m_speedScale > 0, "Available speed has to be >0");
150
151   // Copy the power peak array:
152   p_speedPeakList = xbt_dynar_new(sizeof(double), nullptr);
153   unsigned long n = xbt_dynar_length(speedPeakList);
154   for (unsigned long i = 0; i != n; ++i) {
155     double value = xbt_dynar_get_as(speedPeakList, i, double);
156     xbt_dynar_push(p_speedPeakList, &value);
157   }
158
159   m_pstate = pstate;
160
161   /* Currently, we assume that a VM does not have a multicore CPU. */
162   if (core > 1)
163     xbt_assert(model == surf_cpu_model_pm);
164
165   if (model->getUpdateMechanism() != UM_UNDEFINED) {
166         p_constraintCore = xbt_new(lmm_constraint_t, core);
167         p_constraintCoreId = xbt_new(void*, core);
168
169     int i;
170     for (i = 0; i < core; i++) {
171       /* just for a unique id, never used as a string. */
172       p_constraintCoreId[i] = bprintf("%s:%i", host->name().c_str(), i);
173       p_constraintCore[i] = lmm_constraint_new(model->getMaxminSystem(), p_constraintCoreId[i], m_speedScale * m_speedPeak);
174     }
175   }
176 }
177
178 Cpu::~Cpu()
179 {
180   if (p_constraintCoreId){
181     for (int i = 0; i < m_core; i++) {
182           xbt_free(p_constraintCoreId[i]);
183     }
184     xbt_free(p_constraintCore);
185   }
186   if (p_constraintCoreId)
187     xbt_free(p_constraintCoreId);
188 }
189
190 double Cpu::getCurrentPowerPeak()
191 {
192   return m_speedPeak;
193 }
194
195 int Cpu::getNbPStates()
196 {
197   return xbt_dynar_length(p_speedPeakList);
198 }
199
200 void Cpu::setPState(int pstate_index)
201 {
202   xbt_dynar_t plist = p_speedPeakList;
203   xbt_assert(pstate_index <= (int)xbt_dynar_length(plist),
204                   "Invalid parameters for CPU %s (pstate %d > length of pstates %d)", getName(), pstate_index, (int)xbt_dynar_length(plist));
205
206   double new_peak_speed = xbt_dynar_get_as(plist, pstate_index, double);
207   m_pstate = pstate_index;
208   m_speedPeak = new_peak_speed;
209
210   onSpeedChange();
211 }
212
213 int Cpu::getPState()
214 {
215   return m_pstate;
216 }
217
218 double Cpu::getPowerPeakAt(int pstate_index)
219 {
220   xbt_dynar_t plist = p_speedPeakList;
221   xbt_assert((pstate_index <= (int)xbt_dynar_length(plist)), "Invalid parameters (pstate index out of bounds)");
222
223   return xbt_dynar_get_as(plist, pstate_index, double);
224 }
225
226 double Cpu::getSpeed(double load)
227 {
228   return load * m_speedPeak;
229 }
230
231 double Cpu::getAvailableSpeed()
232 {
233 /* number between 0 and 1 */
234   return m_speedScale;
235 }
236
237 void Cpu::onSpeedChange() {
238         TRACE_surf_host_set_speed(surf_get_clock(), getName(),
239                         m_core * m_speedScale * m_speedPeak);
240 }
241
242
243 int Cpu::getCore()
244 {
245   return m_core;
246 }
247
248 /**********
249  * Action *
250  **********/
251
252 void CpuAction::updateRemainingLazy(double now)
253 {
254   double delta = 0.0;
255
256   xbt_assert(getStateSet() == getModel()->getRunningActionSet(),
257       "You're updating an action that is not running.");
258
259   /* bogus priority, skip it */
260   xbt_assert(getPriority() > 0,
261       "You're updating an action that seems suspended.");
262
263   delta = now - m_lastUpdate;
264
265   if (m_remains > 0) {
266     XBT_CDEBUG(surf_kernel, "Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
267     double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
268
269     if (TRACE_is_enabled()) {
270       Cpu *cpu = static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
271       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), m_lastValue, m_lastUpdate, now - m_lastUpdate);
272     }
273     XBT_CDEBUG(surf_kernel, "Updating action(%p): remains is now %f", this, m_remains);
274   }
275
276   m_lastUpdate = now;
277   m_lastValue = lmm_variable_getvalue(getVariable());
278 }
279
280 /*
281  *
282  * This function formulates a constraint problem that pins a given task to
283  * particular cores. Currently, it is possible to pin a task to an exactly one
284  * specific core. The system links the variable object of the task to the
285  * per-core constraint object.
286  *
287  * But, the taskset command on Linux takes a mask value specifying a CPU
288  * affinity setting of a given task. If the mask value is 0x03, the given task
289  * will be executed on the first core (CPU0) or the second core (CPU1) on the
290  * given PM. The schedular will determine appropriate placements of tasks,
291  * considering given CPU affinities and task activities.
292  *
293  * How should the system formulate constraint problems for an affinity to
294  * multiple cores?
295  *
296  * The cpu argument must be the host where the task is being executed. The
297  * action object does not have the information about the location where the
298  * action is being executed.
299  */
300 void CpuAction::setAffinity(Cpu *cpu, unsigned long mask)
301 {
302   lmm_variable_t var_obj = getVariable();
303   XBT_IN("(%p,%lx)", this, mask);
304
305   {
306     unsigned long nbits = 0;
307
308     /* FIXME: There is much faster algorithms doing this. */
309     for (int i = 0; i < cpu->m_core; i++) {
310       unsigned long has_affinity = (1UL << i) & mask;
311       if (has_affinity)
312         nbits += 1;
313     }
314
315     if (nbits > 1) {
316       XBT_CRITICAL("Do not specify multiple cores for an affinity mask.");
317       XBT_CRITICAL("See the comment in cpu_action_set_affinity().");
318       DIE_IMPOSSIBLE;
319     }
320   }
321
322   for (int i = 0; i < cpu->m_core; i++) {
323     XBT_DEBUG("clear affinity %p to cpu-%d@%s", this, i,  cpu->getName());
324     lmm_shrink(cpu->getModel()->getMaxminSystem(), cpu->p_constraintCore[i], var_obj);
325
326     unsigned long has_affinity = (1UL << i) & mask;
327     if (has_affinity) {
328       /* This function only accepts an affinity setting on the host where the
329        * task is now running. In future, a task might move to another host.
330        * But, at this moment, this function cannot take an affinity setting on
331        * that future host.
332        *
333        * It might be possible to extend the code to allow this function to
334        * accept affinity settings on a future host. We might be able to assign
335        * zero to elem->value to maintain such inactive affinity settings in the
336        * system. But, this will make the system complex. */
337       XBT_DEBUG("set affinity %p to cpu-%d@%s", this, i, cpu->getName());
338       lmm_expand(cpu->getModel()->getMaxminSystem(), cpu->p_constraintCore[i], var_obj, 1.0);
339     }
340   }
341
342   if (cpu->getModel()->getUpdateMechanism() == UM_LAZY) {
343     /* FIXME (hypervisor): Do we need to do something for the LAZY mode? */
344   }
345   XBT_OUT();
346 }
347
348 simgrid::xbt::signal<void(simgrid::surf::CpuAction*, e_surf_action_state_t)> CpuAction::onStateChange;
349
350 void CpuAction::setState(e_surf_action_state_t state){
351   e_surf_action_state_t previous = getState();
352   Action::setState(state);
353   onStateChange(this, previous);
354 }
355
356 }
357 }