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
426 mlp_create_problem_update_value (struct MLP_Problem *p,
427 int row, int col, double val,
436 GNUNET_assert (NULL != p);
437 GNUNET_assert (NULL != p->prob);
439 /* Get number of columns and prepare data structure */
440 c_cols = glp_get_num_cols(p->prob);
444 val_array = GNUNET_malloc ((c_cols +1)* sizeof (double));
445 GNUNET_assert (NULL != val_array);
446 ind_array = GNUNET_malloc ((c_cols+1) * sizeof (int));
447 GNUNET_assert (NULL != ind_array);
448 /* Extract the row */
450 if (0 == (c_elems = glp_get_mat_row (p->prob, row, ind_array, val_array)))
452 GNUNET_free (ind_array);
453 GNUNET_free (val_array);
457 /* Update the value */
458 for (c1 = 1; c1 < (c_elems+1); c1++)
461 fprintf (stderr, "cur %u of %u: [%u] %s <-> [%u] %s\n",
464 glp_get_col_name(p->prob, ind_array[c1]),
466 glp_get_col_name(p->prob, col)
469 if (ind_array[c1] == col)
472 if ((c_elems + 1)== c1)
474 GNUNET_free (ind_array);
475 GNUNET_free (val_array);
476 return; /* not found */
479 LOG (GNUNET_ERROR_TYPE_ERROR, "[P] Updating value for peer from `%.2f' to `%.2f'\n",
483 /* Update the row in the matrix */
484 glp_set_mat_row (p->prob, row, c_elems, ind_array, val_array);
485 GNUNET_free (ind_array);
486 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;
596 /* Check if we have to add this peer due to a pending request */
597 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(mlp->requested_peers, key))
600 mlpi = address->solver_information;
603 fprintf (stderr, "%s %p\n",GNUNET_i2s (&address->peer), address);
609 peer = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, key);
610 if (peer->processed == GNUNET_NO)
612 /* Add peer dependent constraints */
613 /* Add constraint c2 */
614 GNUNET_asprintf(&name, "c2_%s", GNUNET_i2s(&address->peer));
615 peer->r_c2 = mlp_create_problem_create_constraint (p, name, GLP_FX, 1.0, 1.0);
617 /* Add constraint c9 */
618 GNUNET_asprintf(&name, "c9_%s", GNUNET_i2s(&address->peer));
619 peer->r_c9 = mlp_create_problem_create_constraint (p, name, GLP_LO, 0.0, 0.0);
621 /* c 9) set coefficient */
622 mlp_create_problem_set_value (p, peer->r_c9, p->c_r, -peer->f, __LINE__);
623 peer->processed = GNUNET_YES;
626 /* Reset addresses' solver information */
632 for (c = 0; c < mlp->pv.m_q; c++)
635 /* Add bandwidth column */
636 GNUNET_asprintf (&name, "b_%s_%s_%p", GNUNET_i2s (&address->peer), address->plugin, address);
637 #if TEST_MAX_BW_ASSIGNMENT
638 mlpi->c_b = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 1.0);
640 mlpi->c_b = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 0.0);
645 /* Add usage column */
646 GNUNET_asprintf (&name, "n_%s_%s_%p", GNUNET_i2s (&address->peer), address->plugin, address);
647 mlpi->c_n = mlp_create_problem_create_column (p, name, GLP_IV, GLP_DB, 0.0, 1.0, 0.0);
650 /* Add address dependent constraints */
651 /* Add constraint c1) bandwidth capping
652 * b_t + (-M) * n_t <= 0
654 GNUNET_asprintf(&name, "c1_%s_%s_%p", GNUNET_i2s(&address->peer), address->plugin, address);
655 mlpi->r_c1 = mlp_create_problem_create_constraint (p, name, GLP_UP, 0.0, 0.0);
658 /* c1) set b = 1 coefficient */
659 mlp_create_problem_set_value (p, mlpi->r_c1, mlpi->c_b, 1, __LINE__);
660 /* c1) set n = -M coefficient */
661 mlp_create_problem_set_value (p, mlpi->r_c1, mlpi->c_n, -mlp->pv.BIG_M, __LINE__);
663 /* Add constraint c 3) minimum bandwidth
664 * b_t + (-n_t * b_min) >= 0
666 GNUNET_asprintf(&name, "c3_%s_%s_%p", GNUNET_i2s(&address->peer), address->plugin, address);
667 mlpi->r_c3 = mlp_create_problem_create_constraint (p, name, GLP_LO, 0.0, 0.0);
670 /* c3) set b = 1 coefficient */
671 mlp_create_problem_set_value (p, mlpi->r_c3, mlpi->c_b, 1, __LINE__);
672 /* c3) set n = -b_min coefficient */
673 mlp_create_problem_set_value (p, mlpi->r_c3, mlpi->c_n, - ((double )mlp->pv.b_min), __LINE__);
676 /* Set coefficient entries in invariant rows */
677 /* c 4) minimum connections */
678 mlp_create_problem_set_value (p, p->r_c4, mlpi->c_n, 1, __LINE__);
679 /* c 6) maximize diversity */
680 mlp_create_problem_set_value (p, p->r_c6, mlpi->c_n, 1, __LINE__);
681 /* c 2) 1 address peer peer */
682 mlp_create_problem_set_value (p, peer->r_c2, mlpi->c_n, 1, __LINE__);
683 /* c 9) relativity */
684 mlp_create_problem_set_value (p, peer->r_c9, mlpi->c_b, 1, __LINE__);
686 mlp_create_problem_set_value (p, p->r_c8, mlpi->c_b, 1, __LINE__);
688 /* c 10) obey network specific quotas
689 * (1)*b_1 + ... + (1)*b_m <= quota_n
691 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
693 addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
694 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
695 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
697 if (mlp->pv.quota_index[c] == addr_net)
699 mlp_create_problem_set_value (p, p->r_quota[c], mlpi->c_b, 1, __LINE__);
704 /* c 7) Optimize quality */
705 /* For all quality metrics, set quality of this address */
706 for (c = 0; c < mlp->pv.m_q; c++)
709 mlp_create_problem_set_value (p, p->r_q[c], mlpi->c_b, mlpi->q_averaged[c], __LINE__);
716 * Create the invariant columns c4, c6, c10, c8, c7
719 mlp_create_problem_add_invariant_rows (struct GAS_MLP_Handle *mlp, struct MLP_Problem *p)
724 /* Row for c4) minimum connection */
725 /* Number of minimum connections is min(|Peers|, n_min) */
726 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);
728 /* Add row for c6) */
729 p->r_c6 = mlp_create_problem_create_constraint (p, "c6", GLP_FX, 0.0, 0.0);
731 mlp_create_problem_set_value (p, p->r_c6, p->c_d, -1, __LINE__);
733 /* Add rows for c 10) */
734 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
737 GNUNET_asprintf(&text, "c10_quota_ats_%s", GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]));
738 p->r_quota[c] = mlp_create_problem_create_constraint (p, text, GLP_DB, 0.0, mlp->pv.quota_out[c]);
742 /* Adding rows for c 8) */
743 p->r_c8 = mlp_create_problem_create_constraint (p, "c8", GLP_FX, 0.0, 0.0);
745 mlp_create_problem_set_value (p, p->r_c8, p->c_u, -1, __LINE__);
747 /* c 7) For all quality metrics */
748 for (c = 0; c < mlp->pv.m_q; c++)
750 GNUNET_asprintf(&name, "c7_q%i_%s", c, mlp_ats_to_string(mlp->pv.q[c]));
751 p->r_q[c] = mlp_create_problem_create_constraint (p, name, GLP_FX, 0.0, 0.0);
753 mlp_create_problem_set_value (p, p->r_q[c], p->c_q[c], -1, __LINE__);
759 * Create the invariant columns d, u, r, q0 ... qm
762 mlp_create_problem_add_invariant_columns (struct GAS_MLP_Handle *mlp, struct MLP_Problem *p)
767 #if TEST_MAX_BW_ASSIGNMENT
772 //mlp->pv.co_R = 0.0;
774 /* Diversity d column */
775 p->c_d = mlp_create_problem_create_column (p, "d", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_D);
777 /* Utilization u column */
778 p->c_u = mlp_create_problem_create_column (p, "u", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_U);
780 /* Relativity r column */
781 p->c_r = mlp_create_problem_create_column (p, "r", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_R);
783 /* Quality metric columns */
784 for (c = 0; c < mlp->pv.m_q; c++)
786 GNUNET_asprintf (&name, "q_%u", mlp->pv.q[c]);
787 #if TEST_MAX_BW_ASSIGNMENT
788 p->c_q[c] = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 0.0);
790 p->c_q[c] = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_Q[c]);
798 * Create the MLP problem
800 * @param mlp the MLP handle
801 * @param addresses the hashmap containing all adresses
802 * @return GNUNET_OK or GNUNET_SYSERR
805 mlp_create_problem (struct GAS_MLP_Handle *mlp)
807 struct MLP_Problem *p = &mlp->p;
810 GNUNET_assert (p->prob == NULL);
811 GNUNET_assert (p->ia == NULL);
812 GNUNET_assert (p->ja == NULL);
813 GNUNET_assert (p->ar == NULL);
814 /* Reset MLP problem struct */
816 /* create the glpk problem */
817 p->prob = glp_create_prob ();
818 GNUNET_assert (NULL != p->prob);
819 p->num_peers = GNUNET_CONTAINER_multihashmap_size (mlp->requested_peers);
820 p->num_addresses = mlp_create_problem_count_addresses (mlp->requested_peers, mlp->addresses);
822 /* Create problem matrix: 10 * #addresses + #q * #addresses + #q, + #peer + 2 + 1 */
823 p->num_elements = (10 * p->num_addresses + mlp->pv.m_q * p->num_addresses + mlp->pv.m_q + p->num_peers + 2 + 1);
824 LOG (GNUNET_ERROR_TYPE_DEBUG, "Rebuilding problem for %u peer(s) and %u addresse(s) and %u quality metrics == %u elements\n",
825 p->num_peers, p->num_addresses, mlp->pv.m_q, p->num_elements);
827 /* Set a problem name */
828 glp_set_prob_name (p->prob, "GNUnet ATS bandwidth distribution");
829 /* Set optimization direction to maximize */
830 glp_set_obj_dir (p->prob, GLP_MAX);
832 /* Create problem matrix */
833 /* last +1 caused by glpk index starting with one: [1..elements]*/
836 p->ia = GNUNET_malloc (p->num_elements * sizeof (int));
838 p->ja = GNUNET_malloc (p->num_elements * sizeof (int));
840 p->ar = GNUNET_malloc (p->num_elements * sizeof (double));
842 if ((NULL == p->ia) || (NULL == p->ja) || (NULL == p->ar))
844 LOG (GNUNET_ERROR_TYPE_ERROR, _("Problem size too large, cannot allocate memory!\n"));
845 return GNUNET_SYSERR;
848 /* Adding invariant columns */
849 mlp_create_problem_add_invariant_columns (mlp, p);
851 /* Adding address independent constraint rows */
852 mlp_create_problem_add_invariant_rows (mlp, p);
854 /* Adding address dependent columns constraint rows */
855 GNUNET_CONTAINER_multihashmap_iterate (mlp->addresses, &mlp_create_problem_add_address_information, mlp);
857 /* Load the matrix */
858 LOG (GNUNET_ERROR_TYPE_DEBUG, "Loading matrix\n");
859 glp_load_matrix(p->prob, (p->ci)-1, p->ia, p->ja, p->ar);
865 * Solves the LP problem
867 * @param mlp the MLP Handle
868 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
871 mlp_solve_lp_problem (struct GAS_MLP_Handle *mlp)
875 res = glp_simplex(mlp->p.prob, &mlp->control_param_lp);
877 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving LP problem: 0x%02X %s\n", res, mlp_solve_to_string(res));
879 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving LP problem failed: 0x%02X %s\n", res, mlp_solve_to_string(res));
881 /* Analyze problem status */
882 res = glp_get_status (mlp->p.prob);
884 /* solution is optimal */
886 /* solution is feasible */
888 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving LP problem: 0x%02X %s\n",
889 res, mlp_status_to_string(res));
891 /* Problem was ill-defined, no way to handle that */
893 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving LP problem failed, no solution: 0x%02X %s\n",
894 res, mlp_status_to_string(res));
895 return GNUNET_SYSERR;
901 * Solves the MLP problem
903 * @param mlp the MLP Handle
904 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
907 mlp_solve_mlp_problem (struct GAS_MLP_Handle *mlp)
910 res = glp_intopt(mlp->p.prob, &mlp->control_param_mlp);
912 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving MLP problem: 0x%02X %s\n", res, mlp_solve_to_string(res));
914 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving MLP problem failed: 0x%02X %s\n", res, mlp_solve_to_string(res));
915 /* Analyze problem status */
916 res = glp_mip_status(mlp->p.prob);
918 /* solution is optimal */
920 /* solution is feasible */
922 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving MLP problem: 0x%02X %s\n", res, mlp_status_to_string(res));
924 /* Problem was ill-defined, no way to handle that */
926 LOG (GNUNET_ERROR_TYPE_WARNING,"Solving MLP problem failed, 0x%02X %s\n\n", res, mlp_status_to_string(res));
927 return GNUNET_SYSERR;
933 * Propagates the results when MLP problem was solved
935 * @param cls the MLP handle
936 * @param key the peer identity
937 * @param value the address
938 * @return GNUNET_OK to continue
941 mlp_propagate_results (void *cls, const struct GNUNET_HashCode *key, void *value)
943 struct GAS_MLP_Handle *mlp = cls;
944 struct ATS_Address *address;
945 struct MLP_information *mlpi;
946 double mlp_bw_in = MLP_NaN;
947 double mlp_bw_out = MLP_NaN;
948 double mlp_use = MLP_NaN;
950 /* Check if we have to add this peer due to a pending request */
951 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(mlp->requested_peers, key))
954 GNUNET_assert (address->solver_information != NULL);
955 mlpi = address->solver_information;
957 mlp_bw_in = glp_mip_col_val(mlp->p.prob, mlpi->c_b);/* FIXME */
958 if (mlp_bw_in > (double) UINT32_MAX)
960 LOG (GNUNET_ERROR_TYPE_DEBUG, "Overflow in assigned bandwidth, reducing ...\n" );
961 mlp_bw_in = (double) UINT32_MAX;
963 mlp_bw_out = glp_mip_col_val(mlp->p.prob, mlpi->c_b);
964 if (mlp_bw_out > (double) UINT32_MAX)
966 LOG (GNUNET_ERROR_TYPE_DEBUG, "Overflow in assigned bandwidth, reducing ...\n" );
967 mlp_bw_out = (double) UINT32_MAX;
969 mlp_use = glp_mip_col_val(mlp->p.prob, mlpi->c_n);
973 if ((GLP_YES == mlp_use) && (GNUNET_NO == address->active))
975 /* Address switch: Activate address*/
976 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : enabling address\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
977 address->active = GNUNET_YES;
978 address->assigned_bw_in.value__ = htonl (mlp_bw_in);
979 mlpi->b_in.value__ = htonl(mlp_bw_in);
980 address->assigned_bw_out.value__ = htonl (mlp_bw_out);
981 mlpi->b_out.value__ = htonl(mlp_bw_out);
983 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
985 else if ((GLP_NO == mlp_use) && (GNUNET_YES == address->active))
987 /* Address switch: Disable address*/
988 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : disabling address\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
989 address->active = GNUNET_NO;
990 /* Set bandwidth to 0 */
991 address->assigned_bw_in.value__ = htonl (0);
992 mlpi->b_in.value__ = htonl(mlp_bw_in);
993 address->assigned_bw_out.value__ = htonl (0);
994 mlpi->b_out.value__ = htonl(mlp_bw_out);
996 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
998 else if ((mlp_bw_out != ntohl(address->assigned_bw_out.value__)) ||
999 (mlp_bw_in != ntohl(address->assigned_bw_in.value__)))
1001 /* Bandwidth changed */
1002 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : bandwidth changed\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
1003 address->assigned_bw_in.value__ = htonl (mlp_bw_in);
1004 mlpi->b_in.value__ = htonl(mlp_bw_in);
1005 address->assigned_bw_out.value__ = htonl (mlp_bw_out);
1006 mlpi->b_out.value__ = htonl(mlp_bw_out);
1008 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
1012 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : no change\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
1021 * Solves the MLP problem
1023 * @param solver the MLP Handle
1024 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
1027 GAS_mlp_solve_problem (void *solver)
1029 struct GAS_MLP_Handle *mlp = solver;
1033 struct GNUNET_TIME_Absolute start_build;
1034 struct GNUNET_TIME_Relative duration_build;
1035 struct GNUNET_TIME_Absolute start_lp;
1036 struct GNUNET_TIME_Relative duration_lp;
1037 struct GNUNET_TIME_Absolute start_mlp;
1038 struct GNUNET_TIME_Relative duration_mlp;
1039 GNUNET_assert (NULL != solver);
1041 if (GNUNET_YES == mlp->bulk_lock)
1043 mlp->bulk_request ++;
1047 if (0 == GNUNET_CONTAINER_multihashmap_size(mlp->requested_peers))
1052 if (0 == GNUNET_CONTAINER_multihashmap_size(mlp->addresses))
1058 if ((GNUNET_NO == mlp->mlp_prob_changed) && (GNUNET_NO == mlp->mlp_prob_updated))
1060 LOG (GNUNET_ERROR_TYPE_DEBUG, "No changes to problem\n");
1063 if (GNUNET_YES == mlp->mlp_prob_changed)
1065 LOG (GNUNET_ERROR_TYPE_DEBUG, "Problem size changed, rebuilding\n");
1066 mlp_delete_problem (mlp);
1067 start_build = GNUNET_TIME_absolute_get();
1068 if (GNUNET_SYSERR == mlp_create_problem (mlp))
1069 return GNUNET_SYSERR;
1070 duration_build = GNUNET_TIME_absolute_get_duration (start_build);
1071 mlp->control_param_lp.presolve = GLP_YES;
1072 mlp->control_param_mlp.presolve = GNUNET_NO; /* No presolver, we have LP solution */
1076 LOG (GNUNET_ERROR_TYPE_DEBUG, "Problem was updated, resolving\n");
1077 duration_build.rel_value = 0;
1081 LOG (GNUNET_ERROR_TYPE_DEBUG, "Running LP solver %s\n", (GLP_YES == mlp->control_param_lp.presolve)? "with presolver": "without presolver");
1082 start_lp = GNUNET_TIME_absolute_get();
1083 res_lp = mlp_solve_lp_problem (mlp);
1084 duration_lp = GNUNET_TIME_absolute_get_duration (start_lp);
1088 LOG (GNUNET_ERROR_TYPE_DEBUG, "Running MLP solver \n");
1089 start_mlp = GNUNET_TIME_absolute_get();
1090 res_mip = mlp_solve_mlp_problem (mlp);
1092 duration_mlp = GNUNET_TIME_absolute_get_duration (start_mlp);
1095 mlp->ps.lp_res = res_lp;
1096 mlp->ps.mip_res = res_mip;
1097 mlp->ps.build_dur = duration_build;
1098 mlp->ps.lp_dur = duration_lp;
1099 mlp->ps.mip_dur = duration_mlp;
1100 mlp->ps.lp_presolv = mlp->control_param_lp.presolve;
1101 mlp->ps.mip_presolv = mlp->control_param_mlp.presolve;
1102 mlp->ps.p_cols = glp_get_num_cols (mlp->p.prob);
1103 mlp->ps.p_rows = glp_get_num_rows (mlp->p.prob);
1104 mlp->ps.p_elements = mlp->p.num_elements;
1106 LOG (GNUNET_ERROR_TYPE_DEBUG, "Execution time: Build %llu ms, LP %llu ms, MLP %llu ms\n",
1107 (unsigned long long) duration_build.rel_value,
1108 (unsigned long long) duration_lp.rel_value,
1109 (unsigned long long) duration_mlp.rel_value);
1111 /* Propagate result*/
1112 if ((GNUNET_OK == res_lp) && (GNUNET_OK == res_mip))
1113 GNUNET_CONTAINER_multihashmap_iterate (mlp->addresses, &mlp_propagate_results, mlp);
1115 struct GNUNET_TIME_Absolute time = GNUNET_TIME_absolute_get();
1116 if (GNUNET_YES == mlp->write_mip_mps)
1118 /* Write problem to disk */
1119 GNUNET_asprintf (&filename, "problem_p_%u_a%u_%llu.mps", mlp->p.num_peers, mlp->p.num_addresses, time.abs_value);
1120 LOG (GNUNET_ERROR_TYPE_ERROR, "DUMP: %s \n", filename);
1121 glp_write_lp(mlp->p.prob, NULL, filename);
1122 GNUNET_free (filename);
1124 if (GNUNET_YES == mlp->write_mip_sol)
1126 /* Write solution to disk */
1127 GNUNET_asprintf (&filename, "problem_p_%u_a%u_%llu.sol", mlp->p.num_peers, mlp->p.num_addresses, time.abs_value);
1128 glp_print_mip (mlp->p.prob, filename );
1129 LOG (GNUNET_ERROR_TYPE_ERROR, "DUMP: %s \n", filename);
1130 GNUNET_free (filename);
1133 /* Reset change and update marker */
1134 mlp->control_param_lp.presolve = GLP_NO;
1135 mlp->mlp_prob_updated = GNUNET_NO;
1136 mlp->mlp_prob_changed = GNUNET_NO;
1138 if ((GNUNET_OK == res_lp) && (GNUNET_OK == res_mip))
1141 return GNUNET_SYSERR;
1145 * Add a single address to the solve
1147 * @param solver the solver Handle
1148 * @param addresses the address hashmap containing all addresses
1149 * @param address the address to add
1150 * @param network network type of this address
1153 GAS_mlp_address_add (void *solver,
1154 struct ATS_Address *address,
1157 struct GAS_MLP_Handle *mlp = solver;
1159 struct MLP_information *mlpi;
1163 GNUNET_assert (NULL != solver);
1164 GNUNET_assert (NULL != address);
1166 if (NULL == address->solver_information)
1168 address->solver_information = GNUNET_malloc (sizeof (struct MLP_information));
1169 mlpi = address->solver_information;
1170 for (c1 = 0; c1 < mlp->pv.m_q; c1++)
1172 mlpi->q_averaged[c1] = DEFAULT_QUALITY;
1173 for (c2 = 0; c2 < MLP_AVERAGING_QUEUE_LENGTH; c2++)
1174 mlpi->q[c1][c2] = MLP_NaN;
1178 LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding address for peer `%s' multiple times\n"), GNUNET_i2s(&address->peer));
1180 /* Is this peer included in the problem? */
1181 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &address->peer.hashPubKey)))
1183 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding address for peer `%s' without address request \n", GNUNET_i2s(&address->peer));
1187 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding address for peer `%s' with address request \n", GNUNET_i2s(&address->peer));
1188 /* Problem size changed: new address for peer with pending request */
1189 mlp->mlp_prob_changed = GNUNET_YES;
1190 if (GNUNET_YES == mlp->mlp_auto_solve)
1191 GAS_mlp_solve_problem (solver);
1196 mlp_update_quality (struct GAS_MLP_Handle *mlp,
1197 const struct GNUNET_CONTAINER_MultiHashMap *addresses,
1198 struct ATS_Address * address,
1199 const struct GNUNET_ATS_Information *ats_prev, uint32_t ats_prev_count)
1201 struct MLP_information *mlpi = address->solver_information;
1202 unsigned int c_ats_entry;
1203 unsigned int c_queue_entries;
1205 unsigned int c_queue_it;
1207 unsigned int c_qual;
1213 uint32_t prev_value;
1222 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating %u quality metrics for peer `%s'\n",
1223 ats_prev_count, GNUNET_i2s (&address->peer));
1225 GNUNET_assert (NULL != mlp);
1226 GNUNET_assert (NULL != address);
1227 GNUNET_assert (NULL != address->solver_information);
1228 GNUNET_assert (NULL != ats_prev);
1230 if (NULL == mlp->p.prob)
1233 qual_changed = GNUNET_NO;
1234 for (c_ats_entry = 0; c_ats_entry < ats_prev_count; c_ats_entry++)
1236 type = ntohl (ats_prev[c_ats_entry].type);
1237 prev_value = ntohl (ats_prev[c_ats_entry].value);
1241 /* Check for network update */
1242 if (type == GNUNET_ATS_NETWORK_TYPE)
1244 new_value = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
1245 if (GNUNET_ATS_VALUE_UNDEFINED == new_value)
1246 new_value = GNUNET_ATS_NET_UNSPECIFIED;
1247 if (new_value != prev_value)
1249 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating network for peer `%s' from `%s' to `%s'\n",
1250 GNUNET_i2s (&address->peer),
1251 GNUNET_ATS_print_network_type(prev_value),
1252 GNUNET_ATS_print_network_type(new_value));
1255 if (mlpi->c_b == MLP_UNDEFINED)
1256 continue; /* This address is not yet in the matrix*/
1258 rows = glp_get_num_rows(mlp->p.prob);
1259 ind = GNUNET_malloc (rows * sizeof (int) + 1);
1260 val = GNUNET_malloc (rows * sizeof (double) + 1);
1261 int length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1263 for (c_net = 0; c_net <= length + 1; c_net ++)
1265 if (ind[c_net] == mlp->p.r_quota[prev_value])
1266 break; /* Found index for old network */
1269 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1270 /* Set updated column */
1271 ind[c_net] = mlp->p.r_quota[new_value];
1273 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1277 rows = glp_get_num_rows(mlp->p.prob);
1278 ind = GNUNET_malloc (rows * sizeof (int) + 1);
1279 val = GNUNET_malloc (rows * sizeof (double) + 1);
1280 length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1282 for (c_net = 0; c_net <= length + 1; c_net ++)
1284 if (ind[c_net] == mlp->p.r_quota[prev_value])
1285 LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing old network index [%u] == [%f]\n",ind[c_net],val[c_net]);
1286 if (ind[c_net] == mlp->p.r_quota[new_value])
1288 LOG (GNUNET_ERROR_TYPE_DEBUG, "Setting new network index [%u] == [%f]\n",ind[c_net],val[c_net]);
1294 mlp->mlp_prob_changed = GNUNET_YES;
1299 /* Find index for this ATS type */
1300 for (c_cmp = 0; c_cmp < mlp->pv.m_q; c_cmp++)
1302 if (type == mlp->pv.q[c_cmp])
1308 if (-1 == type_index)
1309 continue; /* quality index not found */
1311 /* Get average queue index */
1312 avg_index = mlpi->q_avg_i[type_index];
1314 /* Update averaging queue */
1315 new_value = get_performance_info (address, type);
1316 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating peer `%s': `%s' from %u to %u\n",
1317 GNUNET_i2s (&address->peer),
1318 mlp_ats_to_string(mlp->pv.q[type_index]), prev_value, new_value);
1319 GNUNET_assert (GNUNET_ATS_VALUE_UNDEFINED != new_value);
1320 mlpi->q[type_index][avg_index] = new_value;
1322 /* Update averaging index */
1323 if (mlpi->q_avg_i[type_index] + 1 < (MLP_AVERAGING_QUEUE_LENGTH))
1324 mlpi->q_avg_i[type_index] ++;
1326 mlpi->q_avg_i[type_index] = 0;
1328 /* Update average depending on ATS type */
1331 case GNUNET_ATS_QUALITY_NET_DISTANCE:
1332 case GNUNET_ATS_QUALITY_NET_DELAY:
1333 c_queue_entries = 0;
1335 for (c_queue_it = 0; c_queue_it < MLP_AVERAGING_QUEUE_LENGTH; c_queue_it++)
1337 if (mlpi->q[type_index][c_queue_it] != MLP_NaN)
1339 queue = mlpi->q[type_index] ;
1340 avg += queue[c_queue_it];
1344 if ((c_queue_entries > 0) && (avg > 0))
1345 /* avg = 1 / ((q[0] + ... + q[l]) /c3) => c3 / avg*/
1346 mlpi->q_averaged[type_index] = (double) c_queue_entries / avg;
1348 mlpi->q_averaged[type_index] = 0.0;
1350 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating peer `%s': `%s' average sum of %u elements == %f, average == %f, weight == %f\n",
1351 GNUNET_i2s (&address->peer),
1352 mlp_ats_to_string(mlp->pv.q[type_index]),
1355 avg / (double) c_queue_entries,
1356 mlpi->q_averaged[type_index]);
1357 qual_changed = GNUNET_YES;
1361 LOG (GNUNET_ERROR_TYPE_DEBUG, _("Update for ATS type `%s' not implemented!\n"),
1362 mlp_ats_to_string(type));
1366 /* Changed, but quality will be automatically set during rebuild */
1367 if ((GNUNET_YES == mlp->mlp_prob_changed) &&
1368 (GNUNET_YES == mlp->mlp_auto_solve))
1370 GAS_mlp_solve_problem (mlp);
1374 /* Update problem matrix if required */
1375 if (GNUNET_NO == qual_changed)
1378 /* Address not yet included in matrix */
1379 if (MLP_UNDEFINED == mlpi->c_b)
1382 /* Update c7) [r_q[index]][c_b] = f_q * q_averaged[type_index]
1383 * Get column mlpi->c_b */
1384 rows = glp_get_num_rows(mlp->p.prob);
1385 ind = GNUNET_malloc (rows * sizeof (int) + 1);
1386 val = GNUNET_malloc (rows * sizeof (double) + 1);
1387 int length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1389 for (c_qual = 0; c_qual < mlp->pv.m_q; c_qual++)
1391 for (c_row = 0; c_row <= length; c_row ++)
1393 if (ind[c_row] == mlp->p.r_q[c_qual])
1394 val[c_row] = mlpi->q_averaged[c_qual];
1397 /* Set updated column */
1398 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1401 mlp->mlp_prob_updated = GNUNET_YES;
1405 * Updates a single address in the MLP problem
1407 * If the address did not exist before in the problem:
1408 * The MLP problem has to be recreated and the problem has to be resolved
1410 * ATS performance information in address are already updated, delta + previous
1411 * values are included in atsi_prev (value GNUNET_ATS_VALUE_UNDEFINED if not existing before)
1413 * Otherwise the addresses' values can be updated and the existing base can
1416 * @param solver the solver Handle
1417 * @param addresses the address hashmap containing all addresses
1418 * @param address the update address
1419 * @param prev_session the new session (if changed otherwise current)
1420 * @param prev_in_use the new address in use state (if changed otherwise current)
1421 * @param prev_atsi ATS information updated + previous values, GNUNET_ATS_VALUE_UNDEFINED if not existing before
1422 * @param prev_atsi_count number of atsi values updated
1425 GAS_mlp_address_update (void *solver,
1426 struct ATS_Address *address,
1427 uint32_t prev_session,
1429 const struct GNUNET_ATS_Information *prev_atsi,
1430 uint32_t prev_atsi_count)
1433 struct GAS_MLP_Handle *mlp = solver;
1434 struct MLP_information *mlpi = address->solver_information;
1436 GNUNET_assert (NULL != solver);
1437 GNUNET_assert (NULL != address);
1438 GNUNET_assert ((NULL != prev_atsi) || (0 == prev_atsi_count));
1442 LOG (GNUNET_ERROR_TYPE_ERROR, _("Updating address for peer `%s' not added before\n"), GNUNET_i2s(&address->peer));
1445 mlp_update_quality (mlp, mlp->addresses, address, prev_atsi, prev_atsi_count);
1447 /* Is this peer included in the problem? */
1448 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &address->peer.hashPubKey)))
1450 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating address for peer `%s' without address request \n", GNUNET_i2s(&address->peer));
1453 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating address for peer `%s' with address request \n", GNUNET_i2s(&address->peer));
1455 /* Problem size changed: new address for peer with pending request */
1456 mlp->mlp_prob_updated = GNUNET_YES;
1458 if (GNUNET_YES == mlp->mlp_auto_solve)
1459 GAS_mlp_solve_problem (solver);
1464 * Deletes a single address in the MLP problem
1466 * The MLP problem has to be recreated and the problem has to be resolved
1468 * @param solver the MLP Handle
1469 * @param addresses the address hashmap
1470 * the address has to be already removed from the hashmap
1471 * @param address the address to delete
1472 * @param session_only delete only session not whole address
1475 GAS_mlp_address_delete (void *solver,
1476 struct ATS_Address *address,
1480 struct GAS_MLP_Handle *mlp = solver;
1481 struct MLP_information *mlpi;
1483 GNUNET_assert (NULL != solver);
1484 GNUNET_assert (NULL != address);
1486 mlpi = address->solver_information;
1487 if ((GNUNET_NO == session_only) && (NULL != mlpi))
1490 address->solver_information = NULL;
1493 /* Is this peer included in the problem? */
1494 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &address->peer.hashPubKey)))
1496 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s for peer `%s' without address request \n",
1497 (session_only == GNUNET_YES) ? "session" : "address",
1498 GNUNET_i2s(&address->peer));
1501 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s for peer `%s' with address request \n",
1502 (session_only == GNUNET_YES) ? "session" : "address",
1503 GNUNET_i2s(&address->peer));
1505 /* Problem size changed: new address for peer with pending request */
1506 mlp->mlp_prob_changed = GNUNET_YES;
1507 if (GNUNET_YES == mlp->mlp_auto_solve)
1508 GAS_mlp_solve_problem (solver);
1514 * Find the active address in the set of addresses of a peer
1515 * @param cls destination
1516 * @param key peer id
1517 * @param value address
1521 mlp_get_preferred_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1524 struct ATS_Address *aa = (struct ATS_Address *) cls;
1525 struct ATS_Address *addr = value;
1526 struct MLP_information *mlpi = addr->solver_information;
1529 if (mlpi->n == GNUNET_YES)
1532 aa->assigned_bw_in = mlpi->b_in;
1533 aa->assigned_bw_out = mlpi->b_out;
1540 static double get_peer_pref_value (struct GAS_MLP_Handle *mlp, const struct GNUNET_PeerIdentity *peer)
1543 const double *preferences = NULL;
1545 preferences = mlp->get_preferences (mlp->get_preferences_cls, peer);
1548 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
1550 if (c != GNUNET_ATS_PREFERENCE_END)
1552 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
1553 res += preferences[c];
1556 res /= (GNUNET_ATS_PreferenceCount -1);
1562 * Get the preferred address for a specific peer
1564 * @param solver the MLP Handle
1565 * @param addresses address hashmap
1566 * @param peer the peer
1567 * @return suggested address
1569 const struct ATS_Address *
1570 GAS_mlp_get_preferred_address (void *solver,
1571 const struct GNUNET_PeerIdentity *peer)
1573 struct GAS_MLP_Handle *mlp = solver;
1575 struct ATS_Address *res = NULL;
1577 GNUNET_assert (NULL != solver);
1578 GNUNET_assert (NULL != peer);
1580 LOG (GNUNET_ERROR_TYPE_DEBUG, "Getting preferred address for `%s'\n",
1583 /* Is this peer included in the problem? */
1584 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &peer->hashPubKey)))
1586 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding peer `%s' to list of requested_peers with requests\n",
1589 p = GNUNET_malloc (sizeof (struct ATS_Peer));
1591 p->f = get_peer_pref_value (mlp, peer);
1592 GNUNET_CONTAINER_multihashmap_put (mlp->requested_peers, &peer->hashPubKey, p, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1594 /* Added new peer, we have to rebuild problem before solving */
1595 mlp->mlp_prob_changed = GNUNET_YES;
1597 if (GNUNET_YES == mlp->mlp_auto_solve)
1598 GAS_mlp_solve_problem (mlp);
1600 /* Get prefered address */
1601 GNUNET_CONTAINER_multihashmap_get_multiple (mlp->addresses, &peer->hashPubKey,
1602 mlp_get_preferred_address_it, res);
1609 * Start a bulk operation
1611 * @param solver the solver
1614 GAS_mlp_bulk_start (void *solver)
1616 LOG (GNUNET_ERROR_TYPE_DEBUG, "Locking solver for bulk operation ...\n");
1617 struct GAS_MLP_Handle *s = (struct GAS_MLP_Handle *) solver;
1619 GNUNET_assert (NULL != solver);
1625 GAS_mlp_bulk_stop (void *solver)
1627 LOG (GNUNET_ERROR_TYPE_DEBUG, "Unlocking solver from bulk operation ...\n");
1629 struct GAS_MLP_Handle *s = (struct GAS_MLP_Handle *) solver;
1630 GNUNET_assert (NULL != solver);
1632 if (s->bulk_lock < 1)
1639 if (0 < s->bulk_request)
1641 GAS_mlp_solve_problem (solver);
1649 * Stop notifying about address and bandwidth changes for this peer
1651 * @param solver the MLP handle
1652 * @param addresses address hashmap
1653 * @param peer the peer
1656 GAS_mlp_stop_get_preferred_address (void *solver,
1657 const struct GNUNET_PeerIdentity *peer)
1659 struct GAS_MLP_Handle *mlp = solver;
1660 struct ATS_Peer *p = NULL;
1662 GNUNET_assert (NULL != solver);
1663 GNUNET_assert (NULL != peer);
1665 if (NULL != (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &peer->hashPubKey)))
1667 GNUNET_CONTAINER_multihashmap_remove (mlp->requested_peers, &peer->hashPubKey, p);
1674 * Changes the preferences for a peer in the MLP problem
1676 * @param solver the MLP Handle
1677 * @param addresses the address hashmap
1678 * @param peer the peer
1679 * @param kind the kind to change the preference
1680 * @param pref_rel the relative score
1683 GAS_mlp_address_change_preference (void *solver,
1684 const struct GNUNET_PeerIdentity *peer,
1685 enum GNUNET_ATS_PreferenceKind kind,
1688 struct GAS_MLP_Handle *mlp = solver;
1689 struct ATS_Peer *p = NULL;
1691 LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing preference for address for peer `%s' to %.2f\n",
1692 GNUNET_i2s(peer), pref_rel);
1694 GNUNET_STATISTICS_update (mlp->stats,"# LP address preference changes", 1, GNUNET_NO);
1695 /* Update the constraints with changed preferences */
1697 /* Update quality constraint c7 */
1699 /* Update relativity constraint c9 */
1700 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->requested_peers, &peer->hashPubKey)))
1702 LOG (GNUNET_ERROR_TYPE_ERROR, "Updating preference for unknown peer `%s'\n", GNUNET_i2s(peer));
1705 p->f = get_peer_pref_value (mlp, peer);
1706 LOG (GNUNET_ERROR_TYPE_ERROR, "PEER PREF: %s %.2f\n",
1707 GNUNET_i2s(peer), p->f);
1708 mlp_create_problem_update_value (&mlp->p, p->r_c9, mlp->p.c_r, -p->f, __LINE__);
1710 /* Problem size changed: new address for peer with pending request */
1711 mlp->mlp_prob_updated = GNUNET_YES;
1712 if (GNUNET_YES == mlp->mlp_auto_solve)
1713 GAS_mlp_solve_problem (solver);
1719 mlp_free_peers (void *cls, const struct GNUNET_HashCode *key, void *value)
1721 struct GNUNET_CONTAINER_MultiHashMap *map = cls;
1722 struct ATS_Peer *p = value;
1724 GNUNET_CONTAINER_multihashmap_remove (map, key, value);
1732 * Shutdown the MLP problem solving component
1734 * @param solver the solver handle
1737 GAS_mlp_done (void *solver)
1739 struct GAS_MLP_Handle *mlp = solver;
1740 GNUNET_assert (mlp != NULL);
1742 LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutting down mlp solver\n");
1743 mlp_delete_problem (mlp);
1745 GNUNET_CONTAINER_multihashmap_iterate (mlp->requested_peers, &mlp_free_peers, mlp->requested_peers);
1746 GNUNET_CONTAINER_multihashmap_destroy (mlp->requested_peers);
1747 mlp->requested_peers = NULL;
1749 /* Clean up GLPK environment */
1753 LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutdown down of mlp solver complete\n");
1758 * Init the MLP problem solving component
1760 * @param cfg the GNUNET_CONFIGURATION_Handle handle
1761 * @param stats the GNUNET_STATISTICS handle
1762 * @param network array of GNUNET_ATS_NetworkType with length dest_length
1763 * @param out_dest array of outbound quotas
1764 * @param in_dest array of outbound quota
1765 * @param dest_length array length for quota arrays
1766 * @param bw_changed_cb callback for changed bandwidth amounts
1767 * @param bw_changed_cb_cls cls for callback
1768 * @param get_preference callback to get relative preferences for a peer
1769 * @param get_preference_cls cls for callback to get relative preferences
1770 * @return struct GAS_MLP_Handle on success, NULL on fail
1773 GAS_mlp_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1774 const struct GNUNET_STATISTICS_Handle *stats,
1775 const struct GNUNET_CONTAINER_MultiHashMap *addresses,
1777 unsigned long long *out_dest,
1778 unsigned long long *in_dest,
1780 GAS_bandwidth_changed_cb bw_changed_cb,
1781 void *bw_changed_cb_cls,
1782 GAS_get_preferences get_preference,
1783 void *get_preference_cls,
1784 GAS_get_properties get_properties,
1785 void *get_properties_cls)
1787 struct GAS_MLP_Handle * mlp = GNUNET_malloc (sizeof (struct GAS_MLP_Handle));
1792 unsigned long long tmp;
1799 struct GNUNET_TIME_Relative max_duration;
1800 long long unsigned int max_iterations;
1802 GNUNET_assert (NULL != cfg);
1803 GNUNET_assert (NULL != stats);
1804 GNUNET_assert (NULL != addresses);
1805 GNUNET_assert (NULL != bw_changed_cb);
1806 GNUNET_assert (NULL != get_preference);
1807 GNUNET_assert (NULL != get_properties);
1809 /* Init GLPK environment */
1810 int res = glp_init_env();
1813 LOG (GNUNET_ERROR_TYPE_DEBUG, "GLPK: `%s'\n",
1814 "initialization successful");
1817 LOG (GNUNET_ERROR_TYPE_DEBUG, "GLPK: `%s'\n",
1818 "environment is already initialized");
1821 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not init GLPK: `%s'\n",
1822 "initialization failed (insufficient memory)");
1827 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not init GLPK: `%s'\n",
1828 "initialization failed (unsupported programming model)");
1836 mlp->write_mip_mps = GNUNET_CONFIGURATION_get_value_yesno (cfg, "ats",
1838 if (GNUNET_SYSERR == mlp->write_mip_mps)
1839 mlp->write_mip_mps = GNUNET_NO;
1840 mlp->write_mip_sol = GNUNET_CONFIGURATION_get_value_yesno (cfg, "ats",
1842 if (GNUNET_SYSERR == mlp->write_mip_sol)
1843 mlp->write_mip_sol = GNUNET_NO;
1845 mlp->pv.BIG_M = (double) BIG_M_VALUE;
1847 /* Get timeout for iterations */
1848 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time(cfg, "ats", "MLP_MAX_DURATION", &max_duration))
1850 max_duration = MLP_MAX_EXEC_DURATION;
1853 /* Get maximum number of iterations */
1854 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_size(cfg, "ats", "MLP_MAX_ITERATIONS", &max_iterations))
1856 max_iterations = MLP_MAX_ITERATIONS;
1859 /* Get diversity coefficient from configuration */
1860 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1861 "MLP_COEFFICIENT_D",
1863 D = (double) tmp / 100;
1867 /* Get proportionality coefficient from configuration */
1868 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1869 "MLP_COEFFICIENT_R",
1871 R = (double) tmp / 100;
1875 /* Get utilization coefficient from configuration */
1876 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1877 "MLP_COEFFICIENT_U",
1879 U = (double) tmp / 100;
1883 /* Get quality metric coefficients from configuration */
1884 int i_delay = MLP_NaN;
1885 int i_distance = MLP_NaN;
1886 int q[GNUNET_ATS_QualityPropertiesCount] = GNUNET_ATS_QualityProperties;
1887 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
1889 /* initialize quality coefficients with default value 1.0 */
1890 mlp->pv.co_Q[c] = DEFAULT_QUALITY;
1892 mlp->pv.q[c] = q[c];
1893 if (q[c] == GNUNET_ATS_QUALITY_NET_DELAY)
1895 if (q[c] == GNUNET_ATS_QUALITY_NET_DISTANCE)
1899 if ((i_delay != MLP_NaN) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1900 "MLP_COEFFICIENT_QUALITY_DELAY",
1903 mlp->pv.co_Q[i_delay] = (double) tmp / 100;
1905 mlp->pv.co_Q[i_delay] = DEFAULT_QUALITY;
1907 if ((i_distance != MLP_NaN) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1908 "MLP_COEFFICIENT_QUALITY_DISTANCE",
1910 mlp->pv.co_Q[i_distance] = (double) tmp / 100;
1912 mlp->pv.co_Q[i_distance] = DEFAULT_QUALITY;
1914 /* Get minimum bandwidth per used address from configuration */
1915 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1916 "MLP_MIN_BANDWIDTH",
1921 b_min = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1924 /* Get minimum number of connections from configuration */
1925 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1926 "MLP_MIN_CONNECTIONS",
1930 n_min = DEFAULT_MIN_CONNECTIONS;
1932 /* Init network quotas */
1933 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1934 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
1937 for (c2 = 0; c2 < dest_length; c2++)
1939 if (quotas[c] == network[c2])
1941 mlp->pv.quota_index[c] = network[c2];
1942 mlp->pv.quota_out[c] = out_dest[c2];
1943 mlp->pv.quota_in[c] = in_dest[c2];
1945 LOG (GNUNET_ERROR_TYPE_DEBUG, "Quota for network `%s' (in/out) %llu/%llu\n",
1946 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1947 mlp->pv.quota_out[c],
1948 mlp->pv.quota_in[c]);
1953 /* Check if defined quota could make problem unsolvable */
1954 if ((n_min * b_min) > mlp->pv.quota_out[c])
1956 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inconsistent outbound quota configuration for network `%s', is %llu must be at least %llu\n"),
1957 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1958 mlp->pv.quota_out[c],
1960 mlp->pv.quota_out[c] = (n_min * b_min);
1962 if ((n_min * b_min) > mlp->pv.quota_in[c])
1964 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inconsistent inbound quota configuration for network `%s', is %llu must be at least %llu\n"),
1965 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1966 mlp->pv.quota_in[c],
1968 mlp->pv.quota_in[c] = (n_min * b_min);
1971 /* Check if bandwidth is too big to make problem solvable */
1972 if (mlp->pv.BIG_M < mlp->pv.quota_out[c])
1974 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting outbound quota configuration for network `%s'from %llu to %.0f\n"),
1975 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1976 mlp->pv.quota_out[c],
1978 mlp->pv.quota_out[c] = mlp->pv.BIG_M ;
1980 if (mlp->pv.BIG_M < mlp->pv.quota_in[c])
1982 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inbound quota configuration for network `%s' from %llu to %.0f\n"),
1983 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1984 mlp->pv.quota_in[c],
1986 mlp->pv.quota_in[c] = mlp->pv.BIG_M ;
1989 if (GNUNET_NO == found)
1991 mlp->pv.quota_in[c] = ntohl(GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1992 mlp->pv.quota_out[c] = ntohl(GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1993 LOG (GNUNET_ERROR_TYPE_INFO, _("Using default quota configuration for network `%s' (in/out) %llu/%llu\n"),
1994 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1995 mlp->pv.quota_in[c],
1996 mlp->pv.quota_out[c]);
2000 /* Assign options to handle */
2001 mlp->stats = (struct GNUNET_STATISTICS_Handle *) stats;
2002 mlp->addresses = addresses;
2003 mlp->bw_changed_cb = bw_changed_cb;
2004 mlp->bw_changed_cb_cls = bw_changed_cb_cls;
2005 mlp->get_preferences = get_preference;
2006 mlp->get_preferences_cls = get_preference_cls;
2007 mlp->get_properties = get_properties;
2008 mlp->get_properties_cls = get_properties_cls;
2009 /* Setting MLP Input variables */
2013 mlp->pv.b_min = b_min;
2014 mlp->pv.n_min = n_min;
2015 mlp->pv.m_q = GNUNET_ATS_QualityPropertiesCount;
2016 mlp->mlp_prob_changed = GNUNET_NO;
2017 mlp->mlp_prob_updated = GNUNET_NO;
2018 mlp->mlp_auto_solve = GNUNET_YES;
2019 mlp->requested_peers = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
2020 mlp->bulk_request = 0;
2024 /* Redirect GLPK output to GNUnet logging */
2025 glp_term_hook (&mlp_term_hook, (void *) mlp);
2027 /* Init LP solving parameters */
2028 glp_init_smcp(&mlp->control_param_lp);
2029 mlp->control_param_lp.msg_lev = GLP_MSG_OFF;
2031 mlp->control_param_lp.msg_lev = GLP_MSG_ALL;
2033 mlp->control_param_lp.it_lim = max_iterations;
2034 mlp->control_param_lp.tm_lim = max_duration.rel_value;
2036 /* Init MLP solving parameters */
2037 glp_init_iocp(&mlp->control_param_mlp);
2038 mlp->control_param_mlp.msg_lev = GLP_MSG_OFF;
2040 mlp->control_param_mlp.msg_lev = GLP_MSG_ALL;
2042 mlp->control_param_mlp.tm_lim = max_duration.rel_value;
2044 LOG (GNUNET_ERROR_TYPE_DEBUG, "solver ready\n");
2049 /* end of gnunet-service-ats_addresses_mlp.c */