diff options
author | Christian Grothoff <christian@grothoff.org> | 2018-11-29 20:50:38 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2018-11-29 20:52:11 +0100 |
commit | 333ed5b94540b68b9967885c215b57818f22fb79 (patch) | |
tree | 2a15a47d8b7a6c60ad4ddc0de7cbe3e1c1bc7426 /src/ats | |
parent | 94771c8ff4a7dc75b7f26b2795b5ed1f0c1f791b (diff) | |
download | gnunet-333ed5b94540b68b9967885c215b57818f22fb79.tar.gz gnunet-333ed5b94540b68b9967885c215b57818f22fb79.zip |
draft ATS API for TNG
Diffstat (limited to 'src/ats')
-rw-r--r-- | src/ats/Makefile.am | 24 | ||||
-rw-r--r-- | src/ats/ats2.h | 298 | ||||
-rw-r--r-- | src/ats/ats_api2_application.c | 363 | ||||
-rw-r--r-- | src/ats/ats_api2_transport.c | 666 |
4 files changed, 1350 insertions, 1 deletions
diff --git a/src/ats/Makefile.am b/src/ats/Makefile.am index 6a5c924e0..648849b1a 100644 --- a/src/ats/Makefile.am +++ b/src/ats/Makefile.am | |||
@@ -18,7 +18,10 @@ if USE_COVERAGE | |||
18 | AM_CFLAGS = -fprofile-arcs -ftest-coverage | 18 | AM_CFLAGS = -fprofile-arcs -ftest-coverage |
19 | endif | 19 | endif |
20 | 20 | ||
21 | lib_LTLIBRARIES = libgnunetats.la | 21 | lib_LTLIBRARIES = \ |
22 | libgnunetats.la \ | ||
23 | libgnunetatsapplication.la \ | ||
24 | libgnunetatstransport.la | ||
22 | 25 | ||
23 | plugin_LTLIBRARIES = \ | 26 | plugin_LTLIBRARIES = \ |
24 | libgnunet_plugin_ats_proportional.la | 27 | libgnunet_plugin_ats_proportional.la |
@@ -45,6 +48,25 @@ libgnunetats_la_LDFLAGS = \ | |||
45 | $(GN_LIB_LDFLAGS) $(WINFLAGS) \ | 48 | $(GN_LIB_LDFLAGS) $(WINFLAGS) \ |
46 | -version-info 4:0:0 | 49 | -version-info 4:0:0 |
47 | 50 | ||
51 | |||
52 | libgnunetatsapplication_la_SOURCES = \ | ||
53 | ats_api2_application.c | ||
54 | libgnunetatsapplication_la_LIBADD = \ | ||
55 | $(top_builddir)/src/util/libgnunetutil.la \ | ||
56 | $(LTLIBINTL) | ||
57 | libgnunetatsapplication_la_LDFLAGS = \ | ||
58 | $(GN_LIB_LDFLAGS) $(WINFLAGS) \ | ||
59 | -version-info 0:0:0 | ||
60 | |||
61 | libgnunetatstransport_la_SOURCES = \ | ||
62 | ats_api2_transport.c | ||
63 | libgnunetatstransport_la_LIBADD = \ | ||
64 | $(top_builddir)/src/util/libgnunetutil.la \ | ||
65 | $(LTLIBINTL) | ||
66 | libgnunetatstransport_la_LDFLAGS = \ | ||
67 | $(GN_LIB_LDFLAGS) $(WINFLAGS) \ | ||
68 | -version-info 0:0:0 | ||
69 | |||
48 | libgnunet_plugin_ats_proportional_la_SOURCES = \ | 70 | libgnunet_plugin_ats_proportional_la_SOURCES = \ |
49 | plugin_ats_proportional.c | 71 | plugin_ats_proportional.c |
50 | libgnunet_plugin_ats_proportional_la_LIBADD = \ | 72 | libgnunet_plugin_ats_proportional_la_LIBADD = \ |
diff --git a/src/ats/ats2.h b/src/ats/ats2.h new file mode 100644 index 000000000..883ac7c38 --- /dev/null +++ b/src/ats/ats2.h | |||
@@ -0,0 +1,298 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2010-2015 GNUnet e.V. | ||
4 | |||
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. | ||
9 | |||
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. | ||
14 | |||
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/>. | ||
17 | */ | ||
18 | /** | ||
19 | * @file ats/ats.h | ||
20 | * @brief automatic transport selection messages | ||
21 | * @author Christian Grothoff | ||
22 | * @author Matthias Wachs | ||
23 | */ | ||
24 | #ifndef ATS_H | ||
25 | #define ATS_H | ||
26 | |||
27 | #include "gnunet_util_lib.h" | ||
28 | #include "gnunet_ats_transport_service.h" | ||
29 | |||
30 | |||
31 | GNUNET_NETWORK_STRUCT_BEGIN | ||
32 | |||
33 | |||
34 | /** | ||
35 | * ATS performance characteristics for an address. | ||
36 | */ | ||
37 | struct PropertiesNBO | ||
38 | { | ||
39 | |||
40 | /** | ||
41 | * Delay. Time between when the time packet is sent and the packet | ||
42 | * arrives. FOREVER if we did not (successfully) measure yet. | ||
43 | */ | ||
44 | struct GNUNET_TIME_RelativeNBO delay; | ||
45 | |||
46 | /** | ||
47 | * Confirmed successful payload on this connection from this peer to | ||
48 | * the other peer. In NBO. | ||
49 | * | ||
50 | * Unit: [bytes/second] | ||
51 | */ | ||
52 | uint32_t goodput_out; | ||
53 | |||
54 | /** | ||
55 | * Confirmed useful payload on this connection to this peer from | ||
56 | * the other peer. In NBO. | ||
57 | * | ||
58 | * Unit: [bytes/second] | ||
59 | */ | ||
60 | uint32_t goodput_in; | ||
61 | |||
62 | /** | ||
63 | * Actual traffic on this connection from this peer to the other peer. | ||
64 | * Includes transport overhead. In NBO. | ||
65 | * | ||
66 | * Unit: [bytes/second] | ||
67 | */ | ||
68 | uint32_t utilization_out; | ||
69 | |||
70 | /** | ||
71 | * Actual traffic on this connection from the other peer to this peer. | ||
72 | * Includes transport overhead. In NBO. | ||
73 | * | ||
74 | * Unit: [bytes/second] | ||
75 | */ | ||
76 | uint32_t utilization_in; | ||
77 | |||
78 | /** | ||
79 | * Distance on network layer (required for distance-vector routing) | ||
80 | * in hops. Zero for direct connections (i.e. plain TCP/UDP). In NBO. | ||
81 | */ | ||
82 | uint32_t distance; | ||
83 | |||
84 | /** | ||
85 | * MTU of the network layer, UINT32_MAX for no MTU (stream). | ||
86 | * | ||
87 | * Unit: [bytes]. In NBO. | ||
88 | */ | ||
89 | uint32_t mtu; | ||
90 | |||
91 | /** | ||
92 | * Which network scope does the respective address belong to? | ||
93 | * A `enum GNUNET_NetworkType nt` in NBO. | ||
94 | */ | ||
95 | uint32_t nt; | ||
96 | |||
97 | /** | ||
98 | * What characteristics does this communicator have? | ||
99 | * A `enum GNUNET_TRANSPORT_CommunicatorCharacteristics` in NBO. | ||
100 | */ | ||
101 | uint32_t cc; | ||
102 | |||
103 | }; | ||
104 | |||
105 | |||
106 | /** | ||
107 | * Application client to ATS service: we would like to have | ||
108 | * address suggestions for this peer. | ||
109 | */ | ||
110 | struct ExpressPreferenceMessage | ||
111 | { | ||
112 | /** | ||
113 | * Type is #GNUNET_MESSAGE_TYPE_ATS_SUGGEST or | ||
114 | * #GNUNET_MESSAGE_TYPE_ATS_SUGGEST_CANCEL to stop | ||
115 | * suggestions. | ||
116 | */ | ||
117 | struct GNUNET_MessageHeader header; | ||
118 | |||
119 | /** | ||
120 | * What type of performance preference does the client have? | ||
121 | */ | ||
122 | uint32_t pk GNUNET_PACKED; | ||
123 | |||
124 | /** | ||
125 | * Peer to get address suggestions for. | ||
126 | */ | ||
127 | struct GNUNET_PeerIdentity peer; | ||
128 | |||
129 | /** | ||
130 | * How much bandwidth in bytes/second does the application expect? | ||
131 | */ | ||
132 | struct GNUNET_BANDWIDTH_Value32NBO bw; | ||
133 | |||
134 | }; | ||
135 | |||
136 | |||
137 | /** | ||
138 | * Transport client to ATS service: here is another session you can use. | ||
139 | */ | ||
140 | struct SessionAddMessage | ||
141 | { | ||
142 | /** | ||
143 | * Type is #GNUNET_MESSAGE_TYPE_ATS_SESSION_ADD or | ||
144 | * #GNUNET_MESSAGE_TYPE_ATS_SESSION_ADD_INBOUND_ONLY | ||
145 | */ | ||
146 | struct GNUNET_MessageHeader header; | ||
147 | |||
148 | /** | ||
149 | * Internal number this client will henceforth use to | ||
150 | * refer to this session. | ||
151 | */ | ||
152 | uint32_t session_id GNUNET_PACKED; | ||
153 | |||
154 | /** | ||
155 | * Identity of the peer that this session is for. | ||
156 | */ | ||
157 | struct GNUNET_PeerIdentity peer; | ||
158 | |||
159 | /** | ||
160 | * Performance properties of the session. | ||
161 | */ | ||
162 | struct PropertiesNBO properties; | ||
163 | |||
164 | /* followed by: | ||
165 | * - char * address (including '\0'-termination). | ||
166 | */ | ||
167 | |||
168 | }; | ||
169 | |||
170 | |||
171 | /** | ||
172 | * Message used to notify ATS that the performance | ||
173 | * characteristics for an session have changed. | ||
174 | */ | ||
175 | struct SessionUpdateMessage | ||
176 | { | ||
177 | /** | ||
178 | * Message of type #GNUNET_MESSAGE_TYPE_ATS_SESSION_UPDATE. | ||
179 | */ | ||
180 | struct GNUNET_MessageHeader header; | ||
181 | |||
182 | /** | ||
183 | * Internal number this client uses to refer to this session. | ||
184 | */ | ||
185 | uint32_t session_id GNUNET_PACKED; | ||
186 | |||
187 | /** | ||
188 | * Which peer is this about? (Technically redundant, as the | ||
189 | * @e session_id should be sufficient, but enables ATS service | ||
190 | * to find the session faster). | ||
191 | */ | ||
192 | struct GNUNET_PeerIdentity peer; | ||
193 | |||
194 | /** | ||
195 | * Performance properties of the session. | ||
196 | */ | ||
197 | struct PropertiesNBO properties; | ||
198 | |||
199 | }; | ||
200 | |||
201 | |||
202 | /** | ||
203 | * Message sent by ATS client to ATS service when an session | ||
204 | * was destroyed and must thus henceforth no longer be considered | ||
205 | * for scheduling. | ||
206 | */ | ||
207 | struct SessionDelMessage | ||
208 | { | ||
209 | /** | ||
210 | * Type is #GNUNET_MESSAGE_TYPE_ATS_SESSION_DEL. | ||
211 | */ | ||
212 | struct GNUNET_MessageHeader header; | ||
213 | |||
214 | /** | ||
215 | * Internal number this client uses to refer to this session. | ||
216 | */ | ||
217 | uint32_t session_id GNUNET_PACKED; | ||
218 | |||
219 | /** | ||
220 | * Which peer is this about? (Technically redundant, as the | ||
221 | * @e session_id should be sufficient, but enables ATS service | ||
222 | * to find the session faster). | ||
223 | */ | ||
224 | struct GNUNET_PeerIdentity peer; | ||
225 | |||
226 | }; | ||
227 | |||
228 | |||
229 | /** | ||
230 | * ATS Service allocates resources to an session | ||
231 | * identified by the given @e session_id for the given @e peer with | ||
232 | * the given @e bandwidth_in and @e bandwidth_out limits from now on. | ||
233 | */ | ||
234 | struct SessionAllocationMessage | ||
235 | { | ||
236 | /** | ||
237 | * A message of type #GNUNET_MESSAGE_TYPE_ATS_SESSION_ALLOCATION. | ||
238 | */ | ||
239 | struct GNUNET_MessageHeader header; | ||
240 | |||
241 | /** | ||
242 | * Internal number this client uses to refer to the session this | ||
243 | * suggestion is about. | ||
244 | */ | ||
245 | uint32_t session_id GNUNET_PACKED; | ||
246 | |||
247 | /** | ||
248 | * Which peer is this about? (Technically redundant, as the | ||
249 | * @e session_id should be sufficient, but may enable client | ||
250 | * to find the session faster and/or check consistency). | ||
251 | */ | ||
252 | struct GNUNET_PeerIdentity peer; | ||
253 | |||
254 | /** | ||
255 | * How much bandwidth we are allowed for sending. | ||
256 | */ | ||
257 | struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out; | ||
258 | |||
259 | /** | ||
260 | * How much bandwidth we are allowed for receiving. | ||
261 | */ | ||
262 | struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in; | ||
263 | |||
264 | }; | ||
265 | |||
266 | |||
267 | /** | ||
268 | * ATS Service suggests to the transport service to try the address | ||
269 | * for the given @e peer. | ||
270 | */ | ||
271 | struct AddressSuggestionMessage | ||
272 | { | ||
273 | /** | ||
274 | * A message of type #GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION. | ||
275 | */ | ||
276 | struct GNUNET_MessageHeader header; | ||
277 | |||
278 | /** | ||
279 | * Zero. | ||
280 | */ | ||
281 | uint32_t reserved GNUNET_PACKED; | ||
282 | |||
283 | /** | ||
284 | * Which peer is this about? (Technically redundant, as the | ||
285 | * @e session_id should be sufficient, but may enable client | ||
286 | * to find the session faster and/or check consistency). | ||
287 | */ | ||
288 | struct GNUNET_PeerIdentity peer; | ||
289 | |||
290 | /* Followed by 0-terminated address */ | ||
291 | }; | ||
292 | |||
293 | |||
294 | GNUNET_NETWORK_STRUCT_END | ||
295 | |||
296 | |||
297 | |||
298 | #endif | ||
diff --git a/src/ats/ats_api2_application.c b/src/ats/ats_api2_application.c new file mode 100644 index 000000000..37198392c --- /dev/null +++ b/src/ats/ats_api2_application.c | |||
@@ -0,0 +1,363 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2010-2016 GNUnet e.V. | ||
4 | |||
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. | ||
9 | |||
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. | ||
14 | |||
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/>. | ||
17 | */ | ||
18 | /** | ||
19 | * @file ats/ats_api2_application.c | ||
20 | * @brief enable clients to ask ATS about establishing connections to peers | ||
21 | * @author Christian Grothoff | ||
22 | * @author Matthias Wachs | ||
23 | */ | ||
24 | #include "platform.h" | ||
25 | #include "gnunet_ats_application_service.h" | ||
26 | #include "ats2.h" | ||
27 | |||
28 | |||
29 | #define LOG(kind,...) GNUNET_log_from(kind, "ats-application-api", __VA_ARGS__) | ||
30 | |||
31 | |||
32 | /** | ||
33 | * Handle for ATS address suggestion requests. | ||
34 | */ | ||
35 | struct GNUNET_ATS_ApplicationSuggestHandle | ||
36 | { | ||
37 | /** | ||
38 | * ID of the peer for which address suggestion was requested. | ||
39 | */ | ||
40 | struct GNUNET_PeerIdentity id; | ||
41 | |||
42 | /** | ||
43 | * Connecitivity handle this suggestion handle belongs to. | ||
44 | */ | ||
45 | struct GNUNET_ATS_ApplicationHandle *ch; | ||
46 | |||
47 | /** | ||
48 | * What preference is being expressed? | ||
49 | */ | ||
50 | enum GNUNET_MQ_PreferenceKind pk; | ||
51 | |||
52 | /** | ||
53 | * How much bandwidth does the client expect? | ||
54 | */ | ||
55 | struct GNUNET_BANDWIDTH_Value32NBO bw; | ||
56 | }; | ||
57 | |||
58 | |||
59 | /** | ||
60 | * Handle to the ATS subsystem for application management. | ||
61 | */ | ||
62 | struct GNUNET_ATS_ApplicationHandle | ||
63 | { | ||
64 | |||
65 | /** | ||
66 | * Our configuration. | ||
67 | */ | ||
68 | const struct GNUNET_CONFIGURATION_Handle *cfg; | ||
69 | |||
70 | /** | ||
71 | * Map with the identities of all the peers for which we would | ||
72 | * like to have address suggestions. The key is the PID, the | ||
73 | * value is currently the `struct GNUNET_ATS_ApplicationSuggestHandle` | ||
74 | */ | ||
75 | struct GNUNET_CONTAINER_MultiPeerMap *sug_requests; | ||
76 | |||
77 | /** | ||
78 | * Message queue for sending requests to the ATS service. | ||
79 | */ | ||
80 | struct GNUNET_MQ_Handle *mq; | ||
81 | |||
82 | /** | ||
83 | * Task to trigger reconnect. | ||
84 | */ | ||
85 | struct GNUNET_SCHEDULER_Task *task; | ||
86 | |||
87 | /** | ||
88 | * Reconnect backoff delay. | ||
89 | */ | ||
90 | struct GNUNET_TIME_Relative backoff; | ||
91 | }; | ||
92 | |||
93 | |||
94 | /** | ||
95 | * Re-establish the connection to the ATS service. | ||
96 | * | ||
97 | * @param ch handle to use to re-connect. | ||
98 | */ | ||
99 | static void | ||
100 | reconnect (struct GNUNET_ATS_ApplicationHandle *ch); | ||
101 | |||
102 | |||
103 | /** | ||
104 | * Re-establish the connection to the ATS service. | ||
105 | * | ||
106 | * @param cls handle to use to re-connect. | ||
107 | */ | ||
108 | static void | ||
109 | reconnect_task (void *cls) | ||
110 | { | ||
111 | struct GNUNET_ATS_ApplicationHandle *ch = cls; | ||
112 | |||
113 | ch->task = NULL; | ||
114 | reconnect (ch); | ||
115 | } | ||
116 | |||
117 | |||
118 | /** | ||
119 | * Disconnect from ATS and then reconnect. | ||
120 | * | ||
121 | * @param ch our handle | ||
122 | */ | ||
123 | static void | ||
124 | force_reconnect (struct GNUNET_ATS_ApplicationHandle *ch) | ||
125 | { | ||
126 | if (NULL != ch->mq) | ||
127 | { | ||
128 | GNUNET_MQ_destroy (ch->mq); | ||
129 | ch->mq = NULL; | ||
130 | } | ||
131 | ch->backoff = GNUNET_TIME_STD_BACKOFF (ch->backoff); | ||
132 | ch->task = GNUNET_SCHEDULER_add_delayed (ch->backoff, | ||
133 | &reconnect_task, | ||
134 | ch); | ||
135 | } | ||
136 | |||
137 | |||
138 | /** | ||
139 | * We encountered an error handling the MQ to the | ||
140 | * ATS service. Reconnect. | ||
141 | * | ||
142 | * @param cls the `struct GNUNET_ATS_ApplicationHandle` | ||
143 | * @param error details about the error | ||
144 | */ | ||
145 | static void | ||
146 | error_handler (void *cls, | ||
147 | enum GNUNET_MQ_Error error) | ||
148 | { | ||
149 | struct GNUNET_ATS_ApplicationHandle *ch = cls; | ||
150 | |||
151 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
152 | "ATS connection died (code %d), reconnecting\n", | ||
153 | (int) error); | ||
154 | force_reconnect (ch); | ||
155 | } | ||
156 | |||
157 | |||
158 | /** | ||
159 | * Transmit request for an address suggestion. | ||
160 | * | ||
161 | * @param cls the `struct GNUNET_ATS_ApplicationHandle` | ||
162 | * @param peer peer to ask for an address suggestion for | ||
163 | * @param value the `struct GNUNET_ATS_SuggestHandle` | ||
164 | * @return #GNUNET_OK (continue to iterate), #GNUNET_SYSERR on | ||
165 | * failure (message queue no longer exists) | ||
166 | */ | ||
167 | static int | ||
168 | transmit_suggestion (void *cls, | ||
169 | const struct GNUNET_PeerIdentity *peer, | ||
170 | void *value) | ||
171 | { | ||
172 | struct GNUNET_ATS_ApplicationHandle *ch = cls; | ||
173 | struct GNUNET_ATS_ApplicationSuggestHandle *sh = value; | ||
174 | struct GNUNET_MQ_Envelope *ev; | ||
175 | struct ExpressPreferenceMessage *m; | ||
176 | |||
177 | if (NULL == ch->mq) | ||
178 | return GNUNET_SYSERR; | ||
179 | ev = GNUNET_MQ_msg (m, | ||
180 | GNUNET_MESSAGE_TYPE_ATS_SUGGEST); | ||
181 | m->pk = htonl ((uint32_t) sh->pk); | ||
182 | m->bw = sh->bw; | ||
183 | m->peer = *peer; | ||
184 | GNUNET_MQ_send (ch->mq, ev); | ||
185 | return GNUNET_OK; | ||
186 | } | ||
187 | |||
188 | |||
189 | /** | ||
190 | * Re-establish the connection to the ATS service. | ||
191 | * | ||
192 | * @param ch handle to use to re-connect. | ||
193 | */ | ||
194 | static void | ||
195 | reconnect (struct GNUNET_ATS_ApplicationHandle *ch) | ||
196 | { | ||
197 | static const struct GNUNET_MQ_MessageHandler handlers[] = { | ||
198 | { NULL, 0, 0 } | ||
199 | }; | ||
200 | |||
201 | GNUNET_assert (NULL == ch->mq); | ||
202 | ch->mq = GNUNET_CLIENT_connect (ch->cfg, | ||
203 | "ats", | ||
204 | handlers, | ||
205 | &error_handler, | ||
206 | ch); | ||
207 | if (NULL == ch->mq) | ||
208 | { | ||
209 | force_reconnect (ch); | ||
210 | return; | ||
211 | } | ||
212 | GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests, | ||
213 | &transmit_suggestion, | ||
214 | ch); | ||
215 | } | ||
216 | |||
217 | |||
218 | /** | ||
219 | * Initialize the ATS application suggestion client handle. | ||
220 | * | ||
221 | * @param cfg configuration to use | ||
222 | * @return ats application handle, NULL on error | ||
223 | */ | ||
224 | struct GNUNET_ATS_ApplicationHandle * | ||
225 | GNUNET_ATS_application_init (const struct GNUNET_CONFIGURATION_Handle *cfg) | ||
226 | { | ||
227 | struct GNUNET_ATS_ApplicationHandle *ch; | ||
228 | |||
229 | ch = GNUNET_new (struct GNUNET_ATS_ApplicationHandle); | ||
230 | ch->cfg = cfg; | ||
231 | ch->sug_requests = GNUNET_CONTAINER_multipeermap_create (32, | ||
232 | GNUNET_YES); | ||
233 | reconnect (ch); | ||
234 | return ch; | ||
235 | } | ||
236 | |||
237 | |||
238 | /** | ||
239 | * Function called to free all `struct GNUNET_ATS_ApplicationSuggestHandle`s | ||
240 | * in the map. | ||
241 | * | ||
242 | * @param cls NULL | ||
243 | * @param key the key | ||
244 | * @param value the value to free | ||
245 | * @return #GNUNET_OK (continue to iterate) | ||
246 | */ | ||
247 | static int | ||
248 | free_sug_handle (void *cls, | ||
249 | const struct GNUNET_PeerIdentity *key, | ||
250 | void *value) | ||
251 | { | ||
252 | struct GNUNET_ATS_ApplicationSuggestHandle *cur = value; | ||
253 | |||
254 | GNUNET_free (cur); | ||
255 | return GNUNET_OK; | ||
256 | } | ||
257 | |||
258 | |||
259 | /** | ||
260 | * Client is done with ATS application management, release resources. | ||
261 | * | ||
262 | * @param ch handle to release | ||
263 | */ | ||
264 | void | ||
265 | GNUNET_ATS_application_done (struct GNUNET_ATS_ApplicationHandle *ch) | ||
266 | { | ||
267 | if (NULL != ch->mq) | ||
268 | { | ||
269 | GNUNET_MQ_destroy (ch->mq); | ||
270 | ch->mq = NULL; | ||
271 | } | ||
272 | if (NULL != ch->task) | ||
273 | { | ||
274 | GNUNET_SCHEDULER_cancel (ch->task); | ||
275 | ch->task = NULL; | ||
276 | } | ||
277 | GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests, | ||
278 | &free_sug_handle, | ||
279 | NULL); | ||
280 | GNUNET_CONTAINER_multipeermap_destroy (ch->sug_requests); | ||
281 | GNUNET_free (ch); | ||
282 | } | ||
283 | |||
284 | |||
285 | /** | ||
286 | * We would like to receive address suggestions for a peer. ATS will | ||
287 | * respond with a call to the continuation immediately containing an address or | ||
288 | * no address if none is available. ATS can suggest more addresses until we call | ||
289 | * #GNUNET_ATS_application_suggest_cancel(). | ||
290 | * | ||
291 | * @param ch handle | ||
292 | * @param peer identity of the peer we need an address for | ||
293 | * @param pk what kind of application will the application require (can be | ||
294 | * #GNUNET_MQ_PREFERENCE_NONE, we will still try to connect) | ||
295 | * @param bw desired bandwith, can be zero (we will still try to connect) | ||
296 | * @return suggest handle, NULL if a request is already pending | ||
297 | */ | ||
298 | struct GNUNET_ATS_ApplicationSuggestHandle * | ||
299 | GNUNET_ATS_application_suggest (struct GNUNET_ATS_ApplicationHandle *ch, | ||
300 | const struct GNUNET_PeerIdentity *peer, | ||
301 | enum GNUNET_MQ_PreferenceKind pk, | ||
302 | struct GNUNET_BANDWIDTH_Value32NBO bw) | ||
303 | { | ||
304 | struct GNUNET_ATS_ApplicationSuggestHandle *s; | ||
305 | |||
306 | s = GNUNET_new (struct GNUNET_ATS_ApplicationSuggestHandle); | ||
307 | s->ch = ch; | ||
308 | s->id = *peer; | ||
309 | s->pk = pk; | ||
310 | s->bw = bw; | ||
311 | (void) GNUNET_CONTAINER_multipeermap_put (ch->sug_requests, | ||
312 | &s->id, | ||
313 | s, | ||
314 | GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE); | ||
315 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
316 | "Requesting ATS to suggest address for `%s'\n", | ||
317 | GNUNET_i2s (peer)); | ||
318 | if (NULL == ch->mq) | ||
319 | return s; | ||
320 | GNUNET_assert (GNUNET_OK == | ||
321 | transmit_suggestion (ch, | ||
322 | &s->id, | ||
323 | s)); | ||
324 | return s; | ||
325 | } | ||
326 | |||
327 | |||
328 | /** | ||
329 | * We no longer care about being connected to a peer. | ||
330 | * | ||
331 | * @param sh handle to stop | ||
332 | */ | ||
333 | void | ||
334 | GNUNET_ATS_application_suggest_cancel (struct GNUNET_ATS_ApplicationSuggestHandle *sh) | ||
335 | { | ||
336 | struct GNUNET_ATS_ApplicationHandle *ch = sh->ch; | ||
337 | struct GNUNET_MQ_Envelope *ev; | ||
338 | struct ExpressPreferenceMessage *m; | ||
339 | |||
340 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
341 | "Telling ATS we no longer care for an address for `%s'\n", | ||
342 | GNUNET_i2s (&sh->id)); | ||
343 | GNUNET_assert (GNUNET_OK == | ||
344 | GNUNET_CONTAINER_multipeermap_remove (ch->sug_requests, | ||
345 | &sh->id, | ||
346 | sh)); | ||
347 | if (NULL == ch->mq) | ||
348 | { | ||
349 | GNUNET_free (sh); | ||
350 | return; | ||
351 | } | ||
352 | ev = GNUNET_MQ_msg (m, | ||
353 | GNUNET_MESSAGE_TYPE_ATS_SUGGEST_CANCEL); | ||
354 | m->pk = htonl ((uint32_t) sh->pk); | ||
355 | m->bw = sh->bw; | ||
356 | m->peer = sh->id; | ||
357 | GNUNET_MQ_send (ch->mq, | ||
358 | ev); | ||
359 | GNUNET_free (sh); | ||
360 | } | ||
361 | |||
362 | |||
363 | /* end of ats_api2_application.c */ | ||
diff --git a/src/ats/ats_api2_transport.c b/src/ats/ats_api2_transport.c new file mode 100644 index 000000000..b8133beea --- /dev/null +++ b/src/ats/ats_api2_transport.c | |||
@@ -0,0 +1,666 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2010-2015, 2018 GNUnet e.V. | ||
4 | |||
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. | ||
9 | |||
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. | ||
14 | |||
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/>. | ||
17 | */ | ||
18 | /** | ||
19 | * @file ats/ats_api2_transport.c | ||
20 | * @brief address suggestions and bandwidth allocation | ||
21 | * @author Christian Grothoff | ||
22 | * @author Matthias Wachs | ||
23 | */ | ||
24 | #include "platform.h" | ||
25 | #include "gnunet_ats_transport_service.h" | ||
26 | #include "ats2.h" | ||
27 | |||
28 | #define LOG(kind,...) GNUNET_log_from(kind, "ats-transport-api", __VA_ARGS__) | ||
29 | |||
30 | |||
31 | /** | ||
32 | * Information we track per session, incoming or outgoing. It also | ||
33 | * doesn't matter if we have a session, any session that ATS is | ||
34 | * allowed to suggest right now should be tracked. | ||
35 | */ | ||
36 | struct GNUNET_ATS_SessionRecord | ||
37 | { | ||
38 | |||
39 | /** | ||
40 | * Transport handle this session record belongs to. | ||
41 | */ | ||
42 | struct GNUNET_ATS_TransportHandle *ath; | ||
43 | |||
44 | /** | ||
45 | * Address data. | ||
46 | */ | ||
47 | const char *address; | ||
48 | |||
49 | /** | ||
50 | * Session handle, NULL if inbound-only (also implies we cannot | ||
51 | * actually control inbound traffic via transport!). So if | ||
52 | * @e session is NULL, the @e properties are informative for | ||
53 | * ATS (connection exists, utilization) but ATS cannot directly | ||
54 | * influence it (and should thus not call the | ||
55 | * #GNUNET_ATS_AllocationCallback for this @e session, which is | ||
56 | * obvious as NULL is not a meaningful session to allocation | ||
57 | * resources to). | ||
58 | */ | ||
59 | struct GNUNET_ATS_Session *session; | ||
60 | |||
61 | /** | ||
62 | * Identity of the peer reached at @e address. | ||
63 | */ | ||
64 | struct GNUNET_PeerIdentity pid; | ||
65 | |||
66 | /** | ||
67 | * Performance data about the @e session. | ||
68 | */ | ||
69 | struct GNUNET_ATS_Properties properties; | ||
70 | |||
71 | /** | ||
72 | * Unique ID to identify this session at this @a pid in IPC | ||
73 | * messages. | ||
74 | */ | ||
75 | uint32_t slot; | ||
76 | |||
77 | }; | ||
78 | |||
79 | |||
80 | /** | ||
81 | * Handle to the ATS subsystem for bandwidth/transport transport information. | ||
82 | */ | ||
83 | struct GNUNET_ATS_TransportHandle | ||
84 | { | ||
85 | |||
86 | /** | ||
87 | * Our configuration. | ||
88 | */ | ||
89 | const struct GNUNET_CONFIGURATION_Handle *cfg; | ||
90 | |||
91 | /** | ||
92 | * Callback to invoke on suggestions. | ||
93 | */ | ||
94 | GNUNET_ATS_SuggestionCallback suggest_cb; | ||
95 | |||
96 | /** | ||
97 | * Closure for @e suggest_cb. | ||
98 | */ | ||
99 | void *suggest_cb_cls; | ||
100 | |||
101 | /** | ||
102 | * Callback to invoke on allocations. | ||
103 | */ | ||
104 | GNUNET_ATS_AllocationCallback alloc_cb; | ||
105 | |||
106 | /** | ||
107 | * Closure for @e alloc_cb. | ||
108 | */ | ||
109 | void *alloc_cb_cls; | ||
110 | |||
111 | /** | ||
112 | * Message queue for sending requests to the ATS service. | ||
113 | */ | ||
114 | struct GNUNET_MQ_Handle *mq; | ||
115 | |||
116 | /** | ||
117 | * Task to trigger reconnect. | ||
118 | */ | ||
119 | struct GNUNET_SCHEDULER_Task *task; | ||
120 | |||
121 | /** | ||
122 | * Hash map mapping PIDs to session records. | ||
123 | */ | ||
124 | struct GNUNET_CONTAINER_MultiPeerMap *records; | ||
125 | |||
126 | /** | ||
127 | * Reconnect backoff delay. | ||
128 | */ | ||
129 | struct GNUNET_TIME_Relative backoff; | ||
130 | |||
131 | }; | ||
132 | |||
133 | |||
134 | /** | ||
135 | * Re-establish the connection to the ATS service. | ||
136 | * | ||
137 | * @param sh handle to use to re-connect. | ||
138 | */ | ||
139 | static void | ||
140 | reconnect (struct GNUNET_ATS_TransportHandle *ath); | ||
141 | |||
142 | |||
143 | /** | ||
144 | * Re-establish the connection to the ATS service. | ||
145 | * | ||
146 | * @param cls handle to use to re-connect. | ||
147 | */ | ||
148 | static void | ||
149 | reconnect_task (void *cls) | ||
150 | { | ||
151 | struct GNUNET_ATS_TransportHandle *ath = cls; | ||
152 | |||
153 | ath->task = NULL; | ||
154 | reconnect (ath); | ||
155 | } | ||
156 | |||
157 | |||
158 | /** | ||
159 | * Disconnect from ATS and then reconnect. | ||
160 | * | ||
161 | * @param ath our handle | ||
162 | */ | ||
163 | static void | ||
164 | force_reconnect (struct GNUNET_ATS_TransportHandle *ath) | ||
165 | { | ||
166 | if (NULL != ath->mq) | ||
167 | { | ||
168 | GNUNET_MQ_destroy (ath->mq); | ||
169 | ath->mq = NULL; | ||
170 | } | ||
171 | /* FIXME: do we tell transport service about disconnect events? CON: | ||
172 | initially ATS will have a really screwed picture of the world and | ||
173 | the rapid change would be bad. PRO: if we don't, ATS and | ||
174 | transport may disagree about the allocation for a while... | ||
175 | For now: lazy: do nothing. */ | ||
176 | ath->backoff = GNUNET_TIME_STD_BACKOFF (ath->backoff); | ||
177 | ath->task = GNUNET_SCHEDULER_add_delayed (ath->backoff, | ||
178 | &reconnect_task, | ||
179 | ath); | ||
180 | } | ||
181 | |||
182 | |||
183 | /** | ||
184 | * Check format of address suggestion message from the service. | ||
185 | * | ||
186 | * @param cls the `struct GNUNET_ATS_TransportHandle` | ||
187 | * @param m message received | ||
188 | */ | ||
189 | static int | ||
190 | check_ats_address_suggestion (void *cls, | ||
191 | const struct AddressSuggestionMessage *m) | ||
192 | { | ||
193 | // FIXME: check 0-termination! | ||
194 | // FIXME: MQ API should really have a macro for this! | ||
195 | return GNUNET_SYSERR; | ||
196 | } | ||
197 | |||
198 | |||
199 | /** | ||
200 | * We received an address suggestion message from the service. | ||
201 | * | ||
202 | * @param cls the `struct GNUNET_ATS_TransportHandle` | ||
203 | * @param m message received | ||
204 | */ | ||
205 | static void | ||
206 | handle_ats_address_suggestion (void *cls, | ||
207 | const struct AddressSuggestionMessage *m) | ||
208 | { | ||
209 | struct GNUNET_ATS_TransportHandle *ath = cls; | ||
210 | const char *address = (const char *) &m[1]; | ||
211 | |||
212 | ath->suggest_cb (ath->suggest_cb_cls, | ||
213 | &m->peer, | ||
214 | address); | ||
215 | } | ||
216 | |||
217 | |||
218 | /** | ||
219 | * Closure for #match_session_cb. | ||
220 | */ | ||
221 | struct FindContext | ||
222 | { | ||
223 | /** | ||
224 | * Key to look for. | ||
225 | */ | ||
226 | uint32_t session_id; | ||
227 | |||
228 | /** | ||
229 | * Where to store the result. | ||
230 | */ | ||
231 | struct GNUNET_ATS_SessionRecord *sr; | ||
232 | }; | ||
233 | |||
234 | |||
235 | /** | ||
236 | * Finds matching session record. | ||
237 | * | ||
238 | * @param cls a `struct FindContext` | ||
239 | * @param pid peer identity (unused) | ||
240 | * @param value a `struct GNUNET_ATS_SessionRecord` | ||
241 | * @return #GNUNET_NO if match found, #GNUNET_YES to continue searching | ||
242 | */ | ||
243 | static int | ||
244 | match_session_cb (void *cls, | ||
245 | const struct GNUNET_PeerIdentity *pid, | ||
246 | void *value) | ||
247 | { | ||
248 | struct FindContext *fc = cls; | ||
249 | struct GNUNET_ATS_SessionRecord *sr = value; | ||
250 | |||
251 | (void) pid; | ||
252 | if (fc->session_id == sr->slot) | ||
253 | { | ||
254 | fc->sr = sr; | ||
255 | return GNUNET_NO; | ||
256 | } | ||
257 | return GNUNET_YES; | ||
258 | } | ||
259 | |||
260 | |||
261 | |||
262 | /** | ||
263 | * Find session record for peer @a pid and session @a session_id | ||
264 | * | ||
265 | * @param ath transport handle to search | ||
266 | * @param session_id session ID to match | ||
267 | * @param pid peer to search under | ||
268 | * @return NULL if no such record exists | ||
269 | */ | ||
270 | static struct GNUNET_ATS_SessionRecord * | ||
271 | find_session (struct GNUNET_ATS_TransportHandle *ath, | ||
272 | uint32_t session_id, | ||
273 | const struct GNUNET_PeerIdentity *pid) | ||
274 | { | ||
275 | struct FindContext fc = { | ||
276 | .session_id = session_id, | ||
277 | .sr = NULL | ||
278 | }; | ||
279 | GNUNET_CONTAINER_multipeermap_get_multiple (ath->records, | ||
280 | pid, | ||
281 | &match_session_cb, | ||
282 | &fc); | ||
283 | return fc.sr; | ||
284 | } | ||
285 | |||
286 | |||
287 | /** | ||
288 | * We received a session allocation message from the service. | ||
289 | * | ||
290 | * @param cls the `struct GNUNET_ATS_TransportHandle` | ||
291 | * @param m message received | ||
292 | */ | ||
293 | static void | ||
294 | handle_ats_session_allocation (void *cls, | ||
295 | const struct SessionAllocationMessage *m) | ||
296 | { | ||
297 | struct GNUNET_ATS_TransportHandle *ath = cls; | ||
298 | struct GNUNET_ATS_SessionRecord *ar; | ||
299 | uint32_t session_id; | ||
300 | |||
301 | session_id = ntohl (m->session_id); | ||
302 | ar = find_session (ath, | ||
303 | session_id, | ||
304 | &m->peer); | ||
305 | if (NULL == ar) | ||
306 | { | ||
307 | /* this can (rarely) happen if ATS changes an sessiones allocation | ||
308 | just when the transport service deleted it */ | ||
309 | GNUNET_log (GNUNET_ERROR_TYPE_INFO, | ||
310 | "Allocation ignored, session unknown\n"); | ||
311 | return; | ||
312 | } | ||
313 | ath->backoff = GNUNET_TIME_UNIT_ZERO; | ||
314 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
315 | "ATS allocates bandwidth for peer `%s' using address %s\n", | ||
316 | GNUNET_i2s (&ar->pid), | ||
317 | ar->address); | ||
318 | ath->alloc_cb (ath->alloc_cb_cls, | ||
319 | ar->session, | ||
320 | m->bandwidth_out, | ||
321 | m->bandwidth_in); | ||
322 | } | ||
323 | |||
324 | |||
325 | /** | ||
326 | * We encountered an error handling the MQ to the ATS service. | ||
327 | * Reconnect. | ||
328 | * | ||
329 | * @param cls the `struct GNUNET_ATS_TransportHandle` | ||
330 | * @param error details about the error | ||
331 | */ | ||
332 | static void | ||
333 | error_handler (void *cls, | ||
334 | enum GNUNET_MQ_Error error) | ||
335 | { | ||
336 | struct GNUNET_ATS_TransportHandle *ath = cls; | ||
337 | |||
338 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
339 | "ATS connection died (code %d), reconnecting\n", | ||
340 | (int) error); | ||
341 | force_reconnect (ath); | ||
342 | } | ||
343 | |||
344 | |||
345 | /** | ||
346 | * Generate and transmit the `struct SessionAddMessage` for the given | ||
347 | * session record. | ||
348 | * | ||
349 | * @param ar the session to inform the ATS service about | ||
350 | */ | ||
351 | static void | ||
352 | send_add_session_message (const struct GNUNET_ATS_SessionRecord *ar) | ||
353 | { | ||
354 | struct GNUNET_ATS_TransportHandle *ath = ar->ath; | ||
355 | struct GNUNET_MQ_Envelope *ev; | ||
356 | struct SessionAddMessage *m; | ||
357 | size_t alen; | ||
358 | |||
359 | if (NULL == ath->mq) | ||
360 | return; /* disconnected, skip for now */ | ||
361 | alen = strlen (ar->address) + 1; | ||
362 | ev = GNUNET_MQ_msg_extra (m, | ||
363 | alen, | ||
364 | (NULL == ar->session) | ||
365 | ? GNUNET_MESSAGE_TYPE_ATS_SESSION_ADD_INBOUND_ONLY | ||
366 | : GNUNET_MESSAGE_TYPE_ATS_SESSION_ADD); | ||
367 | m->peer = ar->pid; | ||
368 | m->session_id = htonl (ar->slot); | ||
369 | // FIXME: convert endianess here! | ||
370 | // m->properties = ar->properties; | ||
371 | GNUNET_memcpy (&m[1], | ||
372 | ar->address, | ||
373 | alen); | ||
374 | |||
375 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
376 | "Adding address `%s' for peer `%s'\n", | ||
377 | ar->address, | ||
378 | GNUNET_i2s (&ar->pid)); | ||
379 | GNUNET_MQ_send (ath->mq, | ||
380 | ev); | ||
381 | } | ||
382 | |||
383 | |||
384 | /** | ||
385 | * Send ATS information about the session record. | ||
386 | * | ||
387 | * @param cls our `struct GNUNET_ATS_TransportHandle *`, unused | ||
388 | * @param pid unused | ||
389 | * @param value the `struct GNUNET_ATS_SessionRecord *` to add | ||
390 | * @return #GNUNET_OK | ||
391 | */ | ||
392 | static int | ||
393 | send_add_session_cb (void *cls, | ||
394 | const struct GNUNET_PeerIdentity *pid, | ||
395 | void *value) | ||
396 | { | ||
397 | struct GNUNET_ATS_SessionRecord *ar = value; | ||
398 | |||
399 | (void) cls; | ||
400 | (void) pid; | ||
401 | send_add_session_message (ar); | ||
402 | return GNUNET_OK; | ||
403 | } | ||
404 | |||
405 | |||
406 | /** | ||
407 | * Re-establish the connection to the ATS service. | ||
408 | * | ||
409 | * @param ath handle to use to re-connect. | ||
410 | */ | ||
411 | static void | ||
412 | reconnect (struct GNUNET_ATS_TransportHandle *ath) | ||
413 | { | ||
414 | struct GNUNET_MQ_MessageHandler handlers[] = { | ||
415 | GNUNET_MQ_hd_var_size (ats_address_suggestion, | ||
416 | GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION, | ||
417 | struct AddressSuggestionMessage, | ||
418 | ath), | ||
419 | GNUNET_MQ_hd_fixed_size (ats_session_allocation, | ||
420 | GNUNET_MESSAGE_TYPE_ATS_SESSION_ALLOCATION, | ||
421 | struct SessionAllocationMessage, | ||
422 | ath), | ||
423 | GNUNET_MQ_handler_end () | ||
424 | }; | ||
425 | struct GNUNET_MQ_Envelope *ev; | ||
426 | struct GNUNET_MessageHeader *init; | ||
427 | |||
428 | GNUNET_assert (NULL == ath->mq); | ||
429 | ath->mq = GNUNET_CLIENT_connect (ath->cfg, | ||
430 | "ats", | ||
431 | handlers, | ||
432 | &error_handler, | ||
433 | ath); | ||
434 | if (NULL == ath->mq) | ||
435 | { | ||
436 | GNUNET_break (0); | ||
437 | force_reconnect (ath); | ||
438 | return; | ||
439 | } | ||
440 | ev = GNUNET_MQ_msg (init, | ||
441 | GNUNET_MESSAGE_TYPE_ATS_START); | ||
442 | GNUNET_MQ_send (ath->mq, | ||
443 | ev); | ||
444 | if (NULL == ath->mq) | ||
445 | return; | ||
446 | GNUNET_CONTAINER_multipeermap_iterate (ath->records, | ||
447 | &send_add_session_cb, | ||
448 | ath); | ||
449 | } | ||
450 | |||
451 | |||
452 | /** | ||
453 | * Initialize the ATS subsystem. | ||
454 | * | ||
455 | * @param cfg configuration to use | ||
456 | * @param alloc_cb notification to call whenever the allocation changed | ||
457 | * @param alloc_cb_cls closure for @a alloc_cb | ||
458 | * @param suggest_cb notification to call whenever the suggestation is made | ||
459 | * @param suggest_cb_cls closure for @a suggest_cb | ||
460 | * @return ats context | ||
461 | */ | ||
462 | struct GNUNET_ATS_TransportHandle * | ||
463 | GNUNET_ATS_transport_init (const struct GNUNET_CONFIGURATION_Handle *cfg, | ||
464 | GNUNET_ATS_AllocationCallback alloc_cb, | ||
465 | void *alloc_cb_cls, | ||
466 | GNUNET_ATS_SuggestionCallback suggest_cb, | ||
467 | void *suggest_cb_cls) | ||
468 | { | ||
469 | struct GNUNET_ATS_TransportHandle *ath; | ||
470 | |||
471 | ath = GNUNET_new (struct GNUNET_ATS_TransportHandle); | ||
472 | ath->cfg = cfg; | ||
473 | ath->suggest_cb = suggest_cb; | ||
474 | ath->suggest_cb_cls = suggest_cb_cls; | ||
475 | ath->alloc_cb = alloc_cb; | ||
476 | ath->alloc_cb_cls = alloc_cb_cls; | ||
477 | ath->records = GNUNET_CONTAINER_multipeermap_create (128, | ||
478 | GNUNET_YES); | ||
479 | reconnect (ath); | ||
480 | return ath; | ||
481 | } | ||
482 | |||
483 | |||
484 | /** | ||
485 | * Release memory associated with the session record. | ||
486 | * | ||
487 | * @param cls NULL | ||
488 | * @param pid unused | ||
489 | * @param value a `struct GNUNET_ATS_SessionRecord` | ||
490 | * @return #GNUNET_OK | ||
491 | */ | ||
492 | static int | ||
493 | free_record (void *cls, | ||
494 | const struct GNUNET_PeerIdentity *pid, | ||
495 | void *value) | ||
496 | { | ||
497 | struct GNUNET_ATS_SessionRecord *ar = value; | ||
498 | |||
499 | (void) cls; | ||
500 | (void) pid; | ||
501 | GNUNET_free (ar); | ||
502 | return GNUNET_OK; | ||
503 | } | ||
504 | |||
505 | |||
506 | /** | ||
507 | * Client is done with ATS transport, release resources. | ||
508 | * | ||
509 | * @param ath handle to release | ||
510 | */ | ||
511 | void | ||
512 | GNUNET_ATS_transport_done (struct GNUNET_ATS_TransportHandle *ath) | ||
513 | { | ||
514 | if (NULL != ath->mq) | ||
515 | { | ||
516 | GNUNET_MQ_destroy (ath->mq); | ||
517 | ath->mq = NULL; | ||
518 | } | ||
519 | if (NULL != ath->task) | ||
520 | { | ||
521 | GNUNET_SCHEDULER_cancel (ath->task); | ||
522 | ath->task = NULL; | ||
523 | } | ||
524 | GNUNET_CONTAINER_multipeermap_iterate (ath->records, | ||
525 | &free_record, | ||
526 | NULL); | ||
527 | GNUNET_CONTAINER_multipeermap_destroy (ath->records); | ||
528 | GNUNET_free (ath); | ||
529 | } | ||
530 | |||
531 | |||
532 | /** | ||
533 | * We have a new session ATS should know. Sessiones have to be added | ||
534 | * with this function before they can be: updated, set in use and | ||
535 | * destroyed. | ||
536 | * | ||
537 | * @param ath handle | ||
538 | * @param pid peer we connected to | ||
539 | * @param address the address (human readable version) | ||
540 | * @param session transport-internal handle for the session/queue, NULL if | ||
541 | * the session is inbound-only | ||
542 | * @param prop performance data for the session | ||
543 | * @return handle to the session representation inside ATS, NULL | ||
544 | * on error (i.e. ATS knows this exact session already) | ||
545 | */ | ||
546 | struct GNUNET_ATS_SessionRecord * | ||
547 | GNUNET_ATS_session_add (struct GNUNET_ATS_TransportHandle *ath, | ||
548 | const struct GNUNET_PeerIdentity *pid, | ||
549 | const char *address, | ||
550 | struct GNUNET_ATS_Session *session, | ||
551 | const struct GNUNET_ATS_Properties *prop) | ||
552 | { | ||
553 | struct GNUNET_ATS_SessionRecord *ar; | ||
554 | uint32_t s; | ||
555 | size_t alen; | ||
556 | |||
557 | if (NULL == address) | ||
558 | { | ||
559 | /* we need a valid address */ | ||
560 | GNUNET_break (0); | ||
561 | return NULL; | ||
562 | } | ||
563 | alen = strlen (address) + 1; | ||
564 | if ( (alen + sizeof (struct SessionAddMessage) >= GNUNET_MAX_MESSAGE_SIZE) || | ||
565 | (alen >= GNUNET_MAX_MESSAGE_SIZE) ) | ||
566 | { | ||
567 | /* address too large for us, this should not happen */ | ||
568 | GNUNET_break (0); | ||
569 | return NULL; | ||
570 | } | ||
571 | |||
572 | /* Spin 's' until we find an unused session ID for this pid */ | ||
573 | for (s = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, | ||
574 | UINT32_MAX); | ||
575 | NULL != find_session (ath, | ||
576 | s, | ||
577 | pid); | ||
578 | s++) ; | ||
579 | |||
580 | alen = strlen (address) + 1; | ||
581 | ar = GNUNET_malloc (sizeof (struct GNUNET_ATS_SessionRecord) + alen); | ||
582 | ar->ath = ath; | ||
583 | ar->slot = 42; // FIXME: make up unique number! | ||
584 | ar->session = session; | ||
585 | ar->address = (const char *) &ar[1]; | ||
586 | ar->pid = *pid; | ||
587 | ar->properties = *prop; | ||
588 | memcpy (&ar[1], | ||
589 | address, | ||
590 | alen); | ||
591 | (void) GNUNET_CONTAINER_multipeermap_put (ath->records, | ||
592 | &ar->pid, | ||
593 | ar, | ||
594 | GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE); | ||
595 | send_add_session_message (ar); | ||
596 | return ar; | ||
597 | } | ||
598 | |||
599 | |||
600 | /** | ||
601 | * We have updated performance statistics for a given session. Note | ||
602 | * that this function can be called for sessiones that are currently | ||
603 | * in use as well as sessiones that are valid but not actively in use. | ||
604 | * Furthermore, the peer may not even be connected to us right now (in | ||
605 | * which case the call may be ignored or the information may be stored | ||
606 | * for later use). Update bandwidth assignments. | ||
607 | * | ||
608 | * @param ar session record to update information for | ||
609 | * @param prop performance data for the session | ||
610 | */ | ||
611 | void | ||
612 | GNUNET_ATS_session_update (struct GNUNET_ATS_SessionRecord *ar, | ||
613 | const struct GNUNET_ATS_Properties *prop) | ||
614 | { | ||
615 | struct GNUNET_ATS_TransportHandle *ath = ar->ath; | ||
616 | struct GNUNET_MQ_Envelope *ev; | ||
617 | struct SessionUpdateMessage *m; | ||
618 | |||
619 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
620 | "Updating address `%s' for peer `%s'\n", | ||
621 | ar->address, | ||
622 | GNUNET_i2s (&ar->pid)); | ||
623 | ar->properties = *prop; | ||
624 | if (NULL == ath->mq) | ||
625 | return; /* disconnected, skip for now */ | ||
626 | ev = GNUNET_MQ_msg (m, | ||
627 | GNUNET_MESSAGE_TYPE_ATS_SESSION_UPDATE); | ||
628 | m->session_id = htonl (ar->slot); | ||
629 | m->peer = ar->pid; | ||
630 | // FIXME: convert endianess here! | ||
631 | // m->properties = ar->properties; | ||
632 | GNUNET_MQ_send (ath->mq, | ||
633 | ev); | ||
634 | } | ||
635 | |||
636 | |||
637 | /** | ||
638 | * A session was destroyed, ATS should now schedule and | ||
639 | * allocate under the assumption that this @a ar is no | ||
640 | * longer in use. | ||
641 | * | ||
642 | * @param ar session record to drop | ||
643 | */ | ||
644 | void | ||
645 | GNUNET_ATS_session_del (struct GNUNET_ATS_SessionRecord *ar) | ||
646 | { | ||
647 | struct GNUNET_ATS_TransportHandle *ath = ar->ath; | ||
648 | struct GNUNET_MQ_Envelope *ev; | ||
649 | struct SessionDelMessage *m; | ||
650 | |||
651 | LOG (GNUNET_ERROR_TYPE_DEBUG, | ||
652 | "Deleting address `%s' for peer `%s'\n", | ||
653 | ar->address, | ||
654 | GNUNET_i2s (&ar->pid)); | ||
655 | if (NULL == ath->mq) | ||
656 | return; | ||
657 | ev = GNUNET_MQ_msg (m, | ||
658 | GNUNET_MESSAGE_TYPE_ATS_SESSION_DEL); | ||
659 | m->session_id = htonl (ar->slot); | ||
660 | m->peer = ar->pid; | ||
661 | GNUNET_MQ_send (ath->mq, | ||
662 | ev); | ||
663 | } | ||
664 | |||
665 | |||
666 | /* end of ats_api2_transport.c */ | ||