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"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_maxmin, surf,
16 "Logging specific to SURF (maxmin)");
18 static void *lmm_variable_mallocator_new_f(void);
19 static void lmm_variable_mallocator_free_f(void *var);
20 static void lmm_variable_mallocator_reset_f(void *var);
22 lmm_system_t lmm_system_new(void)
24 lmm_system_t l = NULL;
26 s_lmm_constraint_t cnst;
28 l = xbt_new0(s_lmm_system_t, 1);
31 xbt_swag_init(&(l->variable_set),
32 xbt_swag_offset(var, variable_set_hookup));
33 xbt_swag_init(&(l->constraint_set),
34 xbt_swag_offset(cnst, constraint_set_hookup));
36 xbt_swag_init(&(l->active_constraint_set),
37 xbt_swag_offset(cnst, active_constraint_set_hookup));
39 xbt_swag_init(&(l->saturated_variable_set),
40 xbt_swag_offset(var, saturated_variable_set_hookup));
41 xbt_swag_init(&(l->saturated_constraint_set),
42 xbt_swag_offset(cnst, saturated_constraint_set_hookup));
44 l->variable_mallocator = xbt_mallocator_new(64,
45 lmm_variable_mallocator_new_f,
46 lmm_variable_mallocator_free_f,
47 lmm_variable_mallocator_reset_f);
52 void lmm_system_free(lmm_system_t sys)
54 lmm_variable_t var = NULL;
55 lmm_constraint_t cnst = NULL;
57 while ((var = extract_variable(sys)))
58 lmm_var_free(sys, var);
60 while ((cnst = extract_constraint(sys)))
61 lmm_cnst_free(sys, cnst);
63 xbt_mallocator_free(sys->variable_mallocator);
67 void lmm_variable_disable(lmm_system_t sys, lmm_variable_t var)
70 lmm_element_t elem = NULL;
72 XBT_IN2("(sys=%p, var=%p)", sys, var);
75 for (i = 0; i < var->cnsts_number; i++) {
76 elem = &var->cnsts[i];
77 xbt_swag_remove(elem, &(elem->constraint->element_set));
78 xbt_swag_remove(elem, &(elem->constraint->active_element_set));
79 if (!xbt_swag_size(&(elem->constraint->element_set)))
80 make_constraint_inactive(sys, elem->constraint);
82 var->cnsts_number = 0;
86 static void lmm_var_free(lmm_system_t sys, lmm_variable_t var)
89 lmm_variable_disable(sys, var);
91 xbt_mallocator_release(sys->variable_mallocator, var);
94 static void lmm_cnst_free(lmm_system_t sys, lmm_constraint_t cnst)
96 /* xbt_assert0(xbt_swag_size(&(cnst->element_set)), */
97 /* "This list should be empty!"); */
98 remove_active_constraint(sys, cnst);
102 lmm_constraint_t lmm_constraint_new(lmm_system_t sys, void *id,
105 lmm_constraint_t cnst = NULL;
106 s_lmm_element_t elem;
108 cnst = xbt_new0(s_lmm_constraint_t, 1);
110 xbt_swag_init(&(cnst->element_set),
111 xbt_swag_offset(elem, element_set_hookup));
112 xbt_swag_init(&(cnst->active_element_set),
113 xbt_swag_offset(elem, active_element_set_hookup));
115 cnst->bound = bound_value;
118 insert_constraint(sys, cnst);
123 void lmm_constraint_shared(lmm_constraint_t cnst)
128 void lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst)
130 remove_constraint(sys, cnst);
131 lmm_cnst_free(sys, cnst);
134 static void *lmm_variable_mallocator_new_f(void)
136 return xbt_new(s_lmm_variable_t, 1);
139 static void lmm_variable_mallocator_free_f(void *var)
144 static void lmm_variable_mallocator_reset_f(void *var)
146 /* memset to zero like calloc */
147 memset(var, 0, sizeof(s_lmm_variable_t));
150 lmm_variable_t lmm_variable_new(lmm_system_t sys, void *id,
152 double bound, int number_of_constraints)
154 lmm_variable_t var = NULL;
157 XBT_IN5("(sys=%p, id=%p, weight=%f, bound=%f, num_cons =%d)",
158 sys, id, weight, bound, number_of_constraints);
160 var = xbt_mallocator_get(sys->variable_mallocator);
162 var->cnsts = xbt_new0(s_lmm_element_t, number_of_constraints);
163 for (i = 0; i < number_of_constraints; i++) {
164 /* Should be useless because of the
165 calloc but it seems to help valgrind... */
166 var->cnsts[i].element_set_hookup.next = NULL;
167 var->cnsts[i].element_set_hookup.prev = NULL;
168 var->cnsts[i].active_element_set_hookup.next = NULL;
169 var->cnsts[i].active_element_set_hookup.prev = NULL;
170 var->cnsts[i].constraint = NULL;
171 var->cnsts[i].variable = NULL;
172 var->cnsts[i].value = 0.0;
174 var->cnsts_size = number_of_constraints;
175 var->cnsts_number = 0; /* Should be useless because of the
176 calloc but it seems to help valgrind... */
177 var->weight = weight;
182 var->func_f = func_f_def;
183 var->func_fp = func_fp_def;
184 var->func_fpi = func_fpi_def;
187 xbt_swag_insert_at_head(var, &(sys->variable_set));
189 xbt_swag_insert_at_tail(var, &(sys->variable_set));
194 void lmm_variable_free(lmm_system_t sys, lmm_variable_t var)
196 remove_variable(sys, var);
197 lmm_var_free(sys, var);
200 double lmm_variable_getvalue(lmm_variable_t var)
205 void lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
206 lmm_variable_t var, double value)
208 lmm_element_t elem = NULL;
212 xbt_assert0(var->cnsts_number < var->cnsts_size, "Too much constraints");
214 elem = &(var->cnsts[var->cnsts_number++]);
217 elem->constraint = cnst;
218 elem->variable = var;
221 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
223 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
225 make_constraint_active(sys, cnst);
228 void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
229 lmm_variable_t var, double value)
234 for (i = 0; i < var->cnsts_number; i++)
235 if (var->cnsts[i].constraint == cnst)
238 if (i < var->cnsts_number)
239 var->cnsts[i].value += value;
241 lmm_expand(sys, cnst, var, value);
244 void lmm_elem_set_value(lmm_system_t sys, lmm_constraint_t cnst,
245 lmm_variable_t var, double value)
249 for (i = 0; i < var->cnsts_number; i++)
250 if (var->cnsts[i].constraint == cnst)
253 if (i < var->cnsts_number) {
254 var->cnsts[i].value = value;
260 lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
261 lmm_variable_t var, int num)
263 if (num < var->cnsts_number)
264 return (var->cnsts[num].constraint);
269 int lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var)
271 return (var->cnsts_number);
274 lmm_variable_t lmm_get_var_from_cnst(lmm_system_t sys,
275 lmm_constraint_t cnst,
276 lmm_variable_t * var)
279 xbt_swag_getFirst(&(cnst->element_set));
281 *var = xbt_swag_getNext(*var, cnst->element_set.offset);
285 void *lmm_constraint_id(lmm_constraint_t cnst)
290 void *lmm_variable_id(lmm_variable_t var)
295 static void saturated_constraint_set_update(lmm_system_t sys,
296 lmm_constraint_t cnst,
299 lmm_constraint_t useless_cnst = NULL;
301 XBT_IN3("sys=%p, cnst=%p, min_usage=%f", sys, cnst, *min_usage);
302 if (cnst->usage <= 0) {
306 if (cnst->remaining <= 0) {
310 if ((*min_usage < 0) || (*min_usage > cnst->remaining / cnst->usage)) {
311 *min_usage = cnst->remaining / cnst->usage;
312 LOG3(xbt_log_priority_trace,
313 "min_usage=%f (cnst->remaining=%f, cnst->usage=%f)", *min_usage,
314 cnst->remaining, cnst->usage);
315 while ((useless_cnst =
316 xbt_swag_getFirst(&(sys->saturated_constraint_set))))
317 xbt_swag_remove(useless_cnst, &(sys->saturated_constraint_set));
319 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
320 } else if (*min_usage == cnst->remaining / cnst->usage) {
321 xbt_swag_insert(cnst, &(sys->saturated_constraint_set));
326 static void saturated_variable_set_update(lmm_system_t sys)
328 lmm_constraint_t cnst = NULL;
329 xbt_swag_t cnst_list = NULL;
330 lmm_element_t elem = NULL;
331 xbt_swag_t elem_list = NULL;
333 cnst_list = &(sys->saturated_constraint_set);
334 while ((cnst = xbt_swag_getFirst(cnst_list))) {
335 elem_list = &(cnst->active_element_set);
336 xbt_swag_foreach(elem, elem_list) {
337 if (elem->variable->weight <= 0)
339 if ((elem->value > 0))
340 xbt_swag_insert(elem->variable, &(sys->saturated_variable_set));
342 xbt_swag_remove(cnst, cnst_list);
346 void lmm_print(lmm_system_t sys)
348 lmm_constraint_t cnst = NULL;
349 lmm_element_t elem = NULL;
350 lmm_variable_t var = NULL;
351 xbt_swag_t cnst_list = NULL;
352 xbt_swag_t var_list = NULL;
353 xbt_swag_t elem_list = NULL;
354 char print_buf[1024];
355 char *trace_buf = xbt_malloc0(sizeof(char));
358 /* Printing Objective */
359 var_list = &(sys->variable_set);
360 sprintf(print_buf, "MAX-MIN ( ");
362 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
363 strcat(trace_buf, print_buf);
364 xbt_swag_foreach(var, var_list) {
365 sprintf(print_buf, "'%p'(%f) ", var, var->weight);
367 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
368 strcat(trace_buf, print_buf);
370 sprintf(print_buf, ")");
372 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
373 strcat(trace_buf, print_buf);
374 DEBUG1("%s", trace_buf);
375 trace_buf[0] = '\000';
377 /* Printing Constraints */
378 cnst_list = &(sys->active_constraint_set);
379 xbt_swag_foreach(cnst, cnst_list) {
381 elem_list = &(cnst->element_set);
382 sprintf(print_buf, "\t");
384 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
385 strcat(trace_buf, print_buf);
386 xbt_swag_foreach(elem, elem_list) {
387 sprintf(print_buf, "%f.'%p'(%f) + ", elem->value,
388 elem->variable, elem->variable->value);
390 xbt_realloc(trace_buf,
391 strlen(trace_buf) + strlen(print_buf) + 1);
392 strcat(trace_buf, print_buf);
393 sum += elem->value * elem->variable->value;
395 sprintf(print_buf, "0 <= %f ('%p')", cnst->bound, cnst);
397 xbt_realloc(trace_buf, strlen(trace_buf) + strlen(print_buf) + 1);
398 strcat(trace_buf, print_buf);
401 sprintf(print_buf, " [MAX-Constraint]");
403 xbt_realloc(trace_buf,
404 strlen(trace_buf) + strlen(print_buf) + 1);
405 strcat(trace_buf, print_buf);
407 DEBUG1("%s", trace_buf);
408 trace_buf[0] = '\000';
409 if (double_positive(sum - cnst->bound))
410 WARN3("Incorrect value (%f is not smaller than %f): %g",
411 sum, cnst->bound, sum - cnst->bound);
414 /* Printing Result */
415 xbt_swag_foreach(var, var_list) {
416 if (var->bound > 0) {
417 DEBUG4("'%p'(%f) : %f (<=%f)", var, var->weight, var->value,
419 if (double_positive(var->value - var->bound))
420 WARN2("Incorrect value (%f is not smaller than %f",
421 var->value, var->bound);
423 DEBUG3("'%p'(%f) : %f", var, var->weight, var->value);
429 void lmm_solve(lmm_system_t sys)
431 lmm_variable_t var = NULL;
432 lmm_constraint_t cnst = NULL;
433 lmm_element_t elem = NULL;
434 xbt_swag_t cnst_list = NULL;
435 xbt_swag_t var_list = NULL;
436 xbt_swag_t elem_list = NULL;
437 double min_usage = -1;
439 if (!(sys->modified))
443 var_list = &(sys->variable_set);
444 DEBUG1("Variable set : %d", xbt_swag_size(var_list));
445 xbt_swag_foreach(var, var_list) {
449 for (i = 0; i < var->cnsts_number; i++) {
450 if(var->cnsts[i].value==0.0) nb++;
452 if((nb==var->cnsts_number) && (var->weight>0.0))
457 * Compute Usage and store the variables that reach the maximum.
459 cnst_list = &(sys->active_constraint_set);
460 DEBUG1("Active constraints : %d", xbt_swag_size(cnst_list));
461 xbt_swag_foreach(cnst, cnst_list) {
463 cnst->remaining = cnst->bound;
465 elem_list = &(cnst->element_set);
467 xbt_swag_foreach(elem, elem_list) {
468 if (elem->variable->weight <= 0)
470 if ((elem->value > 0)) {
472 cnst->usage += elem->value / elem->variable->weight;
473 else if (cnst->usage < elem->value / elem->variable->weight)
474 cnst->usage = elem->value / elem->variable->weight;
475 DEBUG2("Constraint Usage %p : %f", cnst, cnst->usage);
476 make_elem_active(elem);
479 /* Saturated constraints update */
480 saturated_constraint_set_update(sys, cnst, &min_usage);
482 saturated_variable_set_update(sys);
484 /* Saturated variables update */
487 /* Fix the variables that have to be */
488 var_list = &(sys->saturated_variable_set);
490 xbt_swag_foreach(var, var_list) {
491 /* First check if some of these variables have reach their upper
492 bound and update min_usage accordingly. */
494 ("var=%p, var->bound=%f, var->weight=%f, min_usage=%f, var->bound*var->weight=%f",
495 var, var->bound, var->weight, min_usage,
496 var->bound * var->weight);
497 if ((var->bound > 0) && (var->bound * var->weight < min_usage)) {
498 min_usage = var->bound * var->weight;
499 DEBUG1("Updated min_usage=%f", min_usage);
504 while ((var = xbt_swag_getFirst(var_list))) {
507 var->value = min_usage / var->weight;
508 DEBUG5("Min usage: %f, Var(%p)->weight: %f, Var(%p)->value: %f ",
509 min_usage, var, var->weight, var, var->value);
514 for (i = 0; i < var->cnsts_number; i++) {
515 elem = &var->cnsts[i];
516 cnst = elem->constraint;
518 double_update(&(cnst->remaining), elem->value * var->value);
519 double_update(&(cnst->usage), elem->value / var->weight);
520 make_elem_inactive(elem);
521 } else { /* FIXME one day: We recompute usage.... :( */
523 make_elem_inactive(elem);
524 xbt_swag_foreach(elem, elem_list) {
525 if (elem->variable->weight <= 0)
527 if (elem->variable->value > 0)
529 if ((elem->value > 0)) {
530 if (cnst->usage < elem->value / elem->variable->weight)
531 cnst->usage = elem->value / elem->variable->weight;
532 DEBUG2("Constraint Usage %p : %f", cnst, cnst->usage);
533 make_elem_active(elem);
538 xbt_swag_remove(var, var_list);
541 /* Find out which variables reach the maximum */
542 cnst_list = &(sys->active_constraint_set);
544 xbt_swag_foreach(cnst, cnst_list) {
545 saturated_constraint_set_update(sys, cnst, &min_usage);
547 saturated_variable_set_update(sys);
549 } while (xbt_swag_size(&(sys->saturated_variable_set)));
552 if (XBT_LOG_ISENABLED(surf_maxmin, xbt_log_priority_debug)) {
557 /* Not a O(1) function */
559 void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
560 lmm_variable_t var, double value)
565 for (i = 0; i < var->cnsts_number; i++)
566 if (var->cnsts[i].constraint == cnst) {
567 var->cnsts[i].value = value;
572 /** \brief Attribute the value bound to var->bound.
574 * \param sys the lmm_system_t
575 * \param var the lmm_variable_t
576 * \param bound the new bound to associate with var
578 * Makes var->bound equal to bound. Whenever this function is called
579 * a change is signed in the system. To
580 * avoid false system changing detection it is a good idea to test
581 * (bound != 0) before calling it.
584 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
591 /** \brief Add the value delta to var->df (the sum of latencies).
593 * \param sys the lmm_system_t associated
594 * \param var the lmm_variable_t which need to updated
595 * \param delta the variation of the latency
597 * Add the value delta to var->df (the sum of latencys associated to the
598 * flow). Whenever this function is called a change is signed in the system. To
599 * avoid false system changing detection it is a good idea to test
600 * (delta != 0) before calling it.
603 void lmm_update_variable_latency(lmm_system_t sys, lmm_variable_t var,
610 void lmm_update_variable_weight(lmm_system_t sys, lmm_variable_t var,
616 XBT_IN3("(sys=%p, var=%p, weight=%f)", sys, var, weight);
618 var->weight = weight;
619 xbt_swag_remove(var, &(sys->variable_set));
621 xbt_swag_insert_at_head(var, &(sys->variable_set));
623 xbt_swag_insert_at_tail(var, &(sys->variable_set));
625 for (i = 0; i < var->cnsts_number; i++) {
626 elem = &var->cnsts[i];
627 xbt_swag_remove(elem, &(elem->constraint->element_set));
629 xbt_swag_insert_at_head(elem, &(elem->constraint->element_set));
631 xbt_swag_insert_at_tail(elem, &(elem->constraint->element_set));
636 double lmm_get_variable_weight(lmm_variable_t var)
641 void lmm_update_constraint_bound(lmm_system_t sys, lmm_constraint_t cnst,
648 int lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst)
650 return xbt_swag_belongs(cnst, &(sys->active_constraint_set));
653 lmm_constraint_t lmm_get_first_active_constraint(lmm_system_t sys)
655 return xbt_swag_getFirst(&(sys->active_constraint_set));
658 lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t sys,
659 lmm_constraint_t cnst)
661 return xbt_swag_getNext(cnst, (sys->active_constraint_set).offset);