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"
35 * We keep clients that are interested in performance in a linked list.
37 struct PerformanceClient
40 * Next in doubly-linked list.
42 struct PerformanceClient *next;
45 * Previous in doubly-linked list.
47 struct PerformanceClient *prev;
50 * Actual handle to the client.
52 struct GNUNET_SERVER_Client *client;
55 * Options for the client.
63 * We keep clients that are interested in performance in a linked list.
65 struct AddressIteration
68 * Actual handle to the client.
70 struct PerformanceClient *pc;
76 unsigned int msg_type;
82 static struct GAS_Addresses_Handle *GSA_addresses;
85 * Head of linked list of all clients to this service.
87 static struct PerformanceClient *pc_head;
90 * Tail of linked list of all clients to this service.
92 static struct PerformanceClient *pc_tail;
95 * Context for sending messages to performance clients.
97 static struct GNUNET_SERVER_NotificationContext *nc;
101 * Find the performance client associated with the given handle.
103 * @param client server handle
104 * @return internal handle
106 static struct PerformanceClient *
107 find_client (struct GNUNET_SERVER_Client *client)
109 struct PerformanceClient *pc;
111 for (pc = pc_head; pc != NULL; pc = pc->next)
112 if (pc->client == client)
118 * Unregister a client (which may have been a performance client,
119 * but this is not assured).
121 * @param client handle of the (now dead) client
124 GAS_performance_remove_client (struct GNUNET_SERVER_Client *client)
126 struct PerformanceClient *pc;
127 pc = find_client (client);
130 GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
131 GNUNET_SERVER_client_drop (client);
136 * Transmit the given performance information to all performance
139 * @param pc performance client to send to
140 * @param peer peer for which this is an address suggestion
141 * @param plugin_name 0-termintated string specifying the transport plugin
142 * @param plugin_addr binary address for the plugin to use
143 * @param plugin_addr_len number of bytes in plugin_addr
144 * @param active is this address active
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_performance_notify_client (struct PerformanceClient *pc,
152 const struct GNUNET_PeerIdentity *peer,
153 const char *plugin_name,
154 const void *plugin_addr, size_t plugin_addr_len,
156 const struct GNUNET_ATS_Information *atsi,
158 struct GNUNET_BANDWIDTH_Value32NBO
160 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
163 struct PeerInformationMessage *msg;
164 size_t plugin_name_length = strlen (plugin_name) + 1;
166 sizeof (struct PeerInformationMessage) +
167 atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
169 char buf[msize] GNUNET_ALIGN;
170 struct GNUNET_ATS_Information *atsp;
173 GNUNET_assert (NULL != pc);
174 if (NULL == find_client (pc->client))
175 return; /* Client disconnected */
177 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
178 GNUNET_assert (atsi_count <
179 GNUNET_SERVER_MAX_MESSAGE_SIZE /
180 sizeof (struct GNUNET_ATS_Information));
181 msg = (struct PeerInformationMessage *) buf;
182 msg->header.size = htons (msize);
183 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
185 msg->ats_count = htonl (atsi_count);
187 msg->address_length = htons (plugin_addr_len);
188 msg->address_active = ntohl (active);
189 msg->plugin_name_length = htons (plugin_name_length);
190 msg->bandwidth_out = bandwidth_out;
191 msg->bandwidth_in = bandwidth_in;
192 atsp = (struct GNUNET_ATS_Information *) &msg[1];
193 memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
194 addrp = (char *) &atsp[atsi_count];
195 memcpy (addrp, plugin_addr, plugin_addr_len);
196 strcpy (&addrp[plugin_addr_len], plugin_name);
197 GNUNET_SERVER_notification_context_unicast (nc, pc->client, &msg->header,
203 * Transmit the given performance information to all performance
206 * @param peer peer for which this is an address suggestion
207 * @param plugin_name 0-termintated string specifying the transport plugin
208 * @param plugin_addr binary address for the plugin to use
209 * @param plugin_addr_len number of bytes in plugin_addr
210 * @param active is this address active
211 * @param atsi performance data for the address
212 * @param atsi_count number of performance records in 'ats'
213 * @param bandwidth_out assigned outbound bandwidth
214 * @param bandwidth_in assigned inbound bandwidth
217 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
218 const char *plugin_name,
219 const void *plugin_addr, size_t plugin_addr_len,
221 const struct GNUNET_ATS_Information *atsi,
223 struct GNUNET_BANDWIDTH_Value32NBO
225 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
227 struct PerformanceClient *pc;
229 for (pc = pc_head; pc != NULL; pc = pc->next)
230 if (pc->flag == START_FLAG_PERFORMANCE_WITH_PIC)
232 GAS_performance_notify_client (pc,
234 plugin_name, plugin_addr, plugin_addr_len,
237 bandwidth_out, bandwidth_in);
239 GNUNET_STATISTICS_update (GSA_stats,
240 "# performance updates given to clients", 1,
246 peerinfo_it (void *cls,
247 const struct GNUNET_PeerIdentity *id,
248 const char *plugin_name,
249 const void *plugin_addr, size_t plugin_addr_len,
251 const struct GNUNET_ATS_Information *atsi,
253 struct GNUNET_BANDWIDTH_Value32NBO
255 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
257 struct PerformanceClient *pc = cls;
258 GNUNET_assert (NULL != pc);
262 if (GNUNET_NO == active)
265 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
266 "Callback for peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
269 ntohl (bandwidth_out.value__),
270 ntohl (bandwidth_in.value__));
271 GAS_performance_notify_client(pc,
278 bandwidth_out, bandwidth_in);
283 * Iterator for GAS_performance_add_client
285 * @param cls the client requesting information
290 const struct GNUNET_PeerIdentity *id)
292 struct PerformanceClient *pc = cls;
295 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
296 GAS_addresses_get_peer_info (GSA_addresses, id, &peerinfo_it, pc);
301 * Register a new performance client.
303 * @param client handle of the new client
304 * @param flag flag specifying the type of the client
307 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
310 struct PerformanceClient *pc;
311 GNUNET_break (NULL == find_client (client));
313 pc = GNUNET_malloc (sizeof (struct PerformanceClient));
316 GNUNET_SERVER_notification_context_add (nc, client);
317 GNUNET_SERVER_client_keep (client);
318 GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
320 /* Send information about clients */
321 GAS_addresses_iterate_peers (GSA_addresses, &peer_it, pc);
324 static void transmit_req_addr (struct AddressIteration *ai,
325 const struct GNUNET_PeerIdentity *id,
326 const char *plugin_name,
327 const void *plugin_addr, size_t plugin_addr_len,
329 const struct GNUNET_ATS_Information *atsi,
331 struct GNUNET_BANDWIDTH_Value32NBO
333 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
337 struct GNUNET_ATS_Information *atsp;
338 struct PeerInformationMessage *msg;
340 size_t plugin_name_length;
343 if (NULL != plugin_name)
344 plugin_name_length = strlen (plugin_name) + 1;
346 plugin_name_length = 0;
347 msize = sizeof (struct PeerInformationMessage) +
348 atsi_count * sizeof (struct GNUNET_ATS_Information) +
349 plugin_addr_len + plugin_name_length;
350 char buf[msize] GNUNET_ALIGN;
352 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
353 GNUNET_assert (atsi_count <
354 GNUNET_SERVER_MAX_MESSAGE_SIZE /
355 sizeof (struct GNUNET_ATS_Information));
356 msg = (struct PeerInformationMessage *) buf;
357 msg->header.size = htons (msize);
358 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE);
359 msg->ats_count = htonl (atsi_count);
360 msg->id = htonl (ai->id);
364 memset (&msg->peer, '\0', sizeof (struct GNUNET_PeerIdentity));
365 msg->address_length = htons (plugin_addr_len);
366 msg->address_active = ntohl (active);
367 msg->plugin_name_length = htons (plugin_name_length);
368 msg->bandwidth_out = bandwidth_out;
369 msg->bandwidth_in = bandwidth_in;
370 atsp = (struct GNUNET_ATS_Information *) &msg[1];
371 memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
372 addrp = (char *) &atsp[atsi_count];
373 if (NULL != plugin_addr)
374 memcpy (addrp, plugin_addr, plugin_addr_len);
375 if (NULL != plugin_name)
376 strcpy (&addrp[plugin_addr_len], plugin_name);
377 GNUNET_SERVER_notification_context_unicast (nc, ai->pc->client, &msg->header,
382 req_addr_peerinfo_it (void *cls,
383 const struct GNUNET_PeerIdentity *id,
384 const char *plugin_name,
385 const void *plugin_addr, size_t plugin_addr_len,
387 const struct GNUNET_ATS_Information *atsi,
389 struct GNUNET_BANDWIDTH_Value32NBO
391 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
393 struct AddressIteration *ai = cls;
395 GNUNET_assert (NULL != ai);
396 GNUNET_assert (NULL != ai->pc);
397 if (NULL == find_client (ai->pc->client))
398 return; /* Client disconnected */
400 if ((NULL == id) && (NULL == plugin_name) && (NULL == plugin_addr))
402 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
403 "Address iteration done\n");
406 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
407 "Callback for %s peer `%s' plugin `%s' BW out %u, BW in %u \n",
408 (active == GNUNET_YES) ? "ACTIVE" : "INACTIVE",
411 (unsigned int) ntohl (bandwidth_out.value__),
412 (unsigned int) ntohl (bandwidth_in.value__));
414 /* Transmit result */
415 if ((GNUNET_YES == ai->all) || (GNUNET_YES == active))
417 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
418 "Sending result for %s peer `%s' plugin `%s' BW out %u, BW in %u \n",
419 (active == GNUNET_YES) ? "ACTIVE" : "INACTIVE",
422 (unsigned int) ntohl (bandwidth_out.value__),
423 (unsigned int) ntohl (bandwidth_in.value__));
424 transmit_req_addr (cls,
427 plugin_addr, plugin_addr_len,
431 bandwidth_out, bandwidth_in);
437 * Iterator for GAS_handle_request_address_list
439 * @param cls the client requesting information
443 req_addr_peer_it (void *cls,
444 const struct GNUNET_PeerIdentity *id)
446 struct AddressIteration *ai = cls;
449 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
450 GAS_addresses_get_peer_info (GSA_addresses, id, &req_addr_peerinfo_it, ai);
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer iteration done\n");
459 * Handle 'address list request' messages from clients.
461 * @param cls unused, NULL
462 * @param client client that sent the request
463 * @param message the request message
466 GAS_handle_request_address_list (void *cls, struct GNUNET_SERVER_Client *client,
467 const struct GNUNET_MessageHeader *message)
469 struct PerformanceClient *pc;
470 struct AddressIteration ai;
471 struct AddressListRequestMessage * alrm = (struct AddressListRequestMessage *) message;
472 struct GNUNET_PeerIdentity allzeros;
473 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_zero;
475 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
476 "ADDRESSLIST_REQUEST");
478 if (NULL == (pc = find_client(client)))
484 ai.all = ntohl (alrm->all);
485 ai.id = ntohl (alrm->id);
488 memset (&allzeros, '\0', sizeof (struct GNUNET_PeerIdentity));
489 bandwidth_zero.value__ = htonl (0);
490 if (0 == memcmp (&alrm->peer, &allzeros, sizeof (struct GNUNET_PeerIdentity)))
492 /* Return addresses for all peers */
493 GAS_addresses_iterate_peers (GSA_addresses, &req_addr_peer_it, &ai);
494 transmit_req_addr (&ai, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, bandwidth_zero, bandwidth_zero);
498 /* Return addresses for a specific peer */
499 GAS_addresses_get_peer_info (GSA_addresses, &alrm->peer, &req_addr_peerinfo_it, &ai);
500 transmit_req_addr (&ai, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, bandwidth_zero, bandwidth_zero);
502 GNUNET_SERVER_receive_done (client, GNUNET_OK);
507 GAS_handle_performance_update (struct GNUNET_PeerIdentity *peer,
508 struct GNUNET_ATS_Information *ats,
514 struct PerformanceClient *cur;
515 struct PerformanceMonitorClient *curm;
516 struct MonitorResponseMessage *mrm;
519 msglen = sizeof (struct MonitorResponseMessage) +
520 ats_count * sizeof (struct GNUNET_ATS_Information);
521 mrm = GNUNET_malloc (msglen);
523 mrm->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_MONITOR_RESPONSE);
524 mrm->header.size = htons (msglen);
525 mrm->ats_count = htonl (ats_count);
527 memcpy (&mrm[1], ats, ats_count * sizeof (struct GNUNET_ATS_Information));
529 for (cur = pc_head; NULL != cur; cur = cur->next)
530 for (curm = cur->pm_head; NULL != curm; curm = curm->next)
532 /* Notify client about update */
533 mrm->id = htonl (curm->id);
534 GNUNET_SERVER_notification_context_unicast (nc,
536 (struct GNUNET_MessageHeader *) mrm,
545 * Handle 'reservation request' messages from clients.
547 * @param cls unused, NULL
548 * @param client client that sent the request
549 * @param message the request message
552 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
553 const struct GNUNET_MessageHeader *message)
555 const struct ReservationRequestMessage *msg =
556 (const struct ReservationRequestMessage *) message;
557 struct ReservationResultMessage result;
559 struct GNUNET_TIME_Relative res_delay;
561 if (NULL == find_client (client))
563 /* missing start message! */
565 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
568 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
569 "RESERVATION_REQUEST");
570 amount = (int32_t) ntohl (msg->amount);
571 res_delay = GAS_reservations_reserve (&msg->peer, amount);
572 if (res_delay.rel_value > 0)
574 result.header.size = htons (sizeof (struct ReservationResultMessage));
575 result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
576 result.amount = htonl (amount);
577 result.peer = msg->peer;
578 result.res_delay = GNUNET_TIME_relative_hton (res_delay);
579 GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
581 GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
583 GNUNET_SERVER_receive_done (client, GNUNET_OK);
588 * Handle 'preference change' messages from clients.
590 * @param cls unused, NULL
591 * @param client client that sent the request
592 * @param message the request message
595 GAS_handle_preference_change (void *cls,
596 struct GNUNET_SERVER_Client *client,
597 const struct GNUNET_MessageHeader *message)
599 const struct ChangePreferenceMessage *msg;
600 const struct PreferenceInformation *pi;
605 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
606 "PREFERENCE_CHANGE");
607 msize = ntohs (message->size);
608 if (msize < sizeof (struct ChangePreferenceMessage))
611 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
614 msg = (const struct ChangePreferenceMessage *) message;
615 nump = ntohl (msg->num_preferences);
617 sizeof (struct ChangePreferenceMessage) +
618 nump * sizeof (struct PreferenceInformation))
621 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
624 GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
626 pi = (const struct PreferenceInformation *) &msg[1];
627 for (i = 0; i < nump; i++)
628 GAS_addresses_change_preference (GSA_addresses,
631 (enum GNUNET_ATS_PreferenceKind)
632 ntohl (pi[i].preference_kind),
633 pi[i].preference_value);
634 GNUNET_SERVER_receive_done (client, GNUNET_OK);
639 * Initialize performance subsystem.
641 * @param server handle to our server
642 * @param addresses the address handle to use
645 GAS_performance_init (struct GNUNET_SERVER_Handle *server,
646 struct GAS_Addresses_Handle *addresses)
648 GSA_addresses = addresses;
649 nc = GNUNET_SERVER_notification_context_create (server, 128);
654 * Shutdown performance subsystem.
657 GAS_performance_done ()
659 GNUNET_SERVER_notification_context_destroy (nc);
663 /* end of gnunet-service-ats_performance.c */