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",
150 GNUNET_i2s (peer), ntohl (bandwidth_in.value__),
151 ntohl (bandwidth_out.value__));
153 GNUNET_SERVER_notification_context_unicast (nc, my_client, &msg->header,
159 * Handle 'request address' messages from clients.
161 * @param cls unused, NULL
162 * @param client client that sent the request
163 * @param message the request message
166 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
167 const struct GNUNET_MessageHeader *message)
169 const struct RequestAddressMessage *msg =
170 (const struct RequestAddressMessage *) message;
172 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
174 GNUNET_STATISTICS_update (GSA_stats, "# address requests received", 1,
176 GNUNET_break (0 == ntohl (msg->reserved));
177 GAS_addresses_request_address (&msg->peer);
178 GNUNET_SERVER_receive_done (client, GNUNET_OK);
183 * Handle 'request address' messages from clients.
185 * @param cls unused, NULL
186 * @param client client that sent the request
187 * @param message the request message
190 GAS_handle_request_address_cancel (void *cls,
191 struct GNUNET_SERVER_Client *client,
192 const struct GNUNET_MessageHeader *message)
194 const struct RequestAddressMessage *msg =
195 (const struct RequestAddressMessage *) message;
197 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
198 "REQUEST_ADDRESS_CANCEL");
199 GNUNET_break (0 == ntohl (msg->reserved));
201 GAS_addresses_request_address_cancel (&msg->peer);
203 GNUNET_SERVER_receive_done (client, GNUNET_OK);
207 * Handle 'reset backoff' messages from clients.
209 * @param cls unused, NULL
210 * @param client client that sent the request
211 * @param message the request message
214 GAS_handle_reset_backoff (void *cls,
215 struct GNUNET_SERVER_Client *client,
216 const struct GNUNET_MessageHeader *message)
218 const struct ResetBackoffMessage *msg =
219 (const struct ResetBackoffMessage *) message;
221 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
223 GNUNET_STATISTICS_update (GSA_stats, "# backoff reset requests received", 1,
225 GNUNET_break (0 == ntohl (msg->reserved));
226 GAS_addresses_handle_backoff_reset (&msg->peer);
227 GNUNET_SERVER_receive_done (client, GNUNET_OK);
231 * Handle 'address add' messages from clients.
233 * @param cls unused, NULL
234 * @param client client that sent the request
235 * @param message the request message
238 GAS_handle_address_add (void *cls, struct GNUNET_SERVER_Client *client,
239 const struct GNUNET_MessageHeader *message)
241 const struct AddressUpdateMessage *m;
242 const struct GNUNET_ATS_Information *atsi;
244 const char *plugin_name;
245 uint16_t address_length;
246 uint16_t plugin_name_length;
250 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
252 size = ntohs (message->size);
253 if (size < sizeof (struct AddressUpdateMessage))
256 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
259 m = (const struct AddressUpdateMessage *) message;
260 ats_count = ntohl (m->ats_count);
261 address_length = ntohs (m->address_length);
262 plugin_name_length = ntohs (m->plugin_name_length);
263 atsi = (const struct GNUNET_ATS_Information *) &m[1];
264 address = (const char *) &atsi[ats_count];
265 if (plugin_name_length != 0)
266 plugin_name = &address[address_length];
270 if ((address_length + plugin_name_length +
271 ats_count * sizeof (struct GNUNET_ATS_Information) +
272 sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
274 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
275 ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
278 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
281 GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
283 GAS_addresses_add (&m->peer, plugin_name, address, address_length,
284 ntohl (m->session_id), atsi, ats_count);
285 GNUNET_SERVER_receive_done (client, GNUNET_OK);
290 * Handle 'address update' messages from clients.
292 * @param cls unused, NULL
293 * @param client client that sent the request
294 * @param message the request message
297 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
298 const struct GNUNET_MessageHeader *message)
300 const struct AddressUpdateMessage *m;
301 const struct GNUNET_ATS_Information *atsi;
303 const char *plugin_name;
304 uint16_t address_length;
305 uint16_t plugin_name_length;
309 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
311 size = ntohs (message->size);
312 if (size < sizeof (struct AddressUpdateMessage))
315 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
318 m = (const struct AddressUpdateMessage *) message;
319 ats_count = ntohl (m->ats_count);
320 address_length = ntohs (m->address_length);
321 plugin_name_length = ntohs (m->plugin_name_length);
322 atsi = (const struct GNUNET_ATS_Information *) &m[1];
323 address = (const char *) &atsi[ats_count];
324 if (plugin_name_length != 0)
325 plugin_name = &address[address_length];
329 if ((address_length + plugin_name_length +
330 ats_count * sizeof (struct GNUNET_ATS_Information) +
331 sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
333 GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
334 ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
337 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
340 GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
342 GAS_addresses_update (&m->peer, plugin_name, address, address_length,
343 ntohl (m->session_id), atsi, ats_count);
344 GNUNET_SERVER_receive_done (client, GNUNET_OK);
349 * Handle 'address in use' messages from clients.
351 * @param cls unused, NULL
352 * @param client client that sent the request
353 * @param message the request message
356 GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
357 const struct GNUNET_MessageHeader *message)
359 const struct AddressUseMessage *m;
361 const char *plugin_name;
363 uint16_t address_length;
364 uint16_t plugin_name_length;
369 size = ntohs (message->size);
370 if (size < sizeof (struct AddressUseMessage))
373 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
376 m = (const struct AddressUseMessage *) message;
378 address_length = ntohs (m->address_length);
379 plugin_name_length = ntohs (m->plugin_name_length);
381 address = (const char *) &m[1];
382 if (plugin_name_length != 0)
383 plugin_name = &address[address_length];
387 if ((address_length + plugin_name_length +
388 sizeof (struct AddressUseMessage) != ntohs (message->size)) ||
389 ((plugin_name_length > 0) &&
390 (plugin_name[plugin_name_length - 1] != '\0')))
393 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
397 in_use = ntohs (m->in_use);
398 res = GAS_addresses_in_use (&m->peer,
402 ntohl (m->session_id),
405 if (res == GNUNET_OK)
406 GNUNET_SERVER_receive_done (client, GNUNET_OK);
410 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
416 * Handle 'address destroyed' messages from clients.
418 * @param cls unused, NULL
419 * @param client client that sent the request
420 * @param message the request message
423 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
424 const struct GNUNET_MessageHeader *message)
426 const struct AddressDestroyedMessage *m;
427 struct SessionReleaseMessage srm;
429 const char *plugin_name;
430 uint16_t address_length;
431 uint16_t plugin_name_length;
434 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message of size %u %u\n",
435 "ADDRESS_DESTROYED", ntohs (message->size),
436 sizeof (struct AddressDestroyedMessage));
437 size = ntohs (message->size);
438 if ((size < sizeof (struct AddressDestroyedMessage)) || (client != my_client))
441 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
444 m = (const struct AddressDestroyedMessage *) message;
445 GNUNET_break (0 == ntohl (m->reserved));
446 address_length = ntohs (m->address_length);
447 plugin_name_length = ntohs (m->plugin_name_length);
448 address = (const char *) &m[1];
449 if (plugin_name_length != 0)
450 plugin_name = &address[address_length];
453 if ((address_length + plugin_name_length +
454 sizeof (struct AddressDestroyedMessage) != ntohs (message->size)))
457 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
460 if ((plugin_name_length == 0) ||
461 (plugin_name[plugin_name_length - 1] != '\0'))
464 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
467 GNUNET_STATISTICS_update (GSA_stats, "# addresses destroyed", 1, GNUNET_NO);
468 GAS_addresses_destroy (&m->peer, plugin_name, address, address_length,
469 ntohl (m->session_id));
470 if (0 != ntohl (m->session_id))
472 srm.header.type = ntohs (GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE);
473 srm.header.size = ntohs (sizeof (struct SessionReleaseMessage));
474 srm.session_id = m->session_id;
476 GNUNET_SERVER_notification_context_unicast (nc, client, &srm.header,
479 GNUNET_SERVER_receive_done (client, GNUNET_OK);
484 * Initialize scheduling subsystem.
486 * @param server handle to our server
489 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *ah)
492 nc = GNUNET_SERVER_notification_context_create (server, 128);
497 * Shutdown scheduling subsystem.
500 GAS_scheduling_done ()
502 if (NULL != my_client)
506 GNUNET_SERVER_notification_context_destroy (nc);
512 /* end of gnunet-service-ats_scheduling.c */