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_addresses.h"
29 #include "gnunet-service-ats_scheduling.h"
34 * We keep clients that are interested in scheduling in a linked list.
35 * This list typically has only one entry (for the
36 * gnunet-service-transport process); however, it is possible that
37 * there is more than one (at least briefly) because after a crash a
38 * new one may connect before we've been notified to clean up the old
41 struct SchedulingClient
44 * Next in doubly-linked list.
46 struct SchedulingClient * next;
49 * Previous in doubly-linked list.
51 struct SchedulingClient * prev;
54 * Actual handle to the client.
56 struct GNUNET_SERVER_Client *client;
62 * Head of linked list of all clients to this service.
64 static struct SchedulingClient *sc_head;
67 * Tail of linked list of all clients to this service.
69 static struct SchedulingClient *sc_tail;
72 * Context for sending messages to clients.
74 static struct GNUNET_SERVER_NotificationContext *nc;
76 static unsigned long long total_quota_in;
78 static unsigned long long total_quota_out;
82 * Find the scheduling client associated with the given
85 * @param client server handle
86 * @return internal handle
88 static struct SchedulingClient *
89 find_client (struct GNUNET_SERVER_Client *client)
91 struct SchedulingClient * sc;
93 for (sc = sc_head; sc != NULL; sc = sc->next)
94 if (sc->client == client)
101 * Register a new scheduling client.
103 * @param client handle of the new client
106 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client)
108 struct SchedulingClient *sc;
110 GNUNET_break (NULL == find_client (client));
111 sc = GNUNET_malloc (sizeof (struct SchedulingClient));
113 GNUNET_SERVER_notification_context_add (nc, client);
114 GNUNET_SERVER_client_keep (client);
115 GNUNET_CONTAINER_DLL_insert(sc_head, sc_tail, sc);
121 * Unregister a client (which may have been a scheduling client,
122 * but this is not assured).
124 * @param client handle of the (now dead) client
127 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
129 struct SchedulingClient * sc;
131 sc = find_client (client);
134 GNUNET_CONTAINER_DLL_remove (sc_head, sc_tail, sc);
135 GAS_address_client_disconnected (client);
136 GNUNET_SERVER_client_drop (client);
142 * Transmit the given address suggestion and bandwidth update to all scheduling
145 * @param peer peer for which this is an address suggestion
146 * @param plugin_name 0-termintated string specifying the transport plugin
147 * @param plugin_addr binary address for the plugin to use
148 * @param plugin_addr_len number of bytes in plugin_addr
149 * @param session_client which client gave us this session_id?
150 * @param session_id session ID to use for the given client (other clients will see 0)
151 * @param atsi performance data for the address
152 * @param atsi_count number of performance records in 'ats'
153 * @param bandwidth_out assigned outbound bandwidth
154 * @param bandwidth_in assigned inbound bandwidth
157 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity *peer,
158 const char *plugin_name,
159 const void *plugin_addr, size_t plugin_addr_len,
160 struct GNUNET_SERVER_Client *session_client,
162 const struct GNUNET_TRANSPORT_ATS_Information *atsi,
164 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
165 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
167 struct SchedulingClient *sc;
168 struct AddressSuggestionMessage *msg;
169 size_t plugin_name_length = strlen (plugin_name) + 1;
170 size_t msize = sizeof (struct AddressSuggestionMessage) + atsi_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)
171 + plugin_addr_len + plugin_name_length;
173 struct GNUNET_TRANSPORT_ATS_Information *atsp;
176 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
177 GNUNET_assert (atsi_count < GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_TRANSPORT_ATS_Information));
178 msg = (struct AddressSuggestionMessage*) buf;
179 msg->header.size = htons (msize);
180 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
181 msg->ats_count = htonl (atsi_count);
183 msg->address_length = htons (plugin_addr_len);
184 msg->plugin_name_length = htons (plugin_name_length);
185 /* session ID is set only if 'client' is the same... */
186 msg->bandwidth_out = bandwidth_out;
187 msg->bandwidth_in = bandwidth_in;
188 atsp = (struct GNUNET_TRANSPORT_ATS_Information* ) &msg[1];
189 memcpy (atsp, atsi, sizeof (struct GNUNET_TRANSPORT_ATS_Information) * atsi_count);
190 addrp = (char*) &atsp[atsi_count];
191 memcpy (addrp, plugin_addr, plugin_addr_len);
192 strcpy (&addrp[plugin_addr_len], plugin_name);
193 for (sc = sc_head; sc != NULL; sc = sc->next)
195 if (sc->client == session_client)
196 msg->session_id = htonl (session_id);
198 msg->session_id = htonl (0);
199 GNUNET_SERVER_notification_context_unicast (nc,
208 * Handle 'request address' messages from clients.
210 * @param cls unused, NULL
211 * @param client client that sent the request
212 * @param message the request message
215 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
216 const struct GNUNET_MessageHeader *message)
219 const struct RequestAddressMessage * msg = (const struct RequestAddressMessage *) message;
221 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "REQUEST_ADDRESS");
222 GNUNET_break (0 == ntohl (msg->reserved));
223 GAS_addresses_request_address (&msg->peer);
224 GNUNET_SERVER_receive_done (client, GNUNET_OK);
229 * Handle 'address update' messages from clients.
231 * @param cls unused, NULL
232 * @param client client that sent the request
233 * @param message the request message
236 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
237 const struct GNUNET_MessageHeader *message)
240 const struct AddressUpdateMessage * m;
241 const struct GNUNET_TRANSPORT_ATS_Information *atsi;
243 const char *plugin_name;
244 uint16_t address_length;
245 uint16_t plugin_name_length;
249 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
250 "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_TRANSPORT_ATS_Information*) &m[1];
264 address = (const char*) &atsi[ats_count];
265 if (plugin_name_length != 0)
266 plugin_name = &address[address_length];
269 if ( (address_length +
271 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) +
272 sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
273 (ats_count > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_TRANSPORT_ATS_Information)) ||
274 (plugin_name[plugin_name_length - 1] != '\0') )
277 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
280 GAS_address_update (&m->peer,
285 ntohl (m->session_id),
288 GNUNET_SERVER_receive_done (client, GNUNET_OK);
293 * Handle 'address destroyed' messages from clients.
295 * @param cls unused, NULL
296 * @param client client that sent the request
297 * @param message the request message
300 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
301 const struct GNUNET_MessageHeader *message)
304 const struct AddressDestroyedMessage * m;
306 const char *plugin_name;
307 uint16_t address_length;
308 uint16_t plugin_name_length;
311 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
312 "Received `%s' message of size %u %u\n",
313 "ADDRESS_DESTROYED", ntohs (message->size), sizeof (struct AddressDestroyedMessage));
314 size = ntohs (message->size);
315 if (size < sizeof (struct AddressDestroyedMessage))
318 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
321 m = (const struct AddressDestroyedMessage*) message;
322 GNUNET_break (0 == ntohl (m->reserved));
323 address_length = ntohs (m->address_length);
324 plugin_name_length = ntohs (m->plugin_name_length);
325 address = (const char*) &m[1];
326 if (plugin_name_length != 0)
327 plugin_name = &address[address_length];
331 if ( (address_length +
333 sizeof (struct AddressDestroyedMessage) != ntohs (message->size)))
336 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
340 if (plugin_name_length != 0)
341 if (plugin_name[plugin_name_length - 1] != '\0')
344 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
348 GAS_address_destroyed (&m->peer,
353 ntohl (m->session_id));
354 GNUNET_SERVER_receive_done (client, GNUNET_OK);
359 * Initialize scheduling subsystem.
361 * @param server handle to our server
362 * @param cfg configuration to use
365 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server,
366 const struct GNUNET_CONFIGURATION_Handle *cfg)
368 GNUNET_assert (GNUNET_OK ==
369 GNUNET_CONFIGURATION_get_value_number (cfg,
373 GNUNET_assert (GNUNET_OK ==
374 GNUNET_CONFIGURATION_get_value_number (cfg,
378 nc = GNUNET_SERVER_notification_context_create (server, 128);
383 * Shutdown scheduling subsystem.
386 GAS_scheduling_done ()
388 GNUNET_SERVER_notification_context_destroy (nc);
393 /* end of gnunet-service-ats_scheduling.c */