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->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 * sizeof (double));
445 GNUNET_assert (NULL != val_array);
446 ind_array = GNUNET_malloc (c_cols * 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)))
453 /* Update the value */
454 for (c1 = 0; c1 <= c_elems; c1++)
456 if (ind_array[c1] == row)
460 return; /* not found */
465 /* Update the row in the matrix */
466 glp_set_mat_row (p->prob, row, c_elems, ind_array, val_array);
467 GNUNET_free (ind_array);
468 GNUNET_free (val_array);
473 * Creates a new value in the matrix
475 * Sets the row and column index in the problem array and increments the
478 * @param p the mlp problem
479 * @param row the row to create the value in
480 * @param col the column to create the value in
481 * @param val the value to set
482 * @param line calling line for debbuging
485 mlp_create_problem_set_value (struct MLP_Problem *p,
486 int row, int col, double val,
489 if ((p->ci) >= p->num_elements)
491 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: line %u: Request for index %u bigger than array size of %u\n",
492 line, p->ci + 1, p->num_elements);
496 if ((0 == row) || (0 == col))
501 #if DEBUG_MLP_PROBLEM_CREATION
502 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: line %u: Set value [%u,%u] in index %u == %.2f\n",
503 line, p->ia[p->ci], p->ja[p->ci], p->ci, p->ar[p->ci]);
509 mlp_create_problem_create_column (struct MLP_Problem *p, char *name,
510 unsigned int type, unsigned int bound, double lb, double ub,
513 int col = glp_add_cols (p->prob, 1);
514 glp_set_col_name (p->prob, col, name);
515 glp_set_col_bnds (p->prob, col, bound, lb, ub);
516 glp_set_col_kind (p->prob, col, type);
517 glp_set_obj_coef (p->prob, col, coef);
518 #if DEBUG_MLP_PROBLEM_CREATION
519 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: Added column [%u] `%s': %.2f\n",
526 mlp_create_problem_create_constraint (struct MLP_Problem *p, char *name,
527 unsigned int bound, double lb, double ub)
530 int row = glp_add_rows (p->prob, 1);
532 glp_set_row_name (p->prob, row, name);
533 /* set row bounds: <= 0 */
534 glp_set_row_bnds (p->prob, row, bound, lb, ub);
537 GNUNET_asprintf(&op, "-inf <= x <= %.2f", ub);
540 GNUNET_asprintf(&op, "%.2f <= x <= %.2f", lb, ub);
543 GNUNET_asprintf(&op, "%.2f == x == %.2f", lb, ub);
546 GNUNET_asprintf(&op, "%.2f <= x <= inf", lb);
549 GNUNET_asprintf(&op, "ERROR");
552 #if DEBUG_MLP_PROBLEM_CREATION
553 LOG (GNUNET_ERROR_TYPE_DEBUG, "[P]: Added row [%u] `%s': %s\n",
562 * - address columns b and n
563 * - address dependent constraint rows c1, c3
564 * - peer dependent rows c2 and c9
565 * - Set address dependent entries in problem matrix as well
568 mlp_create_problem_add_address_information (void *cls, const struct GNUNET_HashCode *key, void *value)
570 struct GAS_MLP_Handle *mlp = cls;
571 struct MLP_Problem *p = &mlp->p;
572 struct ATS_Address *address = value;
573 struct ATS_Peer *peer;
574 struct MLP_information *mlpi;
579 /* Check if we have to add this peer due to a pending request */
580 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(mlp->peers, key))
583 mlpi = address->solver_information;
591 peer = GNUNET_CONTAINER_multihashmap_get (mlp->peers, key);
592 if (peer->processed == GNUNET_NO)
594 /* Add peer dependent constraints */
595 /* Add constraint c2 */
596 GNUNET_asprintf(&name, "c2_%s", GNUNET_i2s(&address->peer));
597 peer->r_c2 = mlp_create_problem_create_constraint (p, name, GLP_FX, 1.0, 1.0);
599 /* Add constraint c9 */
600 GNUNET_asprintf(&name, "c9_%s", GNUNET_i2s(&address->peer));
601 peer->r_c9 = mlp_create_problem_create_constraint (p, name, GLP_LO, 0.0, 0.0);
603 /* c 9) set coefficient */
604 mlp_create_problem_set_value (p, peer->r_c9, p->c_r, -peer->f, __LINE__);
606 peer->processed = GNUNET_YES;
609 /* Reset addresses' solver information */
615 for (c = 0; c < mlp->pv.m_q; c++)
618 /* Add bandwidth column */
619 GNUNET_asprintf (&name, "b_%s_%s_%p", GNUNET_i2s (&address->peer), address->plugin, address);
620 #if TEST_MAX_BW_ASSIGNMENT
621 mlpi->c_b = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 1.0);
623 mlpi->c_b = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 0.0);
628 /* Add usage column */
629 GNUNET_asprintf (&name, "n_%s_%s_%p", GNUNET_i2s (&address->peer), address->plugin, address);
630 mlpi->c_n = mlp_create_problem_create_column (p, name, GLP_IV, GLP_DB, 0.0, 1.0, 0.0);
633 /* Add address dependent constraints */
634 /* Add constraint c1) bandwidth capping
635 * b_t + (-M) * n_t <= 0
637 GNUNET_asprintf(&name, "c1_%s_%s_%p", GNUNET_i2s(&address->peer), address->plugin, address);
638 mlpi->r_c1 = mlp_create_problem_create_constraint (p, name, GLP_UP, 0.0, 0.0);
641 /* c1) set b = 1 coefficient */
642 mlp_create_problem_set_value (p, mlpi->r_c1, mlpi->c_b, 1, __LINE__);
643 /* c1) set n = -M coefficient */
644 mlp_create_problem_set_value (p, mlpi->r_c1, mlpi->c_n, -mlp->pv.BIG_M, __LINE__);
646 /* Add constraint c 3) minimum bandwidth
647 * b_t + (-n_t * b_min) >= 0
649 GNUNET_asprintf(&name, "c3_%s_%s_%p", GNUNET_i2s(&address->peer), address->plugin, address);
650 mlpi->r_c3 = mlp_create_problem_create_constraint (p, name, GLP_LO, 0.0, 0.0);
653 /* c3) set b = 1 coefficient */
654 mlp_create_problem_set_value (p, mlpi->r_c3, mlpi->c_b, 1, __LINE__);
655 /* c3) set n = -b_min coefficient */
656 mlp_create_problem_set_value (p, mlpi->r_c3, mlpi->c_n, - ((double )mlp->pv.b_min), __LINE__);
659 /* Set coefficient entries in invariant rows */
660 /* c 4) minimum connections */
661 mlp_create_problem_set_value (p, p->r_c4, mlpi->c_n, 1, __LINE__);
662 /* c 6) maximize diversity */
663 mlp_create_problem_set_value (p, p->r_c6, mlpi->c_n, 1, __LINE__);
664 /* c 2) 1 address peer peer */
665 mlp_create_problem_set_value (p, peer->r_c2, mlpi->c_n, 1, __LINE__);
666 /* c 9) relativity */
667 mlp_create_problem_set_value (p, peer->r_c9, mlpi->c_b, 1, __LINE__);
669 mlp_create_problem_set_value (p, p->r_c8, mlpi->c_b, 1, __LINE__);
671 /* c 10) obey network specific quotas
672 * (1)*b_1 + ... + (1)*b_m <= quota_n
674 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
676 addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
677 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
678 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
680 if (mlp->pv.quota_index[c] == addr_net)
682 mlp_create_problem_set_value (p, p->r_quota[c], mlpi->c_b, 1, __LINE__);
687 /* c 7) Optimize quality */
688 /* For all quality metrics, set quality of this address */
689 for (c = 0; c < mlp->pv.m_q; c++)
692 mlp_create_problem_set_value (p, p->r_q[c], mlpi->c_b, mlpi->q_averaged[c], __LINE__);
699 * Create the invariant columns c4, c6, c10, c8, c7
702 mlp_create_problem_add_invariant_rows (struct GAS_MLP_Handle *mlp, struct MLP_Problem *p)
707 /* Row for c4) minimum connection */
708 /* Number of minimum connections is min(|Peers|, n_min) */
709 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);
711 /* Add row for c6) */
712 p->r_c6 = mlp_create_problem_create_constraint (p, "c6", GLP_FX, 0.0, 0.0);
714 mlp_create_problem_set_value (p, p->r_c6, p->c_d, -1, __LINE__);
716 /* Add rows for c 10) */
717 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
720 GNUNET_asprintf(&text, "c10_quota_ats_%s", GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]));
721 p->r_quota[c] = mlp_create_problem_create_constraint (p, text, GLP_DB, 0.0, mlp->pv.quota_out[c]);
725 /* Adding rows for c 8) */
726 p->r_c8 = mlp_create_problem_create_constraint (p, "c8", GLP_FX, 0.0, 0.0);
728 mlp_create_problem_set_value (p, p->r_c8, p->c_u, -1, __LINE__);
730 /* c 7) For all quality metrics */
731 for (c = 0; c < mlp->pv.m_q; c++)
733 GNUNET_asprintf(&name, "c7_q%i_%s", c, mlp_ats_to_string(mlp->pv.q[c]));
734 p->r_q[c] = mlp_create_problem_create_constraint (p, name, GLP_FX, 0.0, 0.0);
736 mlp_create_problem_set_value (p, p->r_q[c], p->c_q[c], -1, __LINE__);
742 * Create the invariant columns d, u, r, q0 ... qm
745 mlp_create_problem_add_invariant_columns (struct GAS_MLP_Handle *mlp, struct MLP_Problem *p)
750 #if TEST_MAX_BW_ASSIGNMENT
755 //mlp->pv.co_R = 0.0;
757 /* Diversity d column */
758 p->c_d = mlp_create_problem_create_column (p, "d", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_D);
760 /* Utilization u column */
761 p->c_u = mlp_create_problem_create_column (p, "u", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_U);
763 /* Relativity r column */
764 p->c_r = mlp_create_problem_create_column (p, "r", GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_R);
766 /* Quality metric columns */
767 for (c = 0; c < mlp->pv.m_q; c++)
769 GNUNET_asprintf (&name, "q_%u", mlp->pv.q[c]);
770 #if TEST_MAX_BW_ASSIGNMENT
771 p->c_q[c] = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, 0.0);
773 p->c_q[c] = mlp_create_problem_create_column (p, name, GLP_CV, GLP_LO, 0.0, 0.0, mlp->pv.co_Q[c]);
781 * Create the MLP problem
783 * @param mlp the MLP handle
784 * @param addresses the hashmap containing all adresses
785 * @return GNUNET_OK or GNUNET_SYSERR
788 mlp_create_problem (struct GAS_MLP_Handle *mlp)
790 struct MLP_Problem *p = &mlp->p;
793 GNUNET_assert (p->prob == NULL);
794 GNUNET_assert (p->ia == NULL);
795 GNUNET_assert (p->ja == NULL);
796 GNUNET_assert (p->ar == NULL);
797 /* Reset MLP problem struct */
799 /* create the glpk problem */
800 p->prob = glp_create_prob ();
801 GNUNET_assert (NULL != p->prob);
802 p->num_peers = GNUNET_CONTAINER_multihashmap_size (mlp->peers);
803 p->num_addresses = mlp_create_problem_count_addresses (mlp->peers, mlp->addresses);
805 /* Create problem matrix: 10 * #addresses + #q * #addresses + #q, + #peer + 2 + 1 */
806 p->num_elements = (10 * p->num_addresses + mlp->pv.m_q * p->num_addresses + mlp->pv.m_q + p->num_peers + 2 + 1);
807 LOG (GNUNET_ERROR_TYPE_DEBUG, "Rebuilding problem for %u peer(s) and %u addresse(s) and %u quality metrics == %u elements\n",
808 p->num_peers, p->num_addresses, mlp->pv.m_q, p->num_elements);
810 /* Set a problem name */
811 glp_set_prob_name (p->prob, "GNUnet ATS bandwidth distribution");
812 /* Set optimization direction to maximize */
813 glp_set_obj_dir (p->prob, GLP_MAX);
815 /* Create problem matrix */
816 /* last +1 caused by glpk index starting with one: [1..elements]*/
819 p->ia = GNUNET_malloc (p->num_elements * sizeof (int));
821 p->ja = GNUNET_malloc (p->num_elements * sizeof (int));
823 p->ar = GNUNET_malloc (p->num_elements * sizeof (double));
825 if ((NULL == p->ia) || (NULL == p->ja) || (NULL == p->ar))
827 LOG (GNUNET_ERROR_TYPE_ERROR, _("Problem size too large, cannot allocate memory!\n"));
828 return GNUNET_SYSERR;
831 /* Adding invariant columns */
832 mlp_create_problem_add_invariant_columns (mlp, p);
834 /* Adding address independent constraint rows */
835 mlp_create_problem_add_invariant_rows (mlp, p);
837 /* Adding address dependent columns constraint rows */
838 GNUNET_CONTAINER_multihashmap_iterate (mlp->addresses, &mlp_create_problem_add_address_information, mlp);
840 /* Load the matrix */
841 LOG (GNUNET_ERROR_TYPE_DEBUG, "Loading matrix\n");
842 glp_load_matrix(p->prob, (p->ci)-1, p->ia, p->ja, p->ar);
848 * Solves the LP problem
850 * @param mlp the MLP Handle
851 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
854 mlp_solve_lp_problem (struct GAS_MLP_Handle *mlp)
858 res = glp_simplex(mlp->p.prob, &mlp->control_param_lp);
860 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving LP problem: 0x%02X %s\n", res, mlp_solve_to_string(res));
862 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving LP problem failed: 0x%02X %s\n", res, mlp_solve_to_string(res));
864 /* Analyze problem status */
865 res = glp_get_status (mlp->p.prob);
867 /* solution is optimal */
869 /* solution is feasible */
871 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving LP problem: 0x%02X %s\n",
872 res, mlp_status_to_string(res));
874 /* Problem was ill-defined, no way to handle that */
876 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving LP problem failed, no solution: 0x%02X %s\n",
877 res, mlp_status_to_string(res));
878 return GNUNET_SYSERR;
884 * Solves the MLP problem
886 * @param mlp the MLP Handle
887 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
890 mlp_solve_mlp_problem (struct GAS_MLP_Handle *mlp)
893 res = glp_intopt(mlp->p.prob, &mlp->control_param_mlp);
895 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving MLP problem: 0x%02X %s\n", res, mlp_solve_to_string(res));
897 LOG (GNUNET_ERROR_TYPE_WARNING, "Solving MLP problem failed: 0x%02X %s\n", res, mlp_solve_to_string(res));
898 /* Analyze problem status */
899 res = glp_mip_status(mlp->p.prob);
901 /* solution is optimal */
903 /* solution is feasible */
905 LOG (GNUNET_ERROR_TYPE_DEBUG, "Solving MLP problem: 0x%02X %s\n", res, mlp_status_to_string(res));
907 /* Problem was ill-defined, no way to handle that */
909 LOG (GNUNET_ERROR_TYPE_WARNING,"Solving MLP problem failed, 0x%02X %s\n\n", res, mlp_status_to_string(res));
910 return GNUNET_SYSERR;
916 * Propagates the results when MLP problem was solved
918 * @param cls the MLP handle
919 * @param key the peer identity
920 * @param value the address
921 * @return GNUNET_OK to continue
924 mlp_propagate_results (void *cls, const struct GNUNET_HashCode *key, void *value)
926 struct GAS_MLP_Handle *mlp = cls;
927 struct ATS_Address *address;
928 struct MLP_information *mlpi;
929 double mlp_bw_in = MLP_NaN;
930 double mlp_bw_out = MLP_NaN;
931 double mlp_use = MLP_NaN;
933 /* Check if we have to add this peer due to a pending request */
934 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(mlp->peers, key))
937 GNUNET_assert (address->solver_information != NULL);
938 mlpi = address->solver_information;
940 mlp_bw_in = glp_mip_col_val(mlp->p.prob, mlpi->c_b);/* FIXME */
941 if (mlp_bw_in > (double) UINT32_MAX)
943 LOG (GNUNET_ERROR_TYPE_DEBUG, "Overflow in assigned bandwidth, reducing ...\n" );
944 mlp_bw_in = (double) UINT32_MAX;
946 mlp_bw_out = glp_mip_col_val(mlp->p.prob, mlpi->c_b);
947 if (mlp_bw_out > (double) UINT32_MAX)
949 LOG (GNUNET_ERROR_TYPE_DEBUG, "Overflow in assigned bandwidth, reducing ...\n" );
950 mlp_bw_out = (double) UINT32_MAX;
952 mlp_use = glp_mip_col_val(mlp->p.prob, mlpi->c_n);
956 if ((GLP_YES == mlp_use) && (GNUNET_NO == address->active))
958 /* Address switch: Activate address*/
959 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : enabling address\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
960 address->active = GNUNET_YES;
961 address->assigned_bw_in.value__ = htonl (mlp_bw_in);
962 mlpi->b_in.value__ = htonl(mlp_bw_in);
963 address->assigned_bw_out.value__ = htonl (mlp_bw_out);
964 mlpi->b_out.value__ = htonl(mlp_bw_out);
966 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
968 else if ((GLP_NO == mlp_use) && (GNUNET_YES == address->active))
970 /* Address switch: Disable address*/
971 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : disabling address\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
972 address->active = GNUNET_NO;
973 /* Set bandwidth to 0 */
974 address->assigned_bw_in.value__ = htonl (0);
975 mlpi->b_in.value__ = htonl(mlp_bw_in);
976 address->assigned_bw_out.value__ = htonl (0);
977 mlpi->b_out.value__ = htonl(mlp_bw_out);
979 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
981 else if ((mlp_bw_out != ntohl(address->assigned_bw_out.value__)) ||
982 (mlp_bw_in != ntohl(address->assigned_bw_in.value__)))
984 /* Bandwidth changed */
985 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : bandwidth changed\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
986 address->assigned_bw_in.value__ = htonl (mlp_bw_in);
987 mlpi->b_in.value__ = htonl(mlp_bw_in);
988 address->assigned_bw_out.value__ = htonl (mlp_bw_out);
989 mlpi->b_out.value__ = htonl(mlp_bw_out);
991 mlp->bw_changed_cb (mlp->bw_changed_cb_cls, address);
995 LOG (GNUNET_ERROR_TYPE_DEBUG, "%s %.2f : no change\n", (1 == mlp_use) ? "[x]": "[ ]", mlp_bw_out);
1004 * Solves the MLP problem
1006 * @param solver the MLP Handle
1007 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
1010 GAS_mlp_solve_problem (void *solver)
1012 struct GAS_MLP_Handle *mlp = solver;
1016 struct GNUNET_TIME_Absolute start_build;
1017 struct GNUNET_TIME_Relative duration_build;
1018 struct GNUNET_TIME_Absolute start_lp;
1019 struct GNUNET_TIME_Relative duration_lp;
1020 struct GNUNET_TIME_Absolute start_mlp;
1021 struct GNUNET_TIME_Relative duration_mlp;
1022 GNUNET_assert (NULL != solver);
1024 if (GNUNET_YES == mlp->bulk_lock)
1026 mlp->bulk_request ++;
1030 if ((GNUNET_NO == mlp->mlp_prob_changed) && (GNUNET_NO == mlp->mlp_prob_updated))
1032 LOG (GNUNET_ERROR_TYPE_DEBUG, "No changes to problem\n");
1035 if (GNUNET_YES == mlp->mlp_prob_changed)
1037 LOG (GNUNET_ERROR_TYPE_DEBUG, "Problem size changed, rebuilding\n");
1038 mlp_delete_problem (mlp);
1039 start_build = GNUNET_TIME_absolute_get();
1040 if (GNUNET_SYSERR == mlp_create_problem (mlp))
1041 return GNUNET_SYSERR;
1042 duration_build = GNUNET_TIME_absolute_get_duration (start_build);
1043 mlp->control_param_lp.presolve = GLP_YES;
1044 mlp->control_param_mlp.presolve = GNUNET_NO; /* No presolver, we have LP solution */
1048 LOG (GNUNET_ERROR_TYPE_DEBUG, "Problem was updated, resolving\n");
1049 duration_build.rel_value = 0;
1053 LOG (GNUNET_ERROR_TYPE_DEBUG, "Running LP solver %s\n", (GLP_YES == mlp->control_param_lp.presolve)? "with presolver": "without presolver");
1054 start_lp = GNUNET_TIME_absolute_get();
1055 res_lp = mlp_solve_lp_problem (mlp);
1056 duration_lp = GNUNET_TIME_absolute_get_duration (start_lp);
1060 LOG (GNUNET_ERROR_TYPE_DEBUG, "Running MLP solver \n");
1061 start_mlp = GNUNET_TIME_absolute_get();
1062 res_mip = mlp_solve_mlp_problem (mlp);
1064 duration_mlp = GNUNET_TIME_absolute_get_duration (start_mlp);
1067 mlp->ps.lp_res = res_lp;
1068 mlp->ps.mip_res = res_mip;
1069 mlp->ps.build_dur = duration_build;
1070 mlp->ps.lp_dur = duration_lp;
1071 mlp->ps.mip_dur = duration_mlp;
1072 mlp->ps.lp_presolv = mlp->control_param_lp.presolve;
1073 mlp->ps.mip_presolv = mlp->control_param_mlp.presolve;
1074 mlp->ps.p_cols = glp_get_num_cols (mlp->p.prob);
1075 mlp->ps.p_rows = glp_get_num_rows (mlp->p.prob);
1076 mlp->ps.p_elements = mlp->p.num_elements;
1078 LOG (GNUNET_ERROR_TYPE_DEBUG, "Execution time: Build %llu ms, LP %llu ms, MLP %llu ms\n",
1079 (unsigned long long) duration_build.rel_value,
1080 (unsigned long long) duration_lp.rel_value,
1081 (unsigned long long) duration_mlp.rel_value);
1083 /* Propagate result*/
1084 if ((GNUNET_OK == res_lp) && (GNUNET_OK == res_mip))
1085 GNUNET_CONTAINER_multihashmap_iterate (mlp->addresses, &mlp_propagate_results, mlp);
1087 struct GNUNET_TIME_Absolute time = GNUNET_TIME_absolute_get();
1088 if (GNUNET_YES == mlp->write_mip_mps)
1090 /* Write problem and solution to disk */
1091 GNUNET_asprintf (&filename, "problem_p_%u_a%u_%llu.mps", mlp->p.num_peers, mlp->p.num_addresses, time.abs_value);
1092 glp_write_mps(mlp->p.prob, GLP_MPS_FILE, NULL, filename);
1093 GNUNET_free (filename);
1095 if (GNUNET_YES == mlp->write_mip_sol)
1097 GNUNET_asprintf (&filename, "problem_p_%u_a%u_%llu.sol", mlp->p.num_peers, mlp->p.num_addresses, time.abs_value);
1098 glp_print_mip (mlp->p.prob, filename );
1099 GNUNET_free (filename);
1102 /* Reset change and update marker */
1103 mlp->control_param_lp.presolve = GLP_NO;
1104 mlp->mlp_prob_updated = GNUNET_NO;
1105 mlp->mlp_prob_changed = GNUNET_NO;
1107 if ((GNUNET_OK == res_lp) && (GNUNET_OK == res_mip))
1110 return GNUNET_SYSERR;
1114 * Add a single address to the solve
1116 * @param solver the solver Handle
1117 * @param addresses the address hashmap containing all addresses
1118 * @param address the address to add
1119 * @param network network type of this address
1122 GAS_mlp_address_add (void *solver,
1123 struct ATS_Address *address,
1126 struct GAS_MLP_Handle *mlp = solver;
1128 struct MLP_information *mlpi;
1132 GNUNET_assert (NULL != solver);
1133 GNUNET_assert (NULL != address);
1135 if (NULL == address->solver_information)
1137 address->solver_information = GNUNET_malloc (sizeof (struct MLP_information));
1138 mlpi = address->solver_information;
1139 for (c1 = 0; c1 < mlp->pv.m_q; c1++)
1141 mlpi->q_averaged[c1] = DEFAULT_QUALITY;
1142 for (c2 = 0; c2 < MLP_AVERAGING_QUEUE_LENGTH; c2++)
1143 mlpi->q[c1][c2] = MLP_NaN;
1147 LOG (GNUNET_ERROR_TYPE_ERROR, _("Adding address for peer `%s' multiple times\n"), GNUNET_i2s(&address->peer));
1149 /* Is this peer included in the problem? */
1150 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->peers, &address->peer.hashPubKey)))
1152 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding address for peer `%s' without address request \n", GNUNET_i2s(&address->peer));
1156 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding address for peer `%s' with address request \n", GNUNET_i2s(&address->peer));
1157 /* Problem size changed: new address for peer with pending request */
1158 mlp->mlp_prob_changed = GNUNET_YES;
1159 if (GNUNET_YES == mlp->mlp_auto_solve)
1160 GAS_mlp_solve_problem (solver);
1165 mlp_update_quality (struct GAS_MLP_Handle *mlp,
1166 const struct GNUNET_CONTAINER_MultiHashMap *addresses,
1167 struct ATS_Address * address,
1168 const struct GNUNET_ATS_Information *ats_prev, uint32_t ats_prev_count)
1170 struct MLP_information *mlpi = address->solver_information;
1171 unsigned int c_ats_entry;
1172 unsigned int c_queue_entries;
1174 unsigned int c_queue_it;
1176 unsigned int c_qual;
1182 uint32_t prev_value;
1191 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating %u quality metrics for peer `%s'\n",
1192 ats_prev_count, GNUNET_i2s (&address->peer));
1194 GNUNET_assert (NULL != mlp);
1195 GNUNET_assert (NULL != address);
1196 GNUNET_assert (NULL != address->solver_information);
1197 GNUNET_assert (NULL != ats_prev);
1199 if (NULL == mlp->p.prob)
1202 qual_changed = GNUNET_NO;
1203 for (c_ats_entry = 0; c_ats_entry < ats_prev_count; c_ats_entry++)
1205 type = ntohl (ats_prev[c_ats_entry].type);
1206 prev_value = ntohl (ats_prev[c_ats_entry].value);
1210 /* Check for network update */
1211 if (type == GNUNET_ATS_NETWORK_TYPE)
1213 new_value = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
1214 if (GNUNET_ATS_VALUE_UNDEFINED == new_value)
1215 new_value = GNUNET_ATS_NET_UNSPECIFIED;
1216 if (new_value != prev_value)
1218 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating network for peer `%s' from `%s' to `%s'\n",
1219 GNUNET_i2s (&address->peer),
1220 GNUNET_ATS_print_network_type(prev_value),
1221 GNUNET_ATS_print_network_type(new_value));
1224 if (mlpi->c_b == MLP_UNDEFINED)
1225 continue; /* This address is not yet in the matrix*/
1227 rows = glp_get_num_rows(mlp->p.prob);
1228 ind = GNUNET_malloc (rows * sizeof (int) + 1);
1229 val = GNUNET_malloc (rows * sizeof (double) + 1);
1230 int length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1232 for (c_net = 0; c_net <= length + 1; c_net ++)
1234 if (ind[c_net] == mlp->p.r_quota[prev_value])
1235 break; /* Found index for old network */
1238 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1239 /* Set updated column */
1240 ind[c_net] = mlp->p.r_quota[new_value];
1242 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1246 rows = glp_get_num_rows(mlp->p.prob);
1247 ind = GNUNET_malloc (rows * sizeof (int) + 1);
1248 val = GNUNET_malloc (rows * sizeof (double) + 1);
1249 length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1251 for (c_net = 0; c_net <= length + 1; c_net ++)
1253 if (ind[c_net] == mlp->p.r_quota[prev_value])
1254 LOG (GNUNET_ERROR_TYPE_DEBUG, "Removing old network index [%u] == [%f]\n",ind[c_net],val[c_net]);
1255 if (ind[c_net] == mlp->p.r_quota[new_value])
1257 LOG (GNUNET_ERROR_TYPE_DEBUG, "Setting new network index [%u] == [%f]\n",ind[c_net],val[c_net]);
1263 mlp->mlp_prob_changed = GNUNET_YES;
1268 /* Find index for this ATS type */
1269 for (c_cmp = 0; c_cmp < mlp->pv.m_q; c_cmp++)
1271 if (type == mlp->pv.q[c_cmp])
1277 if (-1 == type_index)
1278 continue; /* quality index not found */
1280 /* Get average queue index */
1281 avg_index = mlpi->q_avg_i[type_index];
1283 /* Update averaging queue */
1284 new_value = get_performance_info (address, type);
1285 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating peer `%s': `%s' from %u to %u\n",
1286 GNUNET_i2s (&address->peer),
1287 mlp_ats_to_string(mlp->pv.q[type_index]), prev_value, new_value);
1288 GNUNET_assert (GNUNET_ATS_VALUE_UNDEFINED != new_value);
1289 mlpi->q[type_index][avg_index] = new_value;
1291 /* Update averaging index */
1292 if (mlpi->q_avg_i[type_index] + 1 < (MLP_AVERAGING_QUEUE_LENGTH))
1293 mlpi->q_avg_i[type_index] ++;
1295 mlpi->q_avg_i[type_index] = 0;
1297 /* Update average depending on ATS type */
1300 case GNUNET_ATS_QUALITY_NET_DISTANCE:
1301 case GNUNET_ATS_QUALITY_NET_DELAY:
1302 c_queue_entries = 0;
1304 for (c_queue_it = 0; c_queue_it < MLP_AVERAGING_QUEUE_LENGTH; c_queue_it++)
1306 if (mlpi->q[type_index][c_queue_it] != MLP_NaN)
1308 queue = mlpi->q[type_index] ;
1309 avg += queue[c_queue_it];
1313 if ((c_queue_entries > 0) && (avg > 0))
1314 /* avg = 1 / ((q[0] + ... + q[l]) /c3) => c3 / avg*/
1315 mlpi->q_averaged[type_index] = (double) c_queue_entries / avg;
1317 mlpi->q_averaged[type_index] = 0.0;
1319 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating peer `%s': `%s' average sum of %u elements == %f, average == %f, weight == %f\n",
1320 GNUNET_i2s (&address->peer),
1321 mlp_ats_to_string(mlp->pv.q[type_index]),
1324 avg / (double) c_queue_entries,
1325 mlpi->q_averaged[type_index]);
1326 qual_changed = GNUNET_YES;
1330 LOG (GNUNET_ERROR_TYPE_DEBUG, _("Update for ATS type `%s' not implemented!\n"),
1331 mlp_ats_to_string(type));
1335 /* Changed, but quality will be automatically set during rebuild */
1336 if ((GNUNET_YES == mlp->mlp_prob_changed) &&
1337 (GNUNET_YES == mlp->mlp_auto_solve))
1339 GAS_mlp_solve_problem (mlp);
1343 /* Update problem matrix if required */
1344 if (GNUNET_NO == qual_changed)
1347 /* Address not yet included in matrix */
1348 if (MLP_UNDEFINED == mlpi->c_b)
1351 /* Update c7) [r_q[index]][c_b] = f_q * q_averaged[type_index]
1352 * Get column mlpi->c_b */
1353 rows = glp_get_num_rows(mlp->p.prob);
1354 ind = GNUNET_malloc (rows * sizeof (int) + 1);
1355 val = GNUNET_malloc (rows * sizeof (double) + 1);
1356 int length = glp_get_mat_col (mlp->p.prob, mlpi->c_b, ind, val);
1358 for (c_qual = 0; c_qual < mlp->pv.m_q; c_qual++)
1360 for (c_row = 0; c_row <= length; c_row ++)
1362 if (ind[c_row] == mlp->p.r_q[c_qual])
1363 val[c_row] = mlpi->q_averaged[c_qual];
1366 /* Set updated column */
1367 glp_set_mat_col (mlp->p.prob, mlpi->c_b, length, ind, val);
1370 mlp->mlp_prob_updated = GNUNET_YES;
1374 * Updates a single address in the MLP problem
1376 * If the address did not exist before in the problem:
1377 * The MLP problem has to be recreated and the problem has to be resolved
1379 * ATS performance information in address are already updated, delta + previous
1380 * values are included in atsi_prev (value GNUNET_ATS_VALUE_UNDEFINED if not existing before)
1382 * Otherwise the addresses' values can be updated and the existing base can
1385 * @param solver the solver Handle
1386 * @param addresses the address hashmap containing all addresses
1387 * @param address the update address
1388 * @param prev_session the new session (if changed otherwise current)
1389 * @param prev_in_use the new address in use state (if changed otherwise current)
1390 * @param prev_atsi ATS information updated + previous values, GNUNET_ATS_VALUE_UNDEFINED if not existing before
1391 * @param prev_atsi_count number of atsi values updated
1394 GAS_mlp_address_update (void *solver,
1395 struct ATS_Address *address,
1396 uint32_t prev_session,
1398 const struct GNUNET_ATS_Information *prev_atsi,
1399 uint32_t prev_atsi_count)
1402 struct GAS_MLP_Handle *mlp = solver;
1403 struct MLP_information *mlpi = address->solver_information;
1405 GNUNET_assert (NULL != solver);
1406 GNUNET_assert (NULL != address);
1407 GNUNET_assert ((NULL != prev_atsi) || (0 == prev_atsi_count));
1411 LOG (GNUNET_ERROR_TYPE_ERROR, _("Updating address for peer `%s' not added before\n"), GNUNET_i2s(&address->peer));
1414 mlp_update_quality (mlp, mlp->addresses, address, prev_atsi, prev_atsi_count);
1416 /* Is this peer included in the problem? */
1417 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->peers, &address->peer.hashPubKey)))
1419 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating address for peer `%s' without address request \n", GNUNET_i2s(&address->peer));
1422 LOG (GNUNET_ERROR_TYPE_DEBUG, "Updating address for peer `%s' with address request \n", GNUNET_i2s(&address->peer));
1424 /* Problem size changed: new address for peer with pending request */
1425 mlp->mlp_prob_updated = GNUNET_YES;
1427 if (GNUNET_YES == mlp->mlp_auto_solve)
1428 GAS_mlp_solve_problem (solver);
1433 * Deletes a single address in the MLP problem
1435 * The MLP problem has to be recreated and the problem has to be resolved
1437 * @param solver the MLP Handle
1438 * @param addresses the address hashmap
1439 * the address has to be already removed from the hashmap
1440 * @param address the address to delete
1441 * @param session_only delete only session not whole address
1444 GAS_mlp_address_delete (void *solver,
1445 struct ATS_Address *address,
1449 struct GAS_MLP_Handle *mlp = solver;
1450 struct MLP_information *mlpi;
1452 GNUNET_assert (NULL != solver);;
1453 GNUNET_assert (NULL != address);
1455 mlpi = address->solver_information;
1459 address->solver_information = NULL;
1462 /* Is this peer included in the problem? */
1463 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->peers, &address->peer.hashPubKey)))
1465 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting address for peer `%s' without address request \n", GNUNET_i2s(&address->peer));
1468 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting address for peer `%s' with address request \n", GNUNET_i2s(&address->peer));
1470 /* Problem size changed: new address for peer with pending request */
1471 mlp->mlp_prob_changed = GNUNET_YES;
1472 if (GNUNET_YES == mlp->mlp_auto_solve)
1473 GAS_mlp_solve_problem (solver);
1479 * Find the active address in the set of addresses of a peer
1480 * @param cls destination
1481 * @param key peer id
1482 * @param value address
1486 mlp_get_preferred_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1489 struct ATS_Address *aa = (struct ATS_Address *) cls;
1490 struct ATS_Address *addr = value;
1491 struct MLP_information *mlpi = addr->solver_information;
1494 if (mlpi->n == GNUNET_YES)
1497 aa->assigned_bw_in = mlpi->b_in;
1498 aa->assigned_bw_out = mlpi->b_out;
1505 static double get_peer_pref_value (struct GAS_MLP_Handle *mlp, const struct GNUNET_PeerIdentity *peer)
1508 const double *preferences = NULL;
1510 preferences = mlp->get_preferences (mlp->get_preferences_cls, peer);
1513 for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
1515 if (c != GNUNET_ATS_PREFERENCE_END)
1517 //fprintf (stderr, "VALUE[%u] %s %.3f \n", c, GNUNET_i2s (&cur->addr->peer), t[c]);
1518 res += preferences[c];
1521 res /= (GNUNET_ATS_PreferenceCount -1);
1527 * Get the preferred address for a specific peer
1529 * @param solver the MLP Handle
1530 * @param addresses address hashmap
1531 * @param peer the peer
1532 * @return suggested address
1534 const struct ATS_Address *
1535 GAS_mlp_get_preferred_address (void *solver,
1536 const struct GNUNET_PeerIdentity *peer)
1538 struct GAS_MLP_Handle *mlp = solver;
1540 struct ATS_Address *res = NULL;
1542 GNUNET_assert (NULL != solver);
1543 GNUNET_assert (NULL != peer);
1545 LOG (GNUNET_ERROR_TYPE_DEBUG, "Getting preferred address for `%s'\n",
1548 /* Is this peer included in the problem? */
1549 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->peers, &peer->hashPubKey)))
1551 LOG (GNUNET_ERROR_TYPE_DEBUG, "Adding peer `%s' to list of peers with requests\n",
1554 p = GNUNET_malloc (sizeof (struct ATS_Peer));
1556 p->f = get_peer_pref_value (mlp, peer);
1557 GNUNET_CONTAINER_multihashmap_put (mlp->peers, &peer->hashPubKey, p, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1559 /* Added new peer, we have to rebuild problem before solving */
1560 mlp->mlp_prob_changed = GNUNET_YES;
1562 if (GNUNET_YES == mlp->mlp_auto_solve)
1563 GAS_mlp_solve_problem (mlp);
1565 /* Get prefered address */
1566 GNUNET_CONTAINER_multihashmap_get_multiple (mlp->addresses, &peer->hashPubKey,
1567 mlp_get_preferred_address_it, res);
1574 * Start a bulk operation
1576 * @param solver the solver
1579 GAS_mlp_bulk_start (void *solver)
1581 LOG (GNUNET_ERROR_TYPE_DEBUG, "Locking solver for bulk operation ...\n");
1582 struct GAS_MLP_Handle *s = (struct GAS_MLP_Handle *) solver;
1584 GNUNET_assert (NULL != solver);
1590 GAS_mlp_bulk_stop (void *solver)
1592 LOG (GNUNET_ERROR_TYPE_DEBUG, "Unlocking solver from bulk operation ...\n");
1594 struct GAS_MLP_Handle *s = (struct GAS_MLP_Handle *) solver;
1595 GNUNET_assert (NULL != solver);
1597 if (s->bulk_lock < 1)
1604 if (0 < s->bulk_request)
1606 GAS_mlp_solve_problem (solver);
1614 * Stop notifying about address and bandwidth changes for this peer
1616 * @param solver the MLP handle
1617 * @param addresses address hashmap
1618 * @param peer the peer
1621 GAS_mlp_stop_get_preferred_address (void *solver,
1622 const struct GNUNET_PeerIdentity *peer)
1624 struct GAS_MLP_Handle *mlp = solver;
1625 struct ATS_Peer *p = NULL;
1627 GNUNET_assert (NULL != solver);
1628 GNUNET_assert (NULL != peer);
1630 if (NULL != (p = GNUNET_CONTAINER_multihashmap_get (mlp->peers, &peer->hashPubKey)))
1632 GNUNET_CONTAINER_multihashmap_remove (mlp->peers, &peer->hashPubKey, p);
1639 * Changes the preferences for a peer in the MLP problem
1641 * @param solver the MLP Handle
1642 * @param addresses the address hashmap
1643 * @param peer the peer
1644 * @param kind the kind to change the preference
1645 * @param pref_rel the relative score
1648 GAS_mlp_address_change_preference (void *solver,
1649 const struct GNUNET_PeerIdentity *peer,
1650 enum GNUNET_ATS_PreferenceKind kind,
1653 struct GAS_MLP_Handle *mlp = solver;
1654 struct ATS_Peer *p = NULL;
1656 LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing preference for address for peer `%s'\n",
1659 GNUNET_STATISTICS_update (mlp->stats,"# LP address preference changes", 1, GNUNET_NO);
1660 /* Update the constraints with changed preferences */
1662 /* Update quality constraint c7 */
1664 /* Update relativity constraint c9 */
1665 if (NULL == (p = GNUNET_CONTAINER_multihashmap_get (mlp->peers, &peer->hashPubKey)))
1667 LOG (GNUNET_ERROR_TYPE_ERROR, "Updating preference for unknown peer `%s' \n", GNUNET_i2s(peer));
1670 p->f = get_peer_pref_value (mlp, peer);
1671 /* FXIME: cannot use set_value mlp_create_problem_set_value (&mlp->p, p->r_c9, mlp->p.c_r, -p->f, __LINE__);*/
1673 /* Problem size changed: new address for peer with pending request */
1674 mlp->mlp_prob_updated = GNUNET_YES;
1675 if (GNUNET_YES == mlp->mlp_auto_solve)
1676 GAS_mlp_solve_problem (solver);
1682 mlp_free_peers (void *cls, const struct GNUNET_HashCode *key, void *value)
1684 struct GNUNET_CONTAINER_MultiHashMap *map = cls;
1685 struct ATS_Peer *p = value;
1687 GNUNET_CONTAINER_multihashmap_remove (map, key, value);
1695 * Shutdown the MLP problem solving component
1697 * @param solver the solver handle
1700 GAS_mlp_done (void *solver)
1702 struct GAS_MLP_Handle *mlp = solver;
1703 GNUNET_assert (mlp != NULL);
1705 LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutting down mlp solver\n");
1706 mlp_delete_problem (mlp);
1708 GNUNET_CONTAINER_multihashmap_iterate (mlp->peers, &mlp_free_peers, mlp->peers);
1709 GNUNET_CONTAINER_multihashmap_destroy (mlp->peers);
1712 /* Clean up GLPK environment */
1716 LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutdown down of mlp solver complete\n");
1721 * Init the MLP problem solving component
1723 * @param cfg the GNUNET_CONFIGURATION_Handle handle
1724 * @param stats the GNUNET_STATISTICS handle
1725 * @param network array of GNUNET_ATS_NetworkType with length dest_length
1726 * @param out_dest array of outbound quotas
1727 * @param in_dest array of outbound quota
1728 * @param dest_length array length for quota arrays
1729 * @param bw_changed_cb callback for changed bandwidth amounts
1730 * @param bw_changed_cb_cls cls for callback
1731 * @param get_preference callback to get relative preferences for a peer
1732 * @param get_preference_cls cls for callback to get relative preferences
1733 * @return struct GAS_MLP_Handle on success, NULL on fail
1736 GAS_mlp_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1737 const struct GNUNET_STATISTICS_Handle *stats,
1738 const struct GNUNET_CONTAINER_MultiHashMap *addresses,
1740 unsigned long long *out_dest,
1741 unsigned long long *in_dest,
1743 GAS_bandwidth_changed_cb bw_changed_cb,
1744 void *bw_changed_cb_cls,
1745 GAS_get_preferences get_preference,
1746 void *get_preference_cls,
1747 GAS_get_properties get_properties,
1748 void *get_properties_cls)
1750 struct GAS_MLP_Handle * mlp = GNUNET_malloc (sizeof (struct GAS_MLP_Handle));
1755 unsigned long long tmp;
1762 struct GNUNET_TIME_Relative max_duration;
1763 long long unsigned int max_iterations;
1765 GNUNET_assert (NULL != cfg);
1766 GNUNET_assert (NULL != stats);
1767 GNUNET_assert (NULL != addresses);
1768 GNUNET_assert (NULL != bw_changed_cb);
1769 GNUNET_assert (NULL != get_preference);
1770 GNUNET_assert (NULL != get_properties);
1772 /* Init GLPK environment */
1773 int res = glp_init_env();
1776 LOG (GNUNET_ERROR_TYPE_DEBUG, "GLPK: `%s'\n",
1777 "initialization successful");
1780 LOG (GNUNET_ERROR_TYPE_DEBUG, "GLPK: `%s'\n",
1781 "environment is already initialized");
1784 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not init GLPK: `%s'\n",
1785 "initialization failed (insufficient memory)");
1790 LOG (GNUNET_ERROR_TYPE_ERROR, "Could not init GLPK: `%s'\n",
1791 "initialization failed (unsupported programming model)");
1800 mlp->pv.BIG_M = (double) BIG_M_VALUE;
1802 /* Get timeout for iterations */
1803 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time(cfg, "ats", "MLP_MAX_DURATION", &max_duration))
1805 max_duration = MLP_MAX_EXEC_DURATION;
1808 /* Get maximum number of iterations */
1809 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_size(cfg, "ats", "MLP_MAX_ITERATIONS", &max_iterations))
1811 max_iterations = MLP_MAX_ITERATIONS;
1814 /* Get diversity coefficient from configuration */
1815 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1816 "MLP_COEFFICIENT_D",
1818 D = (double) tmp / 100;
1822 /* Get proportionality coefficient from configuration */
1823 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1824 "MLP_COEFFICIENT_R",
1826 R = (double) tmp / 100;
1830 /* Get utilization coefficient from configuration */
1831 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1832 "MLP_COEFFICIENT_U",
1834 U = (double) tmp / 100;
1838 /* Get quality metric coefficients from configuration */
1839 int i_delay = MLP_NaN;
1840 int i_distance = MLP_NaN;
1841 int q[GNUNET_ATS_QualityPropertiesCount] = GNUNET_ATS_QualityProperties;
1842 for (c = 0; c < GNUNET_ATS_QualityPropertiesCount; c++)
1844 /* initialize quality coefficients with default value 1.0 */
1845 mlp->pv.co_Q[c] = DEFAULT_QUALITY;
1847 mlp->pv.q[c] = q[c];
1848 if (q[c] == GNUNET_ATS_QUALITY_NET_DELAY)
1850 if (q[c] == GNUNET_ATS_QUALITY_NET_DISTANCE)
1854 if ((i_delay != MLP_NaN) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1855 "MLP_COEFFICIENT_QUALITY_DELAY",
1858 mlp->pv.co_Q[i_delay] = (double) tmp / 100;
1860 mlp->pv.co_Q[i_delay] = DEFAULT_QUALITY;
1862 if ((i_distance != MLP_NaN) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1863 "MLP_COEFFICIENT_QUALITY_DISTANCE",
1865 mlp->pv.co_Q[i_distance] = (double) tmp / 100;
1867 mlp->pv.co_Q[i_distance] = DEFAULT_QUALITY;
1869 /* Get minimum bandwidth per used address from configuration */
1870 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1871 "MLP_MIN_BANDWIDTH",
1876 b_min = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1879 /* Get minimum number of connections from configuration */
1880 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_size (cfg, "ats",
1881 "MLP_MIN_CONNECTIONS",
1885 n_min = DEFAULT_MIN_CONNECTIONS;
1887 /* Init network quotas */
1888 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1889 for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
1892 for (c2 = 0; c2 < dest_length; c2++)
1894 if (quotas[c] == network[c2])
1896 mlp->pv.quota_index[c] = network[c2];
1897 mlp->pv.quota_out[c] = out_dest[c2];
1898 mlp->pv.quota_in[c] = in_dest[c2];
1900 LOG (GNUNET_ERROR_TYPE_DEBUG, "Quota for network `%s' (in/out) %llu/%llu\n",
1901 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1902 mlp->pv.quota_out[c],
1903 mlp->pv.quota_in[c]);
1908 /* Check if defined quota could make problem unsolvable */
1909 if ((n_min * b_min) > mlp->pv.quota_out[c])
1911 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inconsistent outbound quota configuration for network `%s', is %llu must be at least %llu\n"),
1912 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1913 mlp->pv.quota_out[c],
1915 mlp->pv.quota_out[c] = (n_min * b_min);
1917 if ((n_min * b_min) > mlp->pv.quota_in[c])
1919 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inconsistent inbound quota configuration for network `%s', is %llu must be at least %llu\n"),
1920 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1921 mlp->pv.quota_in[c],
1923 mlp->pv.quota_in[c] = (n_min * b_min);
1926 /* Check if bandwidth is too big to make problem solvable */
1927 if (mlp->pv.BIG_M < mlp->pv.quota_out[c])
1929 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting outbound quota configuration for network `%s'from %llu to %.0f\n"),
1930 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1931 mlp->pv.quota_out[c],
1933 mlp->pv.quota_out[c] = mlp->pv.BIG_M ;
1935 if (mlp->pv.BIG_M < mlp->pv.quota_in[c])
1937 LOG (GNUNET_ERROR_TYPE_INFO, _("Adjusting inbound quota configuration for network `%s' from %llu to %.0f\n"),
1938 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1939 mlp->pv.quota_in[c],
1941 mlp->pv.quota_in[c] = mlp->pv.BIG_M ;
1944 if (GNUNET_NO == found)
1946 mlp->pv.quota_in[c] = ntohl(GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1947 mlp->pv.quota_out[c] = ntohl(GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
1948 LOG (GNUNET_ERROR_TYPE_INFO, _("Using default quota configuration for network `%s' (in/out) %llu/%llu\n"),
1949 GNUNET_ATS_print_network_type(mlp->pv.quota_index[c]),
1950 mlp->pv.quota_in[c],
1951 mlp->pv.quota_out[c]);
1955 /* Assign options to handle */
1956 mlp->stats = (struct GNUNET_STATISTICS_Handle *) stats;
1957 mlp->addresses = addresses;
1958 mlp->bw_changed_cb = bw_changed_cb;
1959 mlp->bw_changed_cb_cls = bw_changed_cb_cls;
1960 mlp->get_preferences = get_preference;
1961 mlp->get_preferences_cls = get_preference_cls;
1962 mlp->get_properties = get_properties;
1963 mlp->get_properties_cls = get_properties_cls;
1964 /* Setting MLP Input variables */
1968 mlp->pv.b_min = b_min;
1969 mlp->pv.n_min = n_min;
1970 mlp->pv.m_q = GNUNET_ATS_QualityPropertiesCount;
1971 mlp->write_mip_mps = GNUNET_NO;
1972 mlp->write_mip_sol = GNUNET_NO;
1973 mlp->mlp_prob_changed = GNUNET_NO;
1974 mlp->mlp_prob_updated = GNUNET_NO;
1975 mlp->mlp_auto_solve = GNUNET_YES;
1976 mlp->peers = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1977 mlp->bulk_request = 0;
1981 /* Redirect GLPK output to GNUnet logging */
1982 glp_term_hook (&mlp_term_hook, (void *) mlp);
1984 /* Init LP solving parameters */
1985 glp_init_smcp(&mlp->control_param_lp);
1986 mlp->control_param_lp.msg_lev = GLP_MSG_OFF;
1988 mlp->control_param_lp.msg_lev = GLP_MSG_ALL;
1990 mlp->control_param_lp.it_lim = max_iterations;
1991 mlp->control_param_lp.tm_lim = max_duration.rel_value;
1993 /* Init MLP solving parameters */
1994 glp_init_iocp(&mlp->control_param_mlp);
1995 mlp->control_param_mlp.msg_lev = GLP_MSG_OFF;
1997 mlp->control_param_mlp.msg_lev = GLP_MSG_ALL;
1999 mlp->control_param_mlp.tm_lim = max_duration.rel_value;
2001 LOG (GNUNET_ERROR_TYPE_DEBUG, "solver ready\n");
2006 /* end of gnunet-service-ats_addresses_mlp.c */