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_performance.c
23 * @brief ats service, interaction with 'performance' 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_performance.h"
31 #include "gnunet-service-ats_reservations.h"
36 * We keep clients that are interested in performance in a linked list.
38 struct PerformanceClient
41 * Next in doubly-linked list.
43 struct PerformanceClient *next;
46 * Previous in doubly-linked list.
48 struct PerformanceClient *prev;
51 * Actual handle to the client.
53 struct GNUNET_SERVER_Client *client;
56 * Options for the client.
64 * Head of linked list of all clients to this service.
66 static struct PerformanceClient *pc_head;
69 * Tail of linked list of all clients to this service.
71 static struct PerformanceClient *pc_tail;
74 * Context for sending messages to performance clients.
76 static struct GNUNET_SERVER_NotificationContext *nc;
80 * Find the performance client associated with the given handle.
82 * @param client server handle
83 * @return internal handle
85 static struct PerformanceClient *
86 find_client (struct GNUNET_SERVER_Client *client)
88 struct PerformanceClient *pc;
90 for (pc = pc_head; pc != NULL; pc = pc->next)
91 if (pc->client == client)
97 * Unregister a client (which may have been a performance client,
98 * but this is not assured).
100 * @param client handle of the (now dead) client
103 GAS_performance_remove_client (struct GNUNET_SERVER_Client *client)
105 struct PerformanceClient *pc;
106 pc = find_client (client);
109 GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
110 GNUNET_SERVER_client_drop (client);
115 * Transmit the given performance information to all performance
118 * @param pc performance client to send to
119 * @param peer peer for which this is an address suggestion
120 * @param plugin_name 0-termintated string specifying the transport plugin
121 * @param plugin_addr binary address for the plugin to use
122 * @param plugin_addr_len number of bytes in plugin_addr
123 * @param atsi performance data for the address
124 * @param atsi_count number of performance records in 'ats'
125 * @param bandwidth_out assigned outbound bandwidth
126 * @param bandwidth_in assigned inbound bandwidth
129 GAS_performance_notify_client (struct PerformanceClient *pc,
130 const struct GNUNET_PeerIdentity *peer,
131 const char *plugin_name,
132 const void *plugin_addr, size_t plugin_addr_len,
133 const struct GNUNET_ATS_Information *atsi,
135 struct GNUNET_BANDWIDTH_Value32NBO
137 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
140 struct PeerInformationMessage *msg;
141 size_t plugin_name_length = strlen (plugin_name) + 1;
143 sizeof (struct PeerInformationMessage) +
144 atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
146 char buf[msize] GNUNET_ALIGN;
147 struct GNUNET_ATS_Information *atsp;
150 GNUNET_assert (NULL != pc);
151 if (NULL == find_client (pc->client))
152 return; /* Client disconnected */
154 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
155 GNUNET_assert (atsi_count <
156 GNUNET_SERVER_MAX_MESSAGE_SIZE /
157 sizeof (struct GNUNET_ATS_Information));
158 msg = (struct PeerInformationMessage *) buf;
159 msg->header.size = htons (msize);
160 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
161 msg->ats_count = htonl (atsi_count);
163 msg->address_length = htons (plugin_addr_len);
164 msg->plugin_name_length = htons (plugin_name_length);
165 msg->bandwidth_out = bandwidth_out;
166 msg->bandwidth_in = bandwidth_in;
167 atsp = (struct GNUNET_ATS_Information *) &msg[1];
168 memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
169 addrp = (char *) &atsp[atsi_count];
170 memcpy (addrp, plugin_addr, plugin_addr_len);
171 strcpy (&addrp[plugin_addr_len], plugin_name);
172 GNUNET_SERVER_notification_context_unicast (nc, pc->client, &msg->header,
178 * Transmit the given performance information to all performance
181 * @param peer peer for which this is an address suggestion
182 * @param plugin_name 0-termintated string specifying the transport plugin
183 * @param plugin_addr binary address for the plugin to use
184 * @param plugin_addr_len number of bytes in plugin_addr
185 * @param atsi performance data for the address
186 * @param atsi_count number of performance records in 'ats'
187 * @param bandwidth_out assigned outbound bandwidth
188 * @param bandwidth_in assigned inbound bandwidth
191 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
192 const char *plugin_name,
193 const void *plugin_addr, size_t plugin_addr_len,
194 const struct GNUNET_ATS_Information *atsi,
196 struct GNUNET_BANDWIDTH_Value32NBO
198 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
200 struct PerformanceClient *pc;
202 for (pc = pc_head; pc != NULL; pc = pc->next)
203 if (pc->flag == START_FLAG_PERFORMANCE_WITH_PIC)
205 GAS_performance_notify_client (pc,
207 plugin_name, plugin_addr, plugin_addr_len,
209 bandwidth_out, bandwidth_in);
212 GNUNET_STATISTICS_update (GSA_stats,
213 "# performance updates given to clients", 1,
219 peerinfo_it (void *cls,
220 const struct GNUNET_PeerIdentity *id,
221 const char *plugin_name,
222 const void *plugin_addr, size_t plugin_addr_len,
223 const struct GNUNET_ATS_Information *atsi,
225 struct GNUNET_BANDWIDTH_Value32NBO
227 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
229 GNUNET_assert (NULL != cls);
232 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
234 plugin_name, ntohl (bandwidth_out.value__), ntohl (bandwidth_in.value__));
235 GAS_performance_notify_client(cls,
237 plugin_name, plugin_addr, plugin_addr_len,
239 bandwidth_out, bandwidth_in);
246 * Iterator for GAS_performance_add_client
248 * @param cls the client requesting information
253 const struct GNUNET_PeerIdentity *id)
255 struct PerformanceClient *pc = cls;
258 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
259 GAS_addresses_get_peer_info (id, &peerinfo_it, pc);
264 * Register a new performance client.
266 * @param client handle of the new client
267 * @param flag flag specifying the type of the client
270 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
273 struct PerformanceClient *pc;
275 GNUNET_break (NULL == find_client (client));
276 pc = GNUNET_malloc (sizeof (struct PerformanceClient));
279 GNUNET_SERVER_notification_context_add (nc, client);
280 GNUNET_SERVER_client_keep (client);
281 GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
283 /* Send information about clients */
284 GAS_addresses_iterate_peers (&peer_it, pc);
290 * Handle 'reservation request' 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_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
298 const struct GNUNET_MessageHeader *message)
300 const struct ReservationRequestMessage *msg =
301 (const struct ReservationRequestMessage *) message;
302 struct ReservationResultMessage result;
304 struct GNUNET_TIME_Relative res_delay;
306 if (NULL == find_client (client))
308 /* missing start message! */
310 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
313 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
314 "RESERVATION_REQUEST");
315 amount = (int32_t) ntohl (msg->amount);
316 res_delay = GAS_reservations_reserve (&msg->peer, amount);
317 if (res_delay.rel_value > 0)
319 result.header.size = htons (sizeof (struct ReservationResultMessage));
320 result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
321 result.amount = htonl (amount);
322 result.peer = msg->peer;
323 result.res_delay = GNUNET_TIME_relative_hton (res_delay);
324 GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
326 GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
328 GNUNET_SERVER_receive_done (client, GNUNET_OK);
333 * Handle 'preference change' messages from clients.
335 * @param cls unused, NULL
336 * @param client client that sent the request
337 * @param message the request message
340 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
341 const struct GNUNET_MessageHeader *message)
343 const struct ChangePreferenceMessage *msg;
344 const struct PreferenceInformation *pi;
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
350 "PREFERENCE_CHANGE");
351 msize = ntohs (message->size);
352 if (msize < sizeof (struct ChangePreferenceMessage))
355 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
358 msg = (const struct ChangePreferenceMessage *) message;
359 nump = ntohl (msg->num_preferences);
361 sizeof (struct ChangePreferenceMessage) +
362 nump * sizeof (struct PreferenceInformation))
365 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
368 GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
370 pi = (const struct PreferenceInformation *) &msg[1];
371 for (i = 0; i < nump; i++)
372 GAS_addresses_change_preference (&msg->peer,
373 (enum GNUNET_ATS_PreferenceKind)
374 ntohl (pi[i].preference_kind),
375 pi[i].preference_value);
376 GNUNET_SERVER_receive_done (client, GNUNET_OK);
381 * Initialize performance subsystem.
383 * @param server handle to our server
386 GAS_performance_init (struct GNUNET_SERVER_Handle *server)
388 nc = GNUNET_SERVER_notification_context_create (server, 128);
393 * Shutdown performance subsystem.
396 GAS_performance_done ()
398 GNUNET_SERVER_notification_context_destroy (nc);
402 /* end of gnunet-service-ats_performance.c */