1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 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. */
8 #include "xbt/sysdep.h"
10 #include "xbt/mallocator.h"
11 #include "maxmin_private.h"
13 #include <stdio.h> /* sprintf */
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_maxmin, surf,
16 "Logging specific to SURF (maxmin)");
18 double sg_maxmin_precision = 0.00001;
20 static void *lmm_variable_mallocator_new_f(void);
21 static void lmm_variable_mallocator_free_f(void *var);
22 static void lmm_variable_mallocator_reset_f(void *var);
23 static void lmm_update_modified_set(lmm_system_t sys,
24 lmm_constraint_t cnst);
25 static void lmm_remove_all_modified_set(lmm_system_t sys);
26 int sg_maxmin_selective_update = 1;
27 static int Global_debug_id = 1;
28 static int Global_const_debug_id = 1;
29 extern xbt_swag_t keep_track;
31 lmm_system_t lmm_system_new(void)
33 lmm_system_t l = NULL;
35 s_lmm_constraint_t cnst;
37 l = xbt_new0(s_lmm_system_t, 1);
40 l->selective_update_active = sg_maxmin_selective_update;
42 DEBUG1("Setting selective_update_active flag to %d\n",
43 l->selective_update_active);
45 xbt_swag_init(&(l->variable_set),
46 xbt_swag_offset(var, variable_set_hookup));
47 xbt_swag_init(&(l->constraint_set),
48 xbt_swag_offset(cnst, constraint_set_hookup));
50 xbt_swag_init(&(l->active_constraint_set),
51 xbt_swag_offset(cnst, active_constraint_set_hookup));
53 xbt_swag_init(&(l->modified_constraint_set),
54 xbt_swag_offset(cnst, modified_constraint_set_hookup));
55 xbt_swag_init(&(l->saturated_variable_set),
56 xbt_swag_offset(var, saturated_variable_set_hookup));
57 xbt_swag_init(&(l->saturated_constraint_set),
58 xbt_swag_offset(cnst, saturated_constraint_set_hookup));
60 l->variable_mallocator = xbt_mallocator_new(64,
61 lmm_variable_mallocator_new_f,
62 lmm_variable_mallocator_free_f,
63 lmm_variable_mallocator_reset_f);
68 void lmm_system_free(lmm_system_t sys)
70 lmm_variable_t var = NULL;
71 lmm_constraint_t cnst = NULL;
73 while ((var = extract_variable(sys))) {
75 ("Variable %p (%d) still in LMM system when freing it: this may be a bug",
77 lmm_var_free(sys, var);
80 while ((cnst = extract_constraint(sys)))
81 lmm_cnst_free(sys, cnst);
83 xbt_mallocator_free(sys->variable_mallocator);
87 XBT_INLINE void lmm_variable_disable(lmm_system_t sys, lmm_variable_t var)
90 lmm_element_t elem = NULL;
92 XBT_IN2("(sys=%p, var=%p)", sys, var);
95 for (i = 0; i < var->cnsts_number; i++) {
96 elem = &var->cnsts[i];
97 xbt_swag_remove(elem, &(elem->constraint->element_set));
98 xbt_swag_remove(elem, &(elem->constraint->active_element_set));
99 if (!xbt_swag_size(&(elem->constraint->element_set)))
100 make_constraint_inactive(sys, elem->constraint);
102 lmm_update_modified_set(sys, elem->constraint);
104 var->cnsts_number = 0;
108 static void lmm_var_free(lmm_system_t sys, lmm_variable_t var)
111 lmm_variable_disable(sys, var);
113 xbt_mallocator_release(sys->variable_mallocator, var);
116 static XBT_INLINE void lmm_cnst_free(lmm_system_t sys,
117 lmm_constraint_t cnst)
119 /* xbt_assert0(xbt_swag_size(&(cnst->element_set)), */
120 /* "This list should be empty!"); */
121 remove_active_constraint(sys, cnst);
125 lmm_constraint_t lmm_constraint_new(lmm_system_t sys, void *id,
128 lmm_constraint_t cnst = NULL;
129 s_lmm_element_t elem;
131 cnst = xbt_new0(s_lmm_constraint_t, 1);
133 cnst->id_int = Global_const_debug_id++;
134 xbt_swag_init(&(cnst->element_set),
135 xbt_swag_offset(elem, element_set_hookup));
136 xbt_swag_init(&(cnst->active_element_set),
137 xbt_swag_offset(elem, active_element_set_hookup));
139 cnst->bound = bound_value;
142 insert_constraint(sys, cnst);
147 XBT_INLINE void lmm_constraint_shared(lmm_constraint_t cnst)
152 XBT_INLINE int lmm_constraint_is_shared(lmm_constraint_t cnst)
154 return (cnst->shared);
157 XBT_INLINE void lmm_constraint_free(lmm_system_t sys,
158 lmm_constraint_t cnst)
160 remove_constraint(sys, cnst);
161 lmm_cnst_free(sys, cnst);
164 static void *lmm_variable_mallocator_new_f(void)
166 return xbt_new(s_lmm_variable_t, 1);
169 static void lmm_variable_mallocator_free_f(void *var)
174 static void lmm_variable_mallocator_reset_f(void *var)
176 /* memset to zero like calloc */
177 memset(var, 0, sizeof(s_lmm_variable_t));
180 lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
182 double bound, int number_of_constraints)
184 lmm_variable_t var = NULL;
187 XBT_IN5("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)",
188 sys, id, weight, bound, number_of_constraints);
190 var = xbt_mallocator_get(sys->variable_mallocator);
192 var->id_int = Global_debug_id++;
193 var->cnsts = xbt_new0(s_lmm_element_t, number_of_constraints);
194 for (i = 0; i < number_of_constraints; i++) {
195 /* Should be useless because of the
196 calloc but it seems to help valgrind... */
197 var->cnsts[i].element_set_hookup.next = NULL;
198 var->cnsts[i].element_set_hookup.prev = NULL;
199 var->cnsts[i].active_element_set_hookup.next = NULL;
200 var->cnsts[i].active_element_set_hookup.prev = NULL;
201 var->cnsts[i].constraint = NULL;
202 var->cnsts[i].variable = NULL;
203 var->cnsts[i].value = 0.0;
205 var->cnsts_size = number_of_constraints;
206 var->cnsts_number = 0; /* Should be useless because of the
207 calloc but it seems to help valgrind... */
208 var->weight = weight;
213 var->func_f = func_f_def;
214 var->func_fp = func_fp_def;
215 var->func_fpi = func_fpi_def;
218 xbt_swag_insert_at_head(var, &(sys->variable_set));
220 xbt_swag_insert_at_tail(var, &(sys->variable_set));
225 void lmm_variable_free(lmm_system_t sys, lmm_variable_t var)
227 remove_variable(sys, var);
228 lmm_var_free(sys, var);
231 XBT_INLINE double lmm_variable_getvalue(lmm_variable_t var)
236 XBT_INLINE double lmm_variable_getbound(lmm_variable_t var)
241 void lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
242 lmm_variable_t var, double value)
244 lmm_element_t elem = NULL;
248 xbt_assert0(var->cnsts_number < var->cnsts_size, "Too much constraints");
250 elem = &(var->cnsts[var->cnsts_number++]);
253 elem->constraint = cnst;
254 elem->variable = var;
257 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
259 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
261 make_constraint_active(sys, cnst);
262 lmm_update_modified_set(sys, cnst);
265 void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
266 lmm_variable_t var, double value)
271 for (i = 0; i < var->cnsts_number; i++)
272 if (var->cnsts[i].constraint == cnst)
275 if (i < var->cnsts_number) {
277 var->cnsts[i].value += value;
279 var->cnsts[i].value = MAX(var->cnsts[i].value, value);
280 lmm_update_modified_set(sys, cnst);
282 lmm_expand(sys, cnst, var, value);
285 void lmm_elem_set_value(lmm_system_t sys, lmm_constraint_t cnst,
286 lmm_variable_t var, double value)
290 for (i = 0; i < var->cnsts_number; i++)
291 if (var->cnsts[i].constraint == cnst)
294 if (i < var->cnsts_number) {
295 var->cnsts[i].value = value;
297 lmm_update_modified_set(sys, cnst);
302 XBT_INLINE lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
306 if (num < var->cnsts_number)
307 return (var->cnsts[num].constraint);
312 XBT_INLINE int lmm_get_number_of_cnst_from_var(lmm_system_t sys,
315 return (var->cnsts_number);
318 lmm_variable_t lmm_get_var_from_cnst(lmm_system_t sys,
319 lmm_constraint_t cnst,
320 lmm_element_t * elem)
323 *elem = xbt_swag_getFirst(&(cnst->element_set));
325 *elem = xbt_swag_getNext(*elem, cnst->element_set.offset);
327 return (*elem)->variable;
332 XBT_INLINE void *lmm_constraint_id(lmm_constraint_t cnst)
337 XBT_INLINE void *lmm_variable_id(lmm_variable_t var)
342 static XBT_INLINE void saturated_constraint_set_update(lmm_system_t sys,
347 lmm_constraint_t useless_cnst = NULL;
349 XBT_IN3("sys=%p, cnst=%p, min_usage=%f", sys, cnst, *min_usage);
350 if (cnst->usage <= 0) {
354 if (cnst->remaining <= 0) {
358 if ((*min_usage < 0) || (*min_usage > cnst->remaining / cnst->usage)) {
359 *min_usage = cnst->remaining / cnst->usage;
360 LOG3(xbt_log_priority_trace,
361 "min_usage=%f (cnst->remaining=%f, cnst->usage=%f)", *min_usage,
362 cnst->remaining, cnst->usage);
363 while ((useless_cnst =
364 xbt_swag_getFirst(&(sys->saturated_constraint_set))))
365 xbt_swag_remove(useless_cnst, &(sys->saturated_constraint_set));
367 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
368 } else if (*min_usage == cnst->remaining / cnst->usage) {
369 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
374 static XBT_INLINE void saturated_variable_set_update(lmm_system_t sys)
376 lmm_constraint_t cnst = NULL;
377 xbt_swag_t cnst_list = NULL;
378 lmm_element_t elem = NULL;
379 xbt_swag_t elem_list = NULL;
381 cnst_list = &(sys->saturated_constraint_set);
382 while ((cnst = xbt_swag_getFirst(cnst_list))) {
383 elem_list = &(cnst->active_element_set);
384 xbt_swag_foreach(elem, elem_list) {
385 if (elem->variable->weight <= 0)
387 if ((elem->value > 0))
388 xbt_swag_insert(elem->variable, &(sys->saturated_variable_set));
390 xbt_swag_remove(cnst, cnst_list);
394 void lmm_print(lmm_system_t sys)
396 lmm_constraint_t cnst = NULL;
397 lmm_element_t elem = NULL;
398 lmm_variable_t var = NULL;
399 xbt_swag_t cnst_list = NULL;
400 xbt_swag_t var_list = NULL;
401 xbt_swag_t elem_list = NULL;
402 char print_buf[1024];
403 char *trace_buf = xbt_malloc0(sizeof(char));
406 /* Printing Objective */
407 var_list = &(sys->variable_set);
408 sprintf(print_buf, "MAX-MIN ( ");
410 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
411 strcat(trace_buf, print_buf);
412 xbt_swag_foreach(var, var_list) {
413 sprintf(print_buf, "'%d'(%f) ", var->id_int, var->weight);
415 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
416 strcat(trace_buf, print_buf);
418 sprintf(print_buf, ")");
420 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
421 strcat(trace_buf, print_buf);
422 fprintf(stderr, "%s", trace_buf);
423 //DEBUG1("%20s", trace_buf); FIXME
424 trace_buf[0] = '\000';
426 DEBUG0("Constraints");
427 /* Printing Constraints */
428 cnst_list = &(sys->active_constraint_set);
429 xbt_swag_foreach(cnst, cnst_list) {
431 elem_list = &(cnst->element_set);
432 sprintf(print_buf, "\t");
434 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
435 strcat(trace_buf, print_buf);
436 sprintf(print_buf, "%s(",(cnst->shared)?"":"max");
438 xbt_realloc(trace_buf,
439 strlen(trace_buf) + strlen(print_buf) + 1);
440 strcat(trace_buf, print_buf);
441 xbt_swag_foreach(elem, elem_list) {
442 sprintf(print_buf, "%f.'%d'(%f) %s ", elem->value,
443 elem->variable->id_int, elem->variable->value,(cnst->shared)?"+":",");
445 xbt_realloc(trace_buf,
446 strlen(trace_buf) + strlen(print_buf) + 1);
447 strcat(trace_buf, print_buf);
449 sum += elem->value * elem->variable->value;
451 sum = MAX(sum,elem->value * elem->variable->value);
453 sprintf(print_buf, "0) <= %f ('%d')", cnst->bound, cnst->id_int);
455 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
456 strcat(trace_buf, print_buf);
459 sprintf(print_buf, " [MAX-Constraint]");
461 xbt_realloc(trace_buf,
462 strlen(trace_buf) + strlen(print_buf) + 1);
463 strcat(trace_buf, print_buf);
465 // DEBUG1("%s", trace_buf);
466 fprintf(stderr, "%s\n", trace_buf);
467 trace_buf[0] = '\000';
468 xbt_assert3(!double_positive(sum - cnst->bound),
469 "Incorrect value (%f is not smaller than %f): %g",
470 sum, cnst->bound, sum - cnst->bound);
474 /* Printing Result */
475 xbt_swag_foreach(var, var_list) {
476 if (var->bound > 0) {
477 DEBUG4("'%d'(%f) : %f (<=%f)", var->id_int, var->weight, var->value,
479 xbt_assert2(!double_positive(var->value - var->bound),
480 "Incorrect value (%f is not smaller than %f",
481 var->value, var->bound);
483 DEBUG3("'%d'(%f) : %f", var->id_int, var->weight, var->value);
490 void lmm_solve(lmm_system_t sys)
492 lmm_variable_t var = NULL;
493 lmm_constraint_t cnst = NULL;
494 lmm_element_t elem = NULL;
495 xbt_swag_t cnst_list = NULL;
496 xbt_swag_t var_list = NULL;
497 xbt_swag_t elem_list = NULL;
498 double min_usage = -1;
499 double min_bound = -1;
501 if (!(sys->modified))
504 XBT_IN1("(sys=%p)", sys);
507 * Compute Usage and store the variables that reach the maximum.
511 selective_update_active ? &(sys->modified_constraint_set) :
512 &(sys->active_constraint_set);
514 DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
515 /* Init: Only modified code portions */
516 xbt_swag_foreach(cnst, cnst_list) {
517 elem_list = &(cnst->element_set);
518 //DEBUG1("Variable set : %d", xbt_swag_size(elem_list));
519 xbt_swag_foreach(elem, elem_list) {
520 var = elem->variable;
521 if (var->weight <= 0.0)
527 xbt_swag_foreach(cnst, cnst_list) {
529 cnst->remaining = cnst->bound;
530 if (cnst->remaining == 0)
533 elem_list = &(cnst->element_set);
534 xbt_swag_foreach(elem, elem_list) {
535 /* 0-weighted elements (ie, sleep actions) are at the end of the swag and we don't want to consider them */
536 if (elem->variable->weight <= 0)
538 if ((elem->value > 0)) {
540 cnst->usage += elem->value / elem->variable->weight;
541 else if (cnst->usage < elem->value / elem->variable->weight)
542 cnst->usage = elem->value / elem->variable->weight;
544 make_elem_active(elem);
546 xbt_swag_insert((elem->variable)->id, keep_track);
550 DEBUG2("Constraint Usage '%d' : %f", cnst->id_int, cnst->usage);
551 /* Saturated constraints update */
552 saturated_constraint_set_update(sys, cnst, &min_usage);
554 saturated_variable_set_update(sys);
556 /* Saturated variables update */
559 /* Fix the variables that have to be */
560 var_list = &(sys->saturated_variable_set);
562 xbt_swag_foreach(var, var_list) {
563 if (var->weight <= 0.0)
565 /* First check if some of these variables have reach their upper
566 bound and update min_usage accordingly. */
568 ("var=%d, var->bound=%f, var->weight=%f, min_usage=%f, var->bound*var->weight=%f",
569 var->id_int, var->bound, var->weight, min_usage,
570 var->bound * var->weight);
571 if ((var->bound > 0) && (var->bound * var->weight < min_usage)) {
573 min_bound = var->bound;
575 min_bound = MIN(min_bound, var->bound);
576 DEBUG1("Updated min_bound=%f", min_bound);
581 while ((var = xbt_swag_getFirst(var_list))) {
585 var->value = min_usage / var->weight;
587 if (min_bound == var->bound)
588 var->value = var->bound;
590 xbt_swag_remove(var, var_list);
594 DEBUG5("Min usage: %f, Var(%d)->weight: %f, Var(%d)->value: %f ",
595 min_usage, var->id_int, var->weight, var->id_int, var->value);
600 for (i = 0; i < var->cnsts_number; i++) {
601 elem = &var->cnsts[i];
602 cnst = elem->constraint;
604 double_update(&(cnst->remaining), elem->value * var->value);
605 double_update(&(cnst->usage), elem->value / var->weight);
606 make_elem_inactive(elem);
607 } else { /* FIXME one day: We recompute usage.... :( */
609 make_elem_inactive(elem);
610 elem_list = &(cnst->element_set);
611 xbt_swag_foreach(elem, elem_list) {
612 if (elem->variable->weight <= 0)
614 if (elem->variable->value > 0)
616 if ((elem->value > 0)) {
618 MAX(cnst->usage, elem->value / elem->variable->weight);
619 DEBUG2("Constraint Usage %d : %f", cnst->id_int,
621 make_elem_active(elem);
626 xbt_swag_remove(var, var_list);
629 /* Find out which variables reach the maximum */
631 sys->selective_update_active ? &(sys->modified_constraint_set) :
632 &(sys->active_constraint_set);
635 xbt_swag_foreach(cnst, cnst_list) {
636 saturated_constraint_set_update(sys, cnst, &min_usage);
638 saturated_variable_set_update(sys);
640 } while (xbt_swag_size(&(sys->saturated_variable_set)));
643 if (sys->selective_update_active)
644 lmm_remove_all_modified_set(sys);
646 if (XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
652 /* Not a O(1) function */
654 void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
655 lmm_variable_t var, double value)
659 for (i = 0; i < var->cnsts_number; i++)
660 if (var->cnsts[i].constraint == cnst) {
661 var->cnsts[i].value = value;
663 lmm_update_modified_set(sys, cnst);
668 /** \brief Attribute the value bound to var->bound.
670 * \param sys the lmm_system_t
671 * \param var the lmm_variable_t
672 * \param bound the new bound to associate with var
674 * Makes var->bound equal to bound. Whenever this function is called
675 * a change is signed in the system. To
676 * avoid false system changing detection it is a good idea to test
677 * (bound != 0) before calling it.
680 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
688 for (i = 0; i < var->cnsts_number; i++)
689 lmm_update_modified_set(sys, var->cnsts[i].constraint);
694 void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
700 if (weight == var->weight)
702 XBT_IN3("(sys=%p, var=%p, weight=%f)", sys, var, weight);
704 var->weight = weight;
705 xbt_swag_remove(var, &(sys->variable_set));
707 xbt_swag_insert_at_head(var, &(sys->variable_set));
709 xbt_swag_insert_at_tail(var, &(sys->variable_set));
711 for (i = 0; i < var->cnsts_number; i++) {
712 elem = &var->cnsts[i];
713 xbt_swag_remove(elem, &(elem->constraint->element_set));
715 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
717 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
719 lmm_update_modified_set(sys, elem->constraint);
727 XBT_INLINE double lmm_get_variable_weight(lmm_variable_t var)
732 XBT_INLINE void lmm_update_constraint_bound(lmm_system_t sys,
733 lmm_constraint_t cnst,
737 lmm_update_modified_set(sys, cnst);
741 XBT_INLINE int lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst)
743 return xbt_swag_belongs(cnst, &(sys->active_constraint_set));
746 XBT_INLINE lmm_constraint_t lmm_get_first_active_constraint(lmm_system_t
749 return xbt_swag_getFirst(&(sys->active_constraint_set));
752 XBT_INLINE lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t
757 return xbt_swag_getNext(cnst, (sys->active_constraint_set).offset);
760 #ifdef HAVE_LATENCY_BOUND_TRACKING
761 XBT_INLINE int lmm_is_variable_limited_by_latency(lmm_variable_t var)
763 return (double_equals(var->bound, var->value));
768 /** \brief Update the constraint set propagating recursively to
769 * other constraints so the system should not be entirely computed.
771 * \param sys the lmm_system_t
772 * \param cnst the lmm_constraint_t affected by the change
774 * A recursive algorithm to optimize the system recalculation selecting only
775 * constraints that have changed. Each constraint change is propagated
776 * to the list of constraints for each variable.
778 static void lmm_update_modified_set(lmm_system_t sys,
779 lmm_constraint_t cnst)
781 lmm_element_t elem = NULL;
782 lmm_variable_t var = NULL;
783 xbt_swag_t elem_list = NULL;
786 /* return if selective update isn't active */
787 if (!sys->selective_update_active)
790 //DEBUG1("Updating modified constraint set with constraint %d", cnst->id_int);
792 if (xbt_swag_belongs(cnst, &(sys->modified_constraint_set)))
795 //DEBUG1("Inserting into modified constraint set %d", cnst->id_int);
797 /* add to modified set */
798 xbt_swag_insert(cnst, &(sys->modified_constraint_set));
800 elem_list = &(cnst->element_set);
801 xbt_swag_foreach(elem, elem_list) {
802 var = elem->variable;
803 for (i = 0; i < var->cnsts_number; i++)
804 if (cnst != var->cnsts[i].constraint) {
805 //DEBUG2("Updating modified %d calling for %d", cnst->id_int, var->cnsts[i].constraint->id_int);
806 lmm_update_modified_set(sys, var->cnsts[i].constraint);
811 /** \brief Remove all constraints of the modified_constraint_set.
813 * \param sys the lmm_system_t
815 static void lmm_remove_all_modified_set(lmm_system_t sys)
817 lmm_element_t elem = NULL;
818 lmm_element_t elem_next = NULL;
819 xbt_swag_t elem_list = NULL;
821 elem_list = &(sys->modified_constraint_set);
822 xbt_swag_foreach_safe(elem, elem_next, elem_list) {
823 xbt_swag_remove(elem, elem_list);