2 This file is part of GNUnet.
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 rps/gnunet-service-rps.c
23 * @brief rps service implementation
24 * @author Julius Bünger
27 #include "gnunet_util_lib.h"
28 #include "gnunet_cadet_service.h"
29 #include "gnunet_nse_service.h"
32 #include "gnunet-service-rps_sampler.h"
37 #define LOG(kind, ...) GNUNET_log(kind, __VA_ARGS__)
39 // TODO modify @brief in every file
41 // TODO take care that messages are not longer than 64k
43 // TODO check for overflows
45 // TODO align message structs
47 // (TODO api -- possibility of getting weak random peer immideately)
49 // TODO malicious peer
51 // TODO Change API to accept initialisation peers
53 // TODO Change API to accept good peers 'friends'
55 // TODO store peers somewhere
57 // TODO check that every id we get is valid - is it reachable?
61 // hist_size_init, hist_size_max
66 static const struct GNUNET_CONFIGURATION_Handle *cfg;
71 static struct GNUNET_PeerIdentity *own_identity;
74 * Closure to the callback cadet calls on each peer it passes to us
79 * The server handle to later listen to client requests
81 struct GNUNET_SERVER_Handle *server;
84 * Counts how many peers cadet already passed to us
90 struct GNUNET_PeerIdentity *
91 get_rand_peer (const struct GNUNET_PeerIdentity *peer_list, unsigned int size);
94 /***********************************************************************
95 * Housekeeping with peers
96 ***********************************************************************/
99 * Struct used to store the context of a connected client.
104 * The message queue to communicate with the client.
106 struct GNUNET_MQ_Handle *mq;
110 * Used to keep track in what lists single peerIDs are.
112 enum in_list_flag // probably unneeded
114 in_other_sampler_list = 0x1,
115 in_other_gossip_list = 0x2, // unneeded?
116 in_own_sampler_list = 0x4,
117 in_own_gossip_list = 0x8 // unneeded?
121 * Struct used to keep track of other peer's status
123 * This is stored in a multipeermap.
128 * In own gossip/sampler list, in other's gossip/sampler list
130 uint32_t in_flags; // unneeded?
133 * Message queue open to client
135 struct GNUNET_MQ_Handle *mq;
138 * Channel open to client.
140 struct GNUNET_CADET_Channel *to_channel;
143 * Channel open from client.
145 struct GNUNET_CADET_Channel *from_channel; // unneeded
148 * This is pobably followed by 'statistical' data (when we first saw
149 * him, how did we get his ID, how many pushes (in a timeinterval),
154 /***********************************************************************
155 * /Housekeeping with peers
156 ***********************************************************************/
158 /***********************************************************************
160 ***********************************************************************/
163 * Set of all peers to keep track of them.
165 static struct GNUNET_CONTAINER_MultiPeerMap *peer_map;
169 * The gossiped list of peers.
171 static struct GNUNET_PeerIdentity *gossip_list;
174 * Size of the gossiped list
176 //static unsigned int gossip_list_size;
177 static uint32_t gossip_list_size;
181 * The actual size of the sampler
183 static unsigned int sampler_size;
184 //size_t sampler_size;
187 * The size of sampler we need to be able to satisfy the client's need of
190 static unsigned int sampler_size_client_need;
193 * The size of sampler we need to be able to satisfy the Brahms protocol's
194 * need of random peers.
196 * This is directly taken as the #gossip_list_size on update of the
199 * This is one minimum size the sampler grows to.
201 static unsigned int sampler_size_est_need;
205 * Percentage of total peer number in the gossip list
206 * to send random PUSHes to
208 * TODO do not read from configuration
213 * Percentage of total peer number in the gossip list
214 * to send random PULLs to
216 * TODO do not read from configuration
221 * The percentage gamma of history updates.
222 * Simply 1 - alpha - beta
227 * Identifier for the main task that runs periodically.
229 static struct GNUNET_SCHEDULER_Task *do_round_task;
232 * Time inverval the do_round task runs in.
234 static struct GNUNET_TIME_Relative round_interval;
239 * List to store peers received through pushes temporary.
241 * TODO -> multipeermap
243 static struct GNUNET_PeerIdentity *push_list;
246 * Size of the push_list;
248 static unsigned int push_list_size;
249 //size_t push_list_size;
252 * List to store peers received through pulls temporary.
254 * TODO -> multipeermap
256 static struct GNUNET_PeerIdentity *pull_list;
259 * Size of the pull_list;
261 static unsigned int pull_list_size;
262 //size_t pull_list_size;
268 static struct GNUNET_NSE_Handle *nse;
273 static struct GNUNET_CADET_Handle *cadet_handle;
279 * Only needed in the beginning to check how many of the 64 deltas
282 static unsigned int req_counter;
285 * Time of the last request we received.
287 * Used to compute the expected request rate.
289 static struct GNUNET_TIME_Absolute last_request;
292 * Size of #request_deltas.
294 #define REQUEST_DELTAS_SIZE 64
295 static unsigned int request_deltas_size = REQUEST_DELTAS_SIZE;
298 * Last 64 deltas between requests
300 static struct GNUNET_TIME_Relative request_deltas[REQUEST_DELTAS_SIZE];
303 * The prediction of the rate of requests
305 static struct GNUNET_TIME_Relative request_rate;
308 /***********************************************************************
310 ***********************************************************************/
313 /***********************************************************************
315 ***********************************************************************/
318 * Check if peer is already in peer array.
321 in_arr (const struct GNUNET_PeerIdentity *array,
322 unsigned int arr_size,
323 const struct GNUNET_PeerIdentity *peer)
325 GNUNET_assert (NULL != peer);
330 GNUNET_assert (NULL != array);
335 while (0 != GNUNET_CRYPTO_cmp_peer_identity (&array[i], peer) &&
347 * Get random peer from the gossip list.
349 struct GNUNET_PeerIdentity *
350 get_rand_peer (const struct GNUNET_PeerIdentity *peer_list, unsigned int list_size)
353 struct GNUNET_PeerIdentity *peer;
355 peer = GNUNET_new (struct GNUNET_PeerIdentity);
356 // FIXME if we have only NULL in gossip list this will block
357 // but then we might have a problem nevertheless
363 * Choose the r_index of the peer we want to return
364 * at random from the interval of the gossip list
366 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
369 *peer = peer_list[r_index];
370 } while (NULL == peer);
377 * Get the context of a peer. If not existing, create.
380 get_peer_ctx (struct GNUNET_CONTAINER_MultiPeerMap *peer_map, const struct GNUNET_PeerIdentity *peer)
382 struct PeerContext *ctx;
384 if ( GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
386 ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
390 ctx = GNUNET_new (struct PeerContext);
393 ctx->to_channel = NULL;
394 ctx->from_channel = NULL;
395 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
402 * Get the channel of a peer. If not existing, create.
404 struct GNUNET_CADET_Channel *
405 get_channel (struct GNUNET_CONTAINER_MultiPeerMap *peer_map, const struct GNUNET_PeerIdentity *peer)
407 struct PeerContext *ctx;
409 ctx = get_peer_ctx (peer_map, peer);
410 if (NULL == ctx->to_channel)
412 ctx->to_channel = GNUNET_CADET_channel_create (cadet_handle, NULL, peer,
413 GNUNET_RPS_CADET_PORT,
414 GNUNET_CADET_OPTION_RELIABLE);
415 // do I have to explicitly put it in the peer_map?
416 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
417 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
419 return ctx->to_channel;
424 * Get the message queue of a specific peer.
426 * If we already have a message queue open to this client,
427 * simply return it, otherways create one.
429 struct GNUNET_MQ_Handle *
430 get_mq (struct GNUNET_CONTAINER_MultiPeerMap *peer_map, const struct GNUNET_PeerIdentity *peer_id)
432 struct PeerContext *ctx;
434 ctx = get_peer_ctx (peer_map, peer_id);
437 (void) get_channel (peer_map, peer_id);
438 ctx->mq = GNUNET_CADET_mq_create (ctx->to_channel);
439 //do I have to explicitly put it in the peer_map?
440 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer_id, ctx,
441 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
448 * Sum all time relatives of an array.
450 struct GNUNET_TIME_Relative
451 T_relative_sum (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
453 struct GNUNET_TIME_Relative sum;
456 sum = GNUNET_TIME_UNIT_ZERO;
457 for ( i = 0 ; i < arr_size ; i++ )
459 sum = GNUNET_TIME_relative_add (sum, rel_array[i]);
466 * Compute the average of given time relatives.
468 struct GNUNET_TIME_Relative
469 T_relative_avg (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
471 return GNUNET_TIME_relative_divide (T_relative_sum (rel_array, arr_size), arr_size); // FIXME find a way to devide that by arr_size
475 /***********************************************************************
477 ***********************************************************************/
480 * Wrapper around _sampler_resize()
485 uint32_t bigger_size;
489 if (sampler_size_est_need > sampler_size_client_need)
490 bigger_size = sampler_size_client_need;
492 bigger_size = sampler_size_est_need;
494 // TODO respect the request rate, min, max
495 if (sampler_size > bigger_size*4)
497 RPS_sampler_resize (sampler_size/2);
499 else if (sampler_size < bigger_size)
501 RPS_sampler_resize (sampler_size*2);
507 * Function called by NSE.
509 * Updates sizes of sampler list and gossip list and adapt those lists
513 nse_callback (void *cls, struct GNUNET_TIME_Absolute timestamp, double logestimate, double std_dev)
516 //double scale; // TODO this might go gloabal/config
518 LOG (GNUNET_ERROR_TYPE_DEBUG,
519 "Received a ns estimate - logest: %f, std_dev: %f (old_size: %f)\n",
520 logestimate, std_dev, sampler_size);
522 estimate = GNUNET_NSE_log_estimate_to_n (logestimate);
523 // GNUNET_NSE_log_estimate_to_n (logestimate);
524 estimate = pow (estimate, 1./3);
525 // TODO add if std_dev is a number
526 // estimate += (std_dev * scale);
527 if ( 0 < estimate ) {
528 LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing estimate to %f\n", estimate);
529 sampler_size_est_need = estimate;
531 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not using estimate %f\n", estimate);
533 /* If the NSE has changed adapt the lists accordingly */
539 * Callback called once the requested PeerIDs are ready.
541 * Sends those to the requesting client.
543 void client_respond (void *cls,
544 struct GNUNET_PeerIdentity *ids, uint32_t num_peers)
546 LOG (GNUNET_ERROR_TYPE_DEBUG, "sampler returned %" PRIX32 " peers\n", num_peers);
547 struct GNUNET_MQ_Envelope *ev;
548 struct GNUNET_RPS_CS_ReplyMessage *out_msg;
549 struct GNUNET_SERVER_Client *client;
550 struct client_ctx *cli_ctx;
552 client = (struct GNUNET_SERVER_Client *) cls;
554 ev = GNUNET_MQ_msg_extra (out_msg,
555 num_peers * sizeof (struct GNUNET_PeerIdentity),
556 GNUNET_MESSAGE_TYPE_RPS_CS_REPLY);
557 out_msg->num_peers = htonl (num_peers);
561 num_peers * sizeof (struct GNUNET_PeerIdentity));
564 cli_ctx = GNUNET_SERVER_client_get_user_context (client, struct client_ctx);
565 if ( NULL == cli_ctx ) {
566 cli_ctx = GNUNET_new (struct client_ctx);
567 cli_ctx->mq = GNUNET_MQ_queue_for_server_client (client);
568 GNUNET_SERVER_client_set_user_context (client, cli_ctx);
571 GNUNET_MQ_send (cli_ctx->mq, ev);
576 * Handle RPS request from the client.
579 * @param client identification of the client
580 * @param message the actual message
583 handle_client_request (void *cls,
584 struct GNUNET_SERVER_Client *client,
585 const struct GNUNET_MessageHeader *message)
587 struct GNUNET_RPS_CS_RequestMessage *msg;
589 struct GNUNET_TIME_Relative max_round_duration;
592 /* Estimate request rate */
593 if (request_deltas_size > req_counter)
595 if ( 1 < req_counter)
597 /* Shift last request deltas to the right */
598 memcpy (&request_deltas[1],
600 (req_counter - 1) * sizeof (struct GNUNET_TIME_Relative));
601 /* Add current delta to beginning */
602 request_deltas[0] = GNUNET_TIME_absolute_get_difference (last_request,
603 GNUNET_TIME_absolute_get ());
604 request_rate = T_relative_avg (request_deltas, req_counter);
606 max_round_duration = GNUNET_TIME_relative_add (round_interval,
607 GNUNET_TIME_relative_divide (round_interval, 2));
608 sampler_size_client_need = max_round_duration.rel_value_us / request_rate.rel_value_us;
612 last_request = GNUNET_TIME_absolute_get ();
615 // TODO check message size
616 msg = (struct GNUNET_RPS_CS_RequestMessage *) message;
618 num_peers = ntohl (msg->num_peers);
620 LOG (GNUNET_ERROR_TYPE_DEBUG, "Client requested %" PRIX32 " random peer(s).\n", num_peers);
622 RPS_sampler_get_n_rand_peers (client_respond, client, num_peers);
624 GNUNET_SERVER_receive_done (client,
630 * Handle seed from the client.
633 * @param client identification of the client
634 * @param message the actual message
637 handle_client_seed (void *cls,
638 struct GNUNET_SERVER_Client *client,
639 const struct GNUNET_MessageHeader *message)
641 struct GNUNET_RPS_CS_SeedMessage *in_msg;
642 struct GNUNET_PeerIdentity *peers;
645 if (sizeof (struct GNUNET_RPS_CS_SeedMessage) < ntohs (message->size))
648 GNUNET_SERVER_receive_done (client,
651 in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
652 if (ntohs (message->size) - sizeof (struct GNUNET_RPS_CS_SeedMessage) /
653 sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
656 GNUNET_SERVER_receive_done (client,
660 in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
661 peers = (struct GNUNET_PeerIdentity *) &message[1];
663 for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
664 RPS_sampler_update_list (&peers[i]);
666 GNUNET_SERVER_receive_done (client,
672 * Handle a PUSH message from another peer.
674 * Check the proof of work and store the PeerID
675 * in the temporary list for pushed PeerIDs.
678 * @param channel The channel the PUSH was received over
679 * @param channel_ctx The context associated with this channel
680 * @param msg The message header
683 handle_peer_push (void *cls,
684 struct GNUNET_CADET_Channel *channel,
686 const struct GNUNET_MessageHeader *msg)
688 const struct GNUNET_PeerIdentity *peer;
690 // (check the proof of work)
692 peer = (const struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
693 // FIXME wait for cadet to change this function
694 LOG (GNUNET_ERROR_TYPE_DEBUG, "PUSH received (%s)\n", GNUNET_i2s (peer));
696 /* Add the sending peer to the push_list */
697 if (GNUNET_NO == in_arr (push_list, pull_list_size, peer))
698 GNUNET_array_append (push_list, push_list_size, *peer);
704 * Handle PULL REQUEST request message from another peer.
706 * Reply with the gossip list of PeerIDs.
709 * @param channel The channel the PUSH was received over
710 * @param channel_ctx The context associated with this channel
711 * @param msg The message header
714 handle_peer_pull_request (void *cls,
715 struct GNUNET_CADET_Channel *channel,
717 const struct GNUNET_MessageHeader *msg)
719 struct GNUNET_PeerIdentity *peer;
720 struct GNUNET_MQ_Handle *mq;
721 struct GNUNET_MQ_Envelope *ev;
722 struct GNUNET_RPS_P2P_PullReplyMessage *out_msg;
725 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
726 // FIXME wait for cadet to change this function
727 LOG (GNUNET_ERROR_TYPE_DEBUG,
728 "PULL REQUEST from peer %s received, going to send %u peers\n",
729 GNUNET_i2s (peer), gossip_list_size);
731 mq = get_mq (peer_map, peer);
733 ev = GNUNET_MQ_msg_extra (out_msg,
734 gossip_list_size * sizeof (struct GNUNET_PeerIdentity),
735 GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY);
736 //out_msg->num_peers = htonl (gossip_list_size);
737 out_msg->num_peers = htonl (gossip_list_size);
738 memcpy (&out_msg[1], gossip_list,
739 gossip_list_size * sizeof (struct GNUNET_PeerIdentity));
741 GNUNET_MQ_send (mq, ev);
747 * Handle PULL REPLY message from another peer.
749 * Check whether we sent a corresponding request and
750 * whether this reply is the first one.
753 * @param channel The channel the PUSH was received over
754 * @param channel_ctx The context associated with this channel
755 * @param msg The message header
758 handle_peer_pull_reply (void *cls,
759 struct GNUNET_CADET_Channel *channel,
761 const struct GNUNET_MessageHeader *msg)
763 LOG (GNUNET_ERROR_TYPE_DEBUG, "PULL REPLY received\n");
765 struct GNUNET_RPS_P2P_PullReplyMessage *in_msg;
766 struct GNUNET_PeerIdentity *peers;
769 if (sizeof (struct GNUNET_RPS_P2P_PullReplyMessage) > ntohs (msg->size))
771 GNUNET_break_op (0); // At the moment our own implementation seems to break that.
772 return GNUNET_SYSERR;
774 in_msg = (struct GNUNET_RPS_P2P_PullReplyMessage *) msg;
775 if ((ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
777 LOG (GNUNET_ERROR_TYPE_ERROR, "message says it sends %" PRIu64 " peers, have space for %i peers\n",
778 ntohl (in_msg->num_peers),
779 (ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity));
781 return GNUNET_SYSERR;
784 // TODO check that we sent a request and that it is the first reply
786 peers = (struct GNUNET_PeerIdentity *) &msg[1];
787 for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
789 if (GNUNET_NO == in_arr (pull_list, pull_list_size, &peers[i]))
790 GNUNET_array_append (pull_list, pull_list_size, peers[i]);
793 // TODO check that id is valid - whether it is reachable
800 * Send out PUSHes and PULLs.
802 * This is executed regylary.
805 do_round (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
807 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to execute next round\n");
810 //unsigned int *n_arr;
811 unsigned int n_peers; /* Number of peers we send pushes/pulls to */
812 struct GNUNET_MQ_Envelope *ev;
813 const struct GNUNET_PeerIdentity *peer;
814 struct GNUNET_MQ_Handle *mq;
816 // TODO log lists, ...
819 /* Would it make sense to have one shuffeled gossip list and then
820 * to send PUSHes to first alpha peers, PULL requests to next beta peers and
821 * use the rest to update sampler?
822 * in essence get random peers with consumption */
825 //n_arr = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) gossip_list_size);
826 n_peers = round (alpha * gossip_list_size);
829 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pushes to %u (%f * %u) peers.\n",
830 n_peers, alpha, gossip_list_size);
831 for ( i = 0 ; i < n_peers ; i++ )
833 peer = get_rand_peer (gossip_list, gossip_list_size);
834 if (own_identity != peer)
835 { // FIXME if this fails schedule/loop this for later
836 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PUSH to peer %s of gossiped list.\n", GNUNET_i2s (peer));
838 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PUSH);
839 // FIXME sometimes it returns a pointer to a freed mq
840 mq = get_mq (peer_map, peer);
841 GNUNET_MQ_send (mq, ev);
846 /* Send PULL requests */
847 //n_arr = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list->size);
848 n_peers = round (beta * gossip_list_size);
851 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pulls to %u (%f * %u) peers.\n",
852 n_peers, beta, gossip_list_size);
853 for ( i = 0 ; i < n_peers ; i++ )
855 peer = get_rand_peer (gossip_list, gossip_list_size);
856 if (own_identity != peer)
857 { // FIXME if this fails schedule/loop this for later
858 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PULL request to peer %s of gossiped list.\n", GNUNET_i2s (peer));
860 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST);
862 mq = get_mq (peer_map, peer);
863 GNUNET_MQ_send (mq, ev);
868 /* Update gossip list */
871 if ( push_list_size <= alpha * gossip_list_size &&
872 push_list_size != 0 &&
873 pull_list_size != 0 )
875 LOG (GNUNET_ERROR_TYPE_DEBUG, "Update of the gossip list. ()\n");
877 uint32_t first_border;
878 uint32_t second_border;
880 GNUNET_array_grow (gossip_list, gossip_list_size, sampler_size_est_need);
882 first_border = round (alpha * gossip_list_size);
883 for ( i = 0 ; i < first_border ; i++ )
884 { // TODO use RPS_sampler_get_n_rand_peers
885 /* Update gossip list with peers received through PUSHes */
886 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
888 gossip_list[i] = push_list[r_index];
889 // TODO change the in_flags accordingly
892 second_border = first_border + round (beta * gossip_list_size);
893 for ( i = first_border ; i < second_border ; i++ )
895 /* Update gossip list with peers received through PULLs */
896 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
898 gossip_list[i] = pull_list[r_index];
899 // TODO change the in_flags accordingly
902 for ( i = second_border ; i < gossip_list_size ; i++ )
904 /* Update gossip list with peers from history */
905 peer = RPS_sampler_get_n_rand_peers_ (1);
906 gossip_list[i] = *peer;
907 // TODO change the in_flags accordingly
913 LOG (GNUNET_ERROR_TYPE_DEBUG, "No update of the gossip list. ()\n");
915 // TODO independent of that also get some peers from CADET_get_peers()?
918 /* Update samplers */
920 for ( i = 0 ; i < push_list_size ; i++ )
922 RPS_sampler_update_list (&push_list[i]);
926 for ( i = 0 ; i < pull_list_size ; i++ )
928 RPS_sampler_update_list (&pull_list[i]);
933 /* Empty push/pull lists */
934 GNUNET_array_grow (push_list, push_list_size, 0);
935 GNUNET_array_grow (pull_list, pull_list_size, 0);
937 struct GNUNET_TIME_Relative time_next_round;
938 struct GNUNET_TIME_Relative half_round_interval;
939 unsigned int rand_delay;
941 /* Compute random time value between .5 * round_interval and 1.5 *round_interval */
942 half_round_interval = GNUNET_TIME_relative_divide (round_interval, 2);
946 * Compute random value between (0 and 1) * round_interval
947 * via multiplying round_interval with a 'fraction' (0 to value)/value
949 rand_delay = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT_MAX/10);
950 time_next_round = GNUNET_TIME_relative_multiply (round_interval, rand_delay);
951 time_next_round = GNUNET_TIME_relative_divide (time_next_round, UINT_MAX/10);
952 time_next_round = GNUNET_TIME_relative_add (time_next_round, half_round_interval);
953 } while (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == time_next_round.rel_value_us);
955 /* Schedule next round */
956 do_round_task = GNUNET_SCHEDULER_add_delayed (round_interval, &do_round, NULL);
957 LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished round\n");
962 * Open a connection to given peer and store channel and mq.
965 insertCB (void *cls, const struct GNUNET_PeerIdentity *id)
967 // We open a channel to be notified when this peer goes down.
968 (void) get_channel (peer_map, id);
973 * Close the connection to given peer and delete channel and mq.
976 removeCB (void *cls, const struct GNUNET_PeerIdentity *id)
979 struct PeerContext *ctx;
981 s = RPS_sampler_count_id (id);
984 if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, id))
986 ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, id);
987 if (NULL != ctx->to_channel)
991 GNUNET_MQ_destroy (ctx->mq);
993 // may already be freed at shutdown of cadet
994 //GNUNET_CADET_channel_destroy (ctx->to_channel);
997 (void) GNUNET_CONTAINER_multipeermap_remove_all (peer_map, id);
1003 rps_start (struct GNUNET_SERVER_Handle *server);
1006 * This is called from GNUNET_CADET_get_peers().
1008 * It is called on every peer(ID) that cadet somehow has contact with.
1009 * We use those to initialise the sampler.
1012 init_peer_cb (void *cls,
1013 const struct GNUNET_PeerIdentity *peer,
1014 int tunnel, // "Do we have a tunnel towards this peer?"
1015 unsigned int n_paths, // "Number of known paths towards this peer"
1016 unsigned int best_path) // "How long is the best path?
1017 // (0 = unknown, 1 = ourselves, 2 = neighbor)"
1019 struct init_peer_cls *ipc;
1021 ipc = (struct init_peer_cls *) cls;
1024 LOG (GNUNET_ERROR_TYPE_DEBUG,
1025 "Got %" PRIX32 ". peer %s (at %p) from CADET (gossip_list_size: %u)\n",
1026 ipc->i, GNUNET_i2s (peer), peer, gossip_list_size);
1027 RPS_sampler_update_list (peer);
1028 (void) get_peer_ctx (peer_map, peer); // unneeded? -> insertCB
1030 if (ipc->i < gossip_list_size)
1032 gossip_list[ipc->i] = *peer; // FIXME sometimes we're writing to invalid space here
1033 // not sure whether fixed
1037 // send push/pull to each of those peers?
1041 if (ipc->i < gossip_list_size)
1043 memcpy (&gossip_list[ipc->i],
1044 RPS_sampler_get_n_rand_peers_ (1),
1045 (gossip_list_size - ipc->i) * sizeof (struct GNUNET_PeerIdentity));
1047 rps_start (ipc->server);
1054 * Callback used to clean the multipeermap.
1057 peer_remove_cb (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
1059 struct PeerContext *peer_ctx;
1061 peer_ctx = (struct PeerContext *) value;
1063 if ( NULL != peer_ctx->mq)
1064 GNUNET_MQ_destroy (peer_ctx->mq);
1066 if ( NULL != peer_ctx->to_channel)
1067 GNUNET_CADET_channel_destroy (peer_ctx->to_channel);
1069 if ( NULL != peer_ctx->from_channel)
1070 GNUNET_CADET_channel_destroy (peer_ctx->from_channel);
1072 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_remove_all (peer_map, key))
1073 LOG (GNUNET_ERROR_TYPE_WARNING, "removing peer from peer_map failed\n");
1080 * Task run during shutdown.
1086 shutdown_task (void *cls,
1087 const struct GNUNET_SCHEDULER_TaskContext *tc)
1089 LOG (GNUNET_ERROR_TYPE_DEBUG, "RPS is going down\n");
1091 if ( NULL != do_round_task )
1093 GNUNET_SCHEDULER_cancel (do_round_task);
1094 do_round_task = NULL;
1098 if (GNUNET_SYSERR == GNUNET_CONTAINER_multipeermap_iterate (peer_map, peer_remove_cb, NULL))
1099 LOG (GNUNET_ERROR_TYPE_WARNING,
1100 "Iterating over peers to disconnect from them was cancelled\n");
1102 GNUNET_CONTAINER_multipeermap_destroy (peer_map);
1104 GNUNET_NSE_disconnect (nse);
1105 GNUNET_CADET_disconnect (cadet_handle);
1106 GNUNET_free (own_identity);
1107 RPS_sampler_destroy ();
1108 GNUNET_array_grow (request_deltas, request_deltas_size, 0);
1109 GNUNET_array_grow (gossip_list, gossip_list_size, 0);
1110 GNUNET_array_grow (push_list, push_list_size, 0);
1111 GNUNET_array_grow (pull_list, pull_list_size, 0);
1116 * A client disconnected. Remove all of its data structure entries.
1118 * @param cls closure, NULL
1119 * @param client identification of the client
1122 handle_client_disconnect (void *cls,
1123 struct GNUNET_SERVER_Client * client)
1128 * Handle the channel a peer opens to us.
1130 * @param cls The closure
1131 * @param channel The channel the peer wants to establish
1132 * @param initiator The peer's peer ID
1133 * @param port The port the channel is being established over
1134 * @param options Further options
1137 handle_inbound_channel (void *cls,
1138 struct GNUNET_CADET_Channel *channel,
1139 const struct GNUNET_PeerIdentity *initiator,
1141 enum GNUNET_CADET_ChannelOption options)
1143 struct PeerContext *ctx;
1145 LOG (GNUNET_ERROR_TYPE_DEBUG, "New channel was established to us (Peer %s).\n", GNUNET_i2s (initiator));
1147 GNUNET_assert ( NULL != channel );
1149 // we might not even store the from_channel
1151 ctx = get_peer_ctx (peer_map, initiator);
1152 if (NULL != ctx->from_channel)
1154 ctx->from_channel = channel;
1157 // FIXME there might already be an established channel
1159 //ctx->in_flags = in_other_gossip_list;
1160 ctx->mq = NULL; // TODO create mq?
1162 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, initiator, ctx,
1163 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
1164 return NULL; // TODO
1168 * This is called when a remote peer destroys a channel.
1170 * @param cls The closure
1171 * @param channel The channel being closed
1172 * @param channel_ctx The context associated with this channel
1175 cleanup_channel (void *cls,
1176 const struct GNUNET_CADET_Channel *channel,
1179 struct GNUNET_PeerIdentity *peer;
1180 struct PeerContext *peer_ctx;
1182 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel to remote peer was destroyed.\n");
1184 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1185 (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1186 // Guess simply casting isn't the nicest way...
1187 // FIXME wait for cadet to change this function
1188 RPS_sampler_reinitialise_by_value (peer);
1190 peer_ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
1191 /* Somwewhat {ab,re}use the iterator function */
1192 (void) peer_remove_cb (peer, peer, peer_ctx);
1196 * Actually start the service.
1199 rps_start (struct GNUNET_SERVER_Handle *server)
1201 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1202 {&handle_client_request, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST,
1203 sizeof (struct GNUNET_RPS_CS_RequestMessage)},
1204 {&handle_client_seed, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_SEED, 0},
1208 GNUNET_SERVER_add_handlers (server, handlers);
1209 GNUNET_SERVER_disconnect_notify (server,
1210 &handle_client_disconnect,
1212 LOG (GNUNET_ERROR_TYPE_DEBUG, "Ready to receive requests from clients\n");
1215 do_round_task = GNUNET_SCHEDULER_add_now (&do_round, NULL);
1216 LOG (GNUNET_ERROR_TYPE_DEBUG, "Scheduled first round\n");
1218 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1225 * Process statistics requests.
1227 * @param cls closure
1228 * @param server the initialized server
1229 * @param c configuration to use
1233 struct GNUNET_SERVER_Handle *server,
1234 const struct GNUNET_CONFIGURATION_Handle *c)
1236 // TODO check what this does -- copied from gnunet-boss
1237 // - seems to work as expected
1238 GNUNET_log_setup ("rps", GNUNET_error_type_to_string (GNUNET_ERROR_TYPE_DEBUG), NULL);
1240 LOG (GNUNET_ERROR_TYPE_DEBUG, "RPS started\n");
1242 struct init_peer_cls *ipc;
1248 own_identity = GNUNET_new (struct GNUNET_PeerIdentity);
1249 GNUNET_CRYPTO_get_peer_identity (cfg, own_identity); // TODO check return value
1250 GNUNET_assert (NULL != own_identity);
1251 LOG (GNUNET_ERROR_TYPE_DEBUG, "Own identity is %s (at %p).\n", GNUNET_i2s (own_identity), own_identity);
1254 /* Get time interval from the configuration */
1255 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "RPS",
1259 LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read ROUNDINTERVAL from config\n");
1260 GNUNET_SCHEDULER_shutdown ();
1264 /* Get initial size of sampler/gossip list from the configuration */
1265 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, "RPS",
1267 (long long unsigned int *) &sampler_size_est_need))
1269 LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read INITSIZE from config\n");
1270 GNUNET_SCHEDULER_shutdown ();
1273 LOG (GNUNET_ERROR_TYPE_DEBUG, "INITSIZE is %" PRIu64 "\n", sampler_size_est_need);
1275 //gossip_list_size = sampler_size; // TODO rename sampler_size
1278 GNUNET_array_grow (gossip_list, gossip_list_size, sampler_size_est_need);
1281 /* connect to NSE */
1282 nse = GNUNET_NSE_connect (cfg, nse_callback, NULL);
1283 // TODO check whether that was successful
1284 // TODO disconnect on shutdown
1285 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to NSE\n");
1290 // TODO initialise thresholds - ?
1292 /* Get alpha from the configuration */
1293 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1297 LOG (GNUNET_ERROR_TYPE_DEBUG, "No ALPHA specified in the config\n");
1299 LOG (GNUNET_ERROR_TYPE_DEBUG, "ALPHA is %f\n", alpha);
1301 /* Get beta from the configuration */
1302 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1306 LOG (GNUNET_ERROR_TYPE_DEBUG, "No BETA specified in the config\n");
1308 LOG (GNUNET_ERROR_TYPE_DEBUG, "BETA is %f\n", beta);
1310 // TODO check that alpha + beta < 1
1312 peer_map = GNUNET_CONTAINER_multipeermap_create (sampler_size_est_need, GNUNET_NO);
1315 /* Initialise cadet */
1316 static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1317 {&handle_peer_push , GNUNET_MESSAGE_TYPE_RPS_PP_PUSH ,
1318 sizeof (struct GNUNET_MessageHeader)},
1319 {&handle_peer_pull_request, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST,
1320 sizeof (struct GNUNET_MessageHeader)},
1321 {&handle_peer_pull_reply , GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY , 0},
1325 const uint32_t ports[] = {GNUNET_RPS_CADET_PORT, 0}; // _PORT specified in src/rps/rps.h
1326 cadet_handle = GNUNET_CADET_connect (cfg,
1328 &handle_inbound_channel,
1332 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to CADET\n");
1335 /* Initialise sampler */
1336 struct GNUNET_TIME_Relative half_round_interval;
1337 struct GNUNET_TIME_Relative max_round_interval;
1339 half_round_interval = GNUNET_TIME_relative_multiply (round_interval, .5);
1340 max_round_interval = GNUNET_TIME_relative_add (round_interval, half_round_interval);
1342 RPS_sampler_init (sampler_size_est_need, own_identity, max_round_interval,
1343 insertCB, NULL, removeCB, NULL);
1344 sampler_size = sampler_size_est_need;
1346 /* Initialise push and pull maps */
1353 ipc = GNUNET_new (struct init_peer_cls);
1354 ipc->server = server;
1356 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting peers from CADET\n");
1357 GNUNET_CADET_get_peers (cadet_handle, &init_peer_cb, ipc);
1359 // TODO send push/pull to each of those peers?
1364 * The main function for the rps service.
1366 * @param argc number of arguments from the command line
1367 * @param argv command line arguments
1368 * @return 0 ok, 1 on error
1371 main (int argc, char *const *argv)
1373 return (GNUNET_OK ==
1374 GNUNET_SERVICE_run (argc,
1377 GNUNET_SERVICE_OPTION_NONE,
1378 &run, NULL)) ? 0 : 1;
1381 /* end of gnunet-service-rps.c */