Logo AND Algorithmique Numérique Distribuée

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