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
235 * TODO do not read from configuration
240 * Percentage of total peer number in the gossip list
241 * to send random PULLs to
243 * TODO do not read from configuration
248 * The percentage gamma of history updates.
249 * Simply 1 - alpha - beta
254 * Identifier for the main task that runs periodically.
256 static struct GNUNET_SCHEDULER_Task *do_round_task;
259 * Time inverval the do_round task runs in.
261 static struct GNUNET_TIME_Relative round_interval;
266 * List to store peers received through pushes temporary.
268 * TODO -> multipeermap
270 static struct GNUNET_PeerIdentity *push_list;
273 * Size of the push_list;
275 static unsigned int push_list_size;
276 //size_t push_list_size;
279 * List to store peers received through pulls temporary.
281 * TODO -> multipeermap
283 static struct GNUNET_PeerIdentity *pull_list;
286 * Size of the pull_list;
288 static unsigned int pull_list_size;
289 //size_t pull_list_size;
295 static struct GNUNET_NSE_Handle *nse;
300 static struct GNUNET_CADET_Handle *cadet_handle;
306 * Only needed in the beginning to check how many of the 64 deltas
309 static unsigned int req_counter;
312 * Time of the last request we received.
314 * Used to compute the expected request rate.
316 static struct GNUNET_TIME_Absolute last_request;
319 * Size of #request_deltas.
321 #define REQUEST_DELTAS_SIZE 64
322 static unsigned int request_deltas_size = REQUEST_DELTAS_SIZE;
325 * Last 64 deltas between requests
327 static struct GNUNET_TIME_Relative request_deltas[REQUEST_DELTAS_SIZE];
330 * The prediction of the rate of requests
332 static struct GNUNET_TIME_Relative request_rate;
336 * List with the peers we sent requests to.
338 struct GNUNET_PeerIdentity *pending_pull_reply_list;
341 * Size of #pending_pull_reply_list.
343 uint32_t pending_pull_reply_list_size;
347 * Number of history update tasks.
349 uint32_t num_hist_update_tasks;
352 /***********************************************************************
354 ***********************************************************************/
357 /***********************************************************************
359 ***********************************************************************/
362 * Check if peer is already in peer array.
365 in_arr (const struct GNUNET_PeerIdentity *array,
366 unsigned int arr_size,
367 const struct GNUNET_PeerIdentity *peer)
369 GNUNET_assert (NULL != peer);
374 GNUNET_assert (NULL != array);
379 while (0 != GNUNET_CRYPTO_cmp_peer_identity (&array[i], peer) &&
390 * Remove peer from list.
393 rem_from_list (struct GNUNET_PeerIdentity *peer_list,
394 unsigned int *list_size,
395 const struct GNUNET_PeerIdentity *peer)
399 for ( i = 0 ; i < *list_size ; i++ )
401 if (0 == GNUNET_CRYPTO_cmp_peer_identity (&peer_list[i], peer))
403 if (i < *list_size -1)
404 { /* Not at the last entry -- shift peers left */
405 memcpy (&peer_list[i], &peer_list[i +1],
406 (*list_size - i -1) * sizeof (struct GNUNET_PeerIdentity));
408 /* Remove last entry (should be now useless PeerID) */
409 GNUNET_array_grow (peer_list, *list_size, *list_size -1);
415 * Get random peer from the given list but don't return one from the @a ignore_list.
417 struct GNUNET_PeerIdentity *
418 get_rand_peer_ignore_list (const struct GNUNET_PeerIdentity *peer_list,
420 const struct GNUNET_PeerIdentity *ignore_list,
421 uint32_t ignore_size)
425 struct GNUNET_PeerIdentity *tmp_peer_list;
426 struct GNUNET_PeerIdentity *peer;
429 tmp_peer_list = NULL;
430 GNUNET_array_grow (tmp_peer_list, tmp_size, list_size);
431 memcpy (tmp_peer_list, peer_list, list_size * sizeof (struct GNUNET_PeerIdentity));
432 peer = GNUNET_new (struct GNUNET_PeerIdentity);
433 // FIXME if we have only NULL in gossip list this will block
434 // but then we might have a problem nevertheless
439 * Choose the r_index of the peer we want to return
440 * at random from the interval of the gossip list
442 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
445 *peer = tmp_peer_list[r_index];
446 if (in_arr (tmp_peer_list, list_size, peer))
448 rem_from_list (tmp_peer_list, &tmp_size, peer);
454 } while (NULL == peer);
456 GNUNET_free (tmp_peer_list);
463 * Get the context of a peer. If not existing, create.
466 get_peer_ctx (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
467 const struct GNUNET_PeerIdentity *peer)
469 struct PeerContext *ctx;
471 if ( GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
473 ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
477 ctx = GNUNET_new (struct PeerContext);
480 ctx->send_channel = NULL;
481 ctx->recv_channel = NULL;
482 ctx->outstanding_ops = NULL;
483 ctx->num_outstanding_ops = 0;
484 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
485 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
492 * Put random peer from sampler into the gossip list as history update.
495 hist_update (void *cls, struct GNUNET_PeerIdentity *ids, uint32_t num_peers)
497 GNUNET_assert (1 == num_peers);
499 if (gossip_list_size < sampler_size_est_need)
500 GNUNET_array_append (gossip_list, gossip_list_size, *ids);
502 if (0 < num_hist_update_tasks)
503 num_hist_update_tasks--;
508 * Callback that is called when a channel was effectively established.
509 * This is given to ntfy_tmt_rdy and called when the channel was
510 * successfully established.
513 peer_is_live (void *cls, size_t size, void *buf)
515 struct GNUNET_PeerIdentity *peer;
516 struct PeerContext *peer_ctx;
518 peer = (struct GNUNET_PeerIdentity *) cls;
519 peer_ctx = get_peer_ctx (peer_map, peer);
520 peer_ctx->peer_flags |= LIVING;
522 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peer %s is live\n", GNUNET_i2s (peer));
524 if (0 != peer_ctx->num_outstanding_ops)
525 { /* Call outstanding operations */
528 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
529 peer_ctx->outstanding_ops[i].op (peer_ctx->outstanding_ops[i].op_cls, peer);
530 GNUNET_array_grow (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, 0);
541 * Get the channel of a peer. If not existing, create.
543 struct GNUNET_CADET_Channel *
544 get_channel (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
545 const struct GNUNET_PeerIdentity *peer)
547 struct PeerContext *ctx;
548 struct GNUNET_PeerIdentity *tmp_peer;
550 ctx = get_peer_ctx (peer_map, peer);
551 if (NULL == ctx->send_channel)
553 ctx->send_channel = GNUNET_CADET_channel_create (cadet_handle, NULL, peer,
554 GNUNET_RPS_CADET_PORT,
555 GNUNET_CADET_OPTION_RELIABLE);
557 if (NULL == ctx->recv_channel)
559 tmp_peer = GNUNET_new (struct GNUNET_PeerIdentity);
561 ctx->is_live_task = GNUNET_CADET_notify_transmit_ready (ctx->send_channel, GNUNET_NO,
562 GNUNET_TIME_UNIT_FOREVER_REL,
563 0, peer_is_live, tmp_peer);
566 // do I have to explicitly put it in the peer_map?
567 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
568 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
570 return ctx->send_channel;
575 * Get the message queue of a specific peer.
577 * If we already have a message queue open to this client,
578 * simply return it, otherways create one.
580 struct GNUNET_MQ_Handle *
581 get_mq (struct GNUNET_CONTAINER_MultiPeerMap *peer_map,
582 const struct GNUNET_PeerIdentity *peer_id)
584 struct PeerContext *ctx;
586 ctx = get_peer_ctx (peer_map, peer_id);
589 (void) get_channel (peer_map, peer_id);
590 ctx->mq = GNUNET_CADET_mq_create (ctx->send_channel);
591 //do I have to explicitly put it in the peer_map?
592 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, peer_id, ctx,
593 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
600 * Sum all time relatives of an array.
602 struct GNUNET_TIME_Relative
603 T_relative_sum (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
605 struct GNUNET_TIME_Relative sum;
608 sum = GNUNET_TIME_UNIT_ZERO;
609 for ( i = 0 ; i < arr_size ; i++ )
611 sum = GNUNET_TIME_relative_add (sum, rel_array[i]);
618 * Compute the average of given time relatives.
620 struct GNUNET_TIME_Relative
621 T_relative_avg (const struct GNUNET_TIME_Relative *rel_array, uint32_t arr_size)
623 return GNUNET_TIME_relative_divide (T_relative_sum (rel_array, arr_size), arr_size);
628 * Insert PeerID in #pull_list
630 * Called once we know a peer is live.
633 insert_in_pull_list (void *cls, const struct GNUNET_PeerIdentity *peer)
635 if (GNUNET_NO == in_arr (pull_list, pull_list_size, peer))
636 GNUNET_array_append (pull_list, pull_list_size, *peer);
640 * Check whether #insert_in_pull_list was already scheduled
643 insert_in_pull_list_scheduled (const struct PeerContext *peer_ctx)
647 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
648 if (insert_in_pull_list == peer_ctx->outstanding_ops[i].op)
655 * Insert PeerID in #gossip_list
657 * Called once we know a peer is live.
660 insert_in_gossip_list (void *cls, const struct GNUNET_PeerIdentity *peer)
662 if (GNUNET_NO == in_arr (gossip_list, gossip_list_size, peer))
663 GNUNET_array_append (gossip_list, gossip_list_size, *peer);
667 * Check whether #insert_in_pull_list was already scheduled
670 insert_in_gossip_list_scheduled (const struct PeerContext *peer_ctx)
674 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
675 if (insert_in_gossip_list == peer_ctx->outstanding_ops[i].op)
682 * Update sampler with given PeerID.
685 insert_in_sampler (void *cls, const struct GNUNET_PeerIdentity *peer)
687 RPS_sampler_update_list (peer);
691 * Check whether #insert_in_sampler was already scheduled
694 insert_in_sampler_scheduled (const struct PeerContext *peer_ctx)
698 for ( i = 0 ; i < peer_ctx->num_outstanding_ops ; i++ )
699 if (insert_in_sampler== peer_ctx->outstanding_ops[i].op)
707 * Wrapper around #RPS_sampler_resize()
712 uint32_t bigger_size;
716 if (sampler_size_est_need > sampler_size_client_need)
717 bigger_size = sampler_size_client_need;
719 bigger_size = sampler_size_est_need;
721 // TODO respect the request rate, min, max
722 if (sampler_size > bigger_size*4)
724 RPS_sampler_resize (sampler_size/2);
726 else if (sampler_size < bigger_size)
728 RPS_sampler_resize (sampler_size*2);
733 /***********************************************************************
735 ***********************************************************************/
738 * Function called by NSE.
740 * Updates sizes of sampler list and gossip list and adapt those lists
744 nse_callback (void *cls, struct GNUNET_TIME_Absolute timestamp, double logestimate, double std_dev)
747 //double scale; // TODO this might go gloabal/config
749 LOG (GNUNET_ERROR_TYPE_DEBUG,
750 "Received a ns estimate - logest: %f, std_dev: %f (old_size: %f)\n",
751 logestimate, std_dev, sampler_size);
753 estimate = GNUNET_NSE_log_estimate_to_n (logestimate);
754 // GNUNET_NSE_log_estimate_to_n (logestimate);
755 estimate = pow (estimate, 1./3);
756 // TODO add if std_dev is a number
757 // estimate += (std_dev * scale);
758 if ( 0 < estimate ) {
759 LOG (GNUNET_ERROR_TYPE_DEBUG, "Changing estimate to %f\n", estimate);
760 sampler_size_est_need = estimate;
762 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not using estimate %f\n", estimate);
764 /* If the NSE has changed adapt the lists accordingly */
770 * Callback called once the requested PeerIDs are ready.
772 * Sends those to the requesting client.
774 void client_respond (void *cls,
775 struct GNUNET_PeerIdentity *ids, uint32_t num_peers)
777 LOG (GNUNET_ERROR_TYPE_DEBUG, "sampler returned %" PRIX32 " peers\n", num_peers);
778 struct GNUNET_MQ_Envelope *ev;
779 struct GNUNET_RPS_CS_ReplyMessage *out_msg;
780 struct GNUNET_SERVER_Client *client;
781 struct client_ctx *cli_ctx;
783 client = (struct GNUNET_SERVER_Client *) cls;
785 ev = GNUNET_MQ_msg_extra (out_msg,
786 num_peers * sizeof (struct GNUNET_PeerIdentity),
787 GNUNET_MESSAGE_TYPE_RPS_CS_REPLY);
788 out_msg->num_peers = htonl (num_peers);
792 num_peers * sizeof (struct GNUNET_PeerIdentity));
795 cli_ctx = GNUNET_SERVER_client_get_user_context (client, struct client_ctx);
796 if ( NULL == cli_ctx ) {
797 cli_ctx = GNUNET_new (struct client_ctx);
798 cli_ctx->mq = GNUNET_MQ_queue_for_server_client (client);
799 GNUNET_SERVER_client_set_user_context (client, cli_ctx);
802 GNUNET_MQ_send (cli_ctx->mq, ev);
807 * Handle RPS request from the client.
810 * @param client identification of the client
811 * @param message the actual message
814 handle_client_request (void *cls,
815 struct GNUNET_SERVER_Client *client,
816 const struct GNUNET_MessageHeader *message)
818 struct GNUNET_RPS_CS_RequestMessage *msg;
820 struct GNUNET_TIME_Relative max_round_duration;
823 /* Estimate request rate */
824 if (request_deltas_size > req_counter)
826 if ( 1 < req_counter)
828 /* Shift last request deltas to the right */
829 memcpy (&request_deltas[1],
831 (req_counter - 1) * sizeof (struct GNUNET_TIME_Relative));
832 /* Add current delta to beginning */
833 request_deltas[0] = GNUNET_TIME_absolute_get_difference (last_request,
834 GNUNET_TIME_absolute_get ());
835 request_rate = T_relative_avg (request_deltas, req_counter);
837 max_round_duration = GNUNET_TIME_relative_add (round_interval,
838 GNUNET_TIME_relative_divide (round_interval, 2));
839 sampler_size_client_need = max_round_duration.rel_value_us / request_rate.rel_value_us;
843 last_request = GNUNET_TIME_absolute_get ();
846 // TODO check message size
847 msg = (struct GNUNET_RPS_CS_RequestMessage *) message;
849 num_peers = ntohl (msg->num_peers);
851 LOG (GNUNET_ERROR_TYPE_DEBUG, "Client requested %" PRIX32 " random peer(s).\n", num_peers);
853 RPS_sampler_get_n_rand_peers (client_respond, client, num_peers, GNUNET_YES);
855 GNUNET_SERVER_receive_done (client,
861 * Handle seed from the client.
864 * @param client identification of the client
865 * @param message the actual message
868 handle_client_seed (void *cls,
869 struct GNUNET_SERVER_Client *client,
870 const struct GNUNET_MessageHeader *message)
872 struct GNUNET_RPS_CS_SeedMessage *in_msg;
873 struct GNUNET_PeerIdentity *peers;
876 if (sizeof (struct GNUNET_RPS_CS_SeedMessage) < ntohs (message->size))
879 GNUNET_SERVER_receive_done (client,
882 in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
883 if ((ntohs (message->size) - sizeof (struct GNUNET_RPS_CS_SeedMessage)) /
884 sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
887 GNUNET_SERVER_receive_done (client,
891 in_msg = (struct GNUNET_RPS_CS_SeedMessage *) message;
892 peers = (struct GNUNET_PeerIdentity *) &message[1];
894 for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
895 RPS_sampler_update_list (&peers[i]);
897 GNUNET_SERVER_receive_done (client,
903 * Handle a PUSH message from another peer.
905 * Check the proof of work and store the PeerID
906 * in the temporary list for pushed PeerIDs.
909 * @param channel The channel the PUSH was received over
910 * @param channel_ctx The context associated with this channel
911 * @param msg The message header
914 handle_peer_push (void *cls,
915 struct GNUNET_CADET_Channel *channel,
917 const struct GNUNET_MessageHeader *msg)
919 const struct GNUNET_PeerIdentity *peer;
921 // (check the proof of work)
923 peer = (const struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel, GNUNET_CADET_OPTION_PEER);
924 // FIXME wait for cadet to change this function
925 LOG (GNUNET_ERROR_TYPE_DEBUG, "PUSH received (%s)\n", GNUNET_i2s (peer));
927 /* Add the sending peer to the push_list */
928 if (GNUNET_NO == in_arr (push_list, pull_list_size, peer))
929 GNUNET_array_append (push_list, push_list_size, *peer);
935 * Handle PULL REQUEST request message from another peer.
937 * Reply with the gossip list of PeerIDs.
940 * @param channel The channel the PUSH was received over
941 * @param channel_ctx The context associated with this channel
942 * @param msg The message header
945 handle_peer_pull_request (void *cls,
946 struct GNUNET_CADET_Channel *channel,
948 const struct GNUNET_MessageHeader *msg)
950 struct GNUNET_PeerIdentity *peer;
951 struct GNUNET_MQ_Handle *mq;
952 struct GNUNET_MQ_Envelope *ev;
953 struct GNUNET_RPS_P2P_PullReplyMessage *out_msg;
956 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (channel,
957 GNUNET_CADET_OPTION_PEER);
958 // FIXME wait for cadet to change this function
959 LOG (GNUNET_ERROR_TYPE_DEBUG,
960 "PULL REQUEST from peer %s received, going to send %u peers\n",
961 GNUNET_i2s (peer), gossip_list_size);
963 mq = get_mq (peer_map, peer);
965 ev = GNUNET_MQ_msg_extra (out_msg,
966 gossip_list_size * sizeof (struct GNUNET_PeerIdentity),
967 GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY);
968 //out_msg->num_peers = htonl (gossip_list_size);
969 out_msg->num_peers = htonl (gossip_list_size);
970 memcpy (&out_msg[1], gossip_list,
971 gossip_list_size * sizeof (struct GNUNET_PeerIdentity));
973 GNUNET_MQ_send (mq, ev);
979 * Handle PULL REPLY message from another peer.
981 * Check whether we sent a corresponding request and
982 * whether this reply is the first one.
985 * @param channel The channel the PUSH was received over
986 * @param channel_ctx The context associated with this channel
987 * @param msg The message header
990 handle_peer_pull_reply (void *cls,
991 struct GNUNET_CADET_Channel *channel,
993 const struct GNUNET_MessageHeader *msg)
995 LOG (GNUNET_ERROR_TYPE_DEBUG, "PULL REPLY received\n");
997 struct GNUNET_RPS_P2P_PullReplyMessage *in_msg;
998 struct GNUNET_PeerIdentity *peers;
999 struct PeerContext *peer_ctx;
1000 struct GNUNET_PeerIdentity *sender;
1001 struct PeerContext *sender_ctx;
1002 struct PeerOutstandingOp out_op;
1005 if (sizeof (struct GNUNET_RPS_P2P_PullReplyMessage) > ntohs (msg->size))
1007 GNUNET_break_op (0); // At the moment our own implementation seems to break that.
1008 return GNUNET_SYSERR;
1010 in_msg = (struct GNUNET_RPS_P2P_PullReplyMessage *) msg;
1011 if ((ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity) != ntohl (in_msg->num_peers))
1013 LOG (GNUNET_ERROR_TYPE_ERROR, "message says it sends %" PRIu64 " peers, have space for %i peers\n",
1014 ntohl (in_msg->num_peers),
1015 (ntohs (msg->size) - sizeof (struct GNUNET_RPS_P2P_PullReplyMessage)) / sizeof (struct GNUNET_PeerIdentity));
1016 GNUNET_break_op (0);
1017 return GNUNET_SYSERR;
1020 sender = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1021 (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1022 // Guess simply casting isn't the nicest way...
1023 // FIXME wait for cadet to change this function
1024 sender_ctx = get_peer_ctx (peer_map, sender);
1026 if (0 == (peer_ctx->peer_flags || PULL_REPLY_PENDING))
1028 GNUNET_break_op (0);
1032 peers = (struct GNUNET_PeerIdentity *) &msg[1];
1033 for ( i = 0 ; i < ntohl (in_msg->num_peers) ; i++ )
1035 peer_ctx = get_peer_ctx (peer_map, &peers[i]);
1036 if ((0 != (peer_ctx->peer_flags && LIVING)) ||
1037 NULL != peer_ctx->recv_channel)
1039 if (GNUNET_NO == in_arr (pull_list, pull_list_size, &peers[i]))
1040 GNUNET_array_append (pull_list, pull_list_size, peers[i]);
1042 else if (GNUNET_NO == insert_in_pull_list_scheduled (peer_ctx))
1044 out_op.op = insert_in_pull_list;
1045 GNUNET_array_append (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, out_op);
1049 sender_ctx->peer_flags &= (~PULL_REPLY_PENDING);
1050 rem_from_list (pending_pull_reply_list, &pending_pull_reply_list_size, sender);
1057 * Send out PUSHes and PULLs.
1059 * This is executed regylary.
1062 do_round (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1064 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to execute next round\n");
1067 //unsigned int *n_arr;
1068 unsigned int n_peers; /* Number of peers we send pushes/pulls to */
1069 struct GNUNET_MQ_Envelope *ev;
1070 const struct GNUNET_PeerIdentity *peer;
1071 struct GNUNET_MQ_Handle *mq;
1073 // TODO log lists, ...
1076 /* Would it make sense to have one shuffeled gossip list and then
1077 * to send PUSHes to first alpha peers, PULL requests to next beta peers and
1078 * use the rest to update sampler?
1079 * in essence get random peers with consumption */
1082 //n_arr = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) gossip_list_size);
1083 if (0 != gossip_list_size)
1085 n_peers = round (alpha * gossip_list_size);
1088 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pushes to %u (%f * %u) peers.\n",
1089 n_peers, alpha, gossip_list_size);
1090 for ( i = 0 ; i < n_peers ; i++ )
1093 peer = get_rand_peer_ignore_list (gossip_list, gossip_list_size,
1097 if (own_identity != peer) // TODO
1098 { // FIXME if this fails schedule/loop this for later
1099 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PUSH to peer %s of gossiped list.\n", GNUNET_i2s (peer));
1101 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PUSH);
1102 // FIXME sometimes it returns a pointer to a freed mq
1103 mq = get_mq (peer_map, peer);
1104 GNUNET_MQ_send (mq, ev);
1111 /* Send PULL requests */
1112 //n_arr = GNUNET_CRYPTO_random_permute (GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list->size);
1113 if (0 != gossip_list_size)
1115 n_peers = round (beta * gossip_list_size);
1118 LOG (GNUNET_ERROR_TYPE_DEBUG, "Going to send pulls to %u (%f * %u) peers.\n",
1119 n_peers, beta, gossip_list_size);
1120 for ( i = 0 ; i < n_peers ; i++ )
1122 peer = get_rand_peer_ignore_list (gossip_list, gossip_list_size,
1123 pending_pull_reply_list, pending_pull_reply_list_size);
1126 GNUNET_array_append (pending_pull_reply_list, pending_pull_reply_list_size, *peer);
1128 if (own_identity != peer)
1129 { // FIXME if this fails schedule/loop this for later
1130 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending PULL request to peer %s of gossiped list.\n", GNUNET_i2s (peer));
1132 ev = GNUNET_MQ_msg_header (GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST);
1134 mq = get_mq (peer_map, peer);
1135 GNUNET_MQ_send (mq, ev);
1142 /* Update gossip list */
1145 if ( push_list_size <= alpha * gossip_list_size &&
1146 push_list_size != 0 &&
1147 pull_list_size != 0 )
1149 LOG (GNUNET_ERROR_TYPE_DEBUG, "Update of the gossip list.\n");
1151 uint32_t first_border;
1152 uint32_t second_border;
1154 first_border = round (alpha * sampler_size_est_need);
1155 second_border = first_border + round (beta * sampler_size_est_need);
1157 GNUNET_array_grow (gossip_list, gossip_list_size, second_border);
1159 for ( i = 0 ; i < first_border ; i++ )
1160 { // TODO use RPS_sampler_get_n_rand_peers
1161 /* Update gossip list with peers received through PUSHes */
1162 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
1164 gossip_list[i] = push_list[r_index];
1165 // TODO change the peer_flags accordingly
1168 for ( i = first_border ; i < second_border ; i++ )
1170 /* Update gossip list with peers received through PULLs */
1171 r_index = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_STRONG,
1173 gossip_list[i] = pull_list[r_index];
1174 // TODO change the peer_flags accordingly
1177 for ( i = second_border ; i < gossip_list_size ; i++ )
1179 /* Update gossip list with peers from history */
1180 RPS_sampler_get_n_rand_peers (hist_update, NULL, 1, GNUNET_NO);
1181 num_hist_update_tasks++;
1182 // TODO change the peer_flags accordingly
1188 LOG (GNUNET_ERROR_TYPE_DEBUG, "No update of the gossip list. ()\n");
1190 // TODO independent of that also get some peers from CADET_get_peers()?
1193 /* Update samplers */
1195 for ( i = 0 ; i < push_list_size ; i++ )
1197 RPS_sampler_update_list (&push_list[i]);
1198 // TODO set in_flag?
1201 for ( i = 0 ; i < pull_list_size ; i++ )
1203 RPS_sampler_update_list (&pull_list[i]);
1204 // TODO set in_flag?
1208 /* Empty push/pull lists */
1209 GNUNET_array_grow (push_list, push_list_size, 0);
1210 GNUNET_array_grow (pull_list, pull_list_size, 0);
1212 struct GNUNET_TIME_Relative time_next_round;
1213 struct GNUNET_TIME_Relative half_round_interval;
1214 unsigned int rand_delay;
1216 /* Compute random time value between .5 * round_interval and 1.5 *round_interval */
1217 half_round_interval = GNUNET_TIME_relative_divide (round_interval, 2);
1221 * Compute random value between (0 and 1) * round_interval
1222 * via multiplying round_interval with a 'fraction' (0 to value)/value
1224 rand_delay = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, UINT_MAX/10);
1225 time_next_round = GNUNET_TIME_relative_multiply (round_interval, rand_delay);
1226 time_next_round = GNUNET_TIME_relative_divide (time_next_round, UINT_MAX/10);
1227 time_next_round = GNUNET_TIME_relative_add (time_next_round, half_round_interval);
1228 } while (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == time_next_round.rel_value_us);
1230 /* Schedule next round */
1231 do_round_task = GNUNET_SCHEDULER_add_delayed (round_interval, &do_round, NULL);
1232 LOG (GNUNET_ERROR_TYPE_DEBUG, "Finished round\n");
1237 * Open a connection to given peer and store channel and mq.
1240 insertCB (void *cls, const struct GNUNET_PeerIdentity *id)
1242 // We open a channel to be notified when this peer goes down.
1243 (void) get_channel (peer_map, id);
1248 * Close the connection to given peer and delete channel and mq.
1251 removeCB (void *cls, const struct GNUNET_PeerIdentity *id)
1254 struct PeerContext *ctx;
1256 s = RPS_sampler_count_id (id);
1259 if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (peer_map, id))
1261 ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, id);
1262 if (NULL != ctx->send_channel)
1264 if (NULL != ctx->mq)
1266 GNUNET_MQ_destroy (ctx->mq);
1268 // may already be freed at shutdown of cadet
1269 //GNUNET_CADET_channel_destroy (ctx->send_channel);
1271 // TODO cleanup peer
1272 (void) GNUNET_CONTAINER_multipeermap_remove_all (peer_map, id);
1278 rps_start (struct GNUNET_SERVER_Handle *server);
1281 * This is called from GNUNET_CADET_get_peers().
1283 * It is called on every peer(ID) that cadet somehow has contact with.
1284 * We use those to initialise the sampler.
1287 init_peer_cb (void *cls,
1288 const struct GNUNET_PeerIdentity *peer,
1289 int tunnel, // "Do we have a tunnel towards this peer?"
1290 unsigned int n_paths, // "Number of known paths towards this peer"
1291 unsigned int best_path) // "How long is the best path?
1292 // (0 = unknown, 1 = ourselves, 2 = neighbor)"
1294 struct GNUNET_SERVER_Handle *server;
1295 struct PeerOutstandingOp out_op;
1296 struct PeerContext *peer_ctx;
1298 server = (struct GNUNET_SERVER_Handle *) cls;
1301 LOG (GNUNET_ERROR_TYPE_DEBUG,
1302 "Got peer %s (at %p) from CADET (gossip_list_size: %u)\n",
1303 GNUNET_i2s (peer), peer, gossip_list_size);
1305 // maybe create a function for that
1306 peer_ctx = get_peer_ctx (peer_map, peer);
1307 if (GNUNET_NO == insert_in_sampler_scheduled (peer_ctx))
1309 out_op.op = insert_in_sampler;
1310 GNUNET_array_append (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, out_op);
1313 if (GNUNET_NO == insert_in_gossip_list_scheduled (peer_ctx))
1315 out_op.op = insert_in_gossip_list;
1316 GNUNET_array_append (peer_ctx->outstanding_ops, peer_ctx->num_outstanding_ops, out_op);
1319 /* Issue livelyness test on peer */
1320 (void) get_channel (peer_map, peer);
1322 // send push/pull to each of those peers?
1330 * Callback used to clean the multipeermap.
1333 peer_remove_cb (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
1335 struct PeerContext *peer_ctx;
1337 peer_ctx = (struct PeerContext *) value;
1339 if ( NULL != peer_ctx->mq)
1340 GNUNET_MQ_destroy (peer_ctx->mq);
1342 if ( NULL != peer_ctx->is_live_task)
1343 GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->is_live_task);
1345 if ( NULL != peer_ctx->send_channel)
1346 GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1348 if ( NULL != peer_ctx->recv_channel)
1349 GNUNET_CADET_channel_destroy (peer_ctx->recv_channel);
1351 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_remove_all (peer_map, key))
1352 LOG (GNUNET_ERROR_TYPE_WARNING, "removing peer from peer_map failed\n");
1359 * Task run during shutdown.
1365 shutdown_task (void *cls,
1366 const struct GNUNET_SCHEDULER_TaskContext *tc)
1368 LOG (GNUNET_ERROR_TYPE_DEBUG, "RPS is going down\n");
1370 if ( NULL != do_round_task )
1372 GNUNET_SCHEDULER_cancel (do_round_task);
1373 do_round_task = NULL;
1377 if (GNUNET_SYSERR == GNUNET_CONTAINER_multipeermap_iterate (peer_map, peer_remove_cb, NULL))
1378 LOG (GNUNET_ERROR_TYPE_WARNING,
1379 "Iterating over peers to disconnect from them was cancelled\n");
1381 GNUNET_CONTAINER_multipeermap_destroy (peer_map);
1383 GNUNET_NSE_disconnect (nse);
1384 GNUNET_CADET_disconnect (cadet_handle);
1385 GNUNET_free (own_identity);
1386 RPS_sampler_destroy ();
1387 GNUNET_array_grow (request_deltas, request_deltas_size, 0);
1388 GNUNET_array_grow (gossip_list, gossip_list_size, 0);
1389 GNUNET_array_grow (push_list, push_list_size, 0);
1390 GNUNET_array_grow (pull_list, pull_list_size, 0);
1395 * A client disconnected. Remove all of its data structure entries.
1397 * @param cls closure, NULL
1398 * @param client identification of the client
1401 handle_client_disconnect (void *cls,
1402 struct GNUNET_SERVER_Client * client)
1407 * Handle the channel a peer opens to us.
1409 * @param cls The closure
1410 * @param channel The channel the peer wants to establish
1411 * @param initiator The peer's peer ID
1412 * @param port The port the channel is being established over
1413 * @param options Further options
1416 handle_inbound_channel (void *cls,
1417 struct GNUNET_CADET_Channel *channel,
1418 const struct GNUNET_PeerIdentity *initiator,
1420 enum GNUNET_CADET_ChannelOption options)
1422 struct PeerContext *ctx;
1424 LOG (GNUNET_ERROR_TYPE_DEBUG,
1425 "New channel was established to us (Peer %s).\n",
1426 GNUNET_i2s (initiator));
1428 GNUNET_assert (NULL != channel);
1430 // we might not even store the recv_channel
1432 ctx = get_peer_ctx (peer_map, initiator);
1433 if (NULL != ctx->recv_channel)
1435 ctx->recv_channel = channel;
1438 // FIXME there might already be an established channel
1440 //ctx->peer_flags = IN_OTHER_GOSSIP_LIST;
1441 ctx->mq = NULL; // TODO create mq?
1443 (void) GNUNET_CONTAINER_multipeermap_put (peer_map, initiator, ctx,
1444 GNUNET_CONTAINER_MULTIHASHMAPOPTION_REPLACE);
1445 return NULL; // TODO
1449 * This is called when a remote peer destroys a channel.
1451 * @param cls The closure
1452 * @param channel The channel being closed
1453 * @param channel_ctx The context associated with this channel
1456 cleanup_channel (void *cls,
1457 const struct GNUNET_CADET_Channel *channel,
1460 struct GNUNET_PeerIdentity *peer;
1461 struct PeerContext *peer_ctx;
1463 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel to remote peer was destroyed.\n");
1465 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1466 (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1467 // Guess simply casting isn't the nicest way...
1468 // FIXME wait for cadet to change this function
1469 RPS_sampler_reinitialise_by_value (peer);
1471 peer_ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
1472 /* Somwewhat {ab,re}use the iterator function */
1473 (void) peer_remove_cb (peer, peer, peer_ctx);
1478 * Actually start the service.
1481 rps_start (struct GNUNET_SERVER_Handle *server)
1483 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1484 {&handle_client_request, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST,
1485 sizeof (struct GNUNET_RPS_CS_RequestMessage)},
1486 {&handle_client_seed, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_SEED, 0},
1490 GNUNET_SERVER_add_handlers (server, handlers);
1491 GNUNET_SERVER_disconnect_notify (server,
1492 &handle_client_disconnect,
1494 LOG (GNUNET_ERROR_TYPE_DEBUG, "Ready to receive requests from clients\n");
1497 num_hist_update_tasks = 0;
1499 do_round_task = GNUNET_SCHEDULER_add_now (&do_round, NULL);
1500 LOG (GNUNET_ERROR_TYPE_DEBUG, "Scheduled first round\n");
1502 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1509 * Process statistics requests.
1511 * @param cls closure
1512 * @param server the initialized server
1513 * @param c configuration to use
1517 struct GNUNET_SERVER_Handle *server,
1518 const struct GNUNET_CONFIGURATION_Handle *c)
1520 // TODO check what this does -- copied from gnunet-boss
1521 // - seems to work as expected
1522 GNUNET_log_setup ("rps", GNUNET_error_type_to_string (GNUNET_ERROR_TYPE_DEBUG), NULL);
1524 LOG (GNUNET_ERROR_TYPE_DEBUG, "RPS started\n");
1531 own_identity = GNUNET_new (struct GNUNET_PeerIdentity);
1532 GNUNET_CRYPTO_get_peer_identity (cfg, own_identity); // TODO check return value
1533 GNUNET_assert (NULL != own_identity);
1534 LOG (GNUNET_ERROR_TYPE_DEBUG, "Own identity is %s (at %p).\n", GNUNET_i2s (own_identity), own_identity);
1537 /* Get time interval from the configuration */
1538 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "RPS",
1542 LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read ROUNDINTERVAL from config\n");
1543 GNUNET_SCHEDULER_shutdown ();
1547 /* Get initial size of sampler/gossip list from the configuration */
1548 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, "RPS",
1550 (long long unsigned int *) &sampler_size_est_need))
1552 LOG (GNUNET_ERROR_TYPE_DEBUG, "Failed to read INITSIZE from config\n");
1553 GNUNET_SCHEDULER_shutdown ();
1556 LOG (GNUNET_ERROR_TYPE_DEBUG, "INITSIZE is %" PRIu64 "\n", sampler_size_est_need);
1562 /* connect to NSE */
1563 nse = GNUNET_NSE_connect (cfg, nse_callback, NULL);
1564 // TODO check whether that was successful
1565 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to NSE\n");
1571 peer_map = GNUNET_CONTAINER_multipeermap_create (sampler_size_est_need, GNUNET_NO);
1574 /* Initialise cadet */
1575 static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1576 {&handle_peer_push , GNUNET_MESSAGE_TYPE_RPS_PP_PUSH ,
1577 sizeof (struct GNUNET_MessageHeader)},
1578 {&handle_peer_pull_request, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST,
1579 sizeof (struct GNUNET_MessageHeader)},
1580 {&handle_peer_pull_reply , GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY , 0},
1584 const uint32_t ports[] = {GNUNET_RPS_CADET_PORT, 0}; // _PORT specified in src/rps/rps.h
1585 cadet_handle = GNUNET_CADET_connect (cfg,
1587 &handle_inbound_channel,
1591 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to CADET\n");
1594 /* Initialise sampler */
1595 struct GNUNET_TIME_Relative half_round_interval;
1596 struct GNUNET_TIME_Relative max_round_interval;
1598 half_round_interval = GNUNET_TIME_relative_multiply (round_interval, .5);
1599 max_round_interval = GNUNET_TIME_relative_add (round_interval, half_round_interval);
1601 RPS_sampler_init (sampler_size_est_need, max_round_interval,
1602 insertCB, NULL, removeCB, NULL);
1603 sampler_size = sampler_size_est_need;
1605 /* Initialise push and pull maps */
1610 pending_pull_reply_list = NULL;
1611 pending_pull_reply_list_size = 0;
1614 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting peers from CADET\n");
1615 GNUNET_CADET_get_peers (cadet_handle, &init_peer_cb, server);
1617 // TODO send push/pull to each of those peers?
1622 * The main function for the rps service.
1624 * @param argc number of arguments from the command line
1625 * @param argv command line arguments
1626 * @return 0 ok, 1 on error
1629 main (int argc, char *const *argv)
1631 return (GNUNET_OK ==
1632 GNUNET_SERVICE_run (argc,
1635 GNUNET_SERVICE_OPTION_NONE,
1636 &run, NULL)) ? 0 : 1;
1639 /* end of gnunet-service-rps.c */