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_scheduling.c
23 * @brief ats service, interaction with 'scheduling' API
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet-service-ats.h"
29 #include "gnunet-service-ats_addresses.h"
30 #include "gnunet-service-ats_scheduling.h"
35 * Context for sending messages to clients.
37 static struct GNUNET_SERVER_NotificationContext *nc;
40 * Actual handle to the client.
42 static struct GNUNET_SERVER_Client *my_client;
46 * Handle to address subsystem
48 static struct GAS_Addresses_Handle *address_handle;
51 * Register a new scheduling client.
53 * @param client handle of the new client
54 * @return GNUNET_OK on success, GNUNET_SYSERR on error
57 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client)
59 if (my_client != NULL)
61 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
62 "This ATS already has a scheduling client, refusing new scheduling client for now.\n");
66 GNUNET_SERVER_notification_context_add (nc, client);
72 * Unregister a client (which may have been a scheduling client,
73 * but this is not assured).
75 * @param client handle of the (now dead) client
78 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
80 if (my_client != client)
82 GAS_addresses_destroy_all (address_handle);
88 * Transmit the given address suggestion and bandwidth update to all scheduling
91 * @param peer peer for which this is an address suggestion
92 * @param plugin_name 0-termintated string specifying the transport plugin
93 * @param plugin_addr binary address for the plugin to use
94 * @param plugin_addr_len number of bytes in plugin_addr
95 * @param session_id session ID to use for the given client (other clients will see 0)
96 * @param atsi performance data for the address
97 * @param atsi_count number of performance records in 'ats'
98 * @param bandwidth_out assigned outbound bandwidth
99 * @param bandwidth_in assigned inbound bandwidth
102 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity
103 *peer, const char *plugin_name,
104 const void *plugin_addr,
105 size_t plugin_addr_len,
107 const struct GNUNET_ATS_Information
108 *atsi, uint32_t atsi_count,
109 struct GNUNET_BANDWIDTH_Value32NBO
111 struct GNUNET_BANDWIDTH_Value32NBO
114 struct AddressSuggestionMessage *msg;
115 size_t plugin_name_length = strlen (plugin_name) + 1;
117 sizeof (struct AddressSuggestionMessage) +
118 atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
120 char buf[msize] GNUNET_ALIGN;
121 struct GNUNET_ATS_Information *atsp;
124 if (my_client == NULL)
126 GNUNET_STATISTICS_update (GSA_stats, "# address suggestions made", 1,
128 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
129 GNUNET_assert (atsi_count <
130 GNUNET_SERVER_MAX_MESSAGE_SIZE /
131 sizeof (struct GNUNET_ATS_Information));
132 msg = (struct AddressSuggestionMessage *) buf;
133 msg->header.size = htons (msize);
134 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
135 msg->ats_count = htonl (atsi_count);
137 msg->address_length = htons (plugin_addr_len);
138 msg->plugin_name_length = htons (plugin_name_length);
139 msg->session_id = htonl (session_id);
140 msg->bandwidth_out = bandwidth_out;
141 msg->bandwidth_in = bandwidth_in;
142 atsp = (struct GNUNET_ATS_Information *) &msg[1];
143 memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
144 addrp = (char *) &atsp[atsi_count];
145 memcpy (addrp, plugin_addr, plugin_addr_len);
146 strcpy (&addrp[plugin_addr_len], plugin_name);
148 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
149 "ATS sends quota for peer `%s': (in/out) %u/%u\n",
151 (unsigned int) ntohl (bandwidth_in.value__),
152 (unsigned int) ntohl (bandwidth_out.value__));
154 GNUNET_SERVER_notification_context_unicast (nc, my_client, &msg->header,
160 * Handle 'request address' messages from clients.
162 * @param cls unused, NULL
163 * @param client client that sent the request
164 * @param message the request message
167 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
168 const struct GNUNET_MessageHeader *message)
170 const struct RequestAddressMessage *msg =
171 (const struct RequestAddressMessage *) message;
173 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
175 GNUNET_break (0 == ntohl (msg->reserved));
176 GAS_addresses_request_address (address_handle, &msg->peer);
177 GNUNET_SERVER_receive_done (client, GNUNET_OK);
182 * Handle 'request address' messages from clients.
184 * @param cls unused, NULL
185 * @param client client that sent the request
186 * @param message the request message
189 GAS_handle_request_address_cancel (void *cls,
190 struct GNUNET_SERVER_Client *client,
191 const struct GNUNET_MessageHeader *message)
193 const struct RequestAddressMessage *msg =
194 (const struct RequestAddressMessage *) message;
196 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
197 "REQUEST_ADDRESS_CANCEL");
198 GNUNET_break (0 == ntohl (msg->reserved));
200 GAS_addresses_request_address_cancel (address_handle, &msg->peer);
202 GNUNET_SERVER_receive_done (client, GNUNET_OK);
206 * Handle 'reset backoff' messages from clients.
208 * @param cls unused, NULL
209 * @param client client that sent the request
210 * @param message the request message
213 GAS_handle_reset_backoff (void *cls,
214 struct GNUNET_SERVER_Client *client,
215 const struct GNUNET_MessageHeader *message)
217 const struct ResetBackoffMessage *msg =
218 (const struct ResetBackoffMessage *) message;
220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
222 GNUNET_break (0 == ntohl (msg->reserved));
223 GAS_addresses_handle_backoff_reset (address_handle, &msg->peer);
224 GNUNET_SERVER_receive_done (client, GNUNET_OK);
228 * Handle 'address add' messages from clients.
230 * @param cls unused, NULL
231 * @param client client that sent the request
232 * @param message the request message
235 GAS_handle_address_add (void *cls, struct GNUNET_SERVER_Client *client,
236 const struct GNUNET_MessageHeader *message)
238 const struct AddressUpdateMessage *m;
239 const struct GNUNET_ATS_Information *atsi;
241 const char *plugin_name;
242 uint16_t address_length;
243 uint16_t plugin_name_length;
247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
249 size = ntohs (message->size);
250 if (size < sizeof (struct AddressUpdateMessage))
253 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
256 m = (const struct AddressUpdateMessage *) message;
257 ats_count = ntohl (m->ats_count);
258 address_length = ntohs (m->address_length);
259 plugin_name_length = ntohs (m->plugin_name_length);
260 atsi = (const struct GNUNET_ATS_Information *) &m[1];
261 address = (const char *) &atsi[ats_count];
262 if (plugin_name_length != 0)
263 plugin_name = &address[address_length];
267 if ((address_length + plugin_name_length +
268 ats_count * sizeof (struct GNUNET_ATS_Information) +
269 sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
271 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
272 ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
275 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
278 GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
280 GAS_addresses_add (address_handle, &m->peer, plugin_name, address, address_length,
281 ntohl (m->session_id), atsi, ats_count);
282 GNUNET_SERVER_receive_done (client, GNUNET_OK);
287 * Handle 'address update' messages from clients.
289 * @param cls unused, NULL
290 * @param client client that sent the request
291 * @param message the request message
294 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
295 const struct GNUNET_MessageHeader *message)
297 const struct AddressUpdateMessage *m;
298 const struct GNUNET_ATS_Information *atsi;
300 const char *plugin_name;
301 uint16_t address_length;
302 uint16_t plugin_name_length;
306 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
308 size = ntohs (message->size);
309 if (size < sizeof (struct AddressUpdateMessage))
312 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
315 m = (const struct AddressUpdateMessage *) message;
316 ats_count = ntohl (m->ats_count);
317 address_length = ntohs (m->address_length);
318 plugin_name_length = ntohs (m->plugin_name_length);
319 atsi = (const struct GNUNET_ATS_Information *) &m[1];
320 address = (const char *) &atsi[ats_count];
321 if (plugin_name_length != 0)
322 plugin_name = &address[address_length];
326 if ((address_length + plugin_name_length +
327 ats_count * sizeof (struct GNUNET_ATS_Information) +
328 sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
330 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
331 ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
334 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
337 GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
339 GAS_addresses_update (address_handle, &m->peer, plugin_name, address, address_length,
340 ntohl (m->session_id), atsi, ats_count);
341 GNUNET_SERVER_receive_done (client, GNUNET_OK);
346 * Handle 'address in use' messages from clients.
348 * @param cls unused, NULL
349 * @param client client that sent the request
350 * @param message the request message
353 GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
354 const struct GNUNET_MessageHeader *message)
356 const struct AddressUseMessage *m;
358 const char *plugin_name;
360 uint16_t address_length;
361 uint16_t plugin_name_length;
366 size = ntohs (message->size);
367 if (size < sizeof (struct AddressUseMessage))
370 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
373 m = (const struct AddressUseMessage *) message;
375 address_length = ntohs (m->address_length);
376 plugin_name_length = ntohs (m->plugin_name_length);
378 address = (const char *) &m[1];
379 if (plugin_name_length != 0)
380 plugin_name = &address[address_length];
384 if ((address_length + plugin_name_length +
385 sizeof (struct AddressUseMessage) != ntohs (message->size)) ||
386 ((plugin_name_length > 0) &&
387 (plugin_name[plugin_name_length - 1] != '\0')))
390 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
394 in_use = ntohs (m->in_use);
395 res = GAS_addresses_in_use (address_handle,
400 ntohl (m->session_id),
403 if (res == GNUNET_OK)
404 GNUNET_SERVER_receive_done (client, GNUNET_OK);
408 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
414 * Handle 'address destroyed' messages from clients.
416 * @param cls unused, NULL
417 * @param client client that sent the request
418 * @param message the request message
421 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
422 const struct GNUNET_MessageHeader *message)
424 const struct AddressDestroyedMessage *m;
425 struct SessionReleaseMessage srm;
427 const char *plugin_name;
428 uint16_t address_length;
429 uint16_t plugin_name_length;
432 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message of size %u %u\n",
433 "ADDRESS_DESTROYED", ntohs (message->size),
434 sizeof (struct AddressDestroyedMessage));
435 size = ntohs (message->size);
436 if ((size < sizeof (struct AddressDestroyedMessage)) || (client != my_client))
439 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
442 m = (const struct AddressDestroyedMessage *) message;
443 GNUNET_break (0 == ntohl (m->reserved));
444 address_length = ntohs (m->address_length);
445 plugin_name_length = ntohs (m->plugin_name_length);
446 address = (const char *) &m[1];
447 if (plugin_name_length != 0)
448 plugin_name = &address[address_length];
451 if ((address_length + plugin_name_length +
452 sizeof (struct AddressDestroyedMessage) != ntohs (message->size)))
455 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
458 if ((plugin_name_length == 0) ||
459 (plugin_name[plugin_name_length - 1] != '\0'))
462 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
465 GNUNET_STATISTICS_update (GSA_stats, "# addresses destroyed", 1, GNUNET_NO);
466 GAS_addresses_destroy (address_handle, &m->peer, plugin_name,
467 address, address_length,
468 ntohl (m->session_id));
469 if (0 != ntohl (m->session_id))
471 srm.header.type = ntohs (GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE);
472 srm.header.size = ntohs (sizeof (struct SessionReleaseMessage));
473 srm.session_id = m->session_id;
475 GNUNET_SERVER_notification_context_unicast (nc, client, &srm.header,
478 GNUNET_SERVER_receive_done (client, GNUNET_OK);
483 * Initialize scheduling subsystem.
485 * @param server handle to our server
486 * @param ah the address handle to use
489 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *ah)
491 GNUNET_assert (NULL != ah);
493 nc = GNUNET_SERVER_notification_context_create (server, 128);
498 * Shutdown scheduling subsystem.
501 GAS_scheduling_done ()
503 if (NULL != my_client)
507 GNUNET_SERVER_notification_context_destroy (nc);
513 /* end of gnunet-service-ats_scheduling.c */