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 connect to friends
53 // TODO store peers somewhere
57 // hist_size_init, hist_size_max
62 static const struct GNUNET_CONFIGURATION_Handle *cfg;
67 static struct GNUNET_PeerIdentity *own_identity;
70 struct GNUNET_PeerIdentity *
71 get_rand_peer_ignore_list (const struct GNUNET_PeerIdentity *peer_list, unsigned int size,
72 const struct GNUNET_PeerIdentity *ignore_list, unsigned int ignore_size);
75 /***********************************************************************
76 * Housekeeping with peers
77 ***********************************************************************/
80 * Struct used to store the context of a connected client.
85 * The message queue to communicate with the client.
87 struct GNUNET_MQ_Handle *mq;
91 * Used to keep track in what lists single peerIDs are.
95 PULL_REPLY_PENDING = 0x01,
96 IN_OTHER_GOSSIP_LIST = 0x02, // unneeded?
97 IN_OWN_SAMPLER_LIST = 0x04, // unneeded?
98 IN_OWN_GOSSIP_LIST = 0x08, // unneeded?
101 * We set this bit when we can be sure the other peer is/was live.
108 * Functions of this type can be used to be stored at a peer for later execution.
110 typedef void (* PeerOp) (void *cls, const struct GNUNET_PeerIdentity *peer);
113 * Outstanding operation on peer consisting of callback and closure
115 struct PeerOutstandingOp
130 * Struct used to keep track of other peer's status
132 * This is stored in a multipeermap.
137 * In own gossip/sampler list, in other's gossip/sampler list
142 * Message queue open to client
144 struct GNUNET_MQ_Handle *mq;
147 * Channel open to client.
149 struct GNUNET_CADET_Channel *send_channel;
152 * Channel open from client.
154 struct GNUNET_CADET_Channel *recv_channel; // unneeded?
157 * Array of outstanding operations on this peer.
159 struct PeerOutstandingOp *outstanding_ops;
162 * Number of outstanding operations.
164 unsigned int num_outstanding_ops;
165 //size_t num_outstanding_ops;
168 * Handle to the callback given to cadet_ntfy_tmt_rdy()
170 * To be canceled on shutdown.
172 struct GNUNET_CADET_TransmitHandle *is_live_task;
175 * This is pobably followed by 'statistical' data (when we first saw
176 * him, how did we get his ID, how many pushes (in a timeinterval),
181 /***********************************************************************
182 * /Housekeeping with peers
183 ***********************************************************************/
185 /***********************************************************************
187 ***********************************************************************/
190 * Set of all peers to keep track of them.
192 static struct GNUNET_CONTAINER_MultiPeerMap *peer_map;
196 * The gossiped list of peers.
198 static struct GNUNET_PeerIdentity *gossip_list;
201 * Size of the gossiped list
203 //static unsigned int gossip_list_size;
204 static uint32_t gossip_list_size;
208 * The actual size of the sampler
210 static unsigned int sampler_size;
211 //size_t sampler_size;
214 * The size of sampler we need to be able to satisfy the client's need of
217 static unsigned int sampler_size_client_need;
220 * The size of sampler we need to be able to satisfy the Brahms protocol's
221 * need of random peers.
223 * This is directly taken as the #gossip_list_size on update of the
226 * This is one minimum size the sampler grows to.
228 static unsigned int sampler_size_est_need;
232 * Percentage of total peer number in the gossip list
233 * to send random PUSHes to
238 * Percentage of total peer number in the gossip list
239 * to send random PULLs to
244 * The percentage gamma of history updates.
245 * Simply 1 - alpha - beta
250 * Identifier for the main task that runs periodically.
252 static struct GNUNET_SCHEDULER_Task *do_round_task;
255 * Time inverval the do_round task runs in.
257 static struct GNUNET_TIME_Relative round_interval;
262 * List to store peers received through pushes temporary.
264 * TODO -> multipeermap
266 static struct GNUNET_PeerIdentity *push_list;
269 * Size of the push_list;
271 static unsigned int push_list_size;
272 //size_t push_list_size;
275 * List to store peers received through pulls temporary.
277 * TODO -> multipeermap
279 static struct GNUNET_PeerIdentity *pull_list;
282 * Size of the pull_list;
284 static unsigned int pull_list_size;
285 //size_t pull_list_size;
291 static struct GNUNET_NSE_Handle *nse;
296 static struct GNUNET_CADET_Handle *cadet_handle;
302 * Only needed in the beginning to check how many of the 64 deltas
305 static unsigned int req_counter;
308 * Time of the last request we received.
310 * Used to compute the expected request rate.
312 static struct GNUNET_TIME_Absolute last_request;
315 * Size of #request_deltas.
317 #define REQUEST_DELTAS_SIZE 64
318 static unsigned int request_deltas_size = REQUEST_DELTAS_SIZE;
321 * Last 64 deltas between requests
323 static struct GNUNET_TIME_Relative request_deltas[REQUEST_DELTAS_SIZE];
326 * The prediction of the rate of requests
328 static struct GNUNET_TIME_Relative request_rate;
332 * List with the peers we sent requests to.
334 struct GNUNET_PeerIdentity *pending_pull_reply_list;
337 * Size of #pending_pull_reply_list.
339 uint32_t pending_pull_reply_list_size;
343 * Number of history update tasks.
345 uint32_t num_hist_update_tasks;
348 /***********************************************************************
350 ***********************************************************************/
353 /***********************************************************************
355 ***********************************************************************/
358 * Check if peer is already in peer array.
361 in_arr (const struct GNUNET_PeerIdentity *array,
362 unsigned int arr_size,
363 const struct GNUNET_PeerIdentity *peer)
365 GNUNET_assert (NULL != peer);
370 GNUNET_assert (NULL != array);
375 while (0 != GNUNET_CRYPTO_cmp_peer_identity (&array[i], peer) &&
386 * Remove peer from list.
389 rem_from_list (struct GNUNET_PeerIdentity *peer_list,
390 unsigned int *list_size,
391 const struct GNUNET_PeerIdentity *peer)
395 for ( i = 0 ; i < *list_size ; i++ )
397 if (0 == GNUNET_CRYPTO_cmp_peer_identity (&peer_list[i], peer))
399 if (i < *list_size -1)
400 { /* Not at the last entry -- shift peers left */
401 memcpy (&peer_list[i], &peer_list[i +1],
402 (*list_size - i -1) * sizeof (struct GNUNET_PeerIdentity));
404 /* Remove last entry (should be now useless PeerID) */
405 GNUNET_array_grow (peer_list, *list_size, *list_size -1);
411 * Get random peer from the given list but don't return one from the @a ignore_list.
413 struct GNUNET_PeerIdentity *
414 get_rand_peer_ignore_list (const struct GNUNET_PeerIdentity *peer_list,
416 const struct GNUNET_PeerIdentity *ignore_list,
417 uint32_t ignore_size)
421 struct GNUNET_PeerIdentity *tmp_peer_list;
422 struct GNUNET_PeerIdentity *peer;
425 tmp_peer_list = NULL;
426 GNUNET_array_grow (tmp_peer_list, tmp_size, list_size);
427 memcpy (tmp_peer_list, peer_list, list_size * sizeof (struct GNUNET_PeerIdentity));
428 peer = GNUNET_new (struct GNUNET_PeerIdentity);
429 // FIXME if we have only NULL in gossip list this will block
430 // but then we might have a problem nevertheless
435 * Choose the r_index of the peer we want to return
436 * at random from the interval of the gossip list
438 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
441 *peer = tmp_peer_list[r_index];
442 if (in_arr (tmp_peer_list, list_size, peer))
444 rem_from_list (tmp_peer_list, &tmp_size, peer);
450 } while (NULL == peer);
452 GNUNET_free (tmp_peer_list);
459 * Get the context of a peer. If not existing, create.
462 get_peer_ctx (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
463 const struct GNUNET_PeerIdentity *peer)
465 struct PeerContext *ctx;
467 if ( GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
469 ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
473 ctx = GNUNET_new (struct PeerContext);
476 ctx->send_channel = NULL;
477 ctx->recv_channel = NULL;
478 ctx->outstanding_ops = NULL;
479 ctx->num_outstanding_ops = 0;
480 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
481 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
488 * Put random peer from sampler into the gossip list as history update.
491 hist_update (void *cls, struct GNUNET_PeerIdentity *ids, uint32_t num_peers)
493 GNUNET_assert (1 == num_peers);
495 if (gossip_list_size < sampler_size_est_need)
496 GNUNET_array_append (gossip_list, gossip_list_size, *ids);
498 if (0 < num_hist_update_tasks)
499 num_hist_update_tasks--;
504 * Callback that is called when a channel was effectively established.
505 * This is given to ntfy_tmt_rdy and called when the channel was
506 * successfully established.
509 peer_is_live (void *cls, size_t size, void *buf)
511 struct GNUNET_PeerIdentity *peer;
512 struct PeerContext *peer_ctx;
514 peer = (struct GNUNET_PeerIdentity *) cls;
515 peer_ctx = get_peer_ctx (peer_map, peer);
516 peer_ctx->peer_flags |= LIVING;
518 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer %s is live\n", GNUNET_i2s (peer));
520 if (0 != peer_ctx->num_outstanding_ops)
521 { /* Call outstanding operations */
524 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
525 peer_ctx->outstanding_ops[i].op (peer_ctx->outstanding_ops[i].op_cls, peer);
526 GNUNET_array_grow (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, 0);
537 * Get the channel of a peer. If not existing, create.
539 struct GNUNET_CADET_Channel *
540 get_channel (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
541 const struct GNUNET_PeerIdentity *peer)
543 struct PeerContext *ctx;
544 struct GNUNET_PeerIdentity *tmp_peer;
546 ctx = get_peer_ctx (peer_map, peer);
547 if (NULL == ctx->send_channel)
549 ctx->send_channel = GNUNET_CADET_channel_create (cadet_handle, NULL, peer,
550 GNUNET_RPS_CADET_PORT,
551 GNUNET_CADET_OPTION_RELIABLE);
553 if (NULL == ctx->recv_channel)
555 tmp_peer = GNUNET_new (struct GNUNET_PeerIdentity);
557 ctx->is_live_task = GNUNET_CADET_notify_transmit_ready (ctx->send_channel, GNUNET_NO,
558 GNUNET_TIME_UNIT_FOREVER_REL,
559 0, peer_is_live, tmp_peer);
562 // do I have to explicitly put it in the peer_map?
563 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
564 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
566 return ctx->send_channel;
571 * Get the message queue of a specific peer.
573 * If we already have a message queue open to this client,
574 * simply return it, otherways create one.
576 struct GNUNET_MQ_Handle *
577 get_mq (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
578 const struct GNUNET_PeerIdentity *peer_id)
580 struct PeerContext *ctx;
582 ctx = get_peer_ctx (peer_map, peer_id);
585 (void) get_channel (peer_map, peer_id);
586 ctx->mq = GNUNET_CADET_mq_create (ctx->send_channel);
587 //do I have to explicitly put it in the peer_map?
588 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer_id, ctx,
589 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
596 * Sum all time relatives of an array.
598 struct GNUNET_TIME_Relative
599 T_relative_sum (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
601 struct GNUNET_TIME_Relative sum;
604 sum = GNUNET_TIME_UNIT_ZERO;
605 for ( i = 0 ; i < arr_size ; i++ )
607 sum = GNUNET_TIME_relative_add (sum, rel_array[i]);
614 * Compute the average of given time relatives.
616 struct GNUNET_TIME_Relative
617 T_relative_avg (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
619 return GNUNET_TIME_relative_divide (T_relative_sum (rel_array, arr_size), arr_size);
624 * Insert PeerID in #pull_list
626 * Called once we know a peer is live.
629 insert_in_pull_list (void *cls, const struct GNUNET_PeerIdentity *peer)
631 if (GNUNET_NO == in_arr (pull_list, pull_list_size, peer))
632 GNUNET_array_append (pull_list, pull_list_size, *peer);
636 * Check whether #insert_in_pull_list was already scheduled
639 insert_in_pull_list_scheduled (const struct PeerContext *peer_ctx)
643 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
644 if (insert_in_pull_list == peer_ctx->outstanding_ops[i].op)
651 * Insert PeerID in #gossip_list
653 * Called once we know a peer is live.
656 insert_in_gossip_list (void *cls, const struct GNUNET_PeerIdentity *peer)
658 if (GNUNET_NO == in_arr (gossip_list, gossip_list_size, peer))
659 GNUNET_array_append (gossip_list, gossip_list_size, *peer);
663 * Check whether #insert_in_pull_list was already scheduled
666 insert_in_gossip_list_scheduled (const struct PeerContext *peer_ctx)
670 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
671 if (insert_in_gossip_list == peer_ctx->outstanding_ops[i].op)
678 * Update sampler with given PeerID.
681 insert_in_sampler (void *cls, const struct GNUNET_PeerIdentity *peer)
683 RPS_sampler_update_list (peer);
687 * Check whether #insert_in_sampler was already scheduled
690 insert_in_sampler_scheduled (const struct PeerContext *peer_ctx)
694 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
695 if (insert_in_sampler== peer_ctx->outstanding_ops[i].op)
702 * Wrapper around #RPS_sampler_resize()
707 uint32_t bigger_size;
711 if (sampler_size_est_need > sampler_size_client_need)
712 bigger_size = sampler_size_client_need;
714 bigger_size = sampler_size_est_need;
716 // TODO respect the request rate, min, max
717 if (sampler_size > bigger_size*4)
719 RPS_sampler_resize (sampler_size/2);
721 else if (sampler_size < bigger_size)
723 RPS_sampler_resize (sampler_size*2);
728 /***********************************************************************
730 ***********************************************************************/
733 * Function called by NSE.
735 * Updates sizes of sampler list and gossip list and adapt those lists
739 nse_callback (void *cls, struct GNUNET_TIME_Absolute timestamp, double logestimate, double std_dev)
742 //double scale; // TODO this might go gloabal/config
744 LOG (GNUNET_ERROR_TYPE_DEBUG,
745 "Received a ns estimate - logest: %f, std_dev: %f (old_size: %f)\n",
746 logestimate, std_dev, sampler_size);
748 estimate = GNUNET_NSE_log_estimate_to_n (logestimate);
749 // GNUNET_NSE_log_estimate_to_n (logestimate);
750 estimate = pow (estimate, 1./3);
751 // TODO add if std_dev is a number
752 // estimate += (std_dev * scale);
753 if ( 0 < estimate ) {
754 LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing estimate to %f\n", estimate);
755 sampler_size_est_need = estimate;
757 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not using estimate %f\n", estimate);
759 /* If the NSE has changed adapt the lists accordingly */
765 * Callback called once the requested PeerIDs are ready.
767 * Sends those to the requesting client.
769 void client_respond (void *cls,
770 struct GNUNET_PeerIdentity *ids, uint32_t num_peers)
772 LOG (GNUNET_ERROR_TYPE_DEBUG, "sampler returned %" PRIX32 " peers\n", num_peers);
773 struct GNUNET_MQ_Envelope *ev;
774 struct GNUNET_RPS_CS_ReplyMessage *out_msg;
775 struct GNUNET_SERVER_Client *client;
776 struct client_ctx *cli_ctx;
778 client = (struct GNUNET_SERVER_Client *) cls;
780 ev = GNUNET_MQ_msg_extra (out_msg,
781 num_peers * sizeof (struct GNUNET_PeerIdentity),
782 GNUNET_MESSAGE_TYPE_RPS_CS_REPLY);
783 out_msg->num_peers = htonl (num_peers);
787 num_peers * sizeof (struct GNUNET_PeerIdentity));
790 cli_ctx = GNUNET_SERVER_client_get_user_context (client, struct client_ctx);
791 if ( NULL == cli_ctx ) {
792 cli_ctx = GNUNET_new (struct client_ctx);
793 cli_ctx->mq = GNUNET_MQ_queue_for_server_client (client);
794 GNUNET_SERVER_client_set_user_context (client, cli_ctx);
797 GNUNET_MQ_send (cli_ctx->mq, ev);
802 * Handle RPS request from the client.
805 * @param client identification of the client
806 * @param message the actual message
809 handle_client_request (void *cls,
810 struct GNUNET_SERVER_Client *client,
811 const struct GNUNET_MessageHeader *message)
813 struct GNUNET_RPS_CS_RequestMessage *msg;
815 struct GNUNET_TIME_Relative max_round_duration;
818 /* Estimate request rate */
819 if (request_deltas_size > req_counter)
821 if ( 1 < req_counter)
823 /* Shift last request deltas to the right */
824 memcpy (&request_deltas[1],
826 (req_counter - 1) * sizeof (struct GNUNET_TIME_Relative));
827 /* Add current delta to beginning */
828 request_deltas[0] = GNUNET_TIME_absolute_get_difference (last_request,
829 GNUNET_TIME_absolute_get ());
830 request_rate = T_relative_avg (request_deltas, req_counter);
832 max_round_duration = GNUNET_TIME_relative_add (round_interval,
833 GNUNET_TIME_relative_divide (round_interval, 2));
834 sampler_size_client_need = max_round_duration.rel_value_us / request_rate.rel_value_us;
838 last_request = GNUNET_TIME_absolute_get ();
841 // TODO check message size
842 msg = (struct GNUNET_RPS_CS_RequestMessage *) message;
844 num_peers = ntohl (msg->num_peers);
846 LOG (GNUNET_ERROR_TYPE_DEBUG, "Client requested %" PRIX32 " random peer(s).\n", num_peers);
848 RPS_sampler_get_n_rand_peers (client_respond, client, num_peers, GNUNET_YES);
850 GNUNET_SERVER_receive_done (client,
856 * Handle seed from the client.
859 * @param client identification of the client
860 * @param message the actual message
863 handle_client_seed (void *cls,
864 struct GNUNET_SERVER_Client *client,
865 const struct GNUNET_MessageHeader *message)
867 struct GNUNET_RPS_CS_SeedMessage *in_msg;
868 struct GNUNET_PeerIdentity *peers;
871 if (sizeof (struct GNUNET_RPS_CS_SeedMessage) < ntohs (message->size))
874 GNUNET_SERVER_receive_done (client,
877 in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
878 if ((ntohs (message->size) - sizeof (struct GNUNET_RPS_CS_SeedMessage)) /
879 sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
882 GNUNET_SERVER_receive_done (client,
886 in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
887 peers = (struct GNUNET_PeerIdentity *) &message[1];
889 for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
890 RPS_sampler_update_list (&peers[i]);
892 GNUNET_SERVER_receive_done (client,
898 * Handle a PUSH message from another peer.
900 * Check the proof of work and store the PeerID
901 * in the temporary list for pushed PeerIDs.
904 * @param channel The channel the PUSH was received over
905 * @param channel_ctx The context associated with this channel
906 * @param msg The message header
909 handle_peer_push (void *cls,
910 struct GNUNET_CADET_Channel *channel,
912 const struct GNUNET_MessageHeader *msg)
914 const struct GNUNET_PeerIdentity *peer;
916 // (check the proof of work)
918 peer = (const struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
919 // FIXME wait for cadet to change this function
920 LOG (GNUNET_ERROR_TYPE_DEBUG, "PUSH received (%s)\n", GNUNET_i2s (peer));
922 /* Add the sending peer to the push_list */
923 if (GNUNET_NO == in_arr (push_list, pull_list_size, peer))
924 GNUNET_array_append (push_list, push_list_size, *peer);
930 * Handle PULL REQUEST request message from another peer.
932 * Reply with the gossip list of PeerIDs.
935 * @param channel The channel the PUSH was received over
936 * @param channel_ctx The context associated with this channel
937 * @param msg The message header
940 handle_peer_pull_request (void *cls,
941 struct GNUNET_CADET_Channel *channel,
943 const struct GNUNET_MessageHeader *msg)
945 struct GNUNET_PeerIdentity *peer;
946 struct GNUNET_MQ_Handle *mq;
947 struct GNUNET_MQ_Envelope *ev;
948 struct GNUNET_RPS_P2P_PullReplyMessage *out_msg;
951 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel,
952 GNUNET_CADET_OPTION_PEER);
953 // FIXME wait for cadet to change this function
954 LOG (GNUNET_ERROR_TYPE_DEBUG,
955 "PULL REQUEST from peer %s received, going to send %u peers\n",
956 GNUNET_i2s (peer), gossip_list_size);
958 mq = get_mq (peer_map, peer);
960 ev = GNUNET_MQ_msg_extra (out_msg,
961 gossip_list_size * sizeof (struct GNUNET_PeerIdentity),
962 GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY);
963 //out_msg->num_peers = htonl (gossip_list_size);
964 out_msg->num_peers = htonl (gossip_list_size);
965 memcpy (&out_msg[1], gossip_list,
966 gossip_list_size * sizeof (struct GNUNET_PeerIdentity));
968 GNUNET_MQ_send (mq, ev);
974 * Handle PULL REPLY message from another peer.
976 * Check whether we sent a corresponding request and
977 * whether this reply is the first one.
980 * @param channel The channel the PUSH was received over
981 * @param channel_ctx The context associated with this channel
982 * @param msg The message header
985 handle_peer_pull_reply (void *cls,
986 struct GNUNET_CADET_Channel *channel,
988 const struct GNUNET_MessageHeader *msg)
990 LOG (GNUNET_ERROR_TYPE_DEBUG, "PULL REPLY received\n");
992 struct GNUNET_RPS_P2P_PullReplyMessage *in_msg;
993 struct GNUNET_PeerIdentity *peers;
994 struct PeerContext *peer_ctx;
995 struct GNUNET_PeerIdentity *sender;
996 struct PeerContext *sender_ctx;
997 struct PeerOutstandingOp out_op;
1000 if (sizeof (struct GNUNET_RPS_P2P_PullReplyMessage) > ntohs (msg->size))
1002 GNUNET_break_op (0); // At the moment our own implementation seems to break that.
1003 return GNUNET_SYSERR;
1005 in_msg = (struct GNUNET_RPS_P2P_PullReplyMessage *) msg;
1006 if ((ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
1008 LOG (GNUNET_ERROR_TYPE_ERROR, "message says it sends %" PRIu64 " peers, have space for %i peers\n",
1009 ntohl (in_msg->num_peers),
1010 (ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity));
1011 GNUNET_break_op (0);
1012 return GNUNET_SYSERR;
1015 sender = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1016 (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1017 // Guess simply casting isn't the nicest way...
1018 // FIXME wait for cadet to change this function
1019 sender_ctx = get_peer_ctx (peer_map, sender);
1021 if (0 == (peer_ctx->peer_flags || PULL_REPLY_PENDING))
1023 GNUNET_break_op (0);
1027 peers = (struct GNUNET_PeerIdentity *) &msg[1];
1028 for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
1030 peer_ctx = get_peer_ctx (peer_map, &peers[i]);
1031 if ((0 != (peer_ctx->peer_flags && LIVING)) ||
1032 NULL != peer_ctx->recv_channel)
1034 if (GNUNET_NO == in_arr (pull_list, pull_list_size, &peers[i]))
1035 GNUNET_array_append (pull_list, pull_list_size, peers[i]);
1037 else if (GNUNET_NO == insert_in_pull_list_scheduled (peer_ctx))
1039 out_op.op = insert_in_pull_list;
1040 GNUNET_array_append (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, out_op);
1044 sender_ctx->peer_flags &= (~PULL_REPLY_PENDING);
1045 rem_from_list (pending_pull_reply_list, &pending_pull_reply_list_size, sender);
1052 * Send out PUSHes and PULLs.
1054 * This is executed regylary.
1057 do_round (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1059 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to execute next round\n");
1062 unsigned int *permut;
1063 unsigned int n_peers; /* Number of peers we send pushes/pulls to */
1064 struct GNUNET_MQ_Envelope *ev;
1065 const struct GNUNET_PeerIdentity *peer;
1066 struct GNUNET_MQ_Handle *mq;
1068 // TODO log lists, ...
1071 /* Would it make sense to have one shuffeled gossip list and then
1072 * to send PUSHes to first alpha peers, PULL requests to next beta peers and
1073 * use the rest to update sampler?
1074 * in essence get random peers with consumption */
1077 if (0 < gossip_list_size)
1079 permut = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG,
1080 (unsigned int) gossip_list_size);
1081 if (0 != gossip_list_size)
1083 n_peers = round (alpha * gossip_list_size);
1086 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pushes to %u (%f * %u) peers.\n",
1087 n_peers, alpha, gossip_list_size);
1088 for ( i = 0 ; i < n_peers ; i++ )
1091 //peer = get_rand_peer_ignore_list (gossip_list, gossip_list_size,
1093 peer = &gossip_list[permut[i]];
1094 if (own_identity != peer) // TODO
1095 { // FIXME if this fails schedule/loop this for later
1096 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PUSH to peer %s of gossiped list.\n", GNUNET_i2s (peer));
1098 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PUSH);
1099 // FIXME sometimes it returns a pointer to a freed mq
1100 mq = get_mq (peer_map, peer);
1101 GNUNET_MQ_send (mq, ev);
1108 /* Send PULL requests */
1109 //permut = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list->size);
1110 if (0 != gossip_list_size)
1112 n_peers = round (beta * gossip_list_size);
1115 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pulls to %u (%f * %u) peers.\n",
1116 n_peers, beta, gossip_list_size);
1117 for ( i = 0 ; i < n_peers ; i++ )
1119 peer = get_rand_peer_ignore_list (gossip_list, gossip_list_size,
1120 pending_pull_reply_list, pending_pull_reply_list_size);
1123 GNUNET_array_append (pending_pull_reply_list, pending_pull_reply_list_size, *peer);
1125 if (own_identity != peer)
1126 { // FIXME if this fails schedule/loop this for later
1127 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PULL request to peer %s of gossiped list.\n", GNUNET_i2s (peer));
1129 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST);
1131 mq = get_mq (peer_map, peer);
1132 GNUNET_MQ_send (mq, ev);
1139 /* Update gossip list */
1142 if ( push_list_size <= alpha * gossip_list_size &&
1143 push_list_size != 0 &&
1144 pull_list_size != 0 )
1146 LOG (GNUNET_ERROR_TYPE_DEBUG, "Update of the gossip list.\n");
1148 uint32_t first_border;
1149 uint32_t second_border;
1151 first_border = round (alpha * sampler_size_est_need);
1152 second_border = first_border + round (beta * sampler_size_est_need);
1154 GNUNET_array_grow (gossip_list, gossip_list_size, second_border);
1156 for ( i = 0 ; i < first_border ; i++ )
1157 { // TODO use RPS_sampler_get_n_rand_peers
1158 /* Update gossip list with peers received through PUSHes */
1159 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
1161 gossip_list[i] = push_list[r_index];
1162 // TODO change the peer_flags accordingly
1165 for ( i = first_border ; i < second_border ; i++ )
1167 /* Update gossip list with peers received through PULLs */
1168 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
1170 gossip_list[i] = pull_list[r_index];
1171 // TODO change the peer_flags accordingly
1174 for ( i = second_border ; i < gossip_list_size ; i++ )
1176 /* Update gossip list with peers from history */
1177 RPS_sampler_get_n_rand_peers (hist_update, NULL, 1, GNUNET_NO);
1178 num_hist_update_tasks++;
1179 // TODO change the peer_flags accordingly
1185 LOG (GNUNET_ERROR_TYPE_DEBUG, "No update of the gossip list. ()\n");
1187 // TODO independent of that also get some peers from CADET_get_peers()?
1190 /* Update samplers */
1192 for ( i = 0 ; i < push_list_size ; i++ )
1194 RPS_sampler_update_list (&push_list[i]);
1195 // TODO set in_flag?
1198 for ( i = 0 ; i < pull_list_size ; i++ )
1200 RPS_sampler_update_list (&pull_list[i]);
1201 // TODO set in_flag?
1205 /* Empty push/pull lists */
1206 GNUNET_array_grow (push_list, push_list_size, 0);
1207 GNUNET_array_grow (pull_list, pull_list_size, 0);
1209 struct GNUNET_TIME_Relative time_next_round;
1210 struct GNUNET_TIME_Relative half_round_interval;
1211 unsigned int rand_delay;
1213 /* Compute random time value between .5 * round_interval and 1.5 *round_interval */
1214 half_round_interval = GNUNET_TIME_relative_divide (round_interval, 2);
1218 * Compute random value between (0 and 1) * round_interval
1219 * via multiplying round_interval with a 'fraction' (0 to value)/value
1221 rand_delay = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT_MAX/10);
1222 time_next_round = GNUNET_TIME_relative_multiply (round_interval, rand_delay);
1223 time_next_round = GNUNET_TIME_relative_divide (time_next_round, UINT_MAX/10);
1224 time_next_round = GNUNET_TIME_relative_add (time_next_round, half_round_interval);
1225 } while (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == time_next_round.rel_value_us);
1227 /* Schedule next round */
1228 do_round_task = GNUNET_SCHEDULER_add_delayed (round_interval, &do_round, NULL);
1229 LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished round\n");
1234 * Open a connection to given peer and store channel and mq.
1237 insertCB (void *cls, const struct GNUNET_PeerIdentity *id)
1239 // We open a channel to be notified when this peer goes down.
1240 (void) get_channel (peer_map, id);
1245 * Close the connection to given peer and delete channel and mq.
1248 removeCB (void *cls, const struct GNUNET_PeerIdentity *id)
1251 struct PeerContext *ctx;
1253 s = RPS_sampler_count_id (id);
1256 if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, id))
1258 ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, id);
1259 if (NULL != ctx->send_channel)
1261 if (NULL != ctx->mq)
1263 GNUNET_MQ_destroy (ctx->mq);
1265 // may already be freed at shutdown of cadet
1266 //GNUNET_CADET_channel_destroy (ctx->send_channel);
1268 // TODO cleanup peer
1269 (void) GNUNET_CONTAINER_multipeermap_remove_all (peer_map, id);
1275 rps_start (struct GNUNET_SERVER_Handle *server);
1278 * This is called from GNUNET_CADET_get_peers().
1280 * It is called on every peer(ID) that cadet somehow has contact with.
1281 * We use those to initialise the sampler.
1284 init_peer_cb (void *cls,
1285 const struct GNUNET_PeerIdentity *peer,
1286 int tunnel, // "Do we have a tunnel towards this peer?"
1287 unsigned int n_paths, // "Number of known paths towards this peer"
1288 unsigned int best_path) // "How long is the best path?
1289 // (0 = unknown, 1 = ourselves, 2 = neighbor)"
1291 struct GNUNET_SERVER_Handle *server;
1292 struct PeerOutstandingOp out_op;
1293 struct PeerContext *peer_ctx;
1295 server = (struct GNUNET_SERVER_Handle *) cls;
1298 LOG (GNUNET_ERROR_TYPE_DEBUG,
1299 "Got peer %s (at %p) from CADET (gossip_list_size: %u)\n",
1300 GNUNET_i2s (peer), peer, gossip_list_size);
1302 // maybe create a function for that
1303 peer_ctx = get_peer_ctx (peer_map, peer);
1304 if (GNUNET_NO == insert_in_sampler_scheduled (peer_ctx))
1306 out_op.op = insert_in_sampler;
1307 GNUNET_array_append (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, out_op);
1310 if (GNUNET_NO == insert_in_gossip_list_scheduled (peer_ctx))
1312 out_op.op = insert_in_gossip_list;
1313 GNUNET_array_append (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, out_op);
1316 /* Issue livelyness test on peer */
1317 (void) get_channel (peer_map, peer);
1319 // send push/pull to each of those peers?
1327 * Callback used to clean the multipeermap.
1330 peer_remove_cb (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
1332 struct PeerContext *peer_ctx;
1334 peer_ctx = (struct PeerContext *) value;
1336 if ( NULL != peer_ctx->mq)
1337 GNUNET_MQ_destroy (peer_ctx->mq);
1339 if ( NULL != peer_ctx->is_live_task)
1340 GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->is_live_task);
1342 if ( NULL != peer_ctx->send_channel)
1343 GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1345 if ( NULL != peer_ctx->recv_channel)
1346 GNUNET_CADET_channel_destroy (peer_ctx->recv_channel);
1348 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_remove_all (peer_map, key))
1349 LOG (GNUNET_ERROR_TYPE_WARNING, "removing peer from peer_map failed\n");
1356 * Task run during shutdown.
1362 shutdown_task (void *cls,
1363 const struct GNUNET_SCHEDULER_TaskContext *tc)
1365 LOG (GNUNET_ERROR_TYPE_DEBUG, "RPS is going down\n");
1367 if ( NULL != do_round_task )
1369 GNUNET_SCHEDULER_cancel (do_round_task);
1370 do_round_task = NULL;
1374 if (GNUNET_SYSERR == GNUNET_CONTAINER_multipeermap_iterate (peer_map, peer_remove_cb, NULL))
1375 LOG (GNUNET_ERROR_TYPE_WARNING,
1376 "Iterating over peers to disconnect from them was cancelled\n");
1378 GNUNET_CONTAINER_multipeermap_destroy (peer_map);
1380 GNUNET_NSE_disconnect (nse);
1381 GNUNET_CADET_disconnect (cadet_handle);
1382 GNUNET_free (own_identity);
1383 RPS_sampler_destroy ();
1384 GNUNET_array_grow (request_deltas, request_deltas_size, 0);
1385 GNUNET_array_grow (gossip_list, gossip_list_size, 0);
1386 GNUNET_array_grow (push_list, push_list_size, 0);
1387 GNUNET_array_grow (pull_list, pull_list_size, 0);
1392 * A client disconnected. Remove all of its data structure entries.
1394 * @param cls closure, NULL
1395 * @param client identification of the client
1398 handle_client_disconnect (void *cls,
1399 struct GNUNET_SERVER_Client * client)
1404 * Handle the channel a peer opens to us.
1406 * @param cls The closure
1407 * @param channel The channel the peer wants to establish
1408 * @param initiator The peer's peer ID
1409 * @param port The port the channel is being established over
1410 * @param options Further options
1413 handle_inbound_channel (void *cls,
1414 struct GNUNET_CADET_Channel *channel,
1415 const struct GNUNET_PeerIdentity *initiator,
1417 enum GNUNET_CADET_ChannelOption options)
1419 struct PeerContext *ctx;
1421 LOG (GNUNET_ERROR_TYPE_DEBUG,
1422 "New channel was established to us (Peer %s).\n",
1423 GNUNET_i2s (initiator));
1425 GNUNET_assert (NULL != channel);
1427 // we might not even store the recv_channel
1429 ctx = get_peer_ctx (peer_map, initiator);
1430 if (NULL != ctx->recv_channel)
1432 ctx->recv_channel = channel;
1435 // FIXME there might already be an established channel
1437 //ctx->peer_flags = IN_OTHER_GOSSIP_LIST;
1438 ctx->mq = NULL; // TODO create mq?
1440 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, initiator, ctx,
1441 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
1442 return NULL; // TODO
1446 * This is called when a remote peer destroys a channel.
1448 * @param cls The closure
1449 * @param channel The channel being closed
1450 * @param channel_ctx The context associated with this channel
1453 cleanup_channel (void *cls,
1454 const struct GNUNET_CADET_Channel *channel,
1457 struct GNUNET_PeerIdentity *peer;
1458 struct PeerContext *peer_ctx;
1460 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel to remote peer was destroyed.\n");
1462 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1463 (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1464 // Guess simply casting isn't the nicest way...
1465 // FIXME wait for cadet to change this function
1466 RPS_sampler_reinitialise_by_value (peer);
1468 peer_ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
1469 /* Somwewhat {ab,re}use the iterator function */
1470 (void) peer_remove_cb (peer, peer, peer_ctx);
1475 * Actually start the service.
1478 rps_start (struct GNUNET_SERVER_Handle *server)
1480 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1481 {&handle_client_request, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST,
1482 sizeof (struct GNUNET_RPS_CS_RequestMessage)},
1483 {&handle_client_seed, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_SEED, 0},
1487 GNUNET_SERVER_add_handlers (server, handlers);
1488 GNUNET_SERVER_disconnect_notify (server,
1489 &handle_client_disconnect,
1491 LOG (GNUNET_ERROR_TYPE_DEBUG, "Ready to receive requests from clients\n");
1494 num_hist_update_tasks = 0;
1496 do_round_task = GNUNET_SCHEDULER_add_now (&do_round, NULL);
1497 LOG (GNUNET_ERROR_TYPE_DEBUG, "Scheduled first round\n");
1499 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1506 * Process statistics requests.
1508 * @param cls closure
1509 * @param server the initialized server
1510 * @param c configuration to use
1514 struct GNUNET_SERVER_Handle *server,
1515 const struct GNUNET_CONFIGURATION_Handle *c)
1517 // TODO check what this does -- copied from gnunet-boss
1518 // - seems to work as expected
1519 GNUNET_log_setup ("rps", GNUNET_error_type_to_string (GNUNET_ERROR_TYPE_DEBUG), NULL);
1521 LOG (GNUNET_ERROR_TYPE_DEBUG, "RPS started\n");
1528 own_identity = GNUNET_new (struct GNUNET_PeerIdentity);
1529 GNUNET_CRYPTO_get_peer_identity (cfg, own_identity); // TODO check return value
1530 GNUNET_assert (NULL != own_identity);
1531 LOG (GNUNET_ERROR_TYPE_DEBUG, "Own identity is %s (at %p).\n", GNUNET_i2s (own_identity), own_identity);
1534 /* Get time interval from the configuration */
1535 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "RPS",
1539 LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read ROUNDINTERVAL from config\n");
1540 GNUNET_SCHEDULER_shutdown ();
1544 /* Get initial size of sampler/gossip list from the configuration */
1545 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, "RPS",
1547 (long long unsigned int *) &sampler_size_est_need))
1549 LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read INITSIZE from config\n");
1550 GNUNET_SCHEDULER_shutdown ();
1553 LOG (GNUNET_ERROR_TYPE_DEBUG, "INITSIZE is %" PRIu64 "\n", sampler_size_est_need);
1559 /* connect to NSE */
1560 nse = GNUNET_NSE_connect (cfg, nse_callback, NULL);
1561 // TODO check whether that was successful
1562 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to NSE\n");
1568 peer_map = GNUNET_CONTAINER_multipeermap_create (sampler_size_est_need, GNUNET_NO);
1571 /* Initialise cadet */
1572 static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1573 {&handle_peer_push , GNUNET_MESSAGE_TYPE_RPS_PP_PUSH ,
1574 sizeof (struct GNUNET_MessageHeader)},
1575 {&handle_peer_pull_request, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST,
1576 sizeof (struct GNUNET_MessageHeader)},
1577 {&handle_peer_pull_reply , GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY , 0},
1581 const uint32_t ports[] = {GNUNET_RPS_CADET_PORT, 0}; // _PORT specified in src/rps/rps.h
1582 cadet_handle = GNUNET_CADET_connect (cfg,
1584 &handle_inbound_channel,
1588 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to CADET\n");
1591 /* Initialise sampler */
1592 struct GNUNET_TIME_Relative half_round_interval;
1593 struct GNUNET_TIME_Relative max_round_interval;
1595 half_round_interval = GNUNET_TIME_relative_multiply (round_interval, .5);
1596 max_round_interval = GNUNET_TIME_relative_add (round_interval, half_round_interval);
1598 RPS_sampler_init (sampler_size_est_need, max_round_interval,
1599 insertCB, NULL, removeCB, NULL);
1600 sampler_size = sampler_size_est_need;
1602 /* Initialise push and pull maps */
1607 pending_pull_reply_list = NULL;
1608 pending_pull_reply_list_size = 0;
1611 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting peers from CADET\n");
1612 GNUNET_CADET_get_peers (cadet_handle, &init_peer_cb, server);
1614 // TODO send push/pull to each of those peers?
1619 * The main function for the rps service.
1621 * @param argc number of arguments from the command line
1622 * @param argv command line arguments
1623 * @return 0 ok, 1 on error
1626 main (int argc, char *const *argv)
1628 return (GNUNET_OK ==
1629 GNUNET_SERVICE_run (argc,
1632 GNUNET_SERVICE_OPTION_NONE,
1633 &run, NULL)) ? 0 : 1;
1636 /* end of gnunet-service-rps.c */