2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file ats/gnunet-service-ats-solver_mlp.c
23 * @brief ats mlp problem solver
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet-service-ats-solver_mlp.h"
30 #include "gnunet_statistics_service.h"
35 * NOTE: Do not modify this documentation. This documentation is based on
36 * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
37 * use build_txt.sh to generate plaintext output
39 * The MLP solver (mlp) tries to finds an optimal bandwidth assignmentby
40 * optimizing an mixed integer programming problem. The MLP solver uses a
41 * number of constraints to find the best adddress for a peer and an optimal
42 * bandwidth assignment. mlp uses the GNU Linear Programming Kit to solve the
45 * We defined a constraint system to find an optimal bandwidth assignment.
46 * This constraint system uses as an input data addresses, bandwidth quotas,
47 * preferences and quality values. This constraint system is stored in an
48 * matrix based equotation system.
52 * A (M)LP problem consists of a target function to optimizes, constraints
53 * and rows and columns. FIXME GLP uses three arrays to index the matrix: two
54 * integer arrays storing the row and column indices in the matrix and an
55 * float array to store the coeeficient.
57 * To solve the problem we first find an initial solution for the LP problem
58 * using the LP solver and then find an MLP solution based on this solution
59 * using the MLP solver.
61 * Solving (M)LP problems has the property that finding an initial solution
62 * for the LP problem is computationally expensive and finding the MLP
63 * solution is cheaper. This is especially interesting an existing LP
64 * solution can be reused if only coefficients in the matrix have changed
65 * (addresses updated). Only when the problem size changes (addresses added
66 * or deleted) a new LP solution has to be found.
69 * The mlp solver solves the bandwidth assignment problem only on demand when
70 * an address suggestion is requested. When an address is requested mlp the
71 * solves the mlp problem and if the active address or the bandwidth assigned
72 * changes it calls the callback to addresses. The mlp solver gets notified
73 * about new addresses (adding sessions), removed addresses (address
74 * deletions) and address updates. To benefit from the mlp properties
75 * mentioned in section 5 the solver rembers if since the last solution
76 * addresses were added or deleted (problem size changed, problem has to be
77 * rebuild and solved from sratch) or if addresses were updated and the
78 * existing solution can be reused.
82 * The quotas for each network segment are passed by addresses. MLP can be
83 * adapted using configuration settings and uses the following parameters:
85 * Maximum duration for a MLP solution procees (default: 3 sec.)
87 * Maximum number of iterations for a MLP solution process (default:
89 * * MLP_MIN_CONNECTIONS:
90 * Minimum number of desired connections (default: 4)
91 * * MLP_MIN_BANDWIDTH:
92 * Minimum amount of bandwidth assigned to an address (default: 1024)
93 * * MLP_COEFFICIENT_D:
94 * Diversity coefficient (default: 1.0)
95 * * MLP_COEFFICIENT_R:
96 * Relativity coefficient (default: 1.0)
97 * * MLP_COEFFICIENT_U:
98 * Utilization coefficient (default: 1.0)
99 * * MLP_COEFFICIENT_D:
100 * Diversity coefficient (default: 1.0)
101 * * MLP_COEFFICIENT_QUALITY_DELAY:
102 * Quality delay coefficient (default: 1.0)
103 * * MLP_COEFFICIENT_QUALITY_DISTANCE:
104 * Quality distance coefficient (default: 1.0)
105 * * MLP_COEFFICIENT_QUALITY_DISTANCE:
106 * Quality distance coefficient (default: 1.0)
107 * * MLP_COEFFICIENT_QUALITY_DISTANCE:
108 * Quality distance coefficient (default: 1.0)
109 * * MLP_COEFFICIENT_QUALITY_DISTANCE:
110 * Quality distance coefficient (default: 1.0)
112 * 5.2 Data structures used
114 * mlp has for each known peer a struct ATS_Peer containing information about
115 * a specific peer. The address field solver_information contains information
116 * about the mlp properties of this address.
120 * During initialization mlp initializes the GLPK libray used to solve the
121 * MLP problem: it initializes the glpk environment and creates an initial LP
122 * problem. Next it loads the configuration values from the configuration or
123 * uses the default values configured in -addresses_mlp.h. The quotas used
124 * are given by addresses but may have to be adjusted. mlp uses a upper limit
125 * for the bandwidth assigned called BIG M and a minimum amount of bandwidth
126 * an address gets assigned as well as a minium desired number of
127 * connections. If the configured quota is bigger than BIG M, it is reduced
128 * to BIG M. If the configured quota is smaller than MLP_MIN_CONNECTIONS
129 * *MLP_MIN_BANDWIDTH it is increased to this value.
135 #define LOG(kind,...) GNUNET_log_from (kind, "ats-mlp",__VA_ARGS__)
138 * Print debug output for mlp problem creation
140 #define DEBUG_MLP_PROBLEM_CREATION GNUNET_NO
143 * Enable GLPK verbose output
145 #define VERBOSE_GLPK GNUNET_NO
148 * Maximize bandwidth assigned
150 * This option can be used to test if problem can be solved at all without
151 * optimizing for utility, diversity or relativity
154 #define MAXIMIZE_FOR_BANDWIDTH_ASSIGNED GNUNET_NO
157 * Intercept GLPK terminal output
158 * @param info the mlp handle
159 * @param s the string to print
160 * @return 0: glpk prints output on terminal, 0 != surpress output
163 mlp_term_hook (void *info, const char *s)
165 /* Not needed atm struct MLP_information *mlp = info; */
166 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s", s);
172 * Reset peers for next problem creation
174 * @param cls not used
176 * @param value ATS_Peer
180 reset_peers (void *cls, const struct GNUNET_HashCode * key, void *value)
182 struct ATS_Peer *peer = value;
183 peer->processed = GNUNET_NO;
188 * Delete the MLP problem and free the constrain matrix
190 * @param mlp the MLP handle
193 mlp_delete_problem (struct GAS_MLP_Handle *mlp)
198 if (mlp->p.prob != NULL)
200 glp_delete_prob(mlp->p.prob);
204 /* delete row index */
205 if (mlp->p.ia != NULL)
207 GNUNET_free (mlp->p.ia);
211 /* delete column index */
212 if (mlp->p.ja != NULL)
214 GNUNET_free (mlp->p.ja);
218 /* delete coefficients */
219 if (mlp->p.ar != NULL)
221 GNUNET_free (mlp->p.ar);
227 mlp->p.c_d = MLP_UNDEFINED;
228 mlp->p.c_r = MLP_UNDEFINED;
229 mlp->p.r_c2 = MLP_UNDEFINED;
230 mlp->p.r_c4 = MLP_UNDEFINED;
231 mlp->p.r_c6 = MLP_UNDEFINED;
232 mlp->p.r_c9 = MLP_UNDEFINED;
233 for (c = 0; c < mlp->pv.m_q ; c ++)
234 mlp->p.r_q[c] = MLP_UNDEFINED;
235 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c ++)
236 mlp->p.r_quota[c] = MLP_UNDEFINED;
237 mlp->p.ci = MLP_UNDEFINED;
240 GNUNET_CONTAINER_multihashmap_iterate (mlp->requested_peers, &reset_peers, NULL);
245 * Translate ATS properties to text
246 * Just intended for debugging
248 * @param ats_index the ATS index
249 * @return string with result
252 mlp_ats_to_string (int ats_index)
255 case GNUNET_ATS_ARRAY_TERMINATOR:
256 return "GNUNET_ATS_ARRAY_TERMINATOR";
257 case GNUNET_ATS_UTILIZATION_UP:
258 return "GNUNET_ATS_UTILIZATION_UP";
259 case GNUNET_ATS_UTILIZATION_DOWN:
260 return "GNUNET_ATS_UTILIZATION_DOWN";
261 case GNUNET_ATS_COST_LAN:
262 return "GNUNET_ATS_COST_LAN";
263 case GNUNET_ATS_COST_WAN:
264 return "GNUNET_ATS_COST_LAN";
265 case GNUNET_ATS_COST_WLAN:
266 return "GNUNET_ATS_COST_WLAN";
267 case GNUNET_ATS_NETWORK_TYPE:
268 return "GNUNET_ATS_NETWORK_TYPE";
269 case GNUNET_ATS_QUALITY_NET_DELAY:
270 return "GNUNET_ATS_QUALITY_NET_DELAY";
271 case GNUNET_ATS_QUALITY_NET_DISTANCE:
272 return "GNUNET_ATS_QUALITY_NET_DISTANCE";
280 * Translate glpk status error codes to text
281 * @param retcode return code
282 * @return string with result
285 mlp_status_to_string (int retcode)
289 return "solution is undefined";
291 return "solution is feasible";
293 return "solution is infeasible";
295 return "no feasible solution exists";
297 return "solution is optimal";
299 return "solution is unbounded";
302 return "unknown error";
307 * Translate glpk solver error codes to text
308 * @param retcode return code
309 * @return string with result
312 mlp_solve_to_string (int retcode)
318 return "invalid basis";
320 return "singular matrix";
322 return "ill-conditioned matrix";
324 return "invalid bounds";
326 return "solver failed";
328 return "objective lower limit reached";
330 return "objective upper limit reached";
332 return "iteration limit exceeded";
334 return "time limit exceeded";
336 return "no primal feasible solution";
338 return "no dual feasible solution";
340 return "root LP optimum not provided";
342 return "search terminated by application";
344 return "relative mip gap tolerance reached";
346 return "no dual feasible solution";
348 return "no convergence";
350 return "numerical instability";
352 return "invalid data";
354 return "result out of range";
357 return "unknown error";
362 * Extract an ATS performance info from an address
364 * @param address the address
365 * @param type the type to extract in HBO
366 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
369 get_performance_info (struct ATS_Address *address, uint32_t type)
372 GNUNET_assert (NULL != address);
374 if ((NULL == address->atsi) || (0 == address->atsi_count))
375 return GNUNET_ATS_VALUE_UNDEFINED;
377 for (c1 = 0; c1 < address->atsi_count; c1++)
379 if (ntohl(address->atsi[c1].type) == type)
380 return ntohl(address->atsi[c1].value);
382 return GNUNET_ATS_VALUE_UNDEFINED;
388 struct GNUNET_CONTAINER_MultiHashMap * peers;
393 mlp_create_problem_count_addresses_it (void *cls, const struct GNUNET_HashCode *key, void *value)
395 struct CountContext *cctx = cls;
396 /* Check if we have to add this peer due to a pending request */
397 if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_contains(cctx->peers, key))
402 static int mlp_create_problem_count_addresses (
403 struct GNUNET_CONTAINER_MultiHashMap * peers,
404 const struct GNUNET_CONTAINER_MultiHashMap * addresses)
406 struct CountContext cctx;
409 GNUNET_CONTAINER_multihashmap_iterate (addresses, &mlp_create_problem_count_addresses_it, &cctx);
415 * Updates an existing value in the matrix
417 * Extract the row, updates the value and updates the row in the problem
419 * @param p the mlp problem
420 * @param row the row to create the value in
421 * @param col the column to create the value in
422 * @param val the value to set
423 * @param line calling line for debbuging
424 * @param GNUNET_YES value changed, GNUNET_NO value did not change, GNUNET_SYSERR
428 mlp_create_problem_update_value (struct MLP_Problem *p,
429 int row, int col, double val,
439 GNUNET_assert (NULL != p);
440 GNUNET_assert (NULL != p->prob);
442 /* Get number of columns and prepare data structure */
443 c_cols = glp_get_num_cols(p->prob);
445 return GNUNET_SYSERR;
447 val_array = GNUNET_malloc ((c_cols +1)* sizeof (double));
448 GNUNET_assert (NULL != val_array);
449 ind_array = GNUNET_malloc ((c_cols+1) * sizeof (int));
450 GNUNET_assert (NULL != ind_array);
451 /* Extract the row */
453 if (0 == (c_elems = glp_get_mat_row (p->prob, row, ind_array, val_array)))
455 GNUNET_free (ind_array);
456 GNUNET_free (val_array);
457 return GNUNET_SYSERR;
460 /* Update the value */
461 for (c1 = 1; c1 < (c_elems+1); c1++)
463 if (ind_array[c1] == col)
466 if ((c_elems + 1)== c1)
468 GNUNET_free (ind_array);
469 GNUNET_free (val_array);
470 return GNUNET_SYSERR; /* not found */
473 LOG (GNUNET_ERROR_TYPE_ERROR, "[P] Updating value in [%s : %s] from `%.2f' to `%.2f'\n",
474 glp_get_row_name (p->prob, row), glp_get_col_name (p->prob, col),
476 if (val != val_array[c1])
482 /* Update the row in the matrix */
483 glp_set_mat_row (p->prob, row, c_elems, ind_array, val_array);
484 GNUNET_free (ind_array);
485 GNUNET_free (val_array);
490 * Creates a new value in the matrix
492 * Sets the row and column index in the problem array and increments the
495 * @param p the mlp problem
496 * @param row the row to create the value in
497 * @param col the column to create the value in
498 * @param val the value to set
499 * @param line calling line for debbuging
502 mlp_create_problem_set_value (struct MLP_Problem *p,
503 int row, int col, double val,
506 if ((p->ci) >= p->num_elements)
508 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: line %u: Request for index %u bigger than array size of %u\n",
509 line, p->ci + 1, p->num_elements);
513 if ((0 == row) || (0 == col))
518 #if DEBUG_MLP_PROBLEM_CREATION
519 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: line %u: Set value [%u,%u] in index %u == %.2f\n",
520 line, p->ia[p->ci], p->ja[p->ci], p->ci, p->ar[p->ci]);
526 mlp_create_problem_create_column (struct MLP_Problem *p, char *name,
527 unsigned int type, unsigned int bound, double lb, double ub,
530 int col = glp_add_cols (p->prob, 1);
531 glp_set_col_name (p->prob, col, name);
532 glp_set_col_bnds (p->prob, col, bound, lb, ub);
533 glp_set_col_kind (p->prob, col, type);
534 glp_set_obj_coef (p->prob, col, coef);
535 #if DEBUG_MLP_PROBLEM_CREATION
536 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: Added column [%u] `%s': %.2f\n",
543 mlp_create_problem_create_constraint (struct MLP_Problem *p, char *name,
544 unsigned int bound, double lb, double ub)
547 int row = glp_add_rows (p->prob, 1);
549 glp_set_row_name (p->prob, row, name);
550 /* set row bounds: <= 0 */
551 glp_set_row_bnds (p->prob, row, bound, lb, ub);
554 GNUNET_asprintf(&op, "-inf <= x <= %.2f", ub);
557 GNUNET_asprintf(&op, "%.2f <= x <= %.2f", lb, ub);
560 GNUNET_asprintf(&op, "%.2f == x == %.2f", lb, ub);
563 GNUNET_asprintf(&op, "%.2f <= x <= inf", lb);
566 GNUNET_asprintf(&op, "ERROR");
569 #if DEBUG_MLP_PROBLEM_CREATION
570 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: Added row [%u] `%s': %s\n",
579 * - address columns b and n
580 * - address dependent constraint rows c1, c3
581 * - peer dependent rows c2 and c9
582 * - Set address dependent entries in problem matrix as well
585 mlp_create_problem_add_address_information (void *cls, const struct GNUNET_HashCode *key, void *value)
587 struct GAS_MLP_Handle *mlp = cls;
588 struct MLP_Problem *p = &mlp->p;
589 struct ATS_Address *address = value;
590 struct ATS_Peer *peer;
591 struct MLP_information *mlpi;
597 /* Check if we have to add this peer due to a pending request */
598 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(mlp->requested_peers, key))
601 mlpi = address->solver_information;
604 fprintf (stderr, "%s %p\n",GNUNET_i2s (&address->peer), address);
610 peer = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, key);
611 if (peer->processed == GNUNET_NO)
613 /* Add peer dependent constraints */
614 /* Add constraint c2 */
615 GNUNET_asprintf(&name, "c2_%s", GNUNET_i2s(&address->peer));
616 peer->r_c2 = mlp_create_problem_create_constraint (p, name, GLP_FX, 1.0, 1.0);
618 /* Add constraint c9 */
619 GNUNET_asprintf(&name, "c9_%s", GNUNET_i2s(&address->peer));
620 peer->r_c9 = mlp_create_problem_create_constraint (p, name, GLP_LO, 0.0, 0.0);
622 /* c 9) set coefficient */
623 mlp_create_problem_set_value (p, peer->r_c9, p->c_r, -peer->f, __LINE__);
624 peer->processed = GNUNET_YES;
627 /* Reset addresses' solver information */
634 /* Add bandwidth column */
635 GNUNET_asprintf (&name, "b_%s_%s_%p", GNUNET_i2s (&address->peer), address->plugin, address);
636 #if TEST_MAX_BW_ASSIGNMENT
637 mlpi->c_b = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 1.0);
639 mlpi->c_b = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 0.0);
644 /* Add usage column */
645 GNUNET_asprintf (&name, "n_%s_%s_%p", GNUNET_i2s (&address->peer), address->plugin, address);
646 mlpi->c_n = mlp_create_problem_create_column (p, name, GLP_IV, GLP_DB, 0.0, 1.0, 0.0);
649 /* Add address dependent constraints */
650 /* Add constraint c1) bandwidth capping
651 * b_t + (-M) * n_t <= 0
653 GNUNET_asprintf(&name, "c1_%s_%s_%p", GNUNET_i2s(&address->peer), address->plugin, address);
654 mlpi->r_c1 = mlp_create_problem_create_constraint (p, name, GLP_UP, 0.0, 0.0);
657 /* c1) set b = 1 coefficient */
658 mlp_create_problem_set_value (p, mlpi->r_c1, mlpi->c_b, 1, __LINE__);
659 /* c1) set n = -M coefficient */
660 mlp_create_problem_set_value (p, mlpi->r_c1, mlpi->c_n, -mlp->pv.BIG_M, __LINE__);
662 /* Add constraint c 3) minimum bandwidth
663 * b_t + (-n_t * b_min) >= 0
665 GNUNET_asprintf(&name, "c3_%s_%s_%p", GNUNET_i2s(&address->peer), address->plugin, address);
666 mlpi->r_c3 = mlp_create_problem_create_constraint (p, name, GLP_LO, 0.0, 0.0);
669 /* c3) set b = 1 coefficient */
670 mlp_create_problem_set_value (p, mlpi->r_c3, mlpi->c_b, 1, __LINE__);
671 /* c3) set n = -b_min coefficient */
672 mlp_create_problem_set_value (p, mlpi->r_c3, mlpi->c_n, - ((double )mlp->pv.b_min), __LINE__);
675 /* Set coefficient entries in invariant rows */
676 /* c 4) minimum connections */
677 mlp_create_problem_set_value (p, p->r_c4, mlpi->c_n, 1, __LINE__);
678 /* c 6) maximize diversity */
679 mlp_create_problem_set_value (p, p->r_c6, mlpi->c_n, 1, __LINE__);
680 /* c 2) 1 address peer peer */
681 mlp_create_problem_set_value (p, peer->r_c2, mlpi->c_n, 1, __LINE__);
682 /* c 9) relativity */
683 mlp_create_problem_set_value (p, peer->r_c9, mlpi->c_b, 1, __LINE__);
685 mlp_create_problem_set_value (p, p->r_c8, mlpi->c_b, 1, __LINE__);
687 /* c 10) obey network specific quotas
688 * (1)*b_1 + ... + (1)*b_m <= quota_n
690 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
692 addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
693 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
694 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
696 if (mlp->pv.quota_index[c] == addr_net)
698 mlp_create_problem_set_value (p, p->r_quota[c], mlpi->c_b, 1, __LINE__);
703 /* c 7) Optimize quality */
704 /* For all quality metrics, set quality of this address */
705 props = mlp->get_properties (mlp->get_properties_cls, address);
706 for (c = 0; c < mlp->pv.m_q; c++)
707 mlp_create_problem_set_value (p, p->r_q[c], mlpi->c_b, props[c], __LINE__);
713 * Create the invariant columns c4, c6, c10, c8, c7
716 mlp_create_problem_add_invariant_rows (struct GAS_MLP_Handle *mlp, struct MLP_Problem *p)
721 /* Row for c4) minimum connection */
722 /* Number of minimum connections is min(|Peers|, n_min) */
723 p->r_c4 = mlp_create_problem_create_constraint (p, "c4", GLP_LO, (mlp->pv.n_min > p->num_peers) ? p->num_peers : mlp->pv.n_min, 0.0);
725 /* Add row for c6) */
726 p->r_c6 = mlp_create_problem_create_constraint (p, "c6", GLP_FX, 0.0, 0.0);
728 mlp_create_problem_set_value (p, p->r_c6, p->c_d, -1, __LINE__);
730 /* Add rows for c 10) */
731 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
734 GNUNET_asprintf(&text, "c10_quota_ats_%s", GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]));
735 p->r_quota[c] = mlp_create_problem_create_constraint (p, text, GLP_DB, 0.0, mlp->pv.quota_out[c]);
739 /* Adding rows for c 8) */
740 p->r_c8 = mlp_create_problem_create_constraint (p, "c8", GLP_FX, 0.0, 0.0);
742 mlp_create_problem_set_value (p, p->r_c8, p->c_u, -1, __LINE__);
744 /* c 7) For all quality metrics */
745 for (c = 0; c < mlp->pv.m_q; c++)
747 GNUNET_asprintf(&name, "c7_q%i_%s", c, mlp_ats_to_string(mlp->pv.q[c]));
748 p->r_q[c] = mlp_create_problem_create_constraint (p, name, GLP_FX, 0.0, 0.0);
750 mlp_create_problem_set_value (p, p->r_q[c], p->c_q[c], -1, __LINE__);
756 * Create the invariant columns d, u, r, q0 ... qm
759 mlp_create_problem_add_invariant_columns (struct GAS_MLP_Handle *mlp, struct MLP_Problem *p)
764 #if TEST_MAX_BW_ASSIGNMENT
769 //mlp->pv.co_R = 0.0;
771 /* Diversity d column */
772 p->c_d = mlp_create_problem_create_column (p, "d", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_D);
774 /* Utilization u column */
775 p->c_u = mlp_create_problem_create_column (p, "u", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_U);
777 /* Relativity r column */
778 p->c_r = mlp_create_problem_create_column (p, "r", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_R);
780 /* Quality metric columns */
781 for (c = 0; c < mlp->pv.m_q; c++)
783 GNUNET_asprintf (&name, "q_%u", mlp->pv.q[c]);
784 #if TEST_MAX_BW_ASSIGNMENT
785 p->c_q[c] = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 0.0);
787 p->c_q[c] = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_Q[c]);
795 * Create the MLP problem
797 * @param mlp the MLP handle
798 * @param addresses the hashmap containing all adresses
799 * @return GNUNET_OK or GNUNET_SYSERR
802 mlp_create_problem (struct GAS_MLP_Handle *mlp)
804 struct MLP_Problem *p = &mlp->p;
807 GNUNET_assert (p->prob == NULL);
808 GNUNET_assert (p->ia == NULL);
809 GNUNET_assert (p->ja == NULL);
810 GNUNET_assert (p->ar == NULL);
811 /* Reset MLP problem struct */
813 /* create the glpk problem */
814 p->prob = glp_create_prob ();
815 GNUNET_assert (NULL != p->prob);
816 p->num_peers = GNUNET_CONTAINER_multihashmap_size (mlp->requested_peers);
817 p->num_addresses = mlp_create_problem_count_addresses (mlp->requested_peers, mlp->addresses);
819 /* Create problem matrix: 10 * #addresses + #q * #addresses + #q, + #peer + 2 + 1 */
820 p->num_elements = (10 * p->num_addresses + mlp->pv.m_q * p->num_addresses + mlp->pv.m_q + p->num_peers + 2 + 1);
821 LOG (GNUNET_ERROR_TYPE_DEBUG, "Rebuilding problem for %u peer(s) and %u addresse(s) and %u quality metrics == %u elements\n",
822 p->num_peers, p->num_addresses, mlp->pv.m_q, p->num_elements);
824 /* Set a problem name */
825 glp_set_prob_name (p->prob, "GNUnet ATS bandwidth distribution");
826 /* Set optimization direction to maximize */
827 glp_set_obj_dir (p->prob, GLP_MAX);
829 /* Create problem matrix */
830 /* last +1 caused by glpk index starting with one: [1..elements]*/
833 p->ia = GNUNET_malloc (p->num_elements * sizeof (int));
835 p->ja = GNUNET_malloc (p->num_elements * sizeof (int));
837 p->ar = GNUNET_malloc (p->num_elements * sizeof (double));
839 if ((NULL == p->ia) || (NULL == p->ja) || (NULL == p->ar))
841 LOG (GNUNET_ERROR_TYPE_ERROR, _("Problem size too large, cannot allocate memory!\n"));
842 return GNUNET_SYSERR;
845 /* Adding invariant columns */
846 mlp_create_problem_add_invariant_columns (mlp, p);
848 /* Adding address independent constraint rows */
849 mlp_create_problem_add_invariant_rows (mlp, p);
851 /* Adding address dependent columns constraint rows */
852 GNUNET_CONTAINER_multihashmap_iterate (mlp->addresses, &mlp_create_problem_add_address_information, mlp);
854 /* Load the matrix */
855 LOG (GNUNET_ERROR_TYPE_DEBUG, "Loading matrix\n");
856 glp_load_matrix(p->prob, (p->ci)-1, p->ia, p->ja, p->ar);
862 * Solves the LP problem
864 * @param mlp the MLP Handle
865 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
868 mlp_solve_lp_problem (struct GAS_MLP_Handle *mlp)
872 res = glp_simplex(mlp->p.prob, &mlp->control_param_lp);
874 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving LP problem: 0x%02X %s\n", res, mlp_solve_to_string(res));
876 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving LP problem failed: 0x%02X %s\n", res, mlp_solve_to_string(res));
878 /* Analyze problem status */
879 res = glp_get_status (mlp->p.prob);
881 /* solution is optimal */
883 /* solution is feasible */
885 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving LP problem: 0x%02X %s\n",
886 res, mlp_status_to_string(res));
888 /* Problem was ill-defined, no way to handle that */
890 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving LP problem failed, no solution: 0x%02X %s\n",
891 res, mlp_status_to_string(res));
892 return GNUNET_SYSERR;
898 * Solves the MLP problem
900 * @param mlp the MLP Handle
901 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
904 mlp_solve_mlp_problem (struct GAS_MLP_Handle *mlp)
907 res = glp_intopt(mlp->p.prob, &mlp->control_param_mlp);
909 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving MLP problem: 0x%02X %s\n", res, mlp_solve_to_string(res));
911 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving MLP problem failed: 0x%02X %s\n", res, mlp_solve_to_string(res));
912 /* Analyze problem status */
913 res = glp_mip_status(mlp->p.prob);
915 /* solution is optimal */
917 /* solution is feasible */
919 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving MLP problem: 0x%02X %s\n", res, mlp_status_to_string(res));
921 /* Problem was ill-defined, no way to handle that */
923 LOG (GNUNET_ERROR_TYPE_WARNING,"Solving MLP problem failed, 0x%02X %s\n\n", res, mlp_status_to_string(res));
924 return GNUNET_SYSERR;
930 * Propagates the results when MLP problem was solved
932 * @param cls the MLP handle
933 * @param key the peer identity
934 * @param value the address
935 * @return GNUNET_OK to continue
938 mlp_propagate_results (void *cls, const struct GNUNET_HashCode *key, void *value)
940 struct GAS_MLP_Handle *mlp = cls;
941 struct ATS_Address *address;
942 struct MLP_information *mlpi;
943 double mlp_bw_in = MLP_NaN;
944 double mlp_bw_out = MLP_NaN;
945 double mlp_use = MLP_NaN;
947 /* Check if we have to add this peer due to a pending request */
948 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(mlp->requested_peers, key))
951 GNUNET_assert (address->solver_information != NULL);
952 mlpi = address->solver_information;
954 mlp_bw_in = glp_mip_col_val(mlp->p.prob, mlpi->c_b);/* FIXME */
955 if (mlp_bw_in > (double) UINT32_MAX)
957 LOG (GNUNET_ERROR_TYPE_DEBUG, "Overflow in assigned bandwidth, reducing ...\n" );
958 mlp_bw_in = (double) UINT32_MAX;
960 mlp_bw_out = glp_mip_col_val(mlp->p.prob, mlpi->c_b);
961 if (mlp_bw_out > (double) UINT32_MAX)
963 LOG (GNUNET_ERROR_TYPE_DEBUG, "Overflow in assigned bandwidth, reducing ...\n" );
964 mlp_bw_out = (double) UINT32_MAX;
966 mlp_use = glp_mip_col_val(mlp->p.prob, mlpi->c_n);
970 if ((GLP_YES == mlp_use) && (GNUNET_NO == address->active))
972 /* Address switch: Activate address*/
973 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : enabling address\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
974 address->active = GNUNET_YES;
975 address->assigned_bw_in.value__ = htonl (mlp_bw_in);
976 mlpi->b_in.value__ = htonl(mlp_bw_in);
977 address->assigned_bw_out.value__ = htonl (mlp_bw_out);
978 mlpi->b_out.value__ = htonl(mlp_bw_out);
980 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
982 else if ((GLP_NO == mlp_use) && (GNUNET_YES == address->active))
984 /* Address switch: Disable address*/
985 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : disabling address\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
986 address->active = GNUNET_NO;
987 /* Set bandwidth to 0 */
988 address->assigned_bw_in.value__ = htonl (0);
989 mlpi->b_in.value__ = htonl(mlp_bw_in);
990 address->assigned_bw_out.value__ = htonl (0);
991 mlpi->b_out.value__ = htonl(mlp_bw_out);
993 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
995 else if ((mlp_bw_out != ntohl(address->assigned_bw_out.value__)) ||
996 (mlp_bw_in != ntohl(address->assigned_bw_in.value__)))
998 /* Bandwidth changed */
999 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : bandwidth changed\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
1000 address->assigned_bw_in.value__ = htonl (mlp_bw_in);
1001 mlpi->b_in.value__ = htonl(mlp_bw_in);
1002 address->assigned_bw_out.value__ = htonl (mlp_bw_out);
1003 mlpi->b_out.value__ = htonl(mlp_bw_out);
1005 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
1009 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : no change\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
1018 * Solves the MLP problem
1020 * @param solver the MLP Handle
1021 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
1024 GAS_mlp_solve_problem (void *solver)
1026 struct GAS_MLP_Handle *mlp = solver;
1030 struct GNUNET_TIME_Absolute start_build;
1031 struct GNUNET_TIME_Relative duration_build;
1032 struct GNUNET_TIME_Absolute start_lp;
1033 struct GNUNET_TIME_Relative duration_lp;
1034 struct GNUNET_TIME_Absolute start_mlp;
1035 struct GNUNET_TIME_Relative duration_mlp;
1036 GNUNET_assert (NULL != solver);
1038 if (GNUNET_YES == mlp->bulk_lock)
1040 mlp->bulk_request ++;
1044 if (0 == GNUNET_CONTAINER_multihashmap_size(mlp->requested_peers))
1049 if (0 == GNUNET_CONTAINER_multihashmap_size(mlp->addresses))
1055 if ((GNUNET_NO == mlp->mlp_prob_changed) && (GNUNET_NO == mlp->mlp_prob_updated))
1057 LOG (GNUNET_ERROR_TYPE_DEBUG, "No changes to problem\n");
1060 if (GNUNET_YES == mlp->mlp_prob_changed)
1062 LOG (GNUNET_ERROR_TYPE_DEBUG, "Problem size changed, rebuilding\n");
1063 mlp_delete_problem (mlp);
1064 start_build = GNUNET_TIME_absolute_get();
1065 if (GNUNET_SYSERR == mlp_create_problem (mlp))
1066 return GNUNET_SYSERR;
1067 duration_build = GNUNET_TIME_absolute_get_duration (start_build);
1068 mlp->control_param_lp.presolve = GLP_YES;
1069 mlp->control_param_mlp.presolve = GNUNET_NO; /* No presolver, we have LP solution */
1073 LOG (GNUNET_ERROR_TYPE_DEBUG, "Problem was updated, resolving\n");
1074 duration_build.rel_value = 0;
1078 LOG (GNUNET_ERROR_TYPE_DEBUG, "Running LP solver %s\n", (GLP_YES == mlp->control_param_lp.presolve)? "with presolver": "without presolver");
1079 start_lp = GNUNET_TIME_absolute_get();
1080 res_lp = mlp_solve_lp_problem (mlp);
1081 duration_lp = GNUNET_TIME_absolute_get_duration (start_lp);
1085 LOG (GNUNET_ERROR_TYPE_DEBUG, "Running MLP solver \n");
1086 start_mlp = GNUNET_TIME_absolute_get();
1087 res_mip = mlp_solve_mlp_problem (mlp);
1089 duration_mlp = GNUNET_TIME_absolute_get_duration (start_mlp);
1092 mlp->ps.lp_res = res_lp;
1093 mlp->ps.mip_res = res_mip;
1094 mlp->ps.build_dur = duration_build;
1095 mlp->ps.lp_dur = duration_lp;
1096 mlp->ps.mip_dur = duration_mlp;
1097 mlp->ps.lp_presolv = mlp->control_param_lp.presolve;
1098 mlp->ps.mip_presolv = mlp->control_param_mlp.presolve;
1099 mlp->ps.p_cols = glp_get_num_cols (mlp->p.prob);
1100 mlp->ps.p_rows = glp_get_num_rows (mlp->p.prob);
1101 mlp->ps.p_elements = mlp->p.num_elements;
1103 LOG (GNUNET_ERROR_TYPE_DEBUG, "Execution time: Build %llu ms, LP %llu ms, MLP %llu ms\n",
1104 (unsigned long long) duration_build.rel_value,
1105 (unsigned long long) duration_lp.rel_value,
1106 (unsigned long long) duration_mlp.rel_value);
1108 /* Propagate result*/
1109 if ((GNUNET_OK == res_lp) && (GNUNET_OK == res_mip))
1110 GNUNET_CONTAINER_multihashmap_iterate (mlp->addresses, &mlp_propagate_results, mlp);
1112 struct GNUNET_TIME_Absolute time = GNUNET_TIME_absolute_get();
1113 if (GNUNET_YES == mlp->write_mip_mps)
1115 /* Write problem to disk */
1116 GNUNET_asprintf (&filename, "problem_p_%u_a%u_%llu.mps", mlp->p.num_peers, mlp->p.num_addresses, time.abs_value);
1117 LOG (GNUNET_ERROR_TYPE_ERROR, "DUMP: %s \n", filename);
1118 glp_write_lp(mlp->p.prob, NULL, filename);
1119 GNUNET_free (filename);
1121 if (GNUNET_YES == mlp->write_mip_sol)
1123 /* Write solution to disk */
1124 GNUNET_asprintf (&filename, "problem_p_%u_a%u_%llu.sol", mlp->p.num_peers, mlp->p.num_addresses, time.abs_value);
1125 glp_print_mip (mlp->p.prob, filename );
1126 LOG (GNUNET_ERROR_TYPE_ERROR, "DUMP: %s \n", filename);
1127 GNUNET_free (filename);
1130 /* Reset change and update marker */
1131 mlp->control_param_lp.presolve = GLP_NO;
1132 mlp->mlp_prob_updated = GNUNET_NO;
1133 mlp->mlp_prob_changed = GNUNET_NO;
1135 if ((GNUNET_OK == res_lp) && (GNUNET_OK == res_mip))
1138 return GNUNET_SYSERR;
1142 * Add a single address to the solve
1144 * @param solver the solver Handle
1145 * @param addresses the address hashmap containing all addresses
1146 * @param address the address to add
1147 * @param network network type of this address
1150 GAS_mlp_address_add (void *solver,
1151 struct ATS_Address *address,
1154 struct GAS_MLP_Handle *mlp = solver;
1157 GNUNET_assert (NULL != solver);
1158 GNUNET_assert (NULL != address);
1160 if (NULL == address->solver_information)
1162 address->solver_information = GNUNET_malloc (sizeof (struct MLP_information));
1165 LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding address for peer `%s' multiple times\n"), GNUNET_i2s(&address->peer));
1167 /* Is this peer included in the problem? */
1168 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &address->peer.hashPubKey)))
1170 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding address for peer `%s' without address request \n", GNUNET_i2s(&address->peer));
1174 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding address for peer `%s' with address request \n", GNUNET_i2s(&address->peer));
1175 /* Problem size changed: new address for peer with pending request */
1176 mlp->mlp_prob_changed = GNUNET_YES;
1177 if (GNUNET_YES == mlp->mlp_auto_solve)
1178 GAS_mlp_solve_problem (solver);
1183 * Transport properties for this address have changed
1185 * @param solver solver handle
1186 * @param address the address
1187 * @param type the ATSI type in HBO
1188 * @param abs_value the absolute value of the property
1189 * @param rel_value the normalized value
1192 GAS_mlp_address_property_changed (void *solver,
1193 struct ATS_Address *address,
1198 struct MLP_information *mlpi = address->solver_information;
1199 struct GAS_MLP_Handle *mlp = solver;
1204 GNUNET_assert (NULL != solver);
1205 GNUNET_assert (NULL != address);
1209 LOG (GNUNET_ERROR_TYPE_ERROR,
1210 _("Updating address property `%s' for peer `%s' %p not added before\n"),
1211 GNUNET_ATS_print_property_type (type),
1212 GNUNET_i2s(&address->peer),
1218 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers,
1219 &address->peer.hashPubKey)))
1221 /* Peer is not requested, so no need to update problem */
1224 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating property `%s' address for peer `%s'\n",
1225 GNUNET_ATS_print_property_type (type),
1226 GNUNET_i2s(&address->peer));
1228 /* Find row index */
1230 for (c1 = 0; c1 < mlp->pv.m_q; c1++)
1232 if (type == mlp->pv.q[c1])
1238 if (-1 == type_index)
1241 return; /* quality index not found */
1244 LOG (GNUNET_ERROR_TYPE_ERROR,
1245 _("Updating address property `%s' for peer `%s' %p\n"),
1246 GNUNET_ATS_print_property_type (type),
1247 GNUNET_i2s(&address->peer),
1249 type_index, mlp->p.r_q[type_index]);
1251 /* Update c7) [r_q[index]][c_b] = f_q * q_averaged[type_index] */
1252 if (GNUNET_YES == mlp_create_problem_update_value (&mlp->p,
1253 mlp->p.r_q[type_index], mlpi->c_b, rel_value, __LINE__))
1255 mlp->mlp_prob_updated = GNUNET_YES;
1256 if (GNUNET_YES == mlp->mlp_auto_solve)
1257 GAS_mlp_solve_problem (solver);
1263 * Transport session for this address has changed
1265 * NOTE: values in addresses are already updated
1267 * @param solver solver handle
1268 * @param address the address
1269 * @param cur_session the current session
1270 * @param new_session the new session
1273 GAS_mlp_address_session_changed (void *solver,
1274 struct ATS_Address *address,
1275 uint32_t cur_session,
1276 uint32_t new_session)
1278 /* Nothing to do here */
1284 * Transport session for this address has changed
1286 * NOTE: values in addresses are already updated
1288 * @param solver solver handle
1289 * @param address the address
1290 * @param cur_session the current session
1291 * @param new_session the new session
1294 GAS_mlp_address_inuse_changed (void *solver,
1295 struct ATS_Address *address,
1299 /* Nothing to do here */
1305 * Network scope for this address has changed
1307 * NOTE: values in addresses are already updated
1309 * @param solver solver handle
1310 * @param address the address
1311 * @param current_network the current network
1312 * @param new_network the new network
1315 GAS_mlp_address_change_network (void *solver,
1316 struct ATS_Address *address,
1317 uint32_t current_network,
1318 uint32_t new_network)
1320 struct MLP_information *mlpi = address->solver_information;
1321 struct GAS_MLP_Handle *mlp = solver;
1323 int nets_avail[] = GNUNET_ATS_NetworkType;
1326 GNUNET_assert (NULL != solver);
1327 GNUNET_assert (NULL != address);
1335 if (mlpi->c_b == MLP_UNDEFINED)
1336 return; /* This address is not yet in the matrix*/
1338 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers,
1339 &address->peer.hashPubKey)))
1341 /* Peer is not requested, so no need to update problem */
1346 if (current_network == new_network)
1352 for (c1 = 0; c1 < GNUNET_ATS_NetworkTypeCount ; c1 ++)
1354 if (nets_avail[c1] == new_network)
1358 if (GNUNET_ATS_NetworkTypeCount == c1)
1360 /* Invalid network */
1365 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating network for peer `%s' from `%s' to `%s'\n",
1366 GNUNET_i2s (&address->peer),
1367 GNUNET_ATS_print_network_type(current_network),
1368 GNUNET_ATS_print_network_type(new_network));
1370 /* Get row for this address */
1371 rows = glp_get_num_rows(mlp->p.prob);
1372 ind = GNUNET_malloc (rows * sizeof (int) + 1);
1373 val = GNUNET_malloc (rows * sizeof (double) + 1);
1374 length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1376 /* Remove index from old network */
1377 for (c1 = 1; c1 < length +1; c1 ++)
1379 if (ind[c1] == mlp->p.r_quota[c1])
1380 break; /* Found index for old network */
1382 val[c1] = 0.0; /* Remove from previous network */
1383 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1384 ind[c1] = mlp->p.r_quota[new_network]; /* Add to new network */
1386 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1390 length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1391 for (c1 = 1; c1 < length + 1; c1 ++)
1393 fprintf (stderr, "%u: %s\n", ind[c1], glp_get_row_name(mlp->p.prob, ind[c1]));
1396 mlp->mlp_prob_changed = GNUNET_YES;
1401 * Deletes a single address in the MLP problem
1403 * The MLP problem has to be recreated and the problem has to be resolved
1405 * @param solver the MLP Handle
1406 * @param addresses the address hashmap
1407 * the address has to be already removed from the hashmap
1408 * @param address the address to delete
1409 * @param session_only delete only session not whole address
1412 GAS_mlp_address_delete (void *solver,
1413 struct ATS_Address *address,
1417 struct GAS_MLP_Handle *mlp = solver;
1418 struct MLP_information *mlpi;
1420 GNUNET_assert (NULL != solver);
1421 GNUNET_assert (NULL != address);
1423 mlpi = address->solver_information;
1424 if ((GNUNET_NO == session_only) && (NULL != mlpi))
1427 address->solver_information = NULL;
1430 /* Is this peer included in the problem? */
1431 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &address->peer.hashPubKey)))
1433 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s for peer `%s' without address request \n",
1434 (session_only == GNUNET_YES) ? "session" : "address",
1435 GNUNET_i2s(&address->peer));
1438 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s for peer `%s' with address request \n",
1439 (session_only == GNUNET_YES) ? "session" : "address",
1440 GNUNET_i2s(&address->peer));
1442 /* Problem size changed: new address for peer with pending request */
1443 mlp->mlp_prob_changed = GNUNET_YES;
1444 if (GNUNET_YES == mlp->mlp_auto_solve)
1445 GAS_mlp_solve_problem (solver);
1451 * Find the active address in the set of addresses of a peer
1452 * @param cls destination
1453 * @param key peer id
1454 * @param value address
1458 mlp_get_preferred_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1461 struct ATS_Address *aa = (struct ATS_Address *) cls;
1462 struct ATS_Address *addr = value;
1463 struct MLP_information *mlpi = addr->solver_information;
1466 if (mlpi->n == GNUNET_YES)
1469 aa->assigned_bw_in = mlpi->b_in;
1470 aa->assigned_bw_out = mlpi->b_out;
1477 static double get_peer_pref_value (struct GAS_MLP_Handle *mlp, const struct GNUNET_PeerIdentity *peer)
1480 const double *preferences = NULL;
1482 preferences = mlp->get_preferences (mlp->get_preferences_cls, peer);
1485 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
1487 if (c != GNUNET_ATS_PREFERENCE_END)
1489 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
1490 res += preferences[c];
1493 res /= (GNUNET_ATS_PreferenceCount -1);
1499 * Get the preferred address for a specific peer
1501 * @param solver the MLP Handle
1502 * @param addresses address hashmap
1503 * @param peer the peer
1504 * @return suggested address
1506 const struct ATS_Address *
1507 GAS_mlp_get_preferred_address (void *solver,
1508 const struct GNUNET_PeerIdentity *peer)
1510 struct GAS_MLP_Handle *mlp = solver;
1512 struct ATS_Address *res = NULL;
1514 GNUNET_assert (NULL != solver);
1515 GNUNET_assert (NULL != peer);
1517 LOG (GNUNET_ERROR_TYPE_DEBUG, "Getting preferred address for `%s'\n",
1520 /* Is this peer included in the problem? */
1521 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &peer->hashPubKey)))
1523 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding peer `%s' to list of requested_peers with requests\n",
1526 p = GNUNET_malloc (sizeof (struct ATS_Peer));
1528 p->f = get_peer_pref_value (mlp, peer);
1529 GNUNET_CONTAINER_multihashmap_put (mlp->requested_peers, &peer->hashPubKey, p, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1531 /* Added new peer, we have to rebuild problem before solving */
1532 mlp->mlp_prob_changed = GNUNET_YES;
1534 if (GNUNET_YES == mlp->mlp_auto_solve)
1535 GAS_mlp_solve_problem (mlp);
1537 /* Get prefered address */
1538 GNUNET_CONTAINER_multihashmap_get_multiple (mlp->addresses, &peer->hashPubKey,
1539 mlp_get_preferred_address_it, res);
1546 * Start a bulk operation
1548 * @param solver the solver
1551 GAS_mlp_bulk_start (void *solver)
1553 LOG (GNUNET_ERROR_TYPE_DEBUG, "Locking solver for bulk operation ...\n");
1554 struct GAS_MLP_Handle *s = (struct GAS_MLP_Handle *) solver;
1556 GNUNET_assert (NULL != solver);
1562 GAS_mlp_bulk_stop (void *solver)
1564 LOG (GNUNET_ERROR_TYPE_DEBUG, "Unlocking solver from bulk operation ...\n");
1566 struct GAS_MLP_Handle *s = (struct GAS_MLP_Handle *) solver;
1567 GNUNET_assert (NULL != solver);
1569 if (s->bulk_lock < 1)
1576 if (0 < s->bulk_request)
1578 GAS_mlp_solve_problem (solver);
1586 * Stop notifying about address and bandwidth changes for this peer
1588 * @param solver the MLP handle
1589 * @param addresses address hashmap
1590 * @param peer the peer
1593 GAS_mlp_stop_get_preferred_address (void *solver,
1594 const struct GNUNET_PeerIdentity *peer)
1596 struct GAS_MLP_Handle *mlp = solver;
1597 struct ATS_Peer *p = NULL;
1599 GNUNET_assert (NULL != solver);
1600 GNUNET_assert (NULL != peer);
1602 if (NULL != (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &peer->hashPubKey)))
1604 GNUNET_CONTAINER_multihashmap_remove (mlp->requested_peers, &peer->hashPubKey, p);
1611 * Changes the preferences for a peer in the MLP problem
1613 * @param solver the MLP Handle
1614 * @param addresses the address hashmap
1615 * @param peer the peer
1616 * @param kind the kind to change the preference
1617 * @param pref_rel the relative score
1620 GAS_mlp_address_change_preference (void *solver,
1621 const struct GNUNET_PeerIdentity *peer,
1622 enum GNUNET_ATS_PreferenceKind kind,
1625 struct GAS_MLP_Handle *mlp = solver;
1626 struct ATS_Peer *p = NULL;
1628 LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing preference for address for peer `%s' to %.2f\n",
1629 GNUNET_i2s(peer), pref_rel);
1631 GNUNET_STATISTICS_update (mlp->stats,"# LP address preference changes", 1, GNUNET_NO);
1632 /* Update the constraints with changed preferences */
1634 /* Update quality constraint c7 */
1636 /* Update relativity constraint c9 */
1637 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &peer->hashPubKey)))
1639 LOG (GNUNET_ERROR_TYPE_ERROR, "Updating preference for unknown peer `%s'\n", GNUNET_i2s(peer));
1642 p->f = get_peer_pref_value (mlp, peer);
1643 LOG (GNUNET_ERROR_TYPE_ERROR, "PEER PREF: %s %.2f\n",
1644 GNUNET_i2s(peer), p->f);
1645 mlp_create_problem_update_value (&mlp->p, p->r_c9, mlp->p.c_r, -p->f, __LINE__);
1647 /* Problem size changed: new address for peer with pending request */
1648 mlp->mlp_prob_updated = GNUNET_YES;
1649 if (GNUNET_YES == mlp->mlp_auto_solve)
1650 GAS_mlp_solve_problem (solver);
1656 mlp_free_peers (void *cls, const struct GNUNET_HashCode *key, void *value)
1658 struct GNUNET_CONTAINER_MultiHashMap *map = cls;
1659 struct ATS_Peer *p = value;
1661 GNUNET_CONTAINER_multihashmap_remove (map, key, value);
1669 * Shutdown the MLP problem solving component
1671 * @param solver the solver handle
1674 GAS_mlp_done (void *solver)
1676 struct GAS_MLP_Handle *mlp = solver;
1677 GNUNET_assert (mlp != NULL);
1679 LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutting down mlp solver\n");
1680 mlp_delete_problem (mlp);
1682 GNUNET_CONTAINER_multihashmap_iterate (mlp->requested_peers, &mlp_free_peers, mlp->requested_peers);
1683 GNUNET_CONTAINER_multihashmap_destroy (mlp->requested_peers);
1684 mlp->requested_peers = NULL;
1686 /* Clean up GLPK environment */
1690 LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutdown down of mlp solver complete\n");
1695 * Init the MLP problem solving component
1697 * @param cfg the GNUNET_CONFIGURATION_Handle handle
1698 * @param stats the GNUNET_STATISTICS handle
1699 * @param network array of GNUNET_ATS_NetworkType with length dest_length
1700 * @param out_dest array of outbound quotas
1701 * @param in_dest array of outbound quota
1702 * @param dest_length array length for quota arrays
1703 * @param bw_changed_cb callback for changed bandwidth amounts
1704 * @param bw_changed_cb_cls cls for callback
1705 * @param get_preference callback to get relative preferences for a peer
1706 * @param get_preference_cls cls for callback to get relative preferences
1707 * @return struct GAS_MLP_Handle on success, NULL on fail
1710 GAS_mlp_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1711 const struct GNUNET_STATISTICS_Handle *stats,
1712 const struct GNUNET_CONTAINER_MultiHashMap *addresses,
1714 unsigned long long *out_dest,
1715 unsigned long long *in_dest,
1717 GAS_bandwidth_changed_cb bw_changed_cb,
1718 void *bw_changed_cb_cls,
1719 GAS_get_preferences get_preference,
1720 void *get_preference_cls,
1721 GAS_get_properties get_properties,
1722 void *get_properties_cls)
1724 struct GAS_MLP_Handle * mlp = GNUNET_malloc (sizeof (struct GAS_MLP_Handle));
1729 unsigned long long tmp;
1736 struct GNUNET_TIME_Relative max_duration;
1737 long long unsigned int max_iterations;
1739 GNUNET_assert (NULL != cfg);
1740 GNUNET_assert (NULL != stats);
1741 GNUNET_assert (NULL != addresses);
1742 GNUNET_assert (NULL != bw_changed_cb);
1743 GNUNET_assert (NULL != get_preference);
1744 GNUNET_assert (NULL != get_properties);
1746 /* Init GLPK environment */
1747 int res = glp_init_env();
1750 LOG (GNUNET_ERROR_TYPE_DEBUG, "GLPK: `%s'\n",
1751 "initialization successful");
1754 LOG (GNUNET_ERROR_TYPE_DEBUG, "GLPK: `%s'\n",
1755 "environment is already initialized");
1758 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not init GLPK: `%s'\n",
1759 "initialization failed (insufficient memory)");
1764 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not init GLPK: `%s'\n",
1765 "initialization failed (unsupported programming model)");
1773 mlp->write_mip_mps = GNUNET_CONFIGURATION_get_value_yesno (cfg, "ats",
1775 if (GNUNET_SYSERR == mlp->write_mip_mps)
1776 mlp->write_mip_mps = GNUNET_NO;
1777 mlp->write_mip_sol = GNUNET_CONFIGURATION_get_value_yesno (cfg, "ats",
1779 if (GNUNET_SYSERR == mlp->write_mip_sol)
1780 mlp->write_mip_sol = GNUNET_NO;
1782 mlp->pv.BIG_M = (double) BIG_M_VALUE;
1784 /* Get timeout for iterations */
1785 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time(cfg, "ats", "MLP_MAX_DURATION", &max_duration))
1787 max_duration = MLP_MAX_EXEC_DURATION;
1790 /* Get maximum number of iterations */
1791 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_size(cfg, "ats", "MLP_MAX_ITERATIONS", &max_iterations))
1793 max_iterations = MLP_MAX_ITERATIONS;
1796 /* Get diversity coefficient from configuration */
1797 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1798 "MLP_COEFFICIENT_D",
1800 D = (double) tmp / 100;
1804 /* Get proportionality coefficient from configuration */
1805 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1806 "MLP_COEFFICIENT_R",
1808 R = (double) tmp / 100;
1812 /* Get utilization coefficient from configuration */
1813 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1814 "MLP_COEFFICIENT_U",
1816 U = (double) tmp / 100;
1820 /* Get quality metric coefficients from configuration */
1821 int i_delay = MLP_NaN;
1822 int i_distance = MLP_NaN;
1823 int q[GNUNET_ATS_QualityPropertiesCount] = GNUNET_ATS_QualityProperties;
1824 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
1826 /* initialize quality coefficients with default value 1.0 */
1827 mlp->pv.co_Q[c] = DEFAULT_QUALITY;
1829 mlp->pv.q[c] = q[c];
1830 if (q[c] == GNUNET_ATS_QUALITY_NET_DELAY)
1832 if (q[c] == GNUNET_ATS_QUALITY_NET_DISTANCE)
1836 if ((i_delay != MLP_NaN) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1837 "MLP_COEFFICIENT_QUALITY_DELAY",
1840 mlp->pv.co_Q[i_delay] = (double) tmp / 100;
1842 mlp->pv.co_Q[i_delay] = DEFAULT_QUALITY;
1844 if ((i_distance != MLP_NaN) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1845 "MLP_COEFFICIENT_QUALITY_DISTANCE",
1847 mlp->pv.co_Q[i_distance] = (double) tmp / 100;
1849 mlp->pv.co_Q[i_distance] = DEFAULT_QUALITY;
1851 /* Get minimum bandwidth per used address from configuration */
1852 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1853 "MLP_MIN_BANDWIDTH",
1858 b_min = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1861 /* Get minimum number of connections from configuration */
1862 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1863 "MLP_MIN_CONNECTIONS",
1867 n_min = DEFAULT_MIN_CONNECTIONS;
1869 /* Init network quotas */
1870 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1871 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
1874 for (c2 = 0; c2 < dest_length; c2++)
1876 if (quotas[c] == network[c2])
1878 mlp->pv.quota_index[c] = network[c2];
1879 mlp->pv.quota_out[c] = out_dest[c2];
1880 mlp->pv.quota_in[c] = in_dest[c2];
1882 LOG (GNUNET_ERROR_TYPE_DEBUG, "Quota for network `%s' (in/out) %llu/%llu\n",
1883 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1884 mlp->pv.quota_out[c],
1885 mlp->pv.quota_in[c]);
1890 /* Check if defined quota could make problem unsolvable */
1891 if ((n_min * b_min) > mlp->pv.quota_out[c])
1893 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inconsistent outbound quota configuration for network `%s', is %llu must be at least %llu\n"),
1894 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1895 mlp->pv.quota_out[c],
1897 mlp->pv.quota_out[c] = (n_min * b_min);
1899 if ((n_min * b_min) > mlp->pv.quota_in[c])
1901 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inconsistent inbound quota configuration for network `%s', is %llu must be at least %llu\n"),
1902 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1903 mlp->pv.quota_in[c],
1905 mlp->pv.quota_in[c] = (n_min * b_min);
1908 /* Check if bandwidth is too big to make problem solvable */
1909 if (mlp->pv.BIG_M < mlp->pv.quota_out[c])
1911 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting outbound quota configuration for network `%s'from %llu to %.0f\n"),
1912 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1913 mlp->pv.quota_out[c],
1915 mlp->pv.quota_out[c] = mlp->pv.BIG_M ;
1917 if (mlp->pv.BIG_M < mlp->pv.quota_in[c])
1919 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inbound quota configuration for network `%s' from %llu to %.0f\n"),
1920 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1921 mlp->pv.quota_in[c],
1923 mlp->pv.quota_in[c] = mlp->pv.BIG_M ;
1926 if (GNUNET_NO == found)
1928 mlp->pv.quota_in[c] = ntohl(GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1929 mlp->pv.quota_out[c] = ntohl(GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1930 LOG (GNUNET_ERROR_TYPE_INFO, _("Using default quota configuration for network `%s' (in/out) %llu/%llu\n"),
1931 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1932 mlp->pv.quota_in[c],
1933 mlp->pv.quota_out[c]);
1937 /* Assign options to handle */
1938 mlp->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1939 mlp->addresses = addresses;
1940 mlp->bw_changed_cb = bw_changed_cb;
1941 mlp->bw_changed_cb_cls = bw_changed_cb_cls;
1942 mlp->get_preferences = get_preference;
1943 mlp->get_preferences_cls = get_preference_cls;
1944 mlp->get_properties = get_properties;
1945 mlp->get_properties_cls = get_properties_cls;
1946 /* Setting MLP Input variables */
1950 mlp->pv.b_min = b_min;
1951 mlp->pv.n_min = n_min;
1952 mlp->pv.m_q = GNUNET_ATS_QualityPropertiesCount;
1953 mlp->mlp_prob_changed = GNUNET_NO;
1954 mlp->mlp_prob_updated = GNUNET_NO;
1955 mlp->mlp_auto_solve = GNUNET_YES;
1956 mlp->requested_peers = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1957 mlp->bulk_request = 0;
1961 /* Redirect GLPK output to GNUnet logging */
1962 glp_term_hook (&mlp_term_hook, (void *) mlp);
1964 /* Init LP solving parameters */
1965 glp_init_smcp(&mlp->control_param_lp);
1966 mlp->control_param_lp.msg_lev = GLP_MSG_OFF;
1968 mlp->control_param_lp.msg_lev = GLP_MSG_ALL;
1970 mlp->control_param_lp.it_lim = max_iterations;
1971 mlp->control_param_lp.tm_lim = max_duration.rel_value;
1973 /* Init MLP solving parameters */
1974 glp_init_iocp(&mlp->control_param_mlp);
1975 mlp->control_param_mlp.msg_lev = GLP_MSG_OFF;
1977 mlp->control_param_mlp.msg_lev = GLP_MSG_ALL;
1979 mlp->control_param_mlp.tm_lim = max_duration.rel_value;
1981 LOG (GNUNET_ERROR_TYPE_DEBUG, "solver ready\n");
1986 /* end of gnunet-service-ats_addresses_mlp.c */