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;
78 * Find the scheduling client associated with the given
81 * @param client server handle
82 * @return internal handle
84 static struct SchedulingClient *
85 find_client (struct GNUNET_SERVER_Client *client)
87 struct SchedulingClient * sc;
89 for (sc = sc_head; sc != NULL; sc = sc->next)
90 if (sc->client == client)
97 * Register a new scheduling client.
99 * @param client handle of the new client
102 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client)
104 struct SchedulingClient *sc;
106 GNUNET_break (NULL == find_client (client));
107 sc = GNUNET_malloc (sizeof (struct SchedulingClient));
109 GNUNET_SERVER_notification_context_add (nc, client);
110 GNUNET_SERVER_client_keep (client);
111 GNUNET_CONTAINER_DLL_insert(sc_head, sc_tail, sc);
116 * Unregister a client (which may have been a scheduling client,
117 * but this is not assured).
119 * @param client handle of the (now dead) client
122 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
124 struct SchedulingClient * sc;
126 sc = find_client (client);
129 GNUNET_CONTAINER_DLL_remove (sc_head, sc_tail, sc);
130 GNUNET_SERVER_client_drop (client);
136 * Transmit the given address suggestion and bandwidth update to all scheduling
139 * @param peer peer for which this is an address suggestion
140 * @param plugin_name 0-termintated string specifying the transport plugin
141 * @param plugin_addr binary address for the plugin to use
142 * @param plugin_addr_len number of bytes in plugin_addr
143 * @param session_client which client gave us this session_id?
144 * @param session_id session ID to use for the given client (other clients will see 0)
145 * @param atsi performance data for the address
146 * @param atsi_count number of performance records in 'ats'
147 * @param bandwidth_out assigned outbound bandwidth
148 * @param bandwidth_in assigned inbound bandwidth
151 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity *peer,
152 const char *plugin_name,
153 const void *plugin_addr, size_t plugin_addr_len,
154 struct GNUNET_SERVER_Client *session_client,
156 const struct GNUNET_TRANSPORT_ATS_Information *atsi,
158 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
159 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
161 struct SchedulingClient *sc;
162 struct AddressSuggestionMessage *msg;
163 size_t plugin_name_length = strlen (plugin_name) + 1;
164 size_t msize = sizeof (struct AddressSuggestionMessage) + atsi_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information)
165 + plugin_addr_len + plugin_name_length;
167 struct GNUNET_TRANSPORT_ATS_Information *atsp;
170 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
171 GNUNET_assert (atsi_count < GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_TRANSPORT_ATS_Information));
172 msg = (struct AddressSuggestionMessage*) buf;
173 msg->header.size = htons (msize);
174 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
175 msg->ats_count = htonl (atsi_count);
177 msg->address_length = htons (plugin_addr_len);
178 msg->plugin_name_length = htons (plugin_name_length);
179 /* session ID is set only if 'client' is the same... */
180 msg->bandwidth_out = bandwidth_out;
181 msg->bandwidth_in = bandwidth_in;
182 atsp = (struct GNUNET_TRANSPORT_ATS_Information* ) &msg[1];
183 memcpy (atsp, atsi, sizeof (struct GNUNET_TRANSPORT_ATS_Information) * atsi_count);
184 addrp = (char*) &atsp[atsi_count];
185 memcpy (addrp, plugin_addr, plugin_addr_len);
186 strcpy (&addrp[plugin_addr_len], plugin_name);
187 for (sc = sc_head; sc != NULL; sc = sc->next)
189 if (sc->client == session_client)
190 msg->session_id = htonl (session_id);
192 msg->session_id = htonl (0);
193 GNUNET_SERVER_notification_context_unicast (nc,
202 * Handle 'request address' messages from clients.
204 * @param cls unused, NULL
205 * @param client client that sent the request
206 * @param message the request message
209 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
210 const struct GNUNET_MessageHeader *message)
213 const struct RequestAddressMessage * msg = (const struct RequestAddressMessage *) message;
215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "REQUEST_ADDRESS");
216 GNUNET_break (0 == ntohl (msg->reserved));
217 GAS_addresses_request_address (&msg->peer);
218 GNUNET_SERVER_receive_done (client, GNUNET_OK);
223 * Handle 'address update' messages from clients.
225 * @param cls unused, NULL
226 * @param client client that sent the request
227 * @param message the request message
230 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
231 const struct GNUNET_MessageHeader *message)
234 const struct AddressUpdateMessage * m;
235 const struct GNUNET_TRANSPORT_ATS_Information *atsi;
237 const char *plugin_name;
238 uint16_t address_length;
239 uint16_t plugin_name_length;
243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
244 "Received `%s' message\n",
246 size = ntohs (message->size);
247 if (size <= sizeof (struct AddressUpdateMessage))
250 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
253 m = (const struct AddressUpdateMessage*) message;
254 ats_count = ntohl (m->ats_count);
255 address_length = ntohs (m->address_length);
256 plugin_name_length = ntohs (m->plugin_name_length);
257 atsi = (const struct GNUNET_TRANSPORT_ATS_Information*) &m[1];
258 address = (const char*) &atsi[ats_count];
259 plugin_name = &address[address_length];
260 if ( (address_length +
262 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) +
263 sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
264 (ats_count > GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_TRANSPORT_ATS_Information)) ||
265 (plugin_name[plugin_name_length - 1] != '\0') )
268 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
271 GAS_address_update (&m->peer,
276 ntohl (m->session_id),
279 GNUNET_SERVER_receive_done (client, GNUNET_OK);
284 * Handle 'address destroyed' messages from clients.
286 * @param cls unused, NULL
287 * @param client client that sent the request
288 * @param message the request message
291 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
292 const struct GNUNET_MessageHeader *message)
295 const struct AddressDestroyedMessage * m;
297 const char *plugin_name;
298 uint16_t address_length;
299 uint16_t plugin_name_length;
302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
303 "Received `%s' message\n",
304 "ADDRESS_DESTROYED");
305 size = ntohs (message->size);
306 if (size <= sizeof (struct AddressDestroyedMessage))
309 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
312 m = (const struct AddressDestroyedMessage*) message;
313 GNUNET_break (0 == ntohl (m->reserved));
314 address_length = ntohs (m->address_length);
315 plugin_name_length = ntohs (m->plugin_name_length);
316 address = (const char*) &m[1];
317 plugin_name = &address[address_length];
318 if ( (address_length +
320 sizeof (struct AddressSuggestionMessage) != ntohs (message->size)) ||
321 (plugin_name[plugin_name_length - 1] != '\0') )
324 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
327 GAS_address_destroyed (&m->peer,
332 ntohl (m->session_id));
333 GNUNET_SERVER_receive_done (client, GNUNET_OK);
338 * Initialize scheduling subsystem.
340 * @param server handle to our server
343 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server)
345 nc = GNUNET_SERVER_notification_context_create (server, 128);
350 * Shutdown scheduling subsystem.
353 GAS_scheduling_done ()
355 GNUNET_SERVER_notification_context_destroy (nc);
360 /* end of gnunet-service-ats_scheduling.c */