1 /* Copyright (c) 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "surf_private.h"
9 #undef GENERIC_LMM_ACTION
12 #define GENERIC_LMM_ACTION(action) action->generic_lmm_action
13 #define GENERIC_ACTION(action) GENERIC_LMM_ACTION(action).generic_action
14 #define ACTION_GET_CPU(action) ((surf_action_cpu_Cas01_im_t) action)->cpu
16 typedef struct surf_action_cpu_cas01_im {
17 s_surf_action_lmm_t generic_lmm_action;
18 s_xbt_swag_hookup_t cpu_list_hookup;
21 } s_surf_action_cpu_Cas01_im_t, *surf_action_cpu_Cas01_im_t;
23 typedef struct cpu_Cas01_im {
24 s_surf_resource_t generic_resource;
25 s_xbt_swag_hookup_t modified_cpu_hookup;
28 tmgr_trace_event_t power_event;
29 e_surf_resource_state_t state_current;
30 tmgr_trace_event_t state_event;
31 lmm_constraint_t constraint;
32 xbt_swag_t action_set;
34 } s_cpu_Cas01_im_t, *cpu_Cas01_im_t;
36 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_im, surf,
37 "Logging specific to the SURF CPU IMPROVED module");
40 lmm_system_t cpu_im_maxmin_system = NULL;
41 static xbt_swag_t cpu_im_modified_cpu = NULL;
42 static xbt_heap_t cpu_im_action_heap = NULL;
43 extern int sg_maxmin_selective_update;
46 static xbt_swag_t cpu_im_running_action_set_that_does_not_need_being_checked = NULL;
48 static cpu_Cas01_im_t cpu_im_new(char *name, double power_peak,
50 tmgr_trace_t power_trace,
51 e_surf_resource_state_t state_initial,
52 tmgr_trace_t state_trace,
53 xbt_dict_t cpu_properties)
55 cpu_Cas01_im_t cpu = NULL;
56 s_surf_action_cpu_Cas01_im_t action;
57 cpu = xbt_new0(s_cpu_Cas01_im_t, 1);
60 TRACE_surf_host_declaration (name, power_scale * power_peak);
63 xbt_assert1(!surf_model_resource_by_name(surf_cpu_model, name),
64 "Host '%s' declared several times in the platform file", name);
65 cpu->generic_resource.model = surf_cpu_model;
66 cpu->generic_resource.name = name;
67 cpu->generic_resource.properties = cpu_properties;
68 cpu->power_peak = power_peak;
69 xbt_assert0(cpu->power_peak > 0, "Power has to be >0");
70 cpu->power_scale = power_scale;
73 tmgr_history_add_trace(history, power_trace, 0.0, 0, cpu);
75 cpu->state_current = state_initial;
78 tmgr_history_add_trace(history, state_trace, 0.0, 0, cpu);
81 lmm_constraint_new(cpu_im_maxmin_system, cpu,
82 cpu->power_scale * cpu->power_peak);
84 xbt_dict_set(surf_model_resource_set(surf_cpu_model), name, cpu,
86 cpu->action_set = xbt_swag_new(xbt_swag_offset(action, cpu_list_hookup));
92 static void parse_cpu_im_init(void)
94 double power_peak = 0.0;
95 double power_scale = 0.0;
96 tmgr_trace_t power_trace = NULL;
97 e_surf_resource_state_t state_initial = SURF_RESOURCE_OFF;
98 tmgr_trace_t state_trace = NULL;
100 power_peak = get_cpu_power(A_surfxml_host_power);
101 surf_parse_get_double(&power_scale, A_surfxml_host_availability);
102 power_trace = tmgr_trace_new(A_surfxml_host_availability_file);
104 xbt_assert0((A_surfxml_host_state == A_surfxml_host_state_ON) ||
105 (A_surfxml_host_state == A_surfxml_host_state_OFF),
107 if (A_surfxml_host_state == A_surfxml_host_state_ON)
108 state_initial = SURF_RESOURCE_ON;
109 if (A_surfxml_host_state == A_surfxml_host_state_OFF)
110 state_initial = SURF_RESOURCE_OFF;
111 state_trace = tmgr_trace_new(A_surfxml_host_state_file);
113 current_property_set = xbt_dict_new();
114 cpu_im_new(xbt_strdup(A_surfxml_host_id), power_peak, power_scale,
115 power_trace, state_initial, state_trace, current_property_set);
119 static void cpu_im_add_traces_cpu(void)
121 xbt_dict_cursor_t cursor = NULL;
122 char *trace_name, *elm;
123 static int called = 0;
128 /* connect all traces relative to hosts */
129 xbt_dict_foreach(trace_connect_list_host_avail, cursor, trace_name, elm) {
130 tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
131 cpu_Cas01_im_t host = surf_model_resource_by_name(surf_cpu_model, elm);
133 xbt_assert1(host, "Host %s undefined", elm);
134 xbt_assert1(trace, "Trace %s undefined", trace_name);
136 host->state_event = tmgr_history_add_trace(history, trace, 0.0, 0, host);
139 xbt_dict_foreach(trace_connect_list_power, cursor, trace_name, elm) {
140 tmgr_trace_t trace = xbt_dict_get_or_null(traces_set_list, trace_name);
141 cpu_Cas01_im_t host = surf_model_resource_by_name(surf_cpu_model, elm);
143 xbt_assert1(host, "Host %s undefined", elm);
144 xbt_assert1(trace, "Trace %s undefined", trace_name);
146 host->power_event = tmgr_history_add_trace(history, trace, 0.0, 0, host);
150 static void cpu_im_define_callbacks(const char *file)
153 surf_parse_reset_parser();
154 surfxml_add_callback(STag_surfxml_host_cb_list, parse_cpu_im_init);
155 surfxml_add_callback(ETag_surfxml_platform_cb_list, &cpu_im_add_traces_cpu);
158 static int cpu_im_resource_used(void *resource_id)
160 return lmm_constraint_used(cpu_im_maxmin_system,
161 ((cpu_Cas01_im_t) resource_id)->constraint);
164 static int cpu_im_action_unref(surf_action_t action)
167 if (!action->refcount) {
168 xbt_swag_remove(action, action->state_set);
169 if (((surf_action_lmm_t) action)->variable)
170 lmm_variable_free(cpu_im_maxmin_system,
171 ((surf_action_lmm_t) action)->variable);
172 /* remove from heap */
173 xbt_heap_remove(cpu_im_action_heap,
174 ((surf_action_cpu_Cas01_im_t) action)->index_heap);
175 xbt_swag_remove(action,
176 ((cpu_Cas01_im_t) ACTION_GET_CPU(action))->action_set);
177 xbt_swag_insert(ACTION_GET_CPU(action), cpu_im_modified_cpu);
179 if (action->category) xbt_free (action->category);
187 static void cpu_im_action_cancel(surf_action_t action)
189 surf_action_state_set(action, SURF_ACTION_FAILED);
190 xbt_heap_remove(cpu_im_action_heap,
191 ((surf_action_cpu_Cas01_im_t) action)->index_heap);
192 xbt_swag_remove(action,
193 ((cpu_Cas01_im_t) ACTION_GET_CPU(action))->action_set);
197 static void cpu_im_cpu_action_state_set(surf_action_t action,
198 e_surf_action_state_t state)
200 /* if((state==SURF_ACTION_DONE) || (state==SURF_ACTION_FAILED)) */
201 /* if(((surf_action_lmm_t)action)->variable) { */
202 /* lmm_variable_disable(cpu_im_maxmin_system, ((surf_action_lmm_t)action)->variable); */
203 /* ((surf_action_lmm_t)action)->variable = NULL; */
206 surf_action_state_set(action, state);
210 static void cpu_im_update_remains(cpu_Cas01_im_t cpu, double now)
212 surf_action_cpu_Cas01_im_t action;
214 if (cpu->last_update >= now)
216 xbt_swag_foreach(action, cpu->action_set) {
217 if (GENERIC_ACTION(action).state_set !=
218 surf_cpu_model->states.running_action_set)
221 /* bogus priority, skip it */
222 if (GENERIC_ACTION(action).priority <= 0)
225 if (GENERIC_ACTION(action).remains > 0) {
226 double_update(&(GENERIC_ACTION(action).remains),
227 lmm_variable_getvalue(GENERIC_LMM_ACTION
228 (action).variable) * (now -
231 TRACE_surf_host_set_utilization (cpu->generic_resource.name,
232 action->generic_lmm_action.generic_action.data, (surf_action_t)action, lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable), cpu->last_update, now-cpu->last_update);
234 DEBUG2("Update action(%p) remains %lf", action,
235 GENERIC_ACTION(action).remains);
238 cpu->last_update = now;
241 static double cpu_im_share_resources(double now)
243 surf_action_cpu_Cas01_im_t action;
246 cpu_Cas01_im_t cpu, cpu_next;
248 xbt_swag_foreach(cpu, cpu_im_modified_cpu)
249 cpu_im_update_remains(cpu, now);
251 lmm_solve(cpu_im_maxmin_system);
253 xbt_swag_foreach_safe(cpu, cpu_next, cpu_im_modified_cpu) {
254 xbt_swag_foreach(action, cpu->action_set) {
255 if (GENERIC_ACTION(action).state_set !=
256 surf_cpu_model->states.running_action_set)
259 /* bogus priority, skip it */
260 if (GENERIC_ACTION(action).priority <= 0)
264 value = lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable);
266 if (GENERIC_ACTION(action).remains > 0)
267 value = GENERIC_ACTION(action).remains / value;
274 if ((GENERIC_ACTION(action).max_duration != NO_MAX_DURATION)
276 || GENERIC_ACTION(action).start +
277 GENERIC_ACTION(action).max_duration < min))
279 GENERIC_ACTION(action).start + GENERIC_ACTION(action).max_duration;
281 DEBUG4("Action(%p) Start %lf Finish %lf Max_duration %lf", action,
282 GENERIC_ACTION(action).start, now + value,
283 GENERIC_ACTION(action).max_duration);
285 if (action->index_heap >= 0) {
286 surf_action_cpu_Cas01_im_t heap_act =
287 xbt_heap_remove(cpu_im_action_heap, action->index_heap);
288 if (heap_act != action)
292 xbt_heap_push(cpu_im_action_heap, action, min);
293 DEBUG2("Insert at heap action(%p) min %lf", action, min);
296 xbt_swag_remove(cpu, cpu_im_modified_cpu);
298 return xbt_heap_size(cpu_im_action_heap) >
299 0 ? xbt_heap_maxkey(cpu_im_action_heap) - now : -1;
302 static void cpu_im_update_actions_state(double now, double delta)
304 surf_action_cpu_Cas01_im_t action;
306 while ((xbt_heap_size(cpu_im_action_heap) > 0)
307 && (double_equals(xbt_heap_maxkey(cpu_im_action_heap), now))) {
308 action = xbt_heap_pop(cpu_im_action_heap);
309 DEBUG1("Action %p: finish", action);
310 GENERIC_ACTION(action).finish = surf_get_clock();
311 /* set the remains to 0 due to precision problems when updating the remaining amount */
313 TRACE_surf_host_set_utilization (((cpu_Cas01_im_t)(action->cpu))->generic_resource.name,
314 action->generic_lmm_action.generic_action.data, (surf_action_t)action, lmm_variable_getvalue(GENERIC_LMM_ACTION(action).variable), ((cpu_Cas01_im_t)(action->cpu))->last_update, now-((cpu_Cas01_im_t)(action->cpu))->last_update);
316 GENERIC_ACTION(action).remains = 0;
317 cpu_im_cpu_action_state_set((surf_action_t) action, SURF_ACTION_DONE);
318 cpu_im_update_remains(action->cpu, surf_get_clock());
323 static void cpu_im_update_resource_state(void *id,
324 tmgr_trace_event_t event_type,
325 double value, double date)
327 cpu_Cas01_im_t cpu = id;
328 if (event_type == cpu->power_event) {
329 cpu->power_scale = value;
330 lmm_update_constraint_bound(cpu_im_maxmin_system, cpu->constraint,
331 cpu->power_scale * cpu->power_peak);
333 TRACE_surf_host_set_power (date, cpu->generic_resource.name, cpu->power_scale * cpu->power_peak);
335 xbt_swag_insert(cpu, cpu_im_modified_cpu);
336 if (tmgr_trace_event_free(event_type))
337 cpu->power_event = NULL;
338 } else if (event_type == cpu->state_event) {
340 cpu->state_current = SURF_RESOURCE_ON;
342 lmm_constraint_t cnst = cpu->constraint;
343 lmm_variable_t var = NULL;
344 lmm_element_t elem = NULL;
346 cpu->state_current = SURF_RESOURCE_OFF;
348 while ((var = lmm_get_var_from_cnst(cpu_im_maxmin_system, cnst, &elem))) {
349 surf_action_t action = lmm_variable_id(var);
351 if (surf_action_state_get(action) == SURF_ACTION_RUNNING ||
352 surf_action_state_get(action) == SURF_ACTION_READY ||
353 surf_action_state_get(action) == SURF_ACTION_NOT_IN_THE_SYSTEM) {
354 action->finish = date;
355 cpu_im_cpu_action_state_set(action, SURF_ACTION_FAILED);
359 if (tmgr_trace_event_free(event_type))
360 cpu->state_event = NULL;
362 CRITICAL0("Unknown event ! \n");
369 static surf_action_t cpu_im_execute(void *cpu, double size)
371 surf_action_cpu_Cas01_im_t action = NULL;
372 cpu_Cas01_im_t CPU = cpu;
374 XBT_IN2("(%s,%g)", surf_resource_name(CPU), size);
376 surf_action_new(sizeof(s_surf_action_cpu_Cas01_im_t), size,
377 surf_cpu_model, CPU->state_current != SURF_RESOURCE_ON);
379 GENERIC_LMM_ACTION(action).suspended = 0; /* Should be useless because of the
380 calloc but it seems to help valgrind... */
382 GENERIC_LMM_ACTION(action).variable =
383 lmm_variable_new(cpu_im_maxmin_system, action,
384 GENERIC_ACTION(action).priority, -1.0, 1);
385 action->index_heap = -1;
387 xbt_swag_insert(CPU, cpu_im_modified_cpu);
388 xbt_swag_insert(action, CPU->action_set);
389 lmm_expand(cpu_im_maxmin_system, CPU->constraint,
390 GENERIC_LMM_ACTION(action).variable, 1.0);
392 return (surf_action_t) action;
395 static surf_action_t cpu_im_action_sleep(void *cpu, double duration)
397 surf_action_cpu_Cas01_im_t action = NULL;
400 duration = MAX(duration, MAXMIN_PRECISION);
402 XBT_IN2("(%s,%g)", surf_resource_name(cpu), duration);
403 action = (surf_action_cpu_Cas01_im_t) cpu_im_execute(cpu, 1.0);
404 GENERIC_ACTION(action).max_duration = duration;
405 GENERIC_LMM_ACTION(action).suspended = 2;
406 if (duration == NO_MAX_DURATION) {
407 /* Move to the *end* of the corresponding action set. This convention
408 is used to speed up update_resource_state */
409 xbt_swag_remove(action, ((surf_action_t) action)->state_set);
410 ((surf_action_t) action)->state_set =
411 cpu_im_running_action_set_that_does_not_need_being_checked;
412 xbt_swag_insert(action, ((surf_action_t) action)->state_set);
415 lmm_update_variable_weight(cpu_im_maxmin_system,
416 GENERIC_LMM_ACTION(action).variable, 0.0);
417 xbt_swag_insert(cpu, cpu_im_modified_cpu);
419 return (surf_action_t) action;
422 static void cpu_im_action_suspend(surf_action_t action)
424 XBT_IN1("(%p)", action);
425 if (((surf_action_lmm_t) action)->suspended != 2) {
426 lmm_update_variable_weight(cpu_im_maxmin_system,
427 ((surf_action_lmm_t) action)->variable, 0.0);
428 ((surf_action_lmm_t) action)->suspended = 1;
429 xbt_heap_remove(cpu_im_action_heap,
430 ((surf_action_cpu_Cas01_im_t) action)->index_heap);
431 xbt_swag_insert(ACTION_GET_CPU(action), cpu_im_modified_cpu);
436 static void cpu_im_action_resume(surf_action_t action)
439 XBT_IN1("(%p)", action);
440 if (((surf_action_lmm_t) action)->suspended != 2) {
441 lmm_update_variable_weight(cpu_im_maxmin_system,
442 ((surf_action_lmm_t) action)->variable,
444 ((surf_action_lmm_t) action)->suspended = 0;
445 xbt_swag_insert(ACTION_GET_CPU(action), cpu_im_modified_cpu);
450 static int cpu_im_action_is_suspended(surf_action_t action)
452 return (((surf_action_lmm_t) action)->suspended == 1);
455 static void cpu_im_action_set_max_duration(surf_action_t action, double duration)
457 XBT_IN2("(%p,%g)", action, duration);
459 action->max_duration = duration;
460 /* insert cpu in modified_cpu set to notice the max duration change */
461 xbt_swag_insert(ACTION_GET_CPU(action), cpu_im_modified_cpu);
465 static void cpu_im_action_set_priority(surf_action_t action, double priority)
467 XBT_IN2("(%p,%g)", action, priority);
468 action->priority = priority;
469 lmm_update_variable_weight(cpu_im_maxmin_system,
470 ((surf_action_lmm_t) action)->variable,
473 xbt_swag_insert(ACTION_GET_CPU(action), cpu_im_modified_cpu);
477 static double cpu_im_action_get_remains(surf_action_t action)
479 XBT_IN1("(%p)", action);
480 /* update remains before return it */
481 cpu_im_update_remains(ACTION_GET_CPU(action), surf_get_clock());
482 return action->remains;
486 static e_surf_resource_state_t cpu_im_get_state(void *cpu)
488 return ((cpu_Cas01_im_t) cpu)->state_current;
491 static double cpu_im_get_speed(void *cpu, double load)
493 return load * (((cpu_Cas01_im_t) cpu)->power_peak);
496 static double cpu_im_get_available_speed(void *cpu)
498 /* number between 0 and 1 */
499 return ((cpu_Cas01_im_t) cpu)->power_scale;
502 static void cpu_im_action_update_index_heap(void *action, int i)
504 ((surf_action_cpu_Cas01_im_t) action)->index_heap = i;
506 static void cpu_im_create_resource(char *name, double power_peak,
508 tmgr_trace_t power_trace,
509 e_surf_resource_state_t state_initial,
510 tmgr_trace_t state_trace,
511 xbt_dict_t cpu_properties)
513 cpu_im_new(name,power_peak,power_scale,power_trace,
514 state_initial,state_trace,cpu_properties);
517 static void cpu_im_finalize(void)
520 xbt_dict_cursor_t cursor;
522 xbt_dict_foreach(surf_model_resource_set(surf_cpu_model), cursor, key, cpu) {
523 cpu_Cas01_im_t CPU = cpu;
524 xbt_swag_free(CPU->action_set);
527 lmm_system_free(cpu_im_maxmin_system);
528 cpu_im_maxmin_system = NULL;
530 surf_model_exit(surf_cpu_model);
531 surf_cpu_model = NULL;
533 xbt_swag_free(cpu_im_running_action_set_that_does_not_need_being_checked);
534 cpu_im_running_action_set_that_does_not_need_being_checked = NULL;
535 xbt_heap_free(cpu_im_action_heap);
536 xbt_swag_free(cpu_im_modified_cpu);
539 static void surf_cpu_im_model_init_internal(void)
541 s_surf_action_t action;
542 s_cpu_Cas01_im_t cpu;
544 surf_cpu_model = surf_model_init();
546 cpu_im_running_action_set_that_does_not_need_being_checked =
547 xbt_swag_new(xbt_swag_offset(action, state_hookup));
549 surf_cpu_model->name = "CPU_IM";
551 surf_cpu_model->action_unref = cpu_im_action_unref;
552 surf_cpu_model->action_cancel = cpu_im_action_cancel;
553 surf_cpu_model->action_state_set = cpu_im_cpu_action_state_set;
555 surf_cpu_model->model_private->resource_used = cpu_im_resource_used;
556 surf_cpu_model->model_private->share_resources = cpu_im_share_resources;
557 surf_cpu_model->model_private->update_actions_state = cpu_im_update_actions_state;
558 surf_cpu_model->model_private->update_resource_state =
559 cpu_im_update_resource_state;
560 surf_cpu_model->model_private->finalize = cpu_im_finalize;
562 surf_cpu_model->suspend = cpu_im_action_suspend;
563 surf_cpu_model->resume = cpu_im_action_resume;
564 surf_cpu_model->is_suspended = cpu_im_action_is_suspended;
565 surf_cpu_model->set_max_duration = cpu_im_action_set_max_duration;
566 surf_cpu_model->set_priority = cpu_im_action_set_priority;
567 surf_cpu_model->get_remains = cpu_im_action_get_remains;
569 surf_cpu_model->extension.cpu.execute = cpu_im_execute;
570 surf_cpu_model->extension.cpu.sleep = cpu_im_action_sleep;
572 surf_cpu_model->extension.cpu.get_state = cpu_im_get_state;
573 surf_cpu_model->extension.cpu.get_speed = cpu_im_get_speed;
574 surf_cpu_model->extension.cpu.get_available_speed = cpu_im_get_available_speed;
575 surf_cpu_model->extension.cpu.create_resource = cpu_im_create_resource;
576 surf_cpu_model->extension.cpu.add_traces = cpu_im_add_traces_cpu;
578 if (!cpu_im_maxmin_system) {
579 sg_maxmin_selective_update = 1;
580 cpu_im_maxmin_system = lmm_system_new();
582 cpu_im_action_heap = xbt_heap_new(8, NULL);
583 xbt_heap_set_update_callback(cpu_im_action_heap, cpu_im_action_update_index_heap);
584 cpu_im_modified_cpu = xbt_swag_new(xbt_swag_offset(cpu, modified_cpu_hookup));
587 /*********************************************************************/
588 /* Basic sharing model for CPU: that is where all this started... ;) */
589 /*********************************************************************/
590 /* @InProceedings{casanova01simgrid, */
591 /* author = "H. Casanova", */
592 /* booktitle = "Proceedings of the IEEE Symposium on Cluster Computing */
593 /* and the Grid (CCGrid'01)", */
594 /* publisher = "IEEE Computer Society", */
595 /* title = "Simgrid: {A} Toolkit for the Simulation of Application */
599 /* note = "Available at */
600 /* \url{http://grail.sdsc.edu/papers/simgrid_ccgrid01.ps.gz}." */
602 void surf_cpu_model_init_Cas01_im(const char *filename)
606 surf_cpu_im_model_init_internal();
607 cpu_im_define_callbacks(filename);
608 xbt_dynar_push(model_list, &surf_cpu_model);