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.h
23 * @brief ats MLP problem solver
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_statistics_service.h"
29 #include "gnunet-service-ats_addresses.h"
34 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_MLP_H
35 #define GNUNET_SERVICE_ATS_ADDRESSES_MLP_H
37 #define BIG_M_VALUE (UINT32_MAX) /10
38 #define BIG_M_STRING "unlimited"
40 #define MLP_AVERAGING_QUEUE_LENGTH 3
42 #define MLP_MAX_EXEC_DURATION GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 10)
43 #define MLP_MAX_ITERATIONS 4096
48 #define DEFAULT_QUALITY 1.0
49 #define DEFAULT_MIN_CONNECTIONS 4
50 #define DEFAULT_PEER_PREFERENCE 1.0
53 #define MLP_UNDEFINED 0
60 struct GNUNET_TIME_Relative build_dur;
61 struct GNUNET_TIME_Relative lp_dur;
62 struct GNUNET_TIME_Relative mip_dur;
80 struct GNUNET_PeerIdentity id;
82 /* Was this peer already added to the current problem? */
85 /* constraint 2: 1 address per peer*/
88 /* constraint 9: relativity */
91 /* Legacy preference value */
95 /* Array of quality preferences */
96 double f_q[GNUNET_ATS_QualityPropertiesCount];
106 * GLPK (MLP) problem object
113 /* Number of addresses in problem */
114 unsigned int num_addresses;
115 /* Number of peers in problem */
116 unsigned int num_peers;
117 /* Number of elements in problem matrix */
118 unsigned int num_elements;
120 /* Row index constraint 2: */
122 /* Row index constraint 4: minimum connections */
124 /* Row index constraint 6: maximize diversity */
126 /* Row index constraint 8: utilization*/
128 /* Row index constraint 9: relativity*/
130 /* Row indices quality metrics */
131 int r_q[GNUNET_ATS_QualityPropertiesCount];
132 /* Row indices ATS network quotas */
133 int r_quota[GNUNET_ATS_NetworkTypeCount];
135 /* Column index Diversity (D) column */
137 /* Column index Utilization (U) column */
139 /* Column index Proportionality (R) column */
141 /* Column index quality metrics */
142 int c_q[GNUNET_ATS_QualityPropertiesCount];
147 /* Row index array */
149 /* Column index array */
151 /* Column index value */
157 /* Big M value for bandwidth capping */
160 /* ATS Quality metrics
162 * Array with GNUNET_ATS_QualityPropertiesCount elements
163 * contains mapping to GNUNET_ATS_Property*/
164 int q[GNUNET_ATS_QualityPropertiesCount];
166 /* Number of quality metrics */
169 /* Number of quality metrics */
172 /* Quality metric coefficients*/
173 double co_Q[GNUNET_ATS_QualityPropertiesCount];
175 /* Ressource costs coefficients*/
176 double co_RC[GNUNET_ATS_QualityPropertiesCount];
178 /* Diversity coefficient */
181 /* Utility coefficient */
184 /* Relativity coefficient */
187 /* Minimum bandwidth assigned to an address */
190 /* Minimum number of addresses with bandwidth assigned */
194 /* Array mapping array index to ATS network */
195 int quota_index [GNUNET_ATS_NetworkTypeCount];
196 /* Outbound quotas */
197 unsigned long long quota_out[GNUNET_ATS_NetworkTypeCount];
200 unsigned long long quota_in[GNUNET_ATS_NetworkTypeCount];
202 /* ATS ressource costs
203 * array with GNUNET_ATS_QualityPropertiesCount elements
204 * contains mapping to GNUNET_ATS_Property
206 int rc[GNUNET_ATS_QualityPropertiesCount];
214 struct GAS_MLP_Handle
219 struct GNUNET_STATISTICS_Handle *stats;
222 * Addresses' bandwidth changed callback
224 GAS_bandwidth_changed_cb bw_changed_cb;
227 * Addresses' bandwidth changed callback closure
229 void *bw_changed_cb_cls;
231 GAS_get_preferences get_preferences;
233 void *get_preferences_cls;
235 struct MLP_Problem p;
237 struct MLP_Variables pv;
239 struct MLP_Solution ps;
242 * GLPK LP control parameter
245 glp_smcp control_param_lp;
247 void *control_param_lp;
251 * GLPK LP control parameter
254 glp_iocp control_param_mlp;
256 void *control_param_mlp;
260 * Peers with pending address requests
262 struct GNUNET_CONTAINER_MultiHashMap *peers;
265 * Was the problem updated since last solution
267 int mlp_prob_updated;
270 * Has the problem size changed since last solution
272 int mlp_prob_changed;
275 * Solve the problem automatically when updates occur?
276 * Default: GNUNET_YES
277 * Can be disabled for test and measurements
282 * Write MILP problem to a MPS file
287 * Write MILP problem to a MPS file
295 * Address specific MLP information
297 struct MLP_information
300 /* Bandwidth assigned */
301 struct GNUNET_BANDWIDTH_Value32NBO b_out;
302 struct GNUNET_BANDWIDTH_Value32NBO b_in;
304 /* Address selected */
307 /* bandwidth column index */
310 /* address usage column */
315 /* constraint 1: bandwidth capping */
318 /* constraint 3: minimum bandwidth */
321 /* Quality information row indices */
322 unsigned int r_q[GNUNET_ATS_QualityPropertiesCount];
324 /* Quality information */
325 double q[GNUNET_ATS_QualityPropertiesCount][MLP_AVERAGING_QUEUE_LENGTH];
327 /* Quality information averaged */
328 double q_averaged[GNUNET_ATS_QualityPropertiesCount];
330 /* Averaging index */
331 int q_avg_i[GNUNET_ATS_QualityPropertiesCount];
335 * Solves the MLP problem
337 * @param solver the MLP Handle
338 * @param addresses the address hashmap
339 * @return GNUNET_OK if could be solved, GNUNET_SYSERR on failure
342 GAS_mlp_solve_problem (void *solver, struct GNUNET_CONTAINER_MultiHashMap * addresses);
346 * Init the MLP problem solving component
348 * @param cfg the GNUNET_CONFIGURATION_Handle handle
349 * @param stats the GNUNET_STATISTICS handle
350 * @param network array of GNUNET_ATS_NetworkType with length dest_length
351 * @param out_dest array of outbound quotas
352 * @param in_dest array of outbound quota
353 * @param dest_length array length for quota arrays
354 * @param bw_changed_cb callback for changed bandwidth amounts
355 * @param bw_changed_cb_cls cls for callback
356 * @param get_preference callback to get relative preferences for a peer
357 * @param get_preference_cls cls for callback to get relative preferences
358 * @return struct GAS_MLP_Handle on success, NULL on fail
361 GAS_mlp_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
362 const struct GNUNET_STATISTICS_Handle *stats,
364 unsigned long long *out_dest,
365 unsigned long long *in_dest,
367 GAS_bandwidth_changed_cb bw_changed_cb,
368 void *bw_changed_cb_cls,
369 GAS_get_preferences get_preference,
370 void *get_preference_cls);
374 * Add a single address within a network to the solver
376 * @param solver the solver Handle
377 * @param addresses the address hashmap containing all addresses
378 * @param address the address to add
379 * @param network network type of this address
382 GAS_mlp_address_add (void *solver,
383 struct GNUNET_CONTAINER_MultiHashMap *addresses,
384 struct ATS_Address *address,
388 * Updates a single address in the MLP problem
390 * If the address did not exist before in the problem:
391 * The MLP problem has to be recreated and the problem has to be resolved
393 * ATS performance information in address are already updated, delta + previous
394 * values are included in atsi_prev (value GNUNET_ATS_VALUE_UNDEFINED if not existing before)
396 * Otherwise the addresses' values can be updated and the existing base can
399 * @param solver the solver Handle
400 * @param addresses the address hashmap containing all addresses
401 * @param address the update address
402 * @param prev_session the new session (if changed otherwise current)
403 * @param prev_in_use the new address in use state (if changed otherwise current)
404 * @param prev_atsi ATS information updated + previous values, GNUNET_ATS_VALUE_UNDEFINED if not existing before
405 * @param prev_atsi_count number of atsi values updated
408 GAS_mlp_address_update (void *solver,
409 struct GNUNET_CONTAINER_MultiHashMap *addresses,
410 struct ATS_Address *address,
411 uint32_t prev_session,
413 const struct GNUNET_ATS_Information *prev_atsi,
414 uint32_t prev_atsi_count);
418 * Deletes a single address in the MLP problem
420 * The MLP problem has to be recreated and the problem has to be resolved
422 * @param solver the MLP Handle
423 * @param addresses the address hashmap
424 * the address has to be already removed from the hashmap
425 * @param address the address to delete
426 * @param session_only delete only session not whole address
429 GAS_mlp_address_delete (void *solver,
430 struct GNUNET_CONTAINER_MultiHashMap *addresses,
431 struct ATS_Address *address,
436 * Changes the preferences for a peer in the MLP problem
438 * @param solver the MLP Handle
439 * @param addresses the address hashmap
440 * @param peer the peer
441 * @param kind the kind to change the preference
442 * @param pref_rel the relative score
445 GAS_mlp_address_change_preference (void *solver,
446 struct GNUNET_CONTAINER_MultiHashMap *addresses,
447 const struct GNUNET_PeerIdentity *peer,
448 enum GNUNET_ATS_PreferenceKind kind,
453 * Start a bulk operation
455 * @param solver the solver
458 GAS_mlp_bulk_start (void *solver);
462 * Bulk operation done
465 GAS_mlp_bulk_stop (void *solver);
469 * Get the preferred address for a specific peer
471 * @param solver the MLP Handle
472 * @param addresses address hashmap
473 * @param peer the peer
474 * @return suggested address
476 const struct ATS_Address *
477 GAS_mlp_get_preferred_address (void *solver,
478 struct GNUNET_CONTAINER_MultiHashMap * addresses,
479 const struct GNUNET_PeerIdentity *peer);
483 * Stop notifying about address and bandwidth changes for this peer
485 * @param solver the MLP handle
486 * @param addresses address hashmap
487 * @param peer the peer
491 GAS_mlp_stop_get_preferred_address (void *solver,
492 struct GNUNET_CONTAINER_MultiHashMap *addresses,
493 const struct GNUNET_PeerIdentity *peer);
497 * Shutdown the MLP problem solving component
499 * @param solver the solver handle
502 GAS_mlp_done (void *solver);
505 /* end of gnunet-service-ats_addresses_mlp.h */