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"
35 #define LOG(kind, ...) GNUNET_log(kind, __VA_ARGS__)
37 // TODO modify @brief in every file
39 // TODO take care that messages are not longer than 64k
41 // TODO check for overflows
43 // TODO align message structs
45 // TODO multipeerlist indep of gossiped list
47 // (TODO api -- possibility of getting weak random peer immideately)
49 // TODO malicious peer
51 // TODO switch Slist -> DLL
56 static const struct GNUNET_CONFIGURATION_Handle *cfg;
61 struct GNUNET_PeerIdentity *own_identity;
64 * Compare two peer identities. Taken from secretsharing.
66 * @param p1 Some peer identity.
67 * @param p2 Some peer identity.
68 * @return 1 if p1 > p2, -1 if p1 < p2 and 0 if p1 == p2.
71 peer_id_cmp (const void *p1, const void *p2)
73 return memcmp (p1, p2, sizeof (struct GNUNET_PeerIdentity));
76 /***********************************************************************
79 * WARNING: This section needs to be reviewed regarding the use of
80 * functions providing (pseudo)randomness!
81 ***********************************************************************/
83 // TODO care about invalid input of the caller (size 0 or less...)
86 * A sampler sampling PeerIDs.
91 * Min-wise linear permutation used by this sampler.
93 * This is an key later used by a hmac.
95 struct GNUNET_CRYPTO_AuthKey auth_key;
98 * The PeerID this sampler currently samples.
100 struct GNUNET_PeerIdentity *peer_id;
103 * The according hash value of this PeerID.
105 struct GNUNET_HashCode peer_id_hash;
108 * Samplers are kept in a linked list.
110 struct Sampler *next;
113 * Samplers are kept in a linked list.
115 struct Sampler *prev;
120 * A n-tuple of samplers.
125 * Number of samplers we hold.
130 * All PeerIDs in one array.
132 struct GNUNET_PeerIdentity peer_ids[];
135 * The head of the DLL.
137 struct Sampler *head;
140 * The tail of the DLL.
142 struct Sampler *tail;
147 typedef void (* SAMPLER_deleteCB) (void *cls, const struct GNUNET_PeerIdentity *id, struct GNUNET_HashCode hash);
150 * (Re)Initialise given Sampler with random min-wise independent function.
152 * In this implementation this means choosing an auth_key for later use in
155 * @param id pointer to the place where this sampler will store the PeerID.
156 * This will be overwritten.
159 SAMPLER_init(struct GNUNET_PeerIdentity *id)
163 s = GNUNET_new(struct Sampler);
165 // I guess I don't need to call GNUNET_CRYPTO_hmac_derive_key()...
166 GNUNET_CRYPTO_random_block(GNUNET_CRYPTO_QUALITY_STRONG,
168 GNUNET_CRYPTO_HASH_LENGTH);
170 //s->peer_id = GNUNET_new( struct GNUNET_PeerIdentity );
171 GNUENT_assert(NULL != id);
173 memcpy(s->peer_id, own_identity, sizeof(struct GNUNET_PeerIdentity));
174 //s->peer_id = own_identity; // Maybe set to own PeerID. So we always have
175 // a valid PeerID in the sampler.
176 // Maybe take a PeerID as second argument.
177 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: initialised with PeerID %s (at %p) \n", GNUNET_i2s(s->peer_id), s->peer_id);
179 GNUNET_CRYPTO_hmac(&s->auth_key, s->peer_id,
180 sizeof(struct GNUNET_PeerIdentity),
190 * Compare two hashes.
192 * Returns if the first one is smaller then the second.
193 * Used by SAMPLER_next() to compare hashes.
196 hash_cmp(struct GNUNET_HashCode hash1, struct GNUNET_HashCode hash2)
198 return memcmp( (const void *) &hash1, (const void *) & hash2, sizeof(struct GNUNET_HashCode));
202 * Input an PeerID into the given sampler.
205 SAMPLER_next(struct Sampler *s, const struct GNUNET_PeerIdentity *id, SAMPLER_deleteCB del_cb, void *cb_cls)
206 // TODO set id in peer_ids
208 struct GNUNET_HashCode other_hash;
210 if ( id == s->peer_id )
212 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Got PeerID %s\n",
214 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Have already PeerID %s\n",
215 GNUNET_i2s(s->peer_id));
219 GNUNET_CRYPTO_hmac(&s->auth_key,
221 sizeof(struct GNUNET_PeerIdentity),
224 if ( NULL == s->peer_id )
225 { // Or whatever is a valid way to say
226 // "we have no PeerID at the moment"
227 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Got PeerID %s; Simply accepting (got NULL previously).\n",
229 memcpy(s->peer_id, id, sizeof(struct GNUNET_PeerIdentity));
231 s->peer_id_hash = other_hash;
233 else if ( 0 > hash_cmp(other_hash, s->peer_id_hash) )
235 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Got PeerID %s\n",
237 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Discarding old PeerID %s\n",
238 GNUNET_i2s(s->peer_id));
240 if ( NULL != del_cb )
242 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Removing old PeerID %s with the delete callback.\n",
243 GNUNET_i2s(s->peer_id));
244 del_cb(cb_cls, s->peer_id, s->peer_id_hash);
247 memcpy(s->peer_id, id, sizeof(struct GNUNET_PeerIdentity));
249 s->peer_id_hash = other_hash;
253 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Got PeerID %s\n",
255 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER: Keeping old PeerID %s\n",
256 GNUNET_i2s(s->peer_id), s->peer_id);
263 * Initialise a tuple of samplers.
266 SAMPLER_samplers_init(size_t init_size)
268 struct Samplers *samplers;
272 samplers = GNUNET_new(struct Samplers);
273 samplers->size = init_size;
274 samplers->head = samplers->tail = NULL;
275 samplers->peer_ids = GNUNET_new_array(init_size, struct GNUNET_PeerIdentity);
277 for ( i = 0 ; i < init_size ; i++ )
279 GNUNET_array_append(samplers->peer_ids,
280 sizeof(struct GNUNET_PeerIdentity),
282 s = SAMPLER_init(&samplers->peer_ids[i]);
283 GNUNET_CONTAINER_DLL_insert_tail(samplers->head,
292 * A fuction to update every sampler in the given list
295 SAMPLER_update_list(struct Samplers *samplers, const struct GNUNET_PeerIdentity *id,
296 SAMPLER_deleteCB del_cb, void *cb_cls)
298 struct Sampler *sampler;
300 sampler = samplers->head;
301 while ( NULL != sampler->next )
303 SAMPLER_next(sampler, id, del_cb, cb_cls);
309 * Get one random peer out of the sampled peers.
311 * We might want to reinitialise this sampler after giving the
312 * corrsponding peer to the client.
314 const struct GNUNET_PeerIdentity*
315 SAMPLER_get_rand_peer (struct Samplers *samplers)
317 LOG(GNUNET_ERROR_TYPE_DEBUG, "SAMPLER_get_rand_peer:\n");
319 if ( 0 == samplers->size )
321 LOG(GNUNET_ERROR_TYPE_DEBUG, "Sgrp: List empty - Returning own PeerID %s\n", GNUNET_i2s(own_identity));
327 struct Sampler *iter;
330 const struct GNUNET_PeerIdentity *peer;
333 * Choose the index of the peer we want to give back
334 * at random from the interval of the sampler list
336 index = GNUNET_CRYPTO_random_u64(GNUNET_CRYPTO_QUALITY_STRONG,
338 // TODO check that it does not overflow
339 LOG(GNUNET_ERROR_TYPE_DEBUG, "Sgrp: Length of Slist: %" PRIu64 ", index: %" PRIu64 "\n", list_size, index);
341 s = sizeof( struct Sampler );
342 iter = samplers->head;
343 for ( i = 0 ; i < index ; i++ )
345 if ( NULL == iter->next )
347 iter = samplers->head;
351 // TODO something missing?
353 peer = iter->peer_id;
354 LOG(GNUNET_ERROR_TYPE_DEBUG, "Sgrp: Returning PeerID %s\n", GNUNET_i2s(peer));
355 LOG(GNUNET_ERROR_TYPE_DEBUG, "Sgrp: (own ID: %s)\n", GNUNET_i2s(own_identity));
362 * Get n random peers out of the sampled peers.
364 * We might want to reinitialise this sampler after giving the
365 * corrsponding peer to the client.
366 * Random with or without consumption?
368 const struct GNUNET_PeerIdentity* // TODO give back simple array
369 SAMPLER_get_n_rand_peers (struct Samplers *samplers, uint64_t n)
371 // TODO check if we have too much (distinct) sampled peers
372 // If we are not ready yet maybe schedule for later
373 const struct GNUNET_PeerIdentity *peers;
376 peers = GNUNET_malloc(n * sizeof(struct GNUNET_PeerIdentity));
378 for ( i = 0 ; i < n ; i++ ) {
379 peers[i] = SAMPLER_get_rand_peer(samplers);
382 // TODO something else missing?
387 * Counts how many Samplers currently hold a given PeerID.
390 SAMPLER_count_id ( struct Samplers *samplers, struct GNUNET_PeerIdentity *id )
392 struct Sampler *iter;
395 iter = samplers->head;
397 while ( NULL != iter )
399 if ( peer_id_cmp( iter->peer_id, id) )
407 * Gow the size of the tuple of samplers.
410 SAMPLER_samplers_grow (struct Samplers * samplers, size_t new_size)
415 if ( new_size > samplers->size )
417 GNUNET_array_grow(samplers->peer_ids, samplers->size, new_size);
418 for ( i = 0 ; i < new_size - samplers-size ; i++ )
420 sampler = SAMPLER_init(&samplers->peer_ids[samplers->size + i]);
421 GNUNET_CONTAINER_DLL_insert_tail(samplers->head, samplers->tail, sampler);
424 else if ( new_size < samplers->size )
426 for ( i = 0 ; i < samplers->size - new_size ; i++)
428 // TODO call delCB on elem?
429 GNUNET_CONTAINER_DLL_remove(samplers->head, samplers->tail, samplers->tail);
431 GNUNET_array_grow(samplers->peer_ids, samplers->size, new_size);
434 samplers->size = new_size;
437 /***********************************************************************
439 ***********************************************************************/
443 /***********************************************************************
445 ***********************************************************************/
448 * A struct that just holds the PeerID.
455 struct GNUNET_PeerIdentity *id;
459 * A DLL holding PeerIDs.
464 * The size of the list.
471 struct GNUNET_PeerIdentity *peer_ids;
476 struct PeerEntry *head;
481 struct PeerEntry *tail;
485 * Give back an empty PeerList.
490 struct PeerList *peer_list;
492 peer_list = GNUNET_new(struct PeerList);
494 peer_list->peer_ids = NULL;
495 peer_list->head = peer_list->tail = NULL;
501 * Put one PeerID into the given PeerList.
504 PeerList_put(struct PeerList *peer_list, struct GNUNET_PeerIdentity *id)
509 // * Get one random peer out of the gossiped peer list.
511 // struct GNUNET_PeerIdentity *
512 //get_random_peer(struct GNUNET_CONTAINER_MultiPeerMap * lst)
515 // struct GNUNET_CONTAINER_MultiPeerMapIterator *iter;
518 // struct GNUNET_PeerIdentity *peer;
520 // n = (size_t) GNUNET_CONTAINER_multipeermap_size(lst);
521 // index = GNUNET_CRYPTO_random_u64(GNUNET_CRYPTO_QUALITY_STRONG,
523 // iter = GNUNET_CONTAINER_multipeermap_iterator_create(lst);
525 // for ( i = 0 ; i < index ; i++ ) {
526 // GNUNET_CONTAINER_multipeermap_iterator_next(iter, NULL, NULL);
529 // peer = GNUNET_malloc(sizeof(struct GNUNET_PeerIdentity));
530 // GNUNET_CONTAINER_multipeermap_iterator_next(iter, peer, NULL);
536 /***********************************************************************
538 ***********************************************************************/
542 /***********************************************************************
543 * Housekeeping with peers
544 ***********************************************************************/
547 * Struct used to store the context of a connected client.
552 * The message queue to communicate with the client.
554 struct GNUNET_MQ_Handle *mq;
558 * Used to keep track in what lists single peerIDs are.
560 enum in_list_flag // probably unneeded
562 in_other_sampler_list = 0x1,
563 in_other_gossip_list = 0x2, // unneeded?
564 in_own_sampler_list = 0x4,
565 in_own_gossip_list = 0x8 // unneeded?
569 * Struct used to keep track of other peer's status
571 * This is stored in a multipeermap.
576 * In own gossip/sampler list, in other's gossip/sampler list
578 uint32_t in_flags; // unneeded?
581 * Message queue open to client
583 struct GNUNET_MQ_Handle *mq;
586 * Channel open to client.
588 struct GNUNET_CADET_Channel *to_channel;
591 * Channel open from client.
593 struct GNUNET_CADET_Channel *from_channel; // unneeded
596 * This is pobably followed by 'statistical' data (when we first saw
597 * him, how did we get his ID, how many pushes (in a timeinterval),
602 /***********************************************************************
603 * /Housekeeping with peers
604 ***********************************************************************/
607 * Set of all peers to keep track of them.
609 static struct GNUNET_CONTAINER_MultiPeerMap *peer_map;
612 // -- gossip list length --
613 // Depends on the (estimated) size of the
614 // network. - Initial size might be the
615 // number of peers cadet provides.
616 // TODO other events to grow/shrink size?
619 * List of samplers // TODO get rid of that
621 struct GNUNET_CONTAINER_SList *sampler_list;
626 struct Samplers *samplers; // TODO rename to sampler_list
629 * Sampler list size // TODO get rid of that
631 * Adapts to the nse. Size should be in BigTheta(network_size)^(1/3).
633 size_t sampler_list_size;
637 * The gossiped list of peers.
639 struct GNUNET_PeerIdentity *gossip_list;
642 * Size of the gossiped list
644 unsigned int gossip_list_size;
647 * Min size of the gossip list
649 uint64_t gossip_list_min_size;
652 // * Max size of the gossip list
654 // * This will probably be left to be set by the client.
656 //uint64_t gossip_list_max_size;
660 * The estimated size of the network.
662 * Influenced by the stdev.
669 * Percentage of total peer number in the gossip list
670 * to send random PUSHes to
675 * Percentage of total peer number in the gossip list
676 * to send random PULLs to
681 * The percentage gamma of history updates.
682 * Simply 1 - alpha - beta
689 * Identifier for the main task that runs periodically.
691 GNUNET_SCHEDULER_TaskIdentifier do_round_task;
694 * Time inverval the do_round task runs in.
696 struct GNUNET_TIME_Relative round_interval;
701 * List to store peers received through pushes temporary.
703 struct GNUNET_CONTAINER_SList *push_list;
706 * List to store peers received through pulls temporary.
708 struct GNUNET_CONTAINER_SList *pull_list;
714 struct GNUNET_NSE_Handle *nse;
719 struct GNUNET_CADET_Handle *cadet_handle;
722 /***********************************************************************
724 ***********************************************************************/
727 * Get random peer from the gossip list.
729 struct GNUNET_PeerIdentity *
730 get_rand_gossip_peer()
733 struct GNUNET_PeerIdentity *peer;
735 // TODO find a better solution.
736 // FIXME if we have only own ID in gossip list this will block
737 // but then we might have a problem nevertheless ?
742 * Choose the index of the peer we want to return
743 * at random from the interval of the gossip list
745 index = GNUNET_CRYPTO_random_u64(GNUNET_CRYPTO_QUALITY_STRONG,
748 peer = &(gossip_list[index]);
749 } while ( own_identity == peer || NULL == peer );
755 * Get the message queue of a specific peer.
757 * If we already have a message queue open to this client,
758 * simply return it, otherways create one.
760 struct GNUNET_MQ_Handle *
761 get_mq (struct GNUNET_CONTAINER_MultiPeerMap *peer_map, struct GNUNET_PeerIdentity *peer_id)
763 struct peer_context *ctx;
764 struct GNUNET_MQ_Handle * mq;
765 struct GNUNET_CADET_Channel *channel;
767 if ( GNUNET_OK != GNUNET_CONTAINER_multipeermap_contains( peer_map, peer_id ) ) {
769 channel = GNUNET_CADET_channel_create(cadet_handle, NULL, peer_id,
770 GNUNET_RPS_CADET_PORT,
771 GNUNET_CADET_OPTION_RELIABLE);
772 mq = GNUNET_CADET_mq_create(channel);
774 ctx = GNUNET_malloc(sizeof(struct peer_context));
776 ctx->to_channel = channel;
779 GNUNET_CONTAINER_multipeermap_put(peer_map, peer_id, ctx,
780 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
782 ctx = GNUNET_CONTAINER_multipeermap_get(peer_map, peer_id);
783 if ( NULL == ctx->mq ) {
784 if ( NULL == ctx->to_channel ) {
785 channel = GNUNET_CADET_channel_create(cadet_handle, NULL, peer_id,
786 GNUNET_RPS_CADET_PORT,
787 GNUNET_CADET_OPTION_RELIABLE);
788 ctx->to_channel = channel;
791 mq = GNUNET_CADET_mq_create(ctx->to_channel);
800 /***********************************************************************
802 ***********************************************************************/
805 * Function called by NSE.
807 * Updates sizes of sampler list and gossip list and adapt those lists
811 nse_callback(void *cls, struct GNUNET_TIME_Absolute timestamp, double logestimate, double std_dev)
814 //double scale; // TODO this might go gloabal/config
816 LOG(GNUNET_ERROR_TYPE_DEBUG, "Received a ns estimate - logest: %f, std_dev: %f\n", logestimate, std_dev);
818 estimate = 1 << (uint64_t) round(logestimate);
819 // GNUNET_NSE_log_estimate_to_n (logestimate);
820 estimate = pow(estimate, 1./3);// * (std_dev * scale); // TODO add
821 if ( 0 < estimate ) {
822 LOG(GNUNET_ERROR_TYPE_DEBUG, "Changing estimate to %f\n", estimate);
825 LOG(GNUNET_ERROR_TYPE_DEBUG, "Not using estimate %f\n", estimate);
830 * Handle RPS request from the client.
833 * @param client identification of the client
834 * @param message the actual message
838 handle_cs_request (void *cls,
839 struct GNUNET_SERVER_Client *client,
840 const struct GNUNET_MessageHeader *message)
842 LOG(GNUNET_ERROR_TYPE_DEBUG, "Client requested (a) random peer(s).\n");
844 struct GNUNET_RPS_CS_RequestMessage *msg;
845 //unsigned int n_arr[sampler_list_size];// =
846 //GNUNET_CRYPTO_random_permute(GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list_size);
847 //struct GNUNET_MQ_Handle *mq;
848 struct client_ctx *cli_ctx;
849 struct GNUNET_MQ_Envelope *ev;
850 struct GNUNET_RPS_CS_ReplyMessage *out_msg;
855 msg = (struct GNUNET_RPS_CS_RequestMessage *) message;
856 // Does not work because the compiler seems not to find it.
857 cli_ctx = GNUNET_SERVER_client_get_user_context(client, struct client_ctx);
858 if ( NULL == cli_ctx ) {
859 cli_ctx = GNUNET_new(struct client_ctx);
860 cli_ctx->mq = GNUNET_MQ_queue_for_server_client(client);
861 GNUNET_SERVER_client_set_user_context(client, cli_ctx);
864 //mq = GNUNET_MQ_queue_for_server_client(client);
866 // TODO How many peers do we give back?
867 // Wait until we have enough random peers?
869 ev = GNUNET_MQ_msg_extra(out_msg,
870 GNUNET_ntohll(msg->num_peers) * sizeof(struct GNUNET_PeerIdentity),
871 GNUNET_MESSAGE_TYPE_RPS_CS_REPLY);
872 out_msg->num_peers = GNUNET_ntohll(msg->num_peers);
874 num_peers = GNUNET_ntohll(msg->num_peers);
875 //&out_msg[1] = SAMPLER_get_n_rand_peers(sampler_list, num_peers);
876 for ( i = 0 ; i < num_peers ; i++ ) {
877 memcpy(&out_msg[1] + i * sizeof(struct GNUNET_PeerIdentity),
878 SAMPLER_get_rand_peer(sampler_list),
879 sizeof(struct GNUNET_PeerIdentity));
882 GNUNET_MQ_send(cli_ctx->mq, ev);
883 //GNUNET_MQ_send(mq, ev);
884 //GNUNET_MQ_destroy(mq);
886 GNUNET_SERVER_receive_done (client,
891 * Handle a PUSH message from another peer.
893 * Check the proof of work and store the PeerID
894 * in the temporary list for pushed PeerIDs.
897 * @param channel The channel the PUSH was received over
898 * @param channel_ctx The context associated with this channel
899 * @param msg The message header
902 handle_peer_push (void *cls,
903 struct GNUNET_CADET_Channel *channel,
905 const struct GNUNET_MessageHeader *msg)
907 LOG(GNUNET_ERROR_TYPE_DEBUG, "PUSH received\n");
909 struct GNUNET_PeerIdentity *peer;
911 // TODO check the proof of work
912 // and check limit for PUSHes
913 // IF we count per peer PUSHes
914 // maybe remove from gossip/sampler list
916 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info( channel, GNUNET_CADET_OPTION_PEER );
918 /* Add the sending peer to the push_list */
919 GNUNET_CONTAINER_slist_add(push_list,
920 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT,
921 peer, sizeof(struct GNUNET_PeerIdentity));
927 * Handle PULL REQUEST request message from another peer.
929 * Reply with the gossip list of PeerIDs.
932 * @param channel The channel the PUSH was received over
933 * @param channel_ctx The context associated with this channel
934 * @param msg The message header
937 handle_peer_pull_request (void *cls,
938 struct GNUNET_CADET_Channel *channel,
940 const struct GNUNET_MessageHeader *msg)
943 struct GNUNET_PeerIdentity *peer;
944 struct GNUNET_MQ_Handle *mq;
945 //struct GNUNET_RPS_P2P_PullRequestMessage *in_msg;
946 struct GNUNET_MQ_Envelope *ev;
947 struct GNUNET_RPS_P2P_PullReplyMessage *out_msg;
949 // TODO find some way to keep one peer from spamming with pull requests
950 // allow only one request per time interval ?
951 // otherwise remove from peerlist?
953 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info(channel, GNUNET_CADET_OPTION_PEER);
954 LOG(GNUNET_ERROR_TYPE_DEBUG, "PULL REQUEST from peer %s received\n", GNUNET_i2s(peer));
956 mq = GNUNET_CADET_mq_create(channel); // TODO without mq?
957 //mq = get_mq(peer_map, peer);
959 //in_msg = (struct GNUNET_RPS_P2P_PullRequestMessage *) msg;
960 // TODO how many peers do we actually send?
961 // GNUNET_ntohll(in_msg->num_peers)
962 ev = GNUNET_MQ_msg_extra(out_msg,
963 gossip_list_size * sizeof(struct GNUNET_PeerIdentity),
964 GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY);
965 out_msg->num_peers = GNUNET_htonll(gossip_list_size);
966 memcpy(&out_msg[1], gossip_list,
967 gossip_list_size * sizeof(struct GNUNET_PeerIdentity));
969 GNUNET_MQ_send(mq, ev);
971 GNUNET_MQ_destroy(mq);
978 * Handle PULL REPLY message from another peer.
980 * Check whether we sent a corresponding request and
981 * whether this reply is the first one.
984 * @param channel The channel the PUSH was received over
985 * @param channel_ctx The context associated with this channel
986 * @param msg The message header
989 handle_peer_pull_reply (void *cls,
990 struct GNUNET_CADET_Channel *channel,
992 const struct GNUNET_MessageHeader *msg)
994 LOG(GNUNET_ERROR_TYPE_DEBUG, "PULL REPLY received\n");
996 struct GNUNET_RPS_P2P_PullReplyMessage *in_msg;
999 // TODO check that we sent a request and that it is the first reply
1001 in_msg = (struct GNUNET_RPS_P2P_PullReplyMessage *) msg;
1002 for ( i = 0 ; i < in_msg->num_peers ; i++ ) {
1003 GNUNET_CONTAINER_slist_add(pull_list,
1004 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT,
1005 &in_msg[1] + i * sizeof(struct GNUNET_PeerIdentity),
1006 sizeof(struct GNUNET_PeerIdentity));
1009 // TODO maybe a disconnect happens here
1016 * Callback called when a Sampler is updated.
1019 delete_cb (void *cls, struct GNUNET_PeerIdentity *id, struct GNUNET_HashCode hash)
1023 //s = SAMPLER_count_id(samplers, id); // TODO
1024 s = SAMPLER_count_id(sampler_list, id);
1026 // TODO cleanup peer
1027 GNUNET_CONTAINER_multipeermap_remove_all( peer_map, id);
1033 * Send out PUSHes and PULLs.
1035 * This is executed regylary.
1038 do_round(void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1040 LOG(GNUNET_ERROR_TYPE_DEBUG, "Going to execute next round\n");
1044 struct GNUNET_CONTAINER_SList_Iterator *iter;
1045 //unsigned int *n_arr;
1046 struct GNUNET_RPS_P2P_PushMessage *push_msg;
1047 struct GNUNET_RPS_P2P_PullRequestMessage *pull_msg; // FIXME Send empty message
1048 struct GNUNET_MQ_Envelope *ev;
1049 struct GNUNET_PeerIdentity *peer;
1051 // TODO print lists, ...
1052 // TODO cleanup peer_map
1054 iter = GNUNET_new(struct GNUNET_CONTAINER_SList_Iterator);
1057 /* If the NSE has changed adapt the lists accordingly */
1058 // TODO check nse == 0!
1059 LOG(GNUNET_ERROR_TYPE_DEBUG, "Checking size estimate.\n");
1060 SAMPLER_samplers_grow(samplers, est_size);
1061 //if ( sampler_list_size < est_size ) {
1062 // LOG(GNUNET_ERROR_TYPE_DEBUG, "Growing size.\n");
1063 // /* Grow the lists. */
1064 // for ( i = 0 ; i < est_size - sampler_list_size ; i++ ) {
1065 // s = SAMPLER_init();
1066 // GNUNET_CONTAINER_slist_add_end(sampler_list,
1067 // GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT, // DEPRECATED
1069 // sizeof(struct Sampler));
1071 // // TODO add peers to gossiped ones?
1073 //} else if ( sampler_list_size > est_size ) {
1074 // LOG(GNUNET_ERROR_TYPE_DEBUG, "Shrinking size.\n");
1075 // /* Shrink the lists. */
1076 // for ( i = 0 ; i < sampler_list_size - est_size ; i++ ) {
1077 // *iter = GNUNET_CONTAINER_slist_begin(sampler_list);
1078 // GNUNET_CONTAINER_slist_erase(iter);
1079 // GNUNET_CONTAINER_slist_iter_destroy(iter); // Maybe unneeded but I don't know whether _erase() also deletes the iter
1083 GNUNET_array_grow(gossip_list, gossip_list_size, est_size); // FIXME Do conversion correct or change type
1085 gossip_list_size = sampler_list_size = est_size;
1090 /* Would it make sense to have one shuffeled gossip list and then
1091 * to send PUSHes to first alpha peers, PULL requests to next beta peers and
1092 * use the rest to update sampler? */
1095 //n_arr = GNUNET_CRYPTO_random_permute(GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) gossip_list_size);
1096 LOG(GNUNET_ERROR_TYPE_DEBUG, "Going to send pushes to %f (%f * %" PRIu64 ") peers.\n",
1097 alpha * gossip_list_size, alpha, gossip_list_size);
1098 for ( i = 0 ; i < alpha * gossip_list_size ; i++ ) { // TODO compute length
1099 peer = get_rand_gossip_peer();
1100 // TODO check NULL == peer
1101 LOG(GNUNET_ERROR_TYPE_DEBUG, "Sending PUSH to peer %s of gossiped list.\n", GNUNET_i2s(peer));
1103 ev = GNUNET_MQ_msg(push_msg, GNUNET_MESSAGE_TYPE_RPS_PP_PUSH);
1104 //ev = GNUNET_MQ_msg_extra();
1105 /* TODO Compute proof of work here
1107 push_msg->placeholder = 0;
1108 GNUNET_MQ_send( get_mq(peer_map, peer), ev );
1110 // TODO modify in_flags of respective peer?
1114 /* Send PULL requests */
1116 //n_arr = GNUNET_CRYPTO_random_permute(GNUNET_CRYPTO_QUALITY_STRONG, (unsigned int) sampler_list_size);
1117 LOG(GNUNET_ERROR_TYPE_DEBUG, "Going to send pulls to %f (%f * %" PRIu64 ") peers.\n",
1118 beta * gossip_list_size, beta, gossip_list_size);
1119 for ( i = 0 ; i < beta * gossip_list_size ; i++ ){ // TODO compute length
1120 peer = get_rand_gossip_peer();
1121 // TODO check NULL == peer
1122 LOG(GNUNET_ERROR_TYPE_DEBUG, "Sending PULL request to peer %s of gossiped list.\n", GNUNET_i2s(peer));
1124 ev = GNUNET_MQ_msg(pull_msg, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST);
1125 //ev = GNUNET_MQ_msg_extra();
1126 pull_msg->placeholder = 0;
1127 GNUNET_MQ_send( get_mq(peer_map, peer), ev );
1128 // TODO modify in_flags of respective peer?
1134 /* Update gossip list */
1137 if ( GNUNET_CONTAINER_slist_count(push_list) <= alpha * gossip_list_size &&
1138 GNUNET_CONTAINER_slist_count(push_list) != 0 &&
1139 GNUNET_CONTAINER_slist_count(pull_list) != 0 ) {
1140 LOG(GNUNET_ERROR_TYPE_DEBUG, "Update of the gossip list. ()\n");
1142 for ( i = 0 ; i < alpha * gossip_list_size ; i++ ) { // TODO use SAMPLER_get_n_rand_peers
1143 /* Update gossip list with peers received through PUSHes */
1144 gossip_list[i] = *SAMPLER_get_rand_peer(push_list);
1145 // TODO change the in_flags accordingly
1148 for ( i = 0 ; i < beta * gossip_list_size ; i++ ) {
1149 /* Update gossip list with peers received through PULLs */
1150 tmp_index = i + round(alpha * gossip_list_size);
1151 gossip_list[tmp_index] = *SAMPLER_get_rand_peer(pull_list);
1152 // TODO change the in_flags accordingly
1155 for ( i = 0 ; i < (1 - (alpha + beta)) * gossip_list_size ; i++ ) {
1156 /* Update gossip list with peers from history */
1157 tmp_index = i + round((alpha + beta) * gossip_list_size);
1158 gossip_list[tmp_index] = *SAMPLER_get_rand_peer(sampler_list);
1159 // TODO change the in_flags accordingly
1163 LOG(GNUNET_ERROR_TYPE_DEBUG, "No update of the gossip list. ()\n");
1165 // TODO independent of that also get some peers from CADET_get_peers()?
1169 /* Update samplers */
1172 if ( 0 < GNUNET_CONTAINER_slist_count(push_list) ) {
1173 LOG(GNUNET_ERROR_TYPE_DEBUG, "Update of the sampler list from pushes.\n");
1175 *iter = GNUNET_CONTAINER_slist_begin(push_list);
1176 size = sizeof(struct GNUNET_PeerIdentity);
1178 while ( GNUNET_NO != GNUNET_CONTAINER_slist_next(iter) ) {
1179 peer = (struct GNUNET_PeerIdentity *) GNUNET_CONTAINER_slist_get(iter, &size);
1180 SAMPLER_update_list(sampler_list, peer, NULL, NULL);
1183 GNUNET_CONTAINER_slist_iter_destroy(iter);
1186 LOG(GNUNET_ERROR_TYPE_DEBUG, "No update of the sampler list - received no pushes.\n");
1189 if ( 0 < GNUNET_CONTAINER_slist_count(pull_list) ) {
1190 LOG(GNUNET_ERROR_TYPE_DEBUG, "Update of the sampler list - received no pushes.\n");
1192 *iter = GNUNET_CONTAINER_slist_begin(pull_list);
1194 while ( GNUNET_NO != GNUNET_CONTAINER_slist_next(iter) ) {
1195 peer = (struct GNUNET_PeerIdentity *) GNUNET_CONTAINER_slist_get(iter, &size);
1196 SAMPLER_update_list(sampler_list, peer, NULL, NULL);
1199 GNUNET_CONTAINER_slist_iter_destroy(iter);
1201 LOG(GNUNET_ERROR_TYPE_DEBUG, "No update of the sampler list - received no pulls.\n");
1208 // TODO go over whole peer_map and do cleanups
1209 // delete unneeded peers, set in_flags, check channel/mq
1213 /* Empty push/pull lists */
1214 if ( 0 != GNUNET_CONTAINER_slist_count(push_list) ) {
1215 GNUNET_CONTAINER_slist_clear(push_list);
1218 if ( 0 != GNUNET_CONTAINER_slist_count(push_list) ) {
1219 GNUNET_CONTAINER_slist_clear(push_list);
1223 /* Schedule next round */
1225 do_round_task = GNUNET_SCHEDULER_add_delayed( round_interval, &do_round, NULL );
1226 LOG(GNUNET_ERROR_TYPE_DEBUG, "Finished round\n");
1230 rps_start (struct GNUNET_SERVER_Handle *server);
1233 * This is called from GNUNET_CADET_get_peers().
1235 * It is called on every peer(ID) that cadet somehow has contact with.
1236 * We use those to initialise the sampler.
1239 init_peer_cb (void *cls,
1240 const struct GNUNET_PeerIdentity *peer,
1241 int tunnel, // "Do we have a tunnel towards this peer?"
1242 unsigned int n_paths, // "Number of known paths towards this peer"
1243 unsigned int best_path) // "How long is the best path?
1244 // (0 = unknown, 1 = ourselves, 2 = neighbor)"
1246 // FIXME use the magic 0000 PeerID
1247 if ( NULL != peer ) {
1248 LOG(GNUNET_ERROR_TYPE_DEBUG, "Got peer %s (at %p) from CADET\n", GNUNET_i2s(peer), peer);
1249 SAMPLER_update_list(sampler_list, peer, NULL, NULL);
1250 if ( GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains( peer_map, peer ) ) {
1252 struct peer_context *ctx;
1254 ctx = GNUNET_malloc(sizeof(struct peer_context));
1257 ctx->to_channel = NULL;
1258 ctx->from_channel = NULL;
1259 GNUNET_CONTAINER_multipeermap_put( peer_map, peer, ctx, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1263 i = GNUNET_CRYPTO_random_u64(GNUNET_CRYPTO_QUALITY_STRONG, gossip_list_size);
1264 gossip_list[i] = *peer;
1265 // TODO send push/pull to each of those peers?
1267 rps_start( (struct GNUNET_SERVER_Handle *) cls);
1275 * Task run during shutdown.
1281 shutdown_task (void *cls,
1282 const struct GNUNET_SCHEDULER_TaskContext *tc)
1284 LOG(GNUNET_ERROR_TYPE_DEBUG, "RPS is going down\n");
1286 if ( GNUNET_SCHEDULER_NO_TASK != do_round_task )
1288 GNUNET_SCHEDULER_cancel (do_round_task);
1289 do_round_task = GNUNET_SCHEDULER_NO_TASK;
1292 GNUNET_NSE_disconnect(nse);
1293 GNUNET_CADET_disconnect(cadet_handle);
1294 GNUNET_free(own_identity);
1295 //GNUNET_free(round_interval);
1296 //GNUNET_free(est_size);
1297 //GNUNET_free(gossip_list_size);
1298 //GNUNET_free(sampler_list_size);
1299 GNUNET_free(gossip_list);
1300 // TODO for i in sampler_list free sampler
1301 // TODO destroy sampler_list
1302 // TODO destroy push/pull_list
1303 // TODO delete global data
1308 * A client disconnected. Remove all of its data structure entries.
1310 * @param cls closure, NULL
1311 * @param client identification of the client
1314 handle_client_disconnect (void *cls,
1315 struct GNUNET_SERVER_Client * client)
1317 // TODO reinitialise that sampler
1321 * Handle the channel a peer opens to us.
1323 * @param cls The closure
1324 * @param channel The channel the peer wants to establish
1325 * @param initiator The peer's peer ID
1326 * @param port The port the channel is being established over
1327 * @param options Further options
1330 handle_inbound_channel (void *cls,
1331 struct GNUNET_CADET_Channel *channel,
1332 const struct GNUNET_PeerIdentity *initiator,
1334 enum GNUNET_CADET_ChannelOption options)
1336 LOG(GNUNET_ERROR_TYPE_DEBUG, "New channel was established to us.\n");
1338 GNUNET_assert( NULL != channel );
1340 // TODO we might even not store the from_channel
1342 if ( GNUNET_CONTAINER_multipeermap_contains( peer_map, initiator ) ) {
1343 ((struct peer_context *) GNUNET_CONTAINER_multipeermap_get( peer_map, initiator ))->from_channel = channel;
1344 // FIXME there might already be an established channel
1346 struct peer_context *ctx;
1348 ctx = GNUNET_malloc( sizeof(struct peer_context));
1349 ctx->in_flags = in_other_gossip_list;
1350 ctx->mq = NULL; // TODO create mq?
1351 ctx->from_channel = channel;
1353 GNUNET_CONTAINER_multipeermap_put( peer_map, initiator, ctx, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1355 return NULL; // TODO
1359 * This is called when a remote peer destroys a channel.
1361 * @param cls The closure
1362 * @param channel The channel being closed
1363 * @param channel_ctx The context associated with this channel
1366 cleanup_channel(void *cls,
1367 const struct GNUNET_CADET_Channel *channel,
1370 LOG(GNUNET_ERROR_TYPE_DEBUG, "Channel was destroyed by remote peer.\n");
1374 * Actually start the service.
1377 rps_start (struct GNUNET_SERVER_Handle *server)
1379 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1380 {&handle_cs_request, NULL, GNUNET_MESSAGE_TYPE_RPS_CS_REQUEST, 0},
1384 GNUNET_SERVER_add_handlers (server, handlers);
1385 GNUNET_SERVER_disconnect_notify (server,
1386 &handle_client_disconnect,
1388 LOG(GNUNET_ERROR_TYPE_DEBUG, "Ready to receive requests from clients\n");
1392 do_round_task = GNUNET_SCHEDULER_add_delayed( round_interval, &do_round, NULL);
1393 LOG(GNUNET_ERROR_TYPE_DEBUG, "Scheduled first round\n");
1395 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1403 * Process statistics requests.
1405 * @param cls closure
1406 * @param server the initialized server
1407 * @param c configuration to use
1411 struct GNUNET_SERVER_Handle *server,
1412 const struct GNUNET_CONFIGURATION_Handle *c)
1414 // TODO check what this does -- copied from gnunet-boss
1415 // - seems to work as expected
1416 GNUNET_log_setup("rps", GNUNET_error_type_to_string(GNUNET_ERROR_TYPE_DEBUG), NULL);
1418 LOG(GNUNET_ERROR_TYPE_DEBUG, "RPS started\n");
1425 own_identity = GNUNET_new(struct GNUNET_PeerIdentity);
1427 GNUNET_CRYPTO_get_peer_identity(cfg, own_identity); // TODO check return value
1429 LOG(GNUNET_ERROR_TYPE_DEBUG, "Own identity is %s (at %p).\n", GNUNET_i2s(own_identity), own_identity);
1433 /* Get time interval from the configuration */
1434 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_time (cfg, "RPS",
1438 LOG(GNUNET_ERROR_TYPE_DEBUG, "Failed to read ROUNDINTERVAL from config\n");
1439 GNUNET_SCHEDULER_shutdown();
1443 /* Get initial size of sampler/gossip list from the configuration */
1444 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (cfg, "RPS",
1446 (long long unsigned int *) &est_size))
1448 LOG(GNUNET_ERROR_TYPE_DEBUG, "Failed to read INITSIZE from config\n");
1449 GNUNET_SCHEDULER_shutdown();
1452 LOG(GNUNET_ERROR_TYPE_DEBUG, "INITSIZE is %" PRIu64 "\n", est_size);
1454 gossip_list_size = sampler_list_size = est_size; // TODO rename est_size
1459 static unsigned int tmp = 0;
1461 GNUNET_array_grow(gossip_list, tmp, gossip_list_size);
1465 /* connect to NSE */
1466 nse = GNUNET_NSE_connect(cfg, nse_callback, NULL);
1467 // TODO check whether that was successful
1468 // TODO disconnect on shutdown
1469 LOG(GNUNET_ERROR_TYPE_DEBUG, "Connected to NSE\n");
1474 // TODO initialise thresholds - ?
1476 ///* Get alpha from the configuration */
1477 //if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1481 // LOG(GNUNET_ERROR_TYPE_DEBUG, "No ALPHA specified in the config\n");
1483 //LOG(GNUNET_ERROR_TYPE_DEBUG, "ALPHA is %f\n", alpha);
1485 ///* Get beta from the configuration */
1486 //if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_float (cfg, "RPS",
1490 // LOG(GNUNET_ERROR_TYPE_DEBUG, "No BETA specified in the config\n");
1492 //LOG(GNUNET_ERROR_TYPE_DEBUG, "BETA is %f\n", beta);
1497 peer_map = GNUNET_CONTAINER_multipeermap_create(est_size, GNUNET_NO);
1500 /* Initialise sampler and gossip list */
1503 //sampler_list = GNUNET_CONTAINER_slist_create();
1504 samplers = SAMPLER_samplers_init(est_size);
1506 //if ( gossip_list_size == sampler_list_size ) {
1507 // for ( i = 0 ; i < sampler_list_size ; i++ ) {
1508 // /* Init sampler list */
1509 // s = SAMPLER_init();
1510 // GNUNET_CONTAINER_slist_add(sampler_list,
1511 // GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC, // TODO DEPRECATED
1513 // sizeof(struct Sampler));
1514 // /* Init gossip list */
1515 // // TODO init gossip list
1516 // // What do we need to do here?
1519 // for ( i = 0 ; i < gossip_list_size ; i++ ) {
1520 // // TODO init gossip list
1522 // for ( i = 0 ; i < sampler_list_size ; i++ ) {
1523 // // TODO init RPF func
1524 // // TODO init Sample list
1525 // // TODO init Sampled list
1528 //uint64_t tmp_s = (uint64_t) GNUNET_CONTAINER_slist_count(sampler_list);
1529 //LOG(GNUNET_ERROR_TYPE_DEBUG, "Initialised sampler list %" PRIu64 "\n", tmp_s);
1533 push_list = GNUNET_CONTAINER_slist_create();
1534 pull_list = GNUNET_CONTAINER_slist_create();
1538 static const struct GNUNET_CADET_MessageHandler cadet_handlers[] = {
1539 {&handle_peer_push , GNUNET_MESSAGE_TYPE_RPS_PP_PUSH , 0},
1540 {&handle_peer_pull_request, GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REQUEST, 0},
1541 {&handle_peer_pull_reply , GNUNET_MESSAGE_TYPE_RPS_PP_PULL_REPLY , 0},
1545 const uint32_t ports[] = {GNUNET_RPS_CADET_PORT, 0}; // _PORT specified in src/rps/rps.h
1546 cadet_handle = GNUNET_CADET_connect(cfg,
1548 &handle_inbound_channel,
1552 LOG(GNUNET_ERROR_TYPE_DEBUG, "Connected to CADET\n");
1555 LOG(GNUNET_ERROR_TYPE_DEBUG, "Requesting peers from CADET\n");
1556 GNUNET_CADET_get_peers(cadet_handle, &init_peer_cb, server);
1557 // FIXME use magic 0000 PeerID to _start_ the service
1559 // TODO send push/pull to each of those peers?
1567 * The main function for the rps service.
1569 * @param argc number of arguments from the command line
1570 * @param argv command line arguments
1571 * @return 0 ok, 1 on error
1574 main (int argc, char *const *argv)
1576 return (GNUNET_OK ==
1577 GNUNET_SERVICE_run (argc,
1580 GNUNET_SERVICE_OPTION_NONE,
1581 &run, NULL)) ? 0 : 1;
1584 /* end of gnunet-service-rps.c */