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_addresses.h
23 * @brief ats service address management
24 * @author Matthias Wachs
25 * @author Christian Grothoff
27 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
28 #define GNUNET_SERVICE_ATS_ADDRESSES_H
30 #include "gnunet_util_lib.h"
31 #include "gnunet_ats_service.h"
32 #include "gnunet_statistics_service.h"
35 #define ATS_BLOCKING_DELTA GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
38 * Address with additional information
45 struct ATS_Address *next;
48 * Previous element in DLL
50 struct ATS_Address *prev;
55 struct GNUNET_PeerIdentity peer;
58 * Session ID, 0 if no session is given
78 * Solver specific information for this address
80 void *solver_information;
83 struct GNUNET_TIME_Relative atsp_latency;
86 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
89 struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
93 uint32_t atsp_distance;
96 uint32_t atsp_cost_wan;
99 uint32_t atsp_cost_lan;
102 uint32_t atsp_cost_wlan;
105 uint32_t atsp_network_type;
108 * Inbound bandwidth assigned by solver in NBO
110 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
113 * Outbound bandwidth assigned by solver in NBO
115 struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
120 struct GNUNET_TIME_Relative block_interval;
123 * Time when address can be suggested again
125 struct GNUNET_TIME_Absolute blocked_until;
128 * Is this the active address for this peer?
133 * Is this the address for this peer in use?
140 * Callback to call from solver when bandwidth for address has changed
142 * @param address the with changed bandwidth assigned
146 (*GAS_bandwidth_changed_cb) (struct ATS_Address *address);
149 * Init the simplistic problem solving component
152 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
153 * out_quota[i] contains outbound quota for network type i
154 * in_quota[i] contains inbound quota for network type i
157 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
158 * network[2] == GNUNET_ATS_NET_LAN
159 * out_quota[2] == 65353
160 * in_quota[2] == 65353
162 * @param cfg configuration handle
163 * @param stats the GNUNET_STATISTICS handle
164 * @param network array of GNUNET_ATS_NetworkType with length dest_length
165 * @param out_quota array of outbound quotas
166 * @param in_quota array of outbound quota
167 * @param bw_changed_cb callback to call when assigned changes
168 * @return handle for the solver on success, NULL on fail
171 (*GAS_solver_init) (const struct GNUNET_CONFIGURATION_Handle *cfg,
172 const struct GNUNET_STATISTICS_Handle *stats,
174 unsigned long long *out_quota,
175 unsigned long long *in_quota,
177 GAS_bandwidth_changed_cb bw_changed_cb);
181 (*GAS_solver_address_change_preference) (void *solver,
182 const struct GNUNET_PeerIdentity *peer,
183 enum GNUNET_ATS_PreferenceKind kind,
187 * Add a single address to the solver
189 * @param solver the solver Handle
190 * @param addresses the address hashmap containing all addresses
191 * @param address the address to add
194 (*GAS_solver_address_add) (void *solver,
195 struct GNUNET_CONTAINER_MultiHashMap * addresses,
196 struct ATS_Address *address);
201 (*GAS_solver_address_delete) (void *solver,
202 struct GNUNET_CONTAINER_MultiHashMap *addresses,
203 struct ATS_Address *address);
206 (*GAS_solver_address_update) (void *solver,
207 struct GNUNET_CONTAINER_MultiHashMap *addresses,
208 struct ATS_Address *address);
211 typedef const struct ATS_Address *
212 (*GAS_solver_get_preferred_address) (void *solver,
213 struct GNUNET_CONTAINER_MultiHashMap *addresses,
214 const struct GNUNET_PeerIdentity *peer);
218 (*GAS_solver_done) (void *solver);
222 * Initialize address subsystem.
224 * @param cfg configuration to use
225 * @param stats the statistics handle to use
227 struct GAS_Addresses_Handle *
228 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
229 const struct GNUNET_STATISTICS_Handle *stats);
232 * Shutdown address subsystem.
235 GAS_addresses_done (struct GAS_Addresses_Handle *handle);
238 GAS_addresses_handle_backoff_reset (const struct GNUNET_PeerIdentity *peer);
241 * This address is now used or not used anymore
244 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
245 const char *plugin_name, const void *plugin_addr,
246 size_t plugin_addr_len, uint32_t session_id, int in_use);
249 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
250 const char *plugin_name, const void *plugin_addr,
251 size_t plugin_addr_len, uint32_t session_id,
252 const struct GNUNET_ATS_Information *atsi,
253 uint32_t atsi_count);
257 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
258 const char *plugin_name, const void *plugin_addr,
259 size_t plugin_addr_len, uint32_t session_id);
263 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle);
267 * Cancel address suggestions for a peer
269 * @param peer the respective peer
272 GAS_addresses_request_address_cancel (const struct GNUNET_PeerIdentity *peer);
275 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
278 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
279 enum GNUNET_ATS_PreferenceKind kind,
283 GAS_addresses_add (const struct GNUNET_PeerIdentity *peer,
284 const char *plugin_name, const void *plugin_addr,
285 size_t plugin_addr_len, uint32_t session_id,
286 const struct GNUNET_ATS_Information *atsi,
287 uint32_t atsi_count);
290 typedef void (*GNUNET_ATS_Peer_Iterator) (void *p_it_cls,
291 const struct GNUNET_PeerIdentity *id);
294 * Return all peers currently known to ATS
296 * @param p_it the iterator to call for every peer
297 * @param p_it_cls the closure for the iterator
300 GAS_addresses_iterate_peers (GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls);
302 typedef void (*GNUNET_ATS_PeerInfo_Iterator) (void *p_it_cls,
303 const struct GNUNET_PeerIdentity *id,
304 const char *plugin_name,
305 const void *plugin_addr, size_t plugin_addr_len,
306 const int address_active,
307 const struct GNUNET_ATS_Information *atsi,
309 struct GNUNET_BANDWIDTH_Value32NBO
311 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
314 * Return information all peers currently known to ATS
316 * @param peer the respective peer
317 * @param pi_it the iterator to call for every peer
318 * @param pi_it_cls the closure for the iterator
321 GAS_addresses_get_peer_info (const struct GNUNET_PeerIdentity *peer, GNUNET_ATS_PeerInfo_Iterator pi_it, void *pi_it_cls);
325 /* end of gnunet-service-ats_addresses.h */