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);
23 lmm_system_t lmm_system_new(void)
25 lmm_system_t l = NULL;
27 s_lmm_constraint_t cnst;
29 l = xbt_new0(s_lmm_system_t, 1);
32 xbt_swag_init(&(l->variable_set),
33 xbt_swag_offset(var, variable_set_hookup));
34 xbt_swag_init(&(l->constraint_set),
35 xbt_swag_offset(cnst, constraint_set_hookup));
37 xbt_swag_init(&(l->active_constraint_set),
38 xbt_swag_offset(cnst, active_constraint_set_hookup));
40 xbt_swag_init(&(l->saturated_variable_set),
41 xbt_swag_offset(var, saturated_variable_set_hookup));
42 xbt_swag_init(&(l->saturated_constraint_set),
43 xbt_swag_offset(cnst, saturated_constraint_set_hookup));
45 l->variable_mallocator = xbt_mallocator_new(64,
46 lmm_variable_mallocator_new_f,
47 lmm_variable_mallocator_free_f,
48 lmm_variable_mallocator_reset_f);
53 void lmm_system_free(lmm_system_t sys)
55 lmm_variable_t var = NULL;
56 lmm_constraint_t cnst = NULL;
58 while ((var = extract_variable(sys)))
59 lmm_var_free(sys, var);
61 while ((cnst = extract_constraint(sys)))
62 lmm_cnst_free(sys, cnst);
64 xbt_mallocator_free(sys->variable_mallocator);
68 void lmm_variable_disable(lmm_system_t sys, lmm_variable_t var)
71 lmm_element_t elem = NULL;
73 XBT_IN2("(sys=%p, var=%p)", sys, var);
76 for (i = 0; i < var->cnsts_number; i++) {
77 elem = &var->cnsts[i];
78 xbt_swag_remove(elem, &(elem->constraint->element_set));
79 xbt_swag_remove(elem, &(elem->constraint->active_element_set));
80 if (!xbt_swag_size(&(elem->constraint->element_set)))
81 make_constraint_inactive(sys, elem->constraint);
83 var->cnsts_number = 0;
87 static void lmm_var_free(lmm_system_t sys, lmm_variable_t var)
90 lmm_variable_disable(sys, var);
92 xbt_mallocator_release(sys->variable_mallocator, var);
95 static void lmm_cnst_free(lmm_system_t sys, lmm_constraint_t cnst)
97 /* xbt_assert0(xbt_swag_size(&(cnst->element_set)), */
98 /* "This list should be empty!"); */
99 remove_active_constraint(sys, cnst);
103 lmm_constraint_t lmm_constraint_new(lmm_system_t sys, void *id,
106 lmm_constraint_t cnst = NULL;
107 s_lmm_element_t elem;
109 cnst = xbt_new0(s_lmm_constraint_t, 1);
111 xbt_swag_init(&(cnst->element_set),
112 xbt_swag_offset(elem, element_set_hookup));
113 xbt_swag_init(&(cnst->active_element_set),
114 xbt_swag_offset(elem, active_element_set_hookup));
116 cnst->bound = bound_value;
119 insert_constraint(sys, cnst);
124 void lmm_constraint_shared(lmm_constraint_t cnst)
129 int lmm_constraint_is_shared(lmm_constraint_t cnst)
131 return (cnst->shared);
134 void lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst)
136 remove_constraint(sys, cnst);
137 lmm_cnst_free(sys, cnst);
140 static void *lmm_variable_mallocator_new_f(void)
142 return xbt_new(s_lmm_variable_t, 1);
145 static void lmm_variable_mallocator_free_f(void *var)
150 static void lmm_variable_mallocator_reset_f(void *var)
152 /* memset to zero like calloc */
153 memset(var, 0, sizeof(s_lmm_variable_t));
156 lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
158 double bound, int number_of_constraints)
160 lmm_variable_t var = NULL;
163 XBT_IN5("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)",
164 sys, id, weight, bound, number_of_constraints);
166 var = xbt_mallocator_get(sys->variable_mallocator);
168 var->cnsts = xbt_new0(s_lmm_element_t, number_of_constraints);
169 for (i = 0; i < number_of_constraints; i++) {
170 /* Should be useless because of the
171 calloc but it seems to help valgrind... */
172 var->cnsts[i].element_set_hookup.next = NULL;
173 var->cnsts[i].element_set_hookup.prev = NULL;
174 var->cnsts[i].active_element_set_hookup.next = NULL;
175 var->cnsts[i].active_element_set_hookup.prev = NULL;
176 var->cnsts[i].constraint = NULL;
177 var->cnsts[i].variable = NULL;
178 var->cnsts[i].value = 0.0;
180 var->cnsts_size = number_of_constraints;
181 var->cnsts_number = 0; /* Should be useless because of the
182 calloc but it seems to help valgrind... */
183 var->weight = weight;
188 var->func_f = func_f_def;
189 var->func_fp = func_fp_def;
190 var->func_fpi = func_fpi_def;
193 xbt_swag_insert_at_head(var, &(sys->variable_set));
195 xbt_swag_insert_at_tail(var, &(sys->variable_set));
200 void lmm_variable_free(lmm_system_t sys, lmm_variable_t var)
202 remove_variable(sys, var);
203 lmm_var_free(sys, var);
206 double lmm_variable_getvalue(lmm_variable_t var)
211 double lmm_variable_getbound(lmm_variable_t var)
216 void lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
217 lmm_variable_t var, double value)
219 lmm_element_t elem = NULL;
223 xbt_assert0(var->cnsts_number < var->cnsts_size, "Too much constraints");
225 elem = &(var->cnsts[var->cnsts_number++]);
228 elem->constraint = cnst;
229 elem->variable = var;
232 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
234 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
236 make_constraint_active(sys, cnst);
239 void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
240 lmm_variable_t var, double value)
245 for (i = 0; i < var->cnsts_number; i++)
246 if (var->cnsts[i].constraint == cnst)
249 if (i < var->cnsts_number) {
251 var->cnsts[i].value += value;
253 var->cnsts[i].value = MAX(var->cnsts[i].value, value);
255 lmm_expand(sys, cnst, var, value);
258 void lmm_elem_set_value(lmm_system_t sys, lmm_constraint_t cnst,
259 lmm_variable_t var, double value)
263 for (i = 0; i < var->cnsts_number; i++)
264 if (var->cnsts[i].constraint == cnst)
267 if (i < var->cnsts_number) {
268 var->cnsts[i].value = value;
274 lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
275 lmm_variable_t var, int num)
277 if (num < var->cnsts_number)
278 return (var->cnsts[num].constraint);
283 int lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var)
285 return (var->cnsts_number);
288 lmm_variable_t lmm_get_var_from_cnst(lmm_system_t sys,
289 lmm_constraint_t cnst,
290 lmm_element_t * elem)
293 *elem = xbt_swag_getFirst(&(cnst->element_set));
295 *elem = xbt_swag_getNext(*elem, cnst->element_set.offset);
297 return (*elem)->variable;
302 void *lmm_constraint_id(lmm_constraint_t cnst)
307 void *lmm_variable_id(lmm_variable_t var)
312 static void saturated_constraint_set_update(lmm_system_t sys,
313 lmm_constraint_t cnst,
316 lmm_constraint_t useless_cnst = NULL;
318 XBT_IN3("sys=%p, cnst=%p, min_usage=%f", sys, cnst, *min_usage);
319 if (cnst->usage <= 0) {
323 if (cnst->remaining <= 0) {
327 if ((*min_usage < 0) || (*min_usage > cnst->remaining / cnst->usage)) {
328 *min_usage = cnst->remaining / cnst->usage;
329 LOG3(xbt_log_priority_trace,
330 "min_usage=%f (cnst->remaining=%f, cnst->usage=%f)", *min_usage,
331 cnst->remaining, cnst->usage);
332 while ((useless_cnst =
333 xbt_swag_getFirst(&(sys->saturated_constraint_set))))
334 xbt_swag_remove(useless_cnst, &(sys->saturated_constraint_set));
336 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
337 } else if (*min_usage == cnst->remaining / cnst->usage) {
338 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
343 static void saturated_variable_set_update(lmm_system_t sys)
345 lmm_constraint_t cnst = NULL;
346 xbt_swag_t cnst_list = NULL;
347 lmm_element_t elem = NULL;
348 xbt_swag_t elem_list = NULL;
350 cnst_list = &(sys->saturated_constraint_set);
351 while ((cnst = xbt_swag_getFirst(cnst_list))) {
352 elem_list = &(cnst->active_element_set);
353 xbt_swag_foreach(elem, elem_list) {
354 if (elem->variable->weight <= 0)
356 if ((elem->value > 0))
357 xbt_swag_insert(elem->variable, &(sys->saturated_variable_set));
359 xbt_swag_remove(cnst, cnst_list);
363 void lmm_print(lmm_system_t sys)
365 lmm_constraint_t cnst = NULL;
366 lmm_element_t elem = NULL;
367 lmm_variable_t var = NULL;
368 xbt_swag_t cnst_list = NULL;
369 xbt_swag_t var_list = NULL;
370 xbt_swag_t elem_list = NULL;
371 char print_buf[1024];
372 char *trace_buf = xbt_malloc0(sizeof(char));
375 /* Printing Objective */
376 var_list = &(sys->variable_set);
377 sprintf(print_buf, "MAX-MIN ( ");
379 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
380 strcat(trace_buf, print_buf);
381 xbt_swag_foreach(var, var_list) {
382 sprintf(print_buf, "'%p'(%f) ", var, var->weight);
384 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
385 strcat(trace_buf, print_buf);
387 sprintf(print_buf, ")");
389 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
390 strcat(trace_buf, print_buf);
391 DEBUG1("%s", trace_buf);
392 trace_buf[0] = '\000';
394 DEBUG0("Constraints");
395 /* Printing Constraints */
396 cnst_list = &(sys->active_constraint_set);
397 xbt_swag_foreach(cnst, cnst_list) {
399 elem_list = &(cnst->element_set);
400 sprintf(print_buf, "\t");
402 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
403 strcat(trace_buf, print_buf);
404 xbt_swag_foreach(elem, elem_list) {
405 sprintf(print_buf, "%f.'%p'(%f) + ", elem->value,
406 elem->variable, elem->variable->value);
408 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
409 strcat(trace_buf, print_buf);
410 sum += elem->value * elem->variable->value;
412 sprintf(print_buf, "0 <= %f ('%p')", cnst->bound, cnst);
414 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
415 strcat(trace_buf, print_buf);
418 sprintf(print_buf, " [MAX-Constraint]");
420 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
421 strcat(trace_buf, print_buf);
423 DEBUG1("%s", trace_buf);
424 trace_buf[0] = '\000';
425 xbt_assert3(!double_positive(sum - cnst->bound),
426 "Incorrect value (%f is not smaller than %f): %g",
427 sum, cnst->bound, sum - cnst->bound);
431 /* Printing Result */
432 xbt_swag_foreach(var, var_list) {
433 if (var->bound > 0) {
434 DEBUG4("'%p'(%f) : %f (<=%f)", var, var->weight, var->value,
436 xbt_assert2(!double_positive(var->value - var->bound),
437 "Incorrect value (%f is not smaller than %f",
438 var->value, var->bound);
440 DEBUG3("'%p'(%f) : %f", var, var->weight, var->value);
446 void lmm_solve(lmm_system_t sys)
448 lmm_variable_t var = NULL;
449 lmm_constraint_t cnst = NULL;
450 lmm_element_t elem = NULL;
451 xbt_swag_t cnst_list = NULL;
452 xbt_swag_t var_list = NULL;
453 xbt_swag_t elem_list = NULL;
454 double min_usage = -1;
455 double min_bound = -1;
457 if (!(sys->modified))
461 var_list = &(sys->variable_set);
462 DEBUG1("Variable set : %d", xbt_swag_size(var_list));
463 xbt_swag_foreach(var, var_list) {
466 if (var->weight <= 0.0)
469 for (i = 0; i < var->cnsts_number; i++) {
470 if (var->cnsts[i].value == 0.0)
473 if ((nb == var->cnsts_number) && (var->weight > 0.0))
478 * Compute Usage and store the variables that reach the maximum.
480 cnst_list = &(sys->active_constraint_set);
481 DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
482 xbt_swag_foreach(cnst, cnst_list) {
484 cnst->remaining = cnst->bound;
486 elem_list = &(cnst->element_set);
488 xbt_swag_foreach(elem, elem_list) {
489 if (elem->variable->weight <= 0)
491 if ((elem->value > 0)) {
493 cnst->usage += elem->value / elem->variable->weight;
494 else if (cnst->usage < elem->value / elem->variable->weight)
495 cnst->usage = elem->value / elem->variable->weight;
496 DEBUG2("Constraint Usage %p : %f", cnst, cnst->usage);
497 make_elem_active(elem);
500 /* Saturated constraints update */
501 saturated_constraint_set_update(sys, cnst, &min_usage);
503 saturated_variable_set_update(sys);
505 /* Saturated variables update */
508 /* Fix the variables that have to be */
509 var_list = &(sys->saturated_variable_set);
511 xbt_swag_foreach(var, var_list) {
512 if (var->weight <= 0.0)
514 /* First check if some of these variables have reach their upper
515 bound and update min_usage accordingly. */
517 ("var=%p, var->bound=%f, var->weight=%f, min_usage=%f, var->bound*var->weight=%f",
518 var, var->bound, var->weight, min_usage, var->bound * var->weight);
519 if ((var->bound > 0) && (var->bound * var->weight < min_usage)) {
521 min_bound = var->bound;
523 min_bound = MIN(min_bound, var->bound);
524 DEBUG1("Updated min_bound=%f", min_bound);
529 while ((var = xbt_swag_getFirst(var_list))) {
533 var->value = min_usage / var->weight;
535 if (min_bound == var->bound)
536 var->value = var->bound;
538 xbt_swag_remove(var, var_list);
542 DEBUG5("Min usage: %f, Var(%p)->weight: %f, Var(%p)->value: %f ",
543 min_usage, var, var->weight, var, var->value);
548 for (i = 0; i < var->cnsts_number; i++) {
549 elem = &var->cnsts[i];
550 cnst = elem->constraint;
552 double_update(&(cnst->remaining), elem->value * var->value);
553 double_update(&(cnst->usage), elem->value / var->weight);
554 make_elem_inactive(elem);
555 } else { /* FIXME one day: We recompute usage.... :( */
557 make_elem_inactive(elem);
558 xbt_swag_foreach(elem, elem_list) {
559 if (elem->variable->weight <= 0)
561 if (elem->variable->value > 0)
563 if ((elem->value > 0)) {
564 if (cnst->usage < elem->value / elem->variable->weight)
565 cnst->usage = elem->value / elem->variable->weight;
566 DEBUG2("Constraint Usage %p : %f", cnst, cnst->usage);
567 make_elem_active(elem);
572 xbt_swag_remove(var, var_list);
575 /* Find out which variables reach the maximum */
576 cnst_list = &(sys->active_constraint_set);
579 xbt_swag_foreach(cnst, cnst_list) {
580 saturated_constraint_set_update(sys, cnst, &min_usage);
582 saturated_variable_set_update(sys);
584 } while (xbt_swag_size(&(sys->saturated_variable_set)));
587 if (XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
592 /* Not a O(1) function */
594 void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
595 lmm_variable_t var, double value)
600 for (i = 0; i < var->cnsts_number; i++)
601 if (var->cnsts[i].constraint == cnst) {
602 var->cnsts[i].value = value;
607 /** \brief Attribute the value bound to var->bound.
609 * \param sys the lmm_system_t
610 * \param var the lmm_variable_t
611 * \param bound the new bound to associate with var
613 * Makes var->bound equal to bound. Whenever this function is called
614 * a change is signed in the system. To
615 * avoid false system changing detection it is a good idea to test
616 * (bound != 0) before calling it.
619 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
627 void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
633 if (weight == var->weight)
635 XBT_IN3("(sys=%p, var=%p, weight=%f)", sys, var, weight);
637 var->weight = weight;
638 xbt_swag_remove(var, &(sys->variable_set));
640 xbt_swag_insert_at_head(var, &(sys->variable_set));
642 xbt_swag_insert_at_tail(var, &(sys->variable_set));
644 for (i = 0; i < var->cnsts_number; i++) {
645 elem = &var->cnsts[i];
646 xbt_swag_remove(elem, &(elem->constraint->element_set));
648 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
650 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
658 double lmm_get_variable_weight(lmm_variable_t var)
663 void lmm_update_constraint_bound(lmm_system_t sys, lmm_constraint_t cnst,
670 int lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst)
672 return xbt_swag_belongs(cnst, &(sys->active_constraint_set));
675 lmm_constraint_t lmm_get_first_active_constraint(lmm_system_t sys)
677 return xbt_swag_getFirst(&(sys->active_constraint_set));
680 lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t sys,
681 lmm_constraint_t cnst)
683 return xbt_swag_getNext(cnst, (sys->active_constraint_set).offset);