2 This file is part of GNUnet
3 Copyright (C) 2009-2015 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
25 * API for the ATS solvers.
27 * @defgroup ats-plugin ATS service plugin API
28 * Plugin API for the ATS service.
30 * Specifies the struct that is given to the plugin's entry method and the other
31 * struct that must be returned. Note that the destructors of ATS plugins will
32 * be given the value returned by the constructor and is expected to return a
40 #include "gnunet_ats_service.h"
41 #include "gnunet_statistics_service.h"
44 * Representation of an address the plugin can choose from.
49 * Change the preference for a peer
51 * @param handle the solver handle
52 * @param client the client sending this request
53 * @param peer the peer id
54 * @param kind the preference kind to change
55 * @param score the new preference score
56 * @param pref_rel the normalized preference value for this kind over all clients
59 (*GAS_solver_address_change_preference) (void *solver,
60 const struct GNUNET_PeerIdentity *peer,
61 enum GNUNET_ATS_PreferenceKind kind,
66 * Give feedback about the current assignment
68 * @param handle the solver handle
69 * @param application the application sending this request
70 * @param peer the peer id
71 * @param scope the time interval for this feedback: [now - scope .. now]
72 * @param kind the preference kind for this feedback
73 * @param score the feedback score
76 (*GAS_solver_address_feedback_preference) (void *solver,
77 struct GNUNET_SERVICE_Client *
80 GNUNET_PeerIdentity *peer,
81 const struct GNUNET_TIME_Relative
83 enum GNUNET_ATS_PreferenceKind kind,
87 * Notify the solver about a bulk operation changing possibly a lot of values
88 * Solver will not resolve until all bulk operations are marked as done
90 * @param solver the solver
93 (*GAS_solver_bulk_start) (void *solver);
97 * Mark a bulk operation as done
98 * Solver will resolve if values have changed
100 * @param solver the solver
103 (*GAS_solver_bulk_stop) (void *solver);
107 * Add a single address within a network to the solver
109 * @param solver the solver Handle
110 * @param address the address to add
111 * @param network network type of this address
114 (*GAS_solver_address_add) (void *solver,
115 struct ATS_Address *address,
120 * Delete an address or just the session from the solver
122 * @param solver the solver Handle
123 * @param address the address to delete
126 (*GAS_solver_address_delete) (void *solver,
127 struct ATS_Address *address);
131 * Transport properties for this address have changed
133 * @param solver solver handle
134 * @param address the address
137 (*GAS_solver_address_property_changed) (void *solver,
138 struct ATS_Address *address);
142 * Get the prefered address for a peer from solver
144 * @param solver the solver to use
145 * @param peer the peer
148 (*GAS_solver_get_preferred_address) (void *solver,
149 const struct GNUNET_PeerIdentity *peer);
153 * Stop getting the prefered address for a peer from solver
155 * @param solver the solver to use
156 * @param peer the peer
159 (*GAS_solver_stop_get_preferred_address) (void *solver,
161 GNUNET_PeerIdentity *peer);
167 * Each solver is required to set up and return an instance
168 * of this struct during initialization.
170 struct GNUNET_ATS_SolverFunctions
173 * Closure to pass to all solver functions in this struct.
178 * Add a new address for a peer to the solver
180 * The address is already contained in the addresses hashmap!
182 GAS_solver_address_add s_add;
185 * Update the properties of an address in the solver
187 GAS_solver_address_property_changed s_address_update_property;
190 * Tell solver to notify ATS if the address to use changes for a specific
191 * peer using the bandwidth changed callback
193 * The solver must only notify about changes for peers with pending address
196 GAS_solver_get_preferred_address s_get;
199 * Tell solver stop notifying ATS about changes for this peers
201 * The solver must only notify about changes for peers with pending address
204 GAS_solver_stop_get_preferred_address s_get_stop;
207 * Delete an address in the solver
209 * The address is not contained in the address hashmap anymore!
211 GAS_solver_address_delete s_del;
214 * Change relative preference for quality in solver
216 GAS_solver_address_change_preference s_pref;
219 * Give feedback about the current assignment
221 GAS_solver_address_feedback_preference s_feedback;
224 * Start a bulk operation
226 * Used if many values have to be updated at the same time.
227 * When a bulk operation is pending the solver does not have to resolve
228 * the problem since more updates will follow anyway
230 * For each call to bulk_start, a call to bulk_stop is required!
232 GAS_solver_bulk_start s_bulk_start;
235 * Bulk operation done
237 * If no more bulk operations are pending, the solver can solve the problem
238 * with the updated values
240 GAS_solver_bulk_stop s_bulk_stop;
245 * Operation codes for solver information callback
247 * Order of calls is expected to be:
248 * #GAS_OP_SOLVE_START
250 * #GAS_OP_SOLVE_UPDATE_NOTIFICATION_START
251 * #GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP
254 enum GAS_Solver_Operation
257 * A solution iteration has been started
262 * A solution iteration has been finished
267 * The setup of the problem as a preparation to solve it was started
269 GAS_OP_SOLVE_SETUP_START,
272 * The setup of the problem as a preparation to solve is finished
274 GAS_OP_SOLVE_SETUP_STOP,
277 * Solving of the LP problem was started
280 GAS_OP_SOLVE_MLP_LP_START,
283 * Solving of the LP problem is done
286 GAS_OP_SOLVE_MLP_LP_STOP,
289 * Solving of the MLP problem was started
292 GAS_OP_SOLVE_MLP_MLP_START,
295 * Solving of the MLP problem is done
298 GAS_OP_SOLVE_MLP_MLP_STOP,
301 * After the problem was finished, start notifications about changes
304 GAS_OP_SOLVE_UPDATE_NOTIFICATION_START,
307 * After the problem was finished, notifications about changes to addresses
310 GAS_OP_SOLVE_UPDATE_NOTIFICATION_STOP
315 * Status of a GAS_Solver_Operation operation
317 enum GAS_Solver_Status
332 * Status of the operation
334 enum GAS_Solver_Additional_Information
337 * No more specific information
342 * A full solution process is performed
343 * Quite specific to the MLP solver
348 * An existing solution was reused
349 * Quite specific to the MLP solver
354 * The proportional solver had to recalculate for a single network
356 GAS_INFO_PROP_SINGLE,
359 * The proportional solver had to recalculate for all networks
366 * Callback to call with additional information
367 * Used for measurement
369 * @param cls the closure
370 * @param op the operation
373 (*GAS_solver_information_callback) (void *cls,
374 enum GAS_Solver_Operation op,
375 enum GAS_Solver_Status stat,
376 enum GAS_Solver_Additional_Information);
380 * Callback to call from solver when bandwidth for address has changed
382 * @param address the with changed bandwidth assigned
385 (*GAS_bandwidth_changed_cb) (void *cls,
386 struct ATS_Address *address);
390 * Callback to call from solver to obtain application preference
394 * @param id the peer id
395 * @return carry of double values containing the preferences with
396 * GNUNET_ATS_PreferenceCount elements
398 typedef const double *
399 (*GAS_get_preferences) (void *cls,
400 const struct GNUNET_PeerIdentity *id);
404 * Callback to call from solver to obtain application connectivity
405 * preferences for a peer.
408 * @param id the peer id
409 * @return 0 if connectivity is not desired, non-null if address
410 * suggestions are requested
413 (*GAS_get_connectivity) (void *cls,
414 const struct GNUNET_PeerIdentity *id);
418 * The ATS plugin will pass a pointer to a struct
419 * of this type as to the initialization function
420 * of the ATS plugins.
422 struct GNUNET_ATS_PluginEnvironment
425 * Configuration handle to be used by the solver
427 const struct GNUNET_CONFIGURATION_Handle *cfg;
430 * Statistics handle to be used by the solver
432 struct GNUNET_STATISTICS_Handle *stats;
435 * Closure to pass to all callbacks in this struct.
440 * Hashmap containing all addresses available
442 struct GNUNET_CONTAINER_MultiPeerMap *addresses;
445 * ATS addresses callback to be notified about bandwidth assignment changes
447 GAS_bandwidth_changed_cb bandwidth_changed_cb;
450 * ATS addresses function to obtain preference values
452 GAS_get_preferences get_preferences;
455 * ATS addresses function to obtain preference values
457 GAS_get_connectivity get_connectivity;
460 * Callback for solver to call with status information,
463 GAS_solver_information_callback info_cb;
466 * Number of networks available, size of the @e out_quota
467 * and @e in_quota arrays.
469 unsigned int network_count;
472 * Array of configured outbound quotas
473 * Order according to networks in network array
475 unsigned long long out_quota[GNUNET_NT_COUNT];
478 * Array of configured inbound quotas
479 * Order according to networks in network array
481 unsigned long long in_quota[GNUNET_NT_COUNT];
486 /** @} */ /* end of group */