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;
128 pc = find_client (client);
131 GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
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;
228 for (pc = pc_head; pc != NULL; pc = pc->next)
229 if (pc->flag == START_FLAG_PERFORMANCE_WITH_PIC)
231 GAS_performance_notify_client (pc,
233 plugin_name, plugin_addr, plugin_addr_len,
236 bandwidth_out, bandwidth_in);
238 GNUNET_STATISTICS_update (GSA_stats,
239 "# performance updates given to clients", 1,
245 peerinfo_it (void *cls,
246 const struct GNUNET_PeerIdentity *id,
247 const char *plugin_name,
248 const void *plugin_addr, size_t plugin_addr_len,
250 const struct GNUNET_ATS_Information *atsi,
252 struct GNUNET_BANDWIDTH_Value32NBO
254 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
256 struct PerformanceClient *pc = cls;
257 GNUNET_assert (NULL != pc);
261 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
262 "Callback for peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
265 ntohl (bandwidth_out.value__),
266 ntohl (bandwidth_in.value__));
267 GAS_performance_notify_client(pc,
274 bandwidth_out, bandwidth_in);
279 * Iterator for GAS_performance_add_client
281 * @param cls the client requesting information
286 const struct GNUNET_PeerIdentity *id)
288 struct PerformanceClient *pc = cls;
291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
292 GAS_addresses_get_peer_info (GSA_addresses, id, &peerinfo_it, pc);
297 * Register a new performance client.
299 * @param client handle of the new client
300 * @param flag flag specifying the type of the client
303 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
306 struct PerformanceClient *pc;
307 GNUNET_break (NULL == find_client (client));
309 pc = GNUNET_malloc (sizeof (struct PerformanceClient));
313 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding performance client %s PIC\n",
314 (flag == START_FLAG_PERFORMANCE_WITH_PIC) ? "with" : "without");
316 GNUNET_SERVER_notification_context_add (nc, client);
317 GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
319 /* Send information about clients */
320 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)
336 struct GNUNET_ATS_Information *atsp;
337 struct PeerInformationMessage *msg;
339 size_t plugin_name_length;
342 if (NULL != plugin_name)
343 plugin_name_length = strlen (plugin_name) + 1;
345 plugin_name_length = 0;
346 msize = sizeof (struct PeerInformationMessage) +
347 atsi_count * sizeof (struct GNUNET_ATS_Information) +
348 plugin_addr_len + plugin_name_length;
349 char buf[msize] GNUNET_ALIGN;
351 GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
352 GNUNET_assert (atsi_count <
353 GNUNET_SERVER_MAX_MESSAGE_SIZE /
354 sizeof (struct GNUNET_ATS_Information));
355 msg = (struct PeerInformationMessage *) buf;
356 msg->header.size = htons (msize);
357 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE);
358 msg->ats_count = htonl (atsi_count);
359 msg->id = htonl (ai->id);
363 memset (&msg->peer, '\0', sizeof (struct GNUNET_PeerIdentity));
364 msg->address_length = htons (plugin_addr_len);
365 msg->address_active = ntohl (active);
366 msg->plugin_name_length = htons (plugin_name_length);
367 msg->bandwidth_out = bandwidth_out;
368 msg->bandwidth_in = bandwidth_in;
369 atsp = (struct GNUNET_ATS_Information *) &msg[1];
370 memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
371 addrp = (char *) &atsp[atsi_count];
372 if (NULL != plugin_addr)
373 memcpy (addrp, plugin_addr, plugin_addr_len);
374 if (NULL != plugin_name)
375 strcpy (&addrp[plugin_addr_len], plugin_name);
376 GNUNET_SERVER_notification_context_unicast (nc, ai->pc->client, &msg->header,
381 req_addr_peerinfo_it (void *cls,
382 const struct GNUNET_PeerIdentity *id,
383 const char *plugin_name,
384 const void *plugin_addr, size_t plugin_addr_len,
386 const struct GNUNET_ATS_Information *atsi,
388 struct GNUNET_BANDWIDTH_Value32NBO
390 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
392 struct AddressIteration *ai = cls;
394 GNUNET_assert (NULL != ai);
395 GNUNET_assert (NULL != ai->pc);
396 if (NULL == find_client (ai->pc->client))
397 return; /* Client disconnected */
399 if ((NULL == id) && (NULL == plugin_name) && (NULL == plugin_addr))
401 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
402 "Address iteration done\n");
405 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
406 "Callback for %s peer `%s' plugin `%s' BW out %u, BW in %u \n",
407 (active == GNUNET_YES) ? "ACTIVE" : "INACTIVE",
410 (unsigned int) ntohl (bandwidth_out.value__),
411 (unsigned int) ntohl (bandwidth_in.value__));
413 /* Transmit result */
414 if ((GNUNET_YES == ai->all) || (GNUNET_YES == active))
416 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
417 "Sending result for %s peer `%s' plugin `%s' BW out %u, BW in %u \n",
418 (active == GNUNET_YES) ? "ACTIVE" : "INACTIVE",
421 (unsigned int) ntohl (bandwidth_out.value__),
422 (unsigned int) ntohl (bandwidth_in.value__));
423 transmit_req_addr (cls,
426 plugin_addr, plugin_addr_len,
430 bandwidth_out, bandwidth_in);
436 * Iterator for GAS_handle_request_address_list
438 * @param cls the client requesting information
442 req_addr_peer_it (void *cls,
443 const struct GNUNET_PeerIdentity *id)
445 struct AddressIteration *ai = cls;
448 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
449 GAS_addresses_get_peer_info (GSA_addresses, id, &req_addr_peerinfo_it, ai);
453 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 const char *plugin_name,
509 const void *plugin_addr,
510 size_t plugin_addr_len,
512 struct GNUNET_ATS_Information *ats,
514 struct GNUNET_BANDWIDTH_Value32NBO
516 struct GNUNET_BANDWIDTH_Value32NBO
520 GAS_performance_notify_all_clients (peer,
522 plugin_addr, plugin_addr_len,
525 bandwidth_out, bandwidth_in);
528 struct PerformanceClient *cur;
529 struct PerformanceMonitorClient *curm;
530 struct MonitorResponseMessage *mrm;
533 msglen = sizeof (struct MonitorResponseMessage) +
534 ats_count * sizeof (struct GNUNET_ATS_Information);
535 mrm = GNUNET_malloc (msglen);
537 mrm->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_MONITOR_RESPONSE);
538 mrm->header.size = htons (msglen);
539 mrm->ats_count = htonl (ats_count);
541 memcpy (&mrm[1], ats, ats_count * sizeof (struct GNUNET_ATS_Information));
543 for (cur = pc_head; NULL != cur; cur = cur->next)
544 for (curm = cur->pm_head; NULL != curm; curm = curm->next)
546 /* Notify client about update */
547 mrm->id = htonl (curm->id);
548 GNUNET_SERVER_notification_context_unicast (nc,
550 (struct GNUNET_MessageHeader *) mrm,
559 * Handle 'reservation request' messages from clients.
561 * @param cls unused, NULL
562 * @param client client that sent the request
563 * @param message the request message
566 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
567 const struct GNUNET_MessageHeader *message)
569 const struct ReservationRequestMessage *msg =
570 (const struct ReservationRequestMessage *) message;
571 struct ReservationResultMessage result;
573 struct GNUNET_TIME_Relative res_delay;
575 if (NULL == find_client (client))
577 /* missing start message! */
579 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
582 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
583 "RESERVATION_REQUEST");
584 amount = (int32_t) ntohl (msg->amount);
585 res_delay = GAS_reservations_reserve (&msg->peer, amount);
586 if (res_delay.rel_value_us > 0)
588 result.header.size = htons (sizeof (struct ReservationResultMessage));
589 result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
590 result.amount = htonl (amount);
591 result.peer = msg->peer;
592 result.res_delay = GNUNET_TIME_relative_hton (res_delay);
593 GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
595 GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
597 GNUNET_SERVER_receive_done (client, GNUNET_OK);
602 * Handle 'preference change' messages from clients.
604 * @param cls unused, NULL
605 * @param client client that sent the request
606 * @param message the request message
609 GAS_handle_preference_change (void *cls,
610 struct GNUNET_SERVER_Client *client,
611 const struct GNUNET_MessageHeader *message)
613 const struct ChangePreferenceMessage *msg;
614 const struct PreferenceInformation *pi;
619 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
620 "PREFERENCE_CHANGE");
621 msize = ntohs (message->size);
622 if (msize < sizeof (struct ChangePreferenceMessage))
625 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
628 msg = (const struct ChangePreferenceMessage *) message;
629 nump = ntohl (msg->num_preferences);
631 sizeof (struct ChangePreferenceMessage) +
632 nump * sizeof (struct PreferenceInformation))
635 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
638 GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
640 pi = (const struct PreferenceInformation *) &msg[1];
641 for (i = 0; i < nump; i++)
642 GAS_addresses_change_preference (GSA_addresses,
645 (enum GNUNET_ATS_PreferenceKind)
646 ntohl (pi[i].preference_kind),
647 pi[i].preference_value);
648 GNUNET_SERVER_receive_done (client, GNUNET_OK);
653 * Handle 'preference feedback' messages from clients.
655 * @param cls unused, NULL
656 * @param client client that sent the request
657 * @param message the request message
660 GAS_handle_preference_feedback (void *cls,
661 struct GNUNET_SERVER_Client *client,
662 const struct GNUNET_MessageHeader *message)
664 const struct FeedbackPreferenceMessage *msg;
665 const struct PreferenceInformation *pi;
670 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
671 "PREFERENCE_FEEDBACK");
672 msize = ntohs (message->size);
673 if (msize < sizeof (struct FeedbackPreferenceMessage))
676 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
679 msg = (const struct FeedbackPreferenceMessage *) message;
680 nump = ntohl (msg->num_feedback);
682 sizeof (struct FeedbackPreferenceMessage) +
683 nump * sizeof (struct PreferenceInformation))
686 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
689 GNUNET_STATISTICS_update (GSA_stats, "# preference feedbacks requests processed",
691 pi = (const struct PreferenceInformation *) &msg[1];
692 for (i = 0; i < nump; i++)
693 GAS_addresses_preference_feedback (GSA_addresses,
696 GNUNET_TIME_relative_ntoh(msg->scope),
697 (enum GNUNET_ATS_PreferenceKind)
698 ntohl (pi[i].preference_kind),
699 pi[i].preference_value);
700 GNUNET_SERVER_receive_done (client, GNUNET_OK);
706 * Initialize performance subsystem.
708 * @param server handle to our server
709 * @param addresses the address handle to use
712 GAS_performance_init (struct GNUNET_SERVER_Handle *server,
713 struct GAS_Addresses_Handle *addresses)
715 GSA_addresses = addresses;
716 nc = GNUNET_SERVER_notification_context_create (server, 128);
721 * Shutdown performance subsystem.
724 GAS_performance_done ()
726 GNUNET_SERVER_notification_context_destroy (nc);
730 /* end of gnunet-service-ats_performance.c */