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 void lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst)
131 remove_constraint(sys, cnst);
132 lmm_cnst_free(sys, cnst);
135 static void *lmm_variable_mallocator_new_f(void)
137 return xbt_new(s_lmm_variable_t, 1);
140 static void lmm_variable_mallocator_free_f(void *var)
145 static void lmm_variable_mallocator_reset_f(void *var)
147 /* memset to zero like calloc */
148 memset(var, 0, sizeof(s_lmm_variable_t));
151 lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
153 double bound, int number_of_constraints)
155 lmm_variable_t var = NULL;
158 XBT_IN5("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)",
159 sys, id, weight, bound, number_of_constraints);
161 var = xbt_mallocator_get(sys->variable_mallocator);
163 var->cnsts = xbt_new0(s_lmm_element_t, number_of_constraints);
164 for (i = 0; i < number_of_constraints; i++) {
165 /* Should be useless because of the
166 calloc but it seems to help valgrind... */
167 var->cnsts[i].element_set_hookup.next = NULL;
168 var->cnsts[i].element_set_hookup.prev = NULL;
169 var->cnsts[i].active_element_set_hookup.next = NULL;
170 var->cnsts[i].active_element_set_hookup.prev = NULL;
171 var->cnsts[i].constraint = NULL;
172 var->cnsts[i].variable = NULL;
173 var->cnsts[i].value = 0.0;
175 var->cnsts_size = number_of_constraints;
176 var->cnsts_number = 0; /* Should be useless because of the
177 calloc but it seems to help valgrind... */
178 var->weight = weight;
183 var->func_f = func_f_def;
184 var->func_fp = func_fp_def;
185 var->func_fpi = func_fpi_def;
188 xbt_swag_insert_at_head(var, &(sys->variable_set));
190 xbt_swag_insert_at_tail(var, &(sys->variable_set));
195 void lmm_variable_free(lmm_system_t sys, lmm_variable_t var)
197 remove_variable(sys, var);
198 lmm_var_free(sys, var);
201 double lmm_variable_getvalue(lmm_variable_t var)
206 void lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
207 lmm_variable_t var, double value)
209 lmm_element_t elem = NULL;
213 xbt_assert0(var->cnsts_number < var->cnsts_size, "Too much constraints");
215 elem = &(var->cnsts[var->cnsts_number++]);
218 elem->constraint = cnst;
219 elem->variable = var;
222 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
224 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
226 make_constraint_active(sys, cnst);
229 void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
230 lmm_variable_t var, double value)
235 for (i = 0; i < var->cnsts_number; i++)
236 if (var->cnsts[i].constraint == cnst)
239 if (i < var->cnsts_number)
240 var->cnsts[i].value += value;
242 lmm_expand(sys, cnst, var, value);
245 void lmm_elem_set_value(lmm_system_t sys, lmm_constraint_t cnst,
246 lmm_variable_t var, double value)
250 for (i = 0; i < var->cnsts_number; i++)
251 if (var->cnsts[i].constraint == cnst)
254 if (i < var->cnsts_number) {
255 var->cnsts[i].value = value;
261 lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
262 lmm_variable_t var, int num)
264 if (num < var->cnsts_number)
265 return (var->cnsts[num].constraint);
270 int lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var)
272 return (var->cnsts_number);
275 lmm_variable_t lmm_get_var_from_cnst(lmm_system_t sys,
276 lmm_constraint_t cnst,
277 lmm_variable_t * var)
280 xbt_swag_getFirst(&(cnst->element_set));
282 *var = xbt_swag_getNext(*var, cnst->element_set.offset);
286 void *lmm_constraint_id(lmm_constraint_t cnst)
291 void *lmm_variable_id(lmm_variable_t var)
296 static void saturated_constraint_set_update(lmm_system_t sys,
297 lmm_constraint_t cnst,
300 lmm_constraint_t useless_cnst = NULL;
302 XBT_IN3("sys=%p, cnst=%p, min_usage=%f", sys, cnst, *min_usage);
303 if (cnst->usage <= 0) {
307 if (cnst->remaining <= 0) {
311 if ((*min_usage < 0) || (*min_usage > cnst->remaining / cnst->usage)) {
312 *min_usage = cnst->remaining / cnst->usage;
313 LOG3(xbt_log_priority_trace,
314 "min_usage=%f (cnst->remaining=%f, cnst->usage=%f)", *min_usage,
315 cnst->remaining, cnst->usage);
316 while ((useless_cnst =
317 xbt_swag_getFirst(&(sys->saturated_constraint_set))))
318 xbt_swag_remove(useless_cnst, &(sys->saturated_constraint_set));
320 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
321 } else if (*min_usage == cnst->remaining / cnst->usage) {
322 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
327 static void saturated_variable_set_update(lmm_system_t sys)
329 lmm_constraint_t cnst = NULL;
330 xbt_swag_t cnst_list = NULL;
331 lmm_element_t elem = NULL;
332 xbt_swag_t elem_list = NULL;
334 cnst_list = &(sys->saturated_constraint_set);
335 while ((cnst = xbt_swag_getFirst(cnst_list))) {
336 elem_list = &(cnst->active_element_set);
337 xbt_swag_foreach(elem, elem_list) {
338 if (elem->variable->weight <= 0)
340 if ((elem->value > 0))
341 xbt_swag_insert(elem->variable, &(sys->saturated_variable_set));
343 xbt_swag_remove(cnst, cnst_list);
347 void lmm_print(lmm_system_t sys)
349 lmm_constraint_t cnst = NULL;
350 lmm_element_t elem = NULL;
351 lmm_variable_t var = NULL;
352 xbt_swag_t cnst_list = NULL;
353 xbt_swag_t var_list = NULL;
354 xbt_swag_t elem_list = NULL;
355 char print_buf[1024];
356 char *trace_buf = xbt_malloc0(sizeof(char));
359 /* Printing Objective */
360 var_list = &(sys->variable_set);
361 sprintf(print_buf, "MAX-MIN ( ");
363 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
364 strcat(trace_buf, print_buf);
365 xbt_swag_foreach(var, var_list) {
366 sprintf(print_buf, "'%p'(%f) ", var, var->weight);
368 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
369 strcat(trace_buf, print_buf);
371 sprintf(print_buf, ")");
373 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
374 strcat(trace_buf, print_buf);
375 DEBUG1("%s", trace_buf);
376 trace_buf[0] = '\000';
378 DEBUG0("Constraints");
379 /* Printing Constraints */
380 cnst_list = &(sys->active_constraint_set);
381 xbt_swag_foreach(cnst, cnst_list) {
383 elem_list = &(cnst->element_set);
384 sprintf(print_buf, "\t");
386 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
387 strcat(trace_buf, print_buf);
388 xbt_swag_foreach(elem, elem_list) {
389 sprintf(print_buf, "%f.'%p'(%f) + ", elem->value,
390 elem->variable, elem->variable->value);
392 xbt_realloc(trace_buf,
393 strlen(trace_buf) + strlen(print_buf) + 1);
394 strcat(trace_buf, print_buf);
395 sum += elem->value * elem->variable->value;
397 sprintf(print_buf, "0 <= %f ('%p')", cnst->bound, cnst);
399 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
400 strcat(trace_buf, print_buf);
403 sprintf(print_buf, " [MAX-Constraint]");
405 xbt_realloc(trace_buf,
406 strlen(trace_buf) + strlen(print_buf) + 1);
407 strcat(trace_buf, print_buf);
409 DEBUG1("%s", trace_buf);
410 trace_buf[0] = '\000';
411 if (double_positive(sum - cnst->bound))
412 WARN3("Incorrect value (%f is not smaller than %f): %g",
413 sum, cnst->bound, sum - cnst->bound);
417 /* Printing Result */
418 xbt_swag_foreach(var, var_list) {
419 if (var->bound > 0) {
420 DEBUG4("'%p'(%f) : %f (<=%f)", var, var->weight, var->value,
422 if (double_positive(var->value - var->bound))
423 WARN2("Incorrect value (%f is not smaller than %f",
424 var->value, var->bound);
426 DEBUG3("'%p'(%f) : %f", var, var->weight, var->value);
432 void lmm_solve(lmm_system_t sys)
434 lmm_variable_t var = NULL;
435 lmm_constraint_t cnst = NULL;
436 lmm_element_t elem = NULL;
437 xbt_swag_t cnst_list = NULL;
438 xbt_swag_t var_list = NULL;
439 xbt_swag_t elem_list = NULL;
440 double min_usage = -1;
442 if (!(sys->modified))
446 var_list = &(sys->variable_set);
447 DEBUG1("Variable set : %d", xbt_swag_size(var_list));
448 xbt_swag_foreach(var, var_list) {
452 for (i = 0; i < var->cnsts_number; i++) {
453 if(var->cnsts[i].value==0.0) nb++;
455 if((nb==var->cnsts_number) && (var->weight>0.0))
460 * Compute Usage and store the variables that reach the maximum.
462 cnst_list = &(sys->active_constraint_set);
463 DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
464 xbt_swag_foreach(cnst, cnst_list) {
466 cnst->remaining = cnst->bound;
468 elem_list = &(cnst->element_set);
470 xbt_swag_foreach(elem, elem_list) {
471 if (elem->variable->weight <= 0)
473 if ((elem->value > 0)) {
475 cnst->usage += elem->value / elem->variable->weight;
476 else if (cnst->usage < elem->value / elem->variable->weight)
477 cnst->usage = elem->value / elem->variable->weight;
478 DEBUG2("Constraint Usage %p : %f", cnst, cnst->usage);
479 make_elem_active(elem);
482 /* Saturated constraints update */
483 saturated_constraint_set_update(sys, cnst, &min_usage);
485 saturated_variable_set_update(sys);
487 /* Saturated variables update */
490 /* Fix the variables that have to be */
491 var_list = &(sys->saturated_variable_set);
493 xbt_swag_foreach(var, var_list) {
494 /* First check if some of these variables have reach their upper
495 bound and update min_usage accordingly. */
497 ("var=%p, var->bound=%f, var->weight=%f, min_usage=%f, var->bound*var->weight=%f",
498 var, var->bound, var->weight, min_usage,
499 var->bound * var->weight);
500 if ((var->bound > 0) && (var->bound * var->weight < min_usage)) {
501 min_usage = var->bound * var->weight;
502 DEBUG1("Updated min_usage=%f", min_usage);
507 while ((var = xbt_swag_getFirst(var_list))) {
510 var->value = min_usage / var->weight;
511 DEBUG5("Min usage: %f, Var(%p)->weight: %f, Var(%p)->value: %f ",
512 min_usage, var, var->weight, var, var->value);
517 for (i = 0; i < var->cnsts_number; i++) {
518 elem = &var->cnsts[i];
519 cnst = elem->constraint;
521 double_update(&(cnst->remaining), elem->value * var->value);
522 double_update(&(cnst->usage), elem->value / var->weight);
523 make_elem_inactive(elem);
524 } else { /* FIXME one day: We recompute usage.... :( */
526 make_elem_inactive(elem);
527 xbt_swag_foreach(elem, elem_list) {
528 if (elem->variable->weight <= 0)
530 if (elem->variable->value > 0)
532 if ((elem->value > 0)) {
533 if (cnst->usage < elem->value / elem->variable->weight)
534 cnst->usage = elem->value / elem->variable->weight;
535 DEBUG2("Constraint Usage %p : %f", cnst, cnst->usage);
536 make_elem_active(elem);
541 xbt_swag_remove(var, var_list);
544 /* Find out which variables reach the maximum */
545 cnst_list = &(sys->active_constraint_set);
547 xbt_swag_foreach(cnst, cnst_list) {
548 saturated_constraint_set_update(sys, cnst, &min_usage);
550 saturated_variable_set_update(sys);
552 } while (xbt_swag_size(&(sys->saturated_variable_set)));
555 if (XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
560 /* Not a O(1) function */
562 void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
563 lmm_variable_t var, double value)
568 for (i = 0; i < var->cnsts_number; i++)
569 if (var->cnsts[i].constraint == cnst) {
570 var->cnsts[i].value = value;
575 /** \brief Attribute the value bound to var->bound.
577 * \param sys the lmm_system_t
578 * \param var the lmm_variable_t
579 * \param bound the new bound to associate with var
581 * Makes var->bound equal to bound. Whenever this function is called
582 * a change is signed in the system. To
583 * avoid false system changing detection it is a good idea to test
584 * (bound != 0) before calling it.
587 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
594 /** \brief Add the value delta to var->df (the sum of latencies).
596 * \param sys the lmm_system_t associated
597 * \param var the lmm_variable_t which need to updated
598 * \param delta the variation of the latency
600 * Add the value delta to var->df (the sum of latencys associated to the
601 * flow). Whenever this function is called a change is signed in the system. To
602 * avoid false system changing detection it is a good idea to test
603 * (delta != 0) before calling it.
606 void lmm_update_variable_latency(lmm_system_t sys, lmm_variable_t var,
613 void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
619 XBT_IN3("(sys=%p, var=%p, weight=%f)", sys, var, weight);
621 var->weight = weight;
622 xbt_swag_remove(var, &(sys->variable_set));
624 xbt_swag_insert_at_head(var, &(sys->variable_set));
626 xbt_swag_insert_at_tail(var, &(sys->variable_set));
628 for (i = 0; i < var->cnsts_number; i++) {
629 elem = &var->cnsts[i];
630 xbt_swag_remove(elem, &(elem->constraint->element_set));
632 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
634 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
639 double lmm_get_variable_weight(lmm_variable_t var)
644 void lmm_update_constraint_bound(lmm_system_t sys, lmm_constraint_t cnst,
651 int lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst)
653 return xbt_swag_belongs(cnst, &(sys->active_constraint_set));
656 lmm_constraint_t lmm_get_first_active_constraint(lmm_system_t sys)
658 return xbt_swag_getFirst(&(sys->active_constraint_set));
661 lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t sys,
662 lmm_constraint_t cnst)
664 return xbt_swag_getNext(cnst, (sys->active_constraint_set).offset);