3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "xbt/sysdep.h"
11 #include "xbt/mallocator.h"
12 #include "maxmin_private.h"
14 #include <stdio.h> /* sprintf */
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_maxmin, surf,
17 "Logging specific to SURF (maxmin)");
19 static void *lmm_variable_mallocator_new_f(void);
20 static void lmm_variable_mallocator_free_f(void *var);
21 static void lmm_variable_mallocator_reset_f(void *var);
22 static void lmm_update_modified_set(lmm_system_t sys, lmm_constraint_t cnst);
23 static void lmm_remove_all_modified_set(lmm_system_t sys);
24 int sg_maxmin_selective_update = 1;
25 static int Global_debug_id = 1;
26 static int Global_const_debug_id = 1;
27 lmm_system_t lmm_system_new(void)
29 lmm_system_t l = NULL;
31 s_lmm_constraint_t cnst;
33 l = xbt_new0(s_lmm_system_t, 1);
36 l->selective_update_active = sg_maxmin_selective_update;
38 DEBUG1("Setting selective_update_active flag to %d\n",
39 l->selective_update_active);
41 xbt_swag_init(&(l->variable_set),
42 xbt_swag_offset(var, variable_set_hookup));
43 xbt_swag_init(&(l->constraint_set),
44 xbt_swag_offset(cnst, constraint_set_hookup));
46 xbt_swag_init(&(l->active_constraint_set),
47 xbt_swag_offset(cnst, active_constraint_set_hookup));
49 xbt_swag_init(&(l->modified_constraint_set),
50 xbt_swag_offset(cnst, modified_constraint_set_hookup));
51 xbt_swag_init(&(l->saturated_variable_set),
52 xbt_swag_offset(var, saturated_variable_set_hookup));
53 xbt_swag_init(&(l->saturated_constraint_set),
54 xbt_swag_offset(cnst, saturated_constraint_set_hookup));
56 l->variable_mallocator = xbt_mallocator_new(64,
57 lmm_variable_mallocator_new_f,
58 lmm_variable_mallocator_free_f,
59 lmm_variable_mallocator_reset_f);
64 void lmm_system_free(lmm_system_t sys)
66 lmm_variable_t var = NULL;
67 lmm_constraint_t cnst = NULL;
69 while ((var = extract_variable(sys)))
70 lmm_var_free(sys, var);
72 while ((cnst = extract_constraint(sys)))
73 lmm_cnst_free(sys, cnst);
75 xbt_mallocator_free(sys->variable_mallocator);
79 XBT_INLINE void lmm_variable_disable(lmm_system_t sys, lmm_variable_t var)
82 lmm_element_t elem = NULL;
84 XBT_IN2("(sys=%p, var=%p)", sys, var);
87 for (i = 0; i < var->cnsts_number; i++) {
88 elem = &var->cnsts[i];
89 xbt_swag_remove(elem, &(elem->constraint->element_set));
90 xbt_swag_remove(elem, &(elem->constraint->active_element_set));
91 if (!xbt_swag_size(&(elem->constraint->element_set)))
92 make_constraint_inactive(sys, elem->constraint);
94 lmm_update_modified_set(sys, elem->constraint);
96 var->cnsts_number = 0;
100 static void lmm_var_free(lmm_system_t sys, lmm_variable_t var)
103 lmm_variable_disable(sys, var);
105 xbt_mallocator_release(sys->variable_mallocator, var);
108 static XBT_INLINE void lmm_cnst_free(lmm_system_t sys, lmm_constraint_t cnst)
110 /* xbt_assert0(xbt_swag_size(&(cnst->element_set)), */
111 /* "This list should be empty!"); */
112 remove_active_constraint(sys, cnst);
116 lmm_constraint_t lmm_constraint_new(lmm_system_t sys, void *id,
119 lmm_constraint_t cnst = NULL;
120 s_lmm_element_t elem;
122 cnst = xbt_new0(s_lmm_constraint_t, 1);
124 cnst->id_int = Global_const_debug_id++;
125 xbt_swag_init(&(cnst->element_set),
126 xbt_swag_offset(elem, element_set_hookup));
127 xbt_swag_init(&(cnst->active_element_set),
128 xbt_swag_offset(elem, active_element_set_hookup));
130 cnst->bound = bound_value;
133 insert_constraint(sys, cnst);
138 XBT_INLINE void lmm_constraint_shared(lmm_constraint_t cnst)
143 XBT_INLINE int lmm_constraint_is_shared(lmm_constraint_t cnst)
145 return (cnst->shared);
148 XBT_INLINE void lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst)
150 remove_constraint(sys, cnst);
151 lmm_cnst_free(sys, cnst);
154 static void *lmm_variable_mallocator_new_f(void)
156 return xbt_new(s_lmm_variable_t, 1);
159 static void lmm_variable_mallocator_free_f(void *var)
164 static void lmm_variable_mallocator_reset_f(void *var)
166 /* memset to zero like calloc */
167 memset(var, 0, sizeof(s_lmm_variable_t));
170 lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
172 double bound, int number_of_constraints)
174 lmm_variable_t var = NULL;
177 XBT_IN5("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)",
178 sys, id, weight, bound, number_of_constraints);
180 var = xbt_mallocator_get(sys->variable_mallocator);
182 var->id_int = Global_debug_id++;
183 var->cnsts = xbt_new0(s_lmm_element_t, number_of_constraints);
184 for (i = 0; i < number_of_constraints; i++) {
185 /* Should be useless because of the
186 calloc but it seems to help valgrind... */
187 var->cnsts[i].element_set_hookup.next = NULL;
188 var->cnsts[i].element_set_hookup.prev = NULL;
189 var->cnsts[i].active_element_set_hookup.next = NULL;
190 var->cnsts[i].active_element_set_hookup.prev = NULL;
191 var->cnsts[i].constraint = NULL;
192 var->cnsts[i].variable = NULL;
193 var->cnsts[i].value = 0.0;
195 var->cnsts_size = number_of_constraints;
196 var->cnsts_number = 0; /* Should be useless because of the
197 calloc but it seems to help valgrind... */
198 var->weight = weight;
203 var->func_f = func_f_def;
204 var->func_fp = func_fp_def;
205 var->func_fpi = func_fpi_def;
208 xbt_swag_insert_at_head(var, &(sys->variable_set));
210 xbt_swag_insert_at_tail(var, &(sys->variable_set));
215 void lmm_variable_free(lmm_system_t sys, lmm_variable_t var)
217 remove_variable(sys, var);
218 lmm_var_free(sys, var);
221 XBT_INLINE double lmm_variable_getvalue(lmm_variable_t var)
226 XBT_INLINE double lmm_variable_getbound(lmm_variable_t var)
231 void lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
232 lmm_variable_t var, double value)
234 lmm_element_t elem = NULL;
238 xbt_assert0(var->cnsts_number < var->cnsts_size, "Too much constraints");
240 elem = &(var->cnsts[var->cnsts_number++]);
243 elem->constraint = cnst;
244 elem->variable = var;
247 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
249 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
251 make_constraint_active(sys, cnst);
252 lmm_update_modified_set(sys, cnst);
255 void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
256 lmm_variable_t var, double value)
261 for (i = 0; i < var->cnsts_number; i++)
262 if (var->cnsts[i].constraint == cnst)
265 if (i < var->cnsts_number) {
267 var->cnsts[i].value += value;
269 var->cnsts[i].value = MAX(var->cnsts[i].value, value);
270 lmm_update_modified_set(sys, cnst);
272 lmm_expand(sys, cnst, var, value);
275 void lmm_elem_set_value(lmm_system_t sys, lmm_constraint_t cnst,
276 lmm_variable_t var, double value)
280 for (i = 0; i < var->cnsts_number; i++)
281 if (var->cnsts[i].constraint == cnst)
284 if (i < var->cnsts_number) {
285 var->cnsts[i].value = value;
287 lmm_update_modified_set(sys, cnst);
292 XBT_INLINE lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
293 lmm_variable_t var, int num)
295 if (num < var->cnsts_number)
296 return (var->cnsts[num].constraint);
301 XBT_INLINE int lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var)
303 return (var->cnsts_number);
306 lmm_variable_t lmm_get_var_from_cnst(lmm_system_t sys,
307 lmm_constraint_t cnst,
308 lmm_element_t * elem)
311 *elem = xbt_swag_getFirst(&(cnst->element_set));
313 *elem = xbt_swag_getNext(*elem, cnst->element_set.offset);
315 return (*elem)->variable;
320 XBT_INLINE void *lmm_constraint_id(lmm_constraint_t cnst)
325 XBT_INLINE void *lmm_variable_id(lmm_variable_t var)
330 static XBT_INLINE void saturated_constraint_set_update(lmm_system_t sys,
331 lmm_constraint_t cnst,
334 lmm_constraint_t useless_cnst = NULL;
336 XBT_IN3("sys=%p, cnst=%p, min_usage=%f", sys, cnst, *min_usage);
337 if (cnst->usage <= 0) {
341 if (cnst->remaining <= 0) {
345 if ((*min_usage < 0) || (*min_usage > cnst->remaining / cnst->usage)) {
346 *min_usage = cnst->remaining / cnst->usage;
347 LOG3(xbt_log_priority_trace,
348 "min_usage=%f (cnst->remaining=%f, cnst->usage=%f)", *min_usage,
349 cnst->remaining, cnst->usage);
350 while ((useless_cnst =
351 xbt_swag_getFirst(&(sys->saturated_constraint_set))))
352 xbt_swag_remove(useless_cnst, &(sys->saturated_constraint_set));
354 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
355 } else if (*min_usage == cnst->remaining / cnst->usage) {
356 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
361 static XBT_INLINE void saturated_variable_set_update(lmm_system_t sys)
363 lmm_constraint_t cnst = NULL;
364 xbt_swag_t cnst_list = NULL;
365 lmm_element_t elem = NULL;
366 xbt_swag_t elem_list = NULL;
368 cnst_list = &(sys->saturated_constraint_set);
369 while ((cnst = xbt_swag_getFirst(cnst_list))) {
370 elem_list = &(cnst->active_element_set);
371 xbt_swag_foreach(elem, elem_list) {
372 if (elem->variable->weight <= 0)
374 if ((elem->value > 0))
375 xbt_swag_insert(elem->variable, &(sys->saturated_variable_set));
377 xbt_swag_remove(cnst, cnst_list);
381 void lmm_print(lmm_system_t sys)
383 lmm_constraint_t cnst = NULL;
384 lmm_element_t elem = NULL;
385 lmm_variable_t var = NULL;
386 xbt_swag_t cnst_list = NULL;
387 xbt_swag_t var_list = NULL;
388 xbt_swag_t elem_list = NULL;
389 char print_buf[1024];
390 char *trace_buf = xbt_malloc0(sizeof(char));
393 /* Printing Objective */
394 var_list = &(sys->variable_set);
395 sprintf(print_buf, "MAX-MIN ( ");
397 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
398 strcat(trace_buf, print_buf);
399 xbt_swag_foreach(var, var_list) {
400 sprintf(print_buf, "'%d'(%f) ", var->id_int, var->weight);
402 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
403 strcat(trace_buf, print_buf);
405 sprintf(print_buf, ")");
407 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
408 strcat(trace_buf, print_buf);
409 fprintf(stderr, "%s", trace_buf);
410 //DEBUG1("%20s", trace_buf); FIXME
411 trace_buf[0] = '\000';
413 DEBUG0("Constraints");
414 /* Printing Constraints */
415 cnst_list = &(sys->active_constraint_set);
416 xbt_swag_foreach(cnst, cnst_list) {
418 elem_list = &(cnst->element_set);
419 sprintf(print_buf, "\t");
421 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
422 strcat(trace_buf, print_buf);
423 xbt_swag_foreach(elem, elem_list) {
424 sprintf(print_buf, "%f.'%d'(%f) + ", elem->value,
425 elem->variable->id_int, elem->variable->value);
427 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
428 strcat(trace_buf, print_buf);
429 sum += elem->value * elem->variable->value;
431 sprintf(print_buf, "0 <= %f ('%d')", cnst->bound, cnst->id_int);
433 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
434 strcat(trace_buf, print_buf);
437 sprintf(print_buf, " [MAX-Constraint]");
439 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
440 strcat(trace_buf, print_buf);
442 // DEBUG1("%s", trace_buf);
443 fprintf(stderr, "%s", trace_buf);
444 trace_buf[0] = '\000';
445 xbt_assert3(!double_positive(sum - cnst->bound),
446 "Incorrect value (%f is not smaller than %f): %g",
447 sum, cnst->bound, sum - cnst->bound);
451 /* Printing Result */
452 xbt_swag_foreach(var, var_list) {
453 if (var->bound > 0) {
454 DEBUG4("'%d'(%f) : %f (<=%f)", var->id_int, var->weight, var->value,
456 xbt_assert2(!double_positive(var->value - var->bound),
457 "Incorrect value (%f is not smaller than %f",
458 var->value, var->bound);
460 DEBUG3("'%d'(%f) : %f", var->id_int, var->weight, var->value);
467 void lmm_solve(lmm_system_t sys)
469 lmm_variable_t var = NULL;
470 lmm_constraint_t cnst = NULL;
471 lmm_element_t elem = NULL;
472 xbt_swag_t cnst_list = NULL;
473 xbt_swag_t var_list = NULL;
474 xbt_swag_t elem_list = NULL;
475 double min_usage = -1;
476 double min_bound = -1;
478 if (!(sys->modified))
482 * Compute Usage and store the variables that reach the maximum.
484 cnst_list = sys->selective_update_active ? &(sys->modified_constraint_set) :
485 &(sys->active_constraint_set);
487 DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
488 /* Init: Only modified code portions */
489 xbt_swag_foreach(cnst, cnst_list) {
490 elem_list = &(cnst->element_set);
491 //DEBUG1("Variable set : %d", xbt_swag_size(elem_list));
492 xbt_swag_foreach(elem, elem_list) {
493 var = elem->variable;
494 if (var->weight <= 0.0)
500 DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
501 xbt_swag_foreach(cnst, cnst_list) {
503 cnst->remaining = cnst->bound;
505 elem_list = &(cnst->element_set);
506 xbt_swag_foreach(elem, elem_list) {
507 /* 0-weighted elements (ie, sleep actions) are at the end of the swag and we don't want to consider them */
508 if (elem->variable->weight <= 0)
510 if ((elem->value > 0)) {
512 cnst->usage += elem->value / elem->variable->weight;
513 else if (cnst->usage < elem->value / elem->variable->weight)
514 cnst->usage = elem->value / elem->variable->weight;
516 make_elem_active(elem);
519 DEBUG2("Constraint Usage %d : %f", cnst->id_int, cnst->usage);
520 /* Saturated constraints update */
521 saturated_constraint_set_update(sys, cnst, &min_usage);
523 saturated_variable_set_update(sys);
525 /* Saturated variables update */
528 /* Fix the variables that have to be */
529 var_list = &(sys->saturated_variable_set);
531 xbt_swag_foreach(var, var_list) {
532 if (var->weight <= 0.0)
534 /* First check if some of these variables have reach their upper
535 bound and update min_usage accordingly. */
537 ("var=%d, var->bound=%f, var->weight=%f, min_usage=%f, var->bound*var->weight=%f",
538 var->id_int, var->bound, var->weight, min_usage,
539 var->bound * var->weight);
540 if ((var->bound > 0) && (var->bound * var->weight < min_usage)) {
542 min_bound = var->bound;
544 min_bound = MIN(min_bound, var->bound);
545 DEBUG1("Updated min_bound=%f", min_bound);
550 while ((var = xbt_swag_getFirst(var_list))) {
554 var->value = min_usage / var->weight;
556 if (min_bound == var->bound)
557 var->value = var->bound;
559 xbt_swag_remove(var, var_list);
563 DEBUG5("Min usage: %f, Var(%d)->weight: %f, Var(%d)->value: %f ",
564 min_usage, var->id_int, var->weight, var->id_int, var->value);
569 for (i = 0; i < var->cnsts_number; i++) {
570 elem = &var->cnsts[i];
571 cnst = elem->constraint;
573 double_update(&(cnst->remaining), elem->value * var->value);
574 double_update(&(cnst->usage), elem->value / var->weight);
575 make_elem_inactive(elem);
576 } else { /* FIXME one day: We recompute usage.... :( */
578 make_elem_inactive(elem);
579 elem_list = &(cnst->element_set);
580 xbt_swag_foreach(elem, elem_list) {
581 if (elem->variable->weight <= 0)
583 if (elem->variable->value > 0)
585 if ((elem->value > 0)) {
586 cnst->usage=MAX(cnst->usage,elem->value / elem->variable->weight);
587 DEBUG2("Constraint Usage %d : %f", cnst->id_int, cnst->usage);
588 make_elem_active(elem);
593 xbt_swag_remove(var, var_list);
596 /* Find out which variables reach the maximum */
598 sys->selective_update_active ? &(sys->modified_constraint_set) :
599 &(sys->active_constraint_set);
602 xbt_swag_foreach(cnst, cnst_list) {
603 saturated_constraint_set_update(sys, cnst, &min_usage);
605 saturated_variable_set_update(sys);
607 } while (xbt_swag_size(&(sys->saturated_variable_set)));
610 if (sys->selective_update_active)
611 lmm_remove_all_modified_set(sys);
613 if (XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
618 /* Not a O(1) function */
620 void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
621 lmm_variable_t var, double value)
625 for (i = 0; i < var->cnsts_number; i++)
626 if (var->cnsts[i].constraint == cnst) {
627 var->cnsts[i].value = value;
629 lmm_update_modified_set(sys, cnst);
634 /** \brief Attribute the value bound to var->bound.
636 * \param sys the lmm_system_t
637 * \param var the lmm_variable_t
638 * \param bound the new bound to associate with var
640 * Makes var->bound equal to bound. Whenever this function is called
641 * a change is signed in the system. To
642 * avoid false system changing detection it is a good idea to test
643 * (bound != 0) before calling it.
646 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
654 for (i = 0; i < var->cnsts_number; i++)
655 lmm_update_modified_set(sys, var->cnsts[i].constraint);
660 void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
666 if (weight == var->weight)
668 XBT_IN3("(sys=%p, var=%p, weight=%f)", sys, var, weight);
670 var->weight = weight;
671 xbt_swag_remove(var, &(sys->variable_set));
673 xbt_swag_insert_at_head(var, &(sys->variable_set));
675 xbt_swag_insert_at_tail(var, &(sys->variable_set));
677 for (i = 0; i < var->cnsts_number; i++) {
678 elem = &var->cnsts[i];
679 xbt_swag_remove(elem, &(elem->constraint->element_set));
681 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
683 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
685 lmm_update_modified_set(sys, elem->constraint);
693 XBT_INLINE double lmm_get_variable_weight(lmm_variable_t var)
698 XBT_INLINE void lmm_update_constraint_bound(lmm_system_t sys, lmm_constraint_t cnst,
702 lmm_update_modified_set(sys, cnst);
706 XBT_INLINE int lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst)
708 return xbt_swag_belongs(cnst, &(sys->active_constraint_set));
711 XBT_INLINE lmm_constraint_t lmm_get_first_active_constraint(lmm_system_t sys)
713 return xbt_swag_getFirst(&(sys->active_constraint_set));
716 XBT_INLINE lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t sys,
717 lmm_constraint_t cnst)
719 return xbt_swag_getNext(cnst, (sys->active_constraint_set).offset);
722 /** \brief Update the constraint set propagating recursively to
723 * other constraints so the system should not be entirely computed.
725 * \param sys the lmm_system_t
726 * \param cnst the lmm_constraint_t affected by the change
728 * A recursive algorithm to optimize the system recalculation selecting only
729 * constraints that have changed. Each constraint change is propagated
730 * to the list of constraints for each variable.
732 static void lmm_update_modified_set(lmm_system_t sys, lmm_constraint_t cnst)
734 lmm_element_t elem = NULL;
735 lmm_variable_t var = NULL;
736 xbt_swag_t elem_list = NULL;
739 /* return if selective update isn't active */
740 if (!sys->selective_update_active)
743 //DEBUG1("Updating modified constraint set with constraint %d", cnst->id_int);
745 if (xbt_swag_belongs(cnst, &(sys->modified_constraint_set)))
748 //DEBUG1("Inserting into modified constraint set %d", cnst->id_int);
750 /* add to modified set */
751 xbt_swag_insert(cnst, &(sys->modified_constraint_set));
753 elem_list = &(cnst->element_set);
754 xbt_swag_foreach(elem, elem_list) {
755 var = elem->variable;
756 for (i = 0; i < var->cnsts_number; i++)
757 if (cnst != var->cnsts[i].constraint) {
758 //DEBUG2("Updating modified %d calling for %d", cnst->id_int, var->cnsts[i].constraint->id_int);
759 lmm_update_modified_set(sys, var->cnsts[i].constraint);
764 /** \brief Remove all constraints of the modified_constraint_set.
766 * \param sys the lmm_system_t
768 static void lmm_remove_all_modified_set(lmm_system_t sys)
770 lmm_element_t elem = NULL;
771 lmm_element_t elem_next = NULL;
772 xbt_swag_t elem_list = NULL;
774 elem_list = &(sys->modified_constraint_set);
775 xbt_swag_foreach_safe(elem, elem_next, elem_list) {
776 xbt_swag_remove(elem, elem_list);