1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
/*
This file is part of GNUnet.
(C) 2010,2011 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file include/gnunet_ats_service.h
* @brief automatic transport selection and outbound bandwidth determination
* @author Christian Grothoff
* @author Matthias Wachs
*
* TODO:
* - move GNUNET_TRANSPORT_ATS* in here and rename...
* - extend API to express communication preferences to ATS
* (to be called DIRECTLY from apps, not from transport/core!)
*/
#ifndef GNUNET_ATS_SERVICE_H
#define GNUNET_ATS_SERVICE_H
#include "gnunet_constants.h"
#include "gnunet_util_lib.h"
#include "gnunet_transport_service.h"
#include "gnunet_transport_plugin.h"
/**
* Handle to the ATS subsystem.
*/
struct GNUNET_ATS_Handle;
/**
* Signature of a function called by ATS to notify the callee that the
* assigned bandwidth or address for a given peer was changed. If the
* callback is called with address/bandwidth assignments of zero, the
* ATS disconnect function will still be called once the disconnect
* actually happened.
*
* @param cls closure
* @param peer identity of the peer
* @param plugin_name name of the transport plugin, NULL to disconnect
* @param session session to use (if available)
* @param plugin_addr address to use (if available)
* @param plugin_addr_len number of bytes in addr
* @param bandwidth_out assigned outbound bandwidth for the connection
* @param bandwidth_in assigned inbound bandwidth for the connection
*/
typedef void (*GNUNET_TRANSPORT_ATS_AllocationNotification) (void *cls,
const struct
GNUNET_PeerIdentity
* peer,
const char
*plugin_name,
struct Session *
session,
const void
*plugin_addr,
size_t
plugin_addr_len,
struct
GNUNET_BANDWIDTH_Value32NBO
bandwidth_out,
struct
GNUNET_BANDWIDTH_Value32NBO
bandwidth_in);
/**
* Initialize the ATS subsystem.
*
* @param cfg configuration to use
* @param alloc_cb notification to call whenever the allocation changed
* @param alloc_cb_cls closure for 'alloc_cb'
* @return ats context
*/
struct GNUNET_ATS_Handle *
GNUNET_ATS_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb,
void *alloc_cb_cls);
/**
* Shutdown the ATS subsystem.
*
* @param atc handle
*/
void
GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc);
/**
* Signature of a function that takes an address suggestion
*
* @param cls closure
* @param peer identity of the new peer
* @param plugin_name name of the plugin, NULL if we have no suggestion
* @param plugin_addr suggested address, NULL if we have no suggestion
* @param plugin_addr_len number of bytes in plugin_addr
* @param bandwidth_out assigned outbound bandwidth for the connection
* @param bandwidth_in assigned inbound bandwidth for the connection
* @param ats performance data for the address (as far as known)
* @param ats_count number of performance records in 'ats'
*/
typedef void (*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
const struct
GNUNET_PeerIdentity *
peer,
const char *plugin_name,
const void *plugin_addr,
size_t plugin_addr_len,
struct Session * session,
struct
GNUNET_BANDWIDTH_Value32NBO
bandwidth_out,
struct
GNUNET_BANDWIDTH_Value32NBO
bandwidth_in,
const struct
GNUNET_TRANSPORT_ATS_Information
* ats,
uint32_t ats_count);
/**
* Handle to cancel suggestion request.
*/
struct GNUNET_ATS_SuggestionContext;
/**
* We would like to establish a new connection with a peer.
* ATS should suggest a good address to begin with.
*
* @param atc handle
* @param peer identity of the new peer
* @param cb function to call with the address
* @param cb_cls closure for cb
*/
struct GNUNET_ATS_SuggestionContext *
GNUNET_ATS_suggest_address (struct GNUNET_ATS_Handle *atc,
const struct GNUNET_PeerIdentity *peer,
GNUNET_ATS_AddressSuggestionCallback cb,
void *cb_cls);
/**
* Cancel suggestion request.
*
* @param asc handle of the request to cancel
*/
void
GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc);
/**
* We established a new connection with a peer (for example, because
* core asked for it or because the other peer connected to us).
* Calculate bandwidth assignments including the new peer.
*
* @param atc handle
* @param peer identity of the new peer
* @param plugin_name name of the currently used transport plugin
* @param session session in use (if available)
* @param plugin_addr address in use (if available)
* @param plugin_addr_len number of bytes in plugin_addr
* @param ats performance data for the connection
* @param ats_count number of performance records in 'ats'
*/
void
GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
const struct GNUNET_PeerIdentity *peer,
const char *plugin_name, struct Session *session,
const void *plugin_addr, size_t plugin_addr_len,
const struct GNUNET_TRANSPORT_ATS_Information *ats,
uint32_t ats_count);
/**
* We disconnected from the given peer (for example, because ats, core
* or blacklist asked for it or because the other peer disconnected).
* Calculate bandwidth assignments without the peer.
*
* @param atc handle
* @param peer identity of the peer
*/
void
GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
const struct GNUNET_PeerIdentity *peer);
/**
* A session got destroyed, stop including it as a valid address.
*
* @param atc handle
* @param peer identity of the peer
* @param session session handle that is no longer valid
*/
void
GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
const struct GNUNET_PeerIdentity *peer,
const struct Session *session);
/**
* We have updated performance statistics for a given address. Note
* that this function can be called for addresses that are currently
* in use as well as addresses that are valid but not actively in use.
* Furthermore, the peer may not even be connected to us right now (in
* which case the call may be ignored or the information may be stored
* for later use). Update bandwidth assignments.
*
* @param atc handle
* @param peer identity of the new peer
* @param valid_until how long is the address valid?
* @param plugin_name name of the transport plugin
* @param session session handle (if available)
* @param plugin_addr address (if available)
* @param plugin_addr_len number of bytes in plugin_addr
* @param ats performance data for the address
* @param ats_count number of performance records in 'ats'
*/
void
GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
const struct GNUNET_PeerIdentity *peer,
struct GNUNET_TIME_Absolute valid_until,
const char *plugin_name, struct Session *session,
const void *plugin_addr, size_t plugin_addr_len,
const struct GNUNET_TRANSPORT_ATS_Information *ats,
uint32_t ats_count);
/**
* Function called with perference change information about the given peer.
*
* @param cls closure
* @param peer identifies the peer
* @param amount set to the amount that was actually reserved or unreserved;
* either the full requested amount or zero (no partial reservations)
* @param res_delay if the reservation could not be satisfied (amount was 0), how
* long should the client wait until re-trying?
*/
typedef void (*GNUNET_ATS_PeerConfigurationInfoCallback) (void *cls,
const struct
GNUNET_PeerIdentity *
peer,
int32_t amount,
struct
GNUNET_TIME_Relative
res_delay);
/**
* Context that can be used to cancel a peer information request.
*/
struct GNUNET_ATS_InformationRequestContext;
/**
* Obtain statistics and/or change preferences for the given peer.
* You can only have one such pending request per peer.
*
* @param h core handle
* @param peer identifies the peer
* @param amount reserve N bytes for receiving, negative
* amounts can be used to undo a (recent) reservation;
* @param preference increase incoming traffic share preference by this amount;
* in the absence of "amount" reservations, we use this
* preference value to assign proportional bandwidth shares
* to all connected peers; in the future, this should be
* replaced with more specific QoS expressions...
* @param info function to call with the resulting configuration information
* @param info_cls closure for info
* @return NULL on error
* @deprecated will be replaced soon
*/
struct GNUNET_ATS_InformationRequestContext *
GNUNET_ATS_peer_change_preference (struct GNUNET_ATS_Handle *h,
const struct GNUNET_PeerIdentity *peer,
int32_t amount, uint64_t preference,
GNUNET_ATS_PeerConfigurationInfoCallback
info, void *info_cls);
/**
* Cancel request for getting information about a peer.
* Note that an eventual change in preference, trust or bandwidth
* assignment MAY have already been committed at the time,
* so cancelling a request is NOT sure to undo the original
* request. The original request may or may not still commit.
* The only thing cancellation ensures is that the callback
* from the original request will no longer be called.
*
* @param irc context returned by the original GNUNET_ATS_peer_get_info call
* @deprecated will be replaced soon
*/
void
GNUNET_ATS_peer_change_preference_cancel (struct
GNUNET_ATS_InformationRequestContext
*irc);
#endif
/* end of file gnunet-service-transport_ats.h */
|
