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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file rps/gnunet-service-rps_peers.c
23 * @brief utilities for managing (information about) peers
24 * @author Julius Bünger
27 #include "gnunet_util_lib.h"
28 #include "gnunet_cadet_service.h"
31 #include "gnunet-service-rps_peers.h"
35 #define LOG(kind, ...) GNUNET_log_from(kind,"rps-peers",__VA_ARGS__)
39 * Set a peer flag of given peer context.
41 #define set_peer_flag(peer_ctx, mask) ((peer_ctx->peer_flags) |= (mask))
44 * Get peer flag of given peer context.
46 #define check_peer_flag_set(peer_ctx, mask)\
47 ((peer_ctx->peer_flags) & (mask) ? GNUNET_YES : GNUNET_NO)
50 * Unset flag of given peer context.
52 #define unset_peer_flag(peer_ctx, mask) ((peer_ctx->peer_flags) &= ~(mask))
55 * Set a channel flag of given channel context.
57 #define set_channel_flag(channel_flags, mask) ((*channel_flags) |= (mask))
60 * Get channel flag of given channel context.
62 #define check_channel_flag_set(channel_flags, mask)\
63 ((*channel_flags) & (mask) ? GNUNET_YES : GNUNET_NO)
66 * Unset flag of given channel context.
68 #define unset_channel_flag(channel_flags, mask) ((*channel_flags) &= ~(mask))
73 * Pending operation on peer consisting of callback and closure
75 * When an operation cannot be executed right now this struct is used to store
76 * the callback and closure for later execution.
92 * List containing all messages that are yet to be send
94 * This is used to keep track of all messages that have not been sent yet. When
95 * a peer is to be removed the pending messages can be removed properly.
102 struct PendingMessage *next;
103 struct PendingMessage *prev;
106 * The envelope to the corresponding message
108 struct GNUNET_MQ_Envelope *ev;
111 * The corresponding context
113 struct PeerContext *peer_ctx;
122 * Struct used to keep track of other peer's status
124 * This is stored in a multipeermap.
125 * It contains information such as cadet channels, a message queue for sending,
126 * status about the channels, the pending operations on this peer and some flags
127 * about the status of the peer itself. (live, valid, ...)
132 * Message queue open to client
134 struct GNUNET_MQ_Handle *mq;
137 * Channel open to client.
139 struct GNUNET_CADET_Channel *send_channel;
142 * Flags to the sending channel
144 uint32_t *send_channel_flags;
147 * Channel open from client.
149 struct GNUNET_CADET_Channel *recv_channel; // unneeded?
152 * Flags to the receiving channel
154 uint32_t *recv_channel_flags;
157 * Array of pending operations on this peer.
159 struct PeerPendingOp *pending_ops;
162 * Handle to the callback given to cadet_ntfy_tmt_rdy()
164 * To be canceled on shutdown.
166 struct GNUNET_CADET_TransmitHandle *transmit_handle;
169 * Number of pending operations.
171 unsigned int num_pending_ops;
174 * Identity of the peer
176 struct GNUNET_PeerIdentity peer_id;
179 * Flags indicating status of peer
184 * Last time we received something from that peer.
186 struct GNUNET_TIME_Absolute last_message_recv;
189 * Last time we received a keepalive message.
191 struct GNUNET_TIME_Absolute last_keepalive;
194 * DLL with all messages that are yet to be sent
196 struct PendingMessage *pending_messages_head;
197 struct PendingMessage *pending_messages_tail;
200 * This is pobably followed by 'statistical' data (when we first saw
201 * him, how did we get his ID, how many pushes (in a timeinterval),
207 * @brief Closure to #valid_peer_iterator
209 struct PeersIteratorCls
214 PeersIterator iterator;
217 * Closure to iterator
223 * @brief Hashmap of valid peers.
225 static struct GNUNET_CONTAINER_MultiPeerMap *valid_peers;
228 * @brief Maximum number of valid peers to keep.
229 * TODO read from config
231 static uint32_t num_valid_peers_max = UINT32_MAX;
234 * @brief Filename of the file that stores the valid peers persistently.
236 static char *filename_valid_peers;
239 * Set of all peers to keep track of them.
241 static struct GNUNET_CONTAINER_MultiPeerMap *peer_map;
244 * Own #GNUNET_PeerIdentity.
246 static const struct GNUNET_PeerIdentity *own_identity;
251 static struct GNUNET_CADET_Handle *cadet_handle;
255 * @brief Get the #PeerContext associated with a peer
257 * @param peer the peer id
259 * @return the #PeerContext
261 static struct PeerContext *
262 get_peer_ctx (const struct GNUNET_PeerIdentity *peer)
264 struct PeerContext *ctx;
267 ret = GNUNET_CONTAINER_multipeermap_contains (peer_map, peer);
268 GNUNET_assert (GNUNET_YES == ret);
269 ctx = GNUNET_CONTAINER_multipeermap_get (peer_map, peer);
270 GNUNET_assert (NULL != ctx);
275 * @brief Create a new #PeerContext and insert it into the peer map
277 * @param peer the peer to create the #PeerContext for
279 * @return the #PeerContext
281 static struct PeerContext *
282 create_peer_ctx (const struct GNUNET_PeerIdentity *peer)
284 struct PeerContext *ctx;
287 GNUNET_assert (GNUNET_NO == Peers_check_peer_known (peer));
289 ctx = GNUNET_new (struct PeerContext);
290 ctx->peer_id = *peer;
291 ctx->send_channel_flags = GNUNET_new (uint32_t);
292 ctx->recv_channel_flags = GNUNET_new (uint32_t);
293 ret = GNUNET_CONTAINER_multipeermap_put (peer_map, peer, ctx,
294 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
295 GNUNET_assert (GNUNET_OK == ret);
300 * @brief Create or get a #PeerContext
302 * @param peer the peer to get the associated context to
304 * @return the context
306 static struct PeerContext *
307 create_or_get_peer_ctx (const struct GNUNET_PeerIdentity *peer)
309 if (GNUNET_NO == Peers_check_peer_known (peer))
311 return create_peer_ctx (peer);
313 return get_peer_ctx (peer);
317 * @brief Check whether we have a connection to this @a peer
319 * Also sets the #Peers_ONLINE flag accordingly
321 * @param peer the peer in question
323 * @return #GNUNET_YES if we are connected
324 * #GNUNET_NO otherwise
327 Peers_check_connected (const struct GNUNET_PeerIdentity *peer)
329 const struct PeerContext *peer_ctx;
331 /* If we don't know about this peer we don't know whether it's online */
332 if (GNUNET_NO == Peers_check_peer_known (peer))
336 /* Get the context */
337 peer_ctx = get_peer_ctx (peer);
338 /* If we have no channel to this peer we don't know whether it's online */
339 if ( (NULL == peer_ctx->send_channel) &&
340 (NULL == peer_ctx->recv_channel) )
342 Peers_unset_peer_flag (peer, Peers_ONLINE);
345 /* Otherwise (if we have a channel, we know that it's online */
346 Peers_set_peer_flag (peer, Peers_ONLINE);
351 * @brief The closure to #get_rand_peer_iterator.
353 struct GetRandPeerIteratorCls
356 * @brief The index of the peer to return.
357 * Will be decreased until 0.
358 * Then current peer is returned.
363 * @brief Pointer to peer to return.
365 const struct GNUNET_PeerIdentity *peer;
369 * @brief Iterator function for #get_random_peer_from_peermap.
371 * Implements #GNUNET_CONTAINER_PeerMapIterator.
372 * Decreases the index until the index is null.
373 * Then returns the current peer.
375 * @param cls the #GetRandPeerIteratorCls containing index and peer
376 * @param peer current peer
377 * @param value unused
379 * @return #GNUNET_YES if we should continue to
384 get_rand_peer_iterator (void *cls,
385 const struct GNUNET_PeerIdentity *peer,
388 struct GetRandPeerIteratorCls *iterator_cls = cls;
389 if (0 >= iterator_cls->index)
391 iterator_cls->peer = peer;
394 iterator_cls->index--;
399 * @brief Get a random peer from @a peer_map
401 * @param peer_map the peer_map to get the peer from
403 * @return a random peer
405 static const struct GNUNET_PeerIdentity *
406 get_random_peer_from_peermap (const struct
407 GNUNET_CONTAINER_MultiPeerMap *peer_map)
409 struct GetRandPeerIteratorCls *iterator_cls;
410 const struct GNUNET_PeerIdentity *ret;
412 iterator_cls = GNUNET_new (struct GetRandPeerIteratorCls);
413 iterator_cls->index = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
414 GNUNET_CONTAINER_multipeermap_size (peer_map));
415 (void) GNUNET_CONTAINER_multipeermap_iterate (valid_peers,
416 get_rand_peer_iterator,
418 ret = iterator_cls->peer;
419 GNUNET_free (iterator_cls);
424 * @brief Add a given @a peer to valid peers.
426 * If valid peers are already #num_valid_peers_max, delete a peer previously.
428 * @param peer the peer that is added to the valid peers.
430 * @return #GNUNET_YES if no other peer had to be removed
431 * #GNUNET_NO otherwise
434 add_valid_peer (const struct GNUNET_PeerIdentity *peer)
436 const struct GNUNET_PeerIdentity *rand_peer;
440 while (GNUNET_CONTAINER_multipeermap_size (valid_peers) >= num_valid_peers_max)
442 rand_peer = get_random_peer_from_peermap (valid_peers);
443 GNUNET_CONTAINER_multipeermap_remove_all (valid_peers, rand_peer);
446 (void) GNUNET_CONTAINER_multipeermap_put (valid_peers, peer, NULL,
447 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
452 * @brief Set the peer flag to living and
453 * call the pending operations on this peer.
455 * Also adds peer to #valid_peers.
457 * @param peer_ctx the #PeerContext of the peer to set live
460 set_peer_live (struct PeerContext *peer_ctx)
462 struct GNUNET_PeerIdentity *peer;
465 /* Cancle cadet transmit_handle if still scheduled */
466 if (NULL != peer_ctx->transmit_handle)
468 GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->transmit_handle);
469 peer_ctx->transmit_handle = NULL;
472 peer = &peer_ctx->peer_id;
473 (void) add_valid_peer (peer);
474 set_peer_flag (peer_ctx, Peers_ONLINE);
475 LOG (GNUNET_ERROR_TYPE_DEBUG,
476 "Peer %s is live and valid, calling %i pending operations on it\n",
478 peer_ctx->num_pending_ops);
480 /* Call pending operations */
481 for (i = 0; i < peer_ctx->num_pending_ops; i++)
483 peer_ctx->pending_ops[i].op (peer_ctx->pending_ops[i].op_cls, peer);
485 GNUNET_array_grow (peer_ctx->pending_ops, peer_ctx->num_pending_ops, 0);
489 * @brief Get the channel of a peer. If not existing, create.
491 * @param peer the peer id
492 * @return the #GNUNET_CADET_Channel used to send data to @a peer
494 struct GNUNET_CADET_Channel *
495 get_channel (const struct GNUNET_PeerIdentity *peer)
497 struct PeerContext *peer_ctx;
499 peer_ctx = get_peer_ctx (peer);
500 if (NULL == peer_ctx->send_channel)
502 LOG (GNUNET_ERROR_TYPE_DEBUG,
503 "Trying to establish channel to peer %s\n",
505 peer_ctx->send_channel =
506 GNUNET_CADET_channel_create (cadet_handle,
507 peer_ctx->send_channel_flags, /* context */
509 GNUNET_RPS_CADET_PORT,
510 GNUNET_CADET_OPTION_RELIABLE);
512 return peer_ctx->send_channel;
516 * Get the message queue (#GNUNET_MQ_Handle) of a specific peer.
518 * If we already have a message queue open to this client,
519 * simply return it, otherways create one.
521 * @param peer the peer to get the mq to
522 * @return the #GNUNET_MQ_Handle
524 static struct GNUNET_MQ_Handle *
525 get_mq (const struct GNUNET_PeerIdentity *peer)
527 struct PeerContext *peer_ctx;
529 peer_ctx = get_peer_ctx (peer);
530 GNUNET_assert (NULL == peer_ctx->transmit_handle);
532 if (NULL == peer_ctx->mq)
534 (void) get_channel (peer);
535 peer_ctx->mq = GNUNET_CADET_mq_create (peer_ctx->send_channel);
541 * @brief Callback that is called when a channel was effectively established.
543 * This is an implementation of #GNUNET_CONNECTION_TransmitReadyNotify and
544 * given to #GNUNET_CADET_notify_transmit_ready_cancel and called when the
545 * channel was successfully established.
547 * This function type was originally ment to be called to provide the data to
548 * be sent. This is called when the connection is ready to queue more data.
549 * However we use it to get notified about the successful establishement of a
552 * @a buf will be NULL and @a size zero if the
553 * connection was closed for writing in the meantime.
556 * @param size number of bytes available in @a buf
557 * @param buf where the callee should write the message
558 * @return number of bytes written to @a buf
562 cadet_notify_transmit_ready_cb (void *cls, size_t size, void *buf)
564 struct PeerContext *peer_ctx = (struct PeerContext *) cls;
565 // TODO make sure the context is not deleted or the establishing of the
566 // channel is cancelled
568 peer_ctx->transmit_handle = NULL;
569 LOG (GNUNET_ERROR_TYPE_DEBUG,
570 "Set ->transmit_handle = NULL for peer %s\n",
571 GNUNET_i2s (&peer_ctx->peer_id));
573 if ( (NULL != buf) &&
576 set_peer_live (peer_ctx);
580 LOG (GNUNET_ERROR_TYPE_WARNING,
581 "Problems establishing a connection to peer %s in order to check liveliness\n",
582 GNUNET_i2s (&peer_ctx->peer_id));
583 // TODO reschedule? cleanup?
589 * Issue a check whether peer is live
591 * @param peer_ctx the context of the peer
594 check_peer_live (struct PeerContext *peer_ctx)
596 LOG (GNUNET_ERROR_TYPE_DEBUG,
597 "Get informed about peer %s getting live\n",
598 GNUNET_i2s (&peer_ctx->peer_id));
600 if (NULL == peer_ctx->transmit_handle &&
601 NULL == peer_ctx->send_channel)
603 (void) get_channel (&peer_ctx->peer_id);
604 peer_ctx->transmit_handle =
605 GNUNET_CADET_notify_transmit_ready (peer_ctx->send_channel,
607 GNUNET_TIME_UNIT_FOREVER_REL,
608 sizeof (struct GNUNET_MessageHeader),
609 cadet_notify_transmit_ready_cb,
612 else if (NULL != peer_ctx->transmit_handle)
613 LOG (GNUNET_ERROR_TYPE_DEBUG,
614 "Already waiting for notification\n");
615 else if (NULL != peer_ctx->send_channel)
616 LOG (GNUNET_ERROR_TYPE_DEBUG,
617 "Already have established channel to peer\n");
621 * @brief Add an envelope to a message passed to mq to list of pending messages
623 * @param peer peer the message was sent to
624 * @param ev envelope to the message
625 * @param type type of the message to be sent
626 * @return pointer to pending message
628 static struct PendingMessage *
629 insert_pending_message (const struct GNUNET_PeerIdentity *peer,
630 struct GNUNET_MQ_Envelope *ev,
633 struct PendingMessage *pending_msg;
634 struct PeerContext *peer_ctx;
636 peer_ctx = get_peer_ctx (peer);
637 pending_msg = GNUNET_new (struct PendingMessage);
638 pending_msg->ev = ev;
639 pending_msg->peer_ctx = peer_ctx;
640 pending_msg->type = type;
641 GNUNET_CONTAINER_DLL_insert (peer_ctx->pending_messages_head,
642 peer_ctx->pending_messages_tail,
648 * @brief Remove a pending message from the respective DLL
650 * @param pending_msg the pending message to remove
653 remove_pending_message (struct PendingMessage *pending_msg)
655 struct PeerContext *peer_ctx;
657 peer_ctx = pending_msg->peer_ctx;
658 GNUNET_CONTAINER_DLL_remove (peer_ctx->pending_messages_head,
659 peer_ctx->pending_messages_tail,
661 /* FIXME We are not able to cancel messages as #GNUNET_CADET_mq_create () does
662 * not set a #GNUNET_MQ_CancelImpl */
663 /* GNUNET_MQ_send_cancel (peer_ctx->pending_messages_head->ev); */
664 GNUNET_free (pending_msg);
668 * @brief Check whether function of type #PeerOp was already scheduled
670 * The array with pending operations will probably never grow really big, so
671 * iterating over it should be ok.
673 * @param peer the peer to check
674 * @param peer_op the operation (#PeerOp) on the peer
676 * @return #GNUNET_YES if this operation is scheduled on that peer
677 * #GNUNET_NO otherwise
680 check_operation_scheduled (const struct GNUNET_PeerIdentity *peer,
681 const PeerOp peer_op)
683 const struct PeerContext *peer_ctx;
686 peer_ctx = get_peer_ctx (peer);
687 for (i = 0; i < peer_ctx->num_pending_ops; i++)
688 if (peer_op == peer_ctx->pending_ops[i].op)
694 * Iterator over hash map entries. Deletes all contexts of peers.
697 * @param key current public key
698 * @param value value in the hash map
699 * @return #GNUNET_YES if we should continue to iterate,
703 peermap_clear_iterator (void *cls,
704 const struct GNUNET_PeerIdentity *key,
707 Peers_remove_peer (key);
712 * @brief This is called once a message is sent.
714 * Removes the pending message
716 * @param cls type of the message that was sent
719 mq_notify_sent_cb (void *cls)
721 struct PendingMessage *pending_msg = (struct PendingMessage *) cls;
722 LOG (GNUNET_ERROR_TYPE_DEBUG,
725 remove_pending_message (pending_msg);
729 * @brief Iterator function for #store_valid_peers.
731 * Implements #GNUNET_CONTAINER_PeerMapIterator.
732 * Writes single peer to disk.
734 * @param cls the file handle to write to.
735 * @param peer current peer
736 * @param value unused
738 * @return #GNUNET_YES if we should continue to
743 store_peer_presistently_iterator (void *cls,
744 const struct GNUNET_PeerIdentity *peer,
747 const struct GNUNET_DISK_FileHandle *fh = cls;
748 char peer_string[128];
756 size = GNUNET_snprintf (peer_string,
757 sizeof (peer_string),
759 GNUNET_i2s_full (peer));
760 GNUNET_assert (53 == size);
761 ret = GNUNET_DISK_file_write (fh,
764 GNUNET_assert (size == ret);
769 * @brief Store the peers currently in #valid_peers to disk.
774 struct GNUNET_DISK_FileHandle *fh;
775 uint32_t number_written_peers;
778 GNUNET_DISK_directory_create_for_file (filename_valid_peers))
782 fh = GNUNET_DISK_file_open (filename_valid_peers,
783 GNUNET_DISK_OPEN_WRITE |
784 GNUNET_DISK_OPEN_CREATE,
785 GNUNET_DISK_PERM_USER_READ |
786 GNUNET_DISK_PERM_USER_WRITE);
789 LOG (GNUNET_ERROR_TYPE_WARNING,
790 "Not able to write valid peers to file `%s'\n",
791 filename_valid_peers);
794 LOG (GNUNET_ERROR_TYPE_DEBUG,
795 "Writing %u valid peers to disk\n",
796 GNUNET_CONTAINER_multipeermap_size (valid_peers));
797 number_written_peers =
798 GNUNET_CONTAINER_multipeermap_iterate (valid_peers,
799 store_peer_presistently_iterator,
801 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
802 GNUNET_assert (number_written_peers ==
803 GNUNET_CONTAINER_multipeermap_size (valid_peers));
807 * @brief Convert string representation of peer id to peer id.
809 * Counterpart to #GNUNET_i2s_full.
811 * @param string_repr The string representation of the peer id
813 * @return The peer id
815 static const struct GNUNET_PeerIdentity *
816 s2i_full (const char *string_repr)
818 struct GNUNET_PeerIdentity *peer;
822 peer = GNUNET_new (struct GNUNET_PeerIdentity);
823 len = strlen (string_repr);
826 LOG (GNUNET_ERROR_TYPE_WARNING,
827 "Not able to convert string representation of PeerID to PeerID\n"
828 "Sting representation: %s (len %u) - too short\n",
837 ret = GNUNET_CRYPTO_eddsa_public_key_from_string (string_repr,
840 if (GNUNET_OK != ret)
842 LOG (GNUNET_ERROR_TYPE_WARNING,
843 "Not able to convert string representation of PeerID to PeerID\n"
844 "Sting representation: %s\n",
852 * @brief Restore the peers on disk to #valid_peers.
855 restore_valid_peers ()
859 struct GNUNET_DISK_FileHandle *fh;
863 const char *str_repr;
864 const struct GNUNET_PeerIdentity *peer;
866 if (GNUNET_OK != GNUNET_DISK_file_test (filename_valid_peers))
870 fh = GNUNET_DISK_file_open (filename_valid_peers,
871 GNUNET_DISK_OPEN_READ,
872 GNUNET_DISK_PERM_NONE);
873 GNUNET_assert (NULL != fh);
874 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_handle_size (fh, &file_size));
875 num_peers = file_size / 53;
876 buf = GNUNET_malloc (file_size);
877 size_read = GNUNET_DISK_file_read (fh, buf, file_size);
878 GNUNET_assert (size_read == file_size);
879 for (iter_buf = buf; iter_buf < buf + file_size - 1; iter_buf += 53)
881 str_repr = GNUNET_strndup (iter_buf, 53);
882 peer = s2i_full (str_repr);
883 add_valid_peer (peer);
884 LOG (GNUNET_ERROR_TYPE_DEBUG,
885 "Restored valid peer %s from disk\n",
886 GNUNET_i2s_full (peer));
888 LOG (GNUNET_ERROR_TYPE_DEBUG,
889 "num_peers: %" PRIu32 ", _size (valid_peers): %u\n",
891 GNUNET_CONTAINER_multipeermap_size (valid_peers));
892 GNUNET_assert (num_peers == GNUNET_CONTAINER_multipeermap_size (valid_peers));
893 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
894 LOG (GNUNET_ERROR_TYPE_DEBUG,
895 "Restored %u valid peers from disk\n",
900 * @brief Initialise storage of peers
902 * @param fn_valid_peers filename of the file used to store valid peer ids
903 * @param cadet_h cadet handle
904 * @param own_id own peer identity
907 Peers_initialise (char* fn_valid_peers,
908 struct GNUNET_CADET_Handle *cadet_h,
909 const struct GNUNET_PeerIdentity *own_id)
911 filename_valid_peers = GNUNET_strdup (fn_valid_peers);
912 cadet_handle = cadet_h;
913 own_identity = own_id;
914 peer_map = GNUNET_CONTAINER_multipeermap_create (4, GNUNET_NO);
915 valid_peers = GNUNET_CONTAINER_multipeermap_create (4, GNUNET_NO);
916 restore_valid_peers ();
920 * @brief Delete storage of peers that was created with #Peers_initialise ()
926 GNUNET_CONTAINER_multipeermap_iterate (peer_map,
927 peermap_clear_iterator,
930 LOG (GNUNET_ERROR_TYPE_WARNING,
931 "Iteration destroying peers was aborted.\n");
933 GNUNET_CONTAINER_multipeermap_destroy (peer_map);
934 store_valid_peers ();
935 GNUNET_free (filename_valid_peers);
936 GNUNET_CONTAINER_multipeermap_destroy (valid_peers);
941 * Iterator over #valid_peers hash map entries.
943 * @param cls closure - unused
944 * @param peer current peer id
945 * @param value value in the hash map - unused
946 * @return #GNUNET_YES if we should continue to
951 valid_peer_iterator (void *cls,
952 const struct GNUNET_PeerIdentity *peer,
955 struct PeersIteratorCls *it_cls = cls;
957 return it_cls->iterator (it_cls->cls,
963 * @brief Get all currently known, valid peer ids.
965 * @param it function to call on each peer id
966 * @param it_cls extra argument to @a it
967 * @return the number of key value pairs processed,
968 * #GNUNET_SYSERR if it aborted iteration
971 Peers_get_valid_peers (PeersIterator iterator,
974 struct PeersIteratorCls *cls;
977 cls = GNUNET_new (struct PeersIteratorCls);
978 cls->iterator = iterator;
980 ret = GNUNET_CONTAINER_multipeermap_iterate (valid_peers,
988 * @brief Add peer to known peers.
990 * This function is called on new peer_ids from 'external' sources
991 * (client seed, cadet get_peers(), ...)
993 * @param peer the new #GNUNET_PeerIdentity
995 * @return #GNUNET_YES if peer was inserted
996 * #GNUNET_NO otherwise (if peer was already known or
997 * peer was #own_identity)
1000 Peers_insert_peer (const struct GNUNET_PeerIdentity *peer)
1002 if ( (GNUNET_YES == Peers_check_peer_known (peer)) ||
1003 (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity)) )
1005 return GNUNET_NO; /* We already know this peer - nothing to do */
1007 (void) create_peer_ctx (peer);
1013 * @brief Try connecting to a peer to see whether it is online
1015 * If not known yet, insert into known peers
1017 * @param peer the peer whose liveliness is to be checked
1018 * @return #GNUNET_YES if peer had to be inserted
1019 * #GNUNET_NO otherwise (if peer was already known or
1020 * peer was #own_identity)
1023 Peers_check_peer_live (const struct GNUNET_PeerIdentity *peer)
1025 struct PeerContext *peer_ctx;
1028 if (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity))
1032 ret = Peers_insert_peer (peer);
1033 peer_ctx = get_peer_ctx (peer);
1034 if (GNUNET_NO == Peers_check_peer_flag (peer, Peers_ONLINE))
1036 check_peer_live (peer_ctx);
1042 * @brief Remove unecessary data
1044 * If the other peer is not intending to send messages, we have messages pending
1045 * to be sent to this peer and we are not waiting for a reply, remove the
1046 * information about it (its #PeerContext).
1048 * @param peer the peer to clean
1049 * @return #GNUNET_YES if peer was removed
1050 * #GNUNET_NO otherwise
1053 Peers_clean_peer (const struct GNUNET_PeerIdentity *peer)
1055 struct PeerContext *peer_ctx;
1057 // TODO actually remove unnecessary data
1059 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
1064 peer_ctx = get_peer_ctx (peer);
1065 if ( (NULL != peer_ctx->recv_channel) ||
1066 (NULL != peer_ctx->pending_messages_head) ||
1067 (GNUNET_NO == check_peer_flag_set (peer_ctx, Peers_PULL_REPLY_PENDING)) )
1071 Peers_remove_peer (peer);
1076 * @brief Remove peer
1078 * @param peer the peer to clean
1079 * @return #GNUNET_YES if peer was removed
1080 * #GNUNET_NO otherwise
1083 Peers_remove_peer (const struct GNUNET_PeerIdentity *peer)
1085 struct PeerContext *peer_ctx;
1087 if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
1092 peer_ctx = get_peer_ctx (peer);
1093 set_peer_flag (peer_ctx, Peers_TO_DESTROY);
1094 LOG (GNUNET_ERROR_TYPE_DEBUG,
1095 "Going to remove peer %s\n",
1096 GNUNET_i2s (&peer_ctx->peer_id));
1097 Peers_unset_peer_flag (peer, Peers_ONLINE);
1099 GNUNET_array_grow (peer_ctx->pending_ops, peer_ctx->num_pending_ops, 0);
1100 // TODO delete struct GNUNET_TRANSPORT_TransmitHandle *transmit_handle
1101 /* Cancle messages that have not been sent yet */
1102 while (NULL != peer_ctx->pending_messages_head)
1104 LOG (GNUNET_ERROR_TYPE_DEBUG,
1105 "Removing unsent %s\n",
1106 peer_ctx->pending_messages_head->type);
1107 remove_pending_message (peer_ctx->pending_messages_head);
1109 /* If we are still waiting for notification whether this peer is live
1110 * cancel the according task */
1111 if (NULL != peer_ctx->transmit_handle)
1113 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1114 "Trying to cancle transmit_handle for peer %s\n",
1115 GNUNET_i2s (&peer_ctx->peer_id));
1116 GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->transmit_handle);
1117 peer_ctx->transmit_handle = NULL;
1119 if (NULL != peer_ctx->send_channel)
1121 GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1122 peer_ctx->send_channel = NULL;
1124 if (NULL != peer_ctx->recv_channel)
1126 GNUNET_CADET_channel_destroy (peer_ctx->recv_channel);
1127 peer_ctx->recv_channel = NULL;
1129 if (NULL != peer_ctx->mq)
1131 GNUNET_MQ_destroy (peer_ctx->mq);
1132 peer_ctx->mq = NULL;
1135 GNUNET_free (peer_ctx->send_channel_flags);
1136 GNUNET_free (peer_ctx->recv_channel_flags);
1138 if (GNUNET_YES != GNUNET_CONTAINER_multipeermap_remove_all (peer_map, &peer_ctx->peer_id))
1140 LOG (GNUNET_ERROR_TYPE_WARNING, "removing peer from peer_map failed\n");
1142 GNUNET_free (peer_ctx);
1147 * @brief set flags on a given peer.
1149 * @param peer the peer to set flags on
1150 * @param flags the flags
1153 Peers_set_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags)
1155 struct PeerContext *peer_ctx;
1157 peer_ctx = get_peer_ctx (peer);
1158 set_peer_flag (peer_ctx, flags);
1162 * @brief unset flags on a given peer.
1164 * @param peer the peer to unset flags on
1165 * @param flags the flags
1168 Peers_unset_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags)
1170 struct PeerContext *peer_ctx;
1172 peer_ctx = get_peer_ctx (peer);
1173 unset_peer_flag (peer_ctx, flags);
1177 * @brief Check whether flags on a peer are set.
1179 * @param peer the peer to check the flag of
1180 * @param flags the flags to check
1182 * @return #GNUNET_SYSERR if peer is not known
1183 * #GNUNET_YES if all given flags are set
1184 * #GNUNET_NO otherwise
1187 Peers_check_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags)
1189 struct PeerContext *peer_ctx;
1191 if (GNUNET_NO == Peers_check_peer_known (peer))
1193 return GNUNET_SYSERR;
1195 peer_ctx = get_peer_ctx (peer);
1196 return check_peer_flag_set (peer_ctx, flags);
1201 * @brief set flags on a given channel.
1203 * @param channel the channel to set flags on
1204 * @param flags the flags
1207 Peers_set_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags)
1209 set_channel_flag (channel_flags, flags);
1213 * @brief unset flags on a given channel.
1215 * @param channel the channel to unset flags on
1216 * @param flags the flags
1219 Peers_unset_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags)
1221 unset_channel_flag (channel_flags, flags);
1225 * @brief Check whether flags on a channel are set.
1227 * @param channel the channel to check the flag of
1228 * @param flags the flags to check
1230 * @return #GNUNET_YES if all given flags are set
1231 * #GNUNET_NO otherwise
1234 Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags)
1236 return check_channel_flag_set (channel_flags, flags);
1240 * @brief Check whether we have information about the given peer.
1242 * FIXME probably deprecated. Make this the new _online.
1244 * @param peer peer in question
1246 * @return #GNUNET_YES if peer is known
1247 * #GNUNET_NO if peer is not knwon
1250 Peers_check_peer_known (const struct GNUNET_PeerIdentity *peer)
1252 return GNUNET_CONTAINER_multipeermap_contains (peer_map, peer);
1256 * @brief Check whether @a peer is actually a peer.
1258 * A valid peer is a peer that we know exists eg. we were connected to once.
1260 * @param peer peer in question
1262 * @return #GNUNET_YES if peer is valid
1263 * #GNUNET_NO if peer is not valid
1266 Peers_check_peer_valid (const struct GNUNET_PeerIdentity *peer)
1268 return GNUNET_CONTAINER_multipeermap_contains (valid_peers, peer);
1272 * @brief Indicate that we want to send to the other peer
1274 * This establishes a sending channel
1276 * @param peer the peer to establish channel to
1279 Peers_indicate_sending_intention (const struct GNUNET_PeerIdentity *peer)
1281 GNUNET_assert (GNUNET_YES == Peers_check_peer_known (peer));
1282 (void) get_channel (peer);
1286 * @brief Check whether other peer has the intention to send/opened channel
1289 * @param peer the peer in question
1291 * @return #GNUNET_YES if peer has the intention to send
1292 * #GNUNET_NO otherwise
1295 Peers_check_peer_send_intention (const struct GNUNET_PeerIdentity *peer)
1297 const struct PeerContext *peer_ctx;
1299 peer_ctx = get_peer_ctx (peer);
1300 if (NULL != peer_ctx->recv_channel)
1308 * Handle the channel a peer opens to us.
1310 * @param cls The closure
1311 * @param channel The channel the peer wants to establish
1312 * @param initiator The peer's peer ID
1313 * @param port The port the channel is being established over
1314 * @param options Further options
1316 * @return initial channel context for the channel
1317 * (can be NULL -- that's not an error)
1320 Peers_handle_inbound_channel (void *cls,
1321 struct GNUNET_CADET_Channel *channel,
1322 const struct GNUNET_PeerIdentity *initiator,
1324 enum GNUNET_CADET_ChannelOption options)
1326 struct PeerContext *peer_ctx;
1328 LOG (GNUNET_ERROR_TYPE_DEBUG,
1329 "New channel was established to us (Peer %s).\n",
1330 GNUNET_i2s (initiator));
1331 GNUNET_assert (NULL != channel); /* according to cadet API */
1332 /* Make sure we 'know' about this peer */
1333 peer_ctx = create_or_get_peer_ctx (initiator);
1334 set_peer_live (peer_ctx);
1335 /* We only accept one incoming channel per peer */
1336 if (GNUNET_YES == Peers_check_peer_send_intention (initiator))
1338 set_channel_flag (peer_ctx->recv_channel_flags,
1339 Peers_CHANNEL_ESTABLISHED_TWICE);
1340 GNUNET_CADET_channel_destroy (channel);
1341 /* return the channel context */
1342 return peer_ctx->recv_channel_flags;
1344 peer_ctx->recv_channel = channel;
1345 return peer_ctx->recv_channel_flags;
1349 * @brief Check whether a sending channel towards the given peer exists
1351 * @param peer the peer to check for
1353 * @return #GNUNET_YES if a sending channel towards that peer exists
1354 * #GNUNET_NO otherwise
1357 Peers_check_sending_channel_exists (const struct GNUNET_PeerIdentity *peer)
1359 struct PeerContext *peer_ctx;
1361 if (GNUNET_NO == Peers_check_peer_known (peer))
1362 { /* If no such peer exists, there is no channel */
1365 peer_ctx = get_peer_ctx (peer);
1366 if (NULL == peer_ctx->send_channel)
1374 * @brief check whether the given channel is the sending channel of the given
1377 * @param peer the peer in question
1378 * @param channel the channel to check for
1379 * @param role either #Peers_CHANNEL_ROLE_SENDING, or
1380 * #Peers_CHANNEL_ROLE_RECEIVING
1382 * @return #GNUNET_YES if the given chennel is the sending channel of the peer
1383 * #GNUNET_NO otherwise
1386 Peers_check_channel_role (const struct GNUNET_PeerIdentity *peer,
1387 const struct GNUNET_CADET_Channel *channel,
1388 enum Peers_ChannelRole role)
1390 const struct PeerContext *peer_ctx;
1392 if (GNUNET_NO == Peers_check_peer_known (peer))
1396 peer_ctx = get_peer_ctx (peer);
1397 if ( (Peers_CHANNEL_ROLE_SENDING == role) &&
1398 (channel == peer_ctx->send_channel) )
1402 if ( (Peers_CHANNEL_ROLE_RECEIVING == role) &&
1403 (channel == peer_ctx->recv_channel) )
1411 * @brief Destroy the send channel of a peer e.g. stop indicating a sending
1412 * intention to another peer
1414 * If there is also no channel to receive messages from that peer, remove it
1418 * @peer the peer identity of the peer whose sending channel to destroy
1419 * @return #GNUNET_YES if channel was destroyed
1420 * #GNUNET_NO otherwise
1423 Peers_destroy_sending_channel (const struct GNUNET_PeerIdentity *peer)
1425 struct PeerContext *peer_ctx;
1427 if (GNUNET_NO == Peers_check_peer_known (peer))
1431 peer_ctx = get_peer_ctx (peer);
1432 if (NULL != peer_ctx->send_channel)
1434 set_channel_flag (peer_ctx->send_channel_flags, Peers_CHANNEL_CLEAN);
1435 GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1436 peer_ctx->send_channel = NULL;
1437 (void) Peers_check_connected (peer);
1444 * This is called when a channel is destroyed.
1446 * @param cls The closure
1447 * @param channel The channel being closed
1448 * @param channel_ctx The context associated with this channel
1451 Peers_cleanup_destroyed_channel (void *cls,
1452 const struct GNUNET_CADET_Channel *channel,
1455 struct GNUNET_PeerIdentity *peer;
1456 struct PeerContext *peer_ctx;
1458 peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1459 (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1460 // FIXME wait for cadet to change this function
1462 if (GNUNET_NO == Peers_check_peer_known (peer))
1463 {/* We don't want to implicitly create a context that we're about to kill */
1464 LOG (GNUNET_ERROR_TYPE_DEBUG,
1465 "channel (%s) without associated context was destroyed\n",
1469 peer_ctx = get_peer_ctx (peer);
1471 /* If our peer issued the destruction of the channel, the #Peers_TO_DESTROY
1472 * flag will be set. In this case simply make sure that the channels are
1474 /* FIXME This distinction seems to be redundant */
1475 if (Peers_check_peer_flag (peer, Peers_TO_DESTROY))
1476 {/* We initiatad the destruction of this particular peer */
1477 if (channel == peer_ctx->send_channel)
1478 peer_ctx->send_channel = NULL;
1479 else if (channel == peer_ctx->recv_channel)
1480 peer_ctx->recv_channel = NULL;
1482 if (NULL != peer_ctx->send_channel)
1484 GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1485 peer_ctx->send_channel = NULL;
1487 if (NULL != peer_ctx->recv_channel)
1489 GNUNET_CADET_channel_destroy (peer_ctx->recv_channel);
1490 peer_ctx->recv_channel = NULL;
1492 /* Set the #Peers_ONLINE flag accordingly */
1493 (void) Peers_check_connected (peer);
1498 { /* We did not initiate the destruction of this peer */
1499 if (channel == peer_ctx->send_channel)
1500 { /* Something (but us) killd the channel - clean up peer */
1501 LOG (GNUNET_ERROR_TYPE_DEBUG,
1502 "send channel (%s) was destroyed - cleaning up\n",
1504 peer_ctx->send_channel = NULL;
1506 else if (channel == peer_ctx->recv_channel)
1507 { /* Other peer doesn't want to send us messages anymore */
1508 LOG (GNUNET_ERROR_TYPE_DEBUG,
1509 "Peer %s destroyed recv channel - cleaning up channel\n",
1511 peer_ctx->recv_channel = NULL;
1515 LOG (GNUNET_ERROR_TYPE_WARNING,
1516 "unknown channel (%s) was destroyed\n",
1520 (void) Peers_check_connected (peer);
1524 * @brief Issue a check whether peer is live
1526 * This tries to establish a channel to the given peer. Once the channel is
1527 * established successfully, we know the peer is live.
1529 * @param peer the peer to check liveliness
1532 Peers_issue_peer_liveliness_check (const struct GNUNET_PeerIdentity *peer)
1534 struct PeerContext *peer_ctx;
1536 if (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity))
1538 return; /* We know that we are online */
1541 peer_ctx = create_or_get_peer_ctx (peer);
1542 // TODO if LIVE/ONLINE
1543 check_peer_live (peer_ctx);
1547 * @brief Send a message to another peer.
1549 * Keeps track about pending messages so they can be properly removed when the
1550 * peer is destroyed.
1552 * @param peer receeiver of the message
1553 * @param ev envelope of the message
1554 * @param type type of the message
1557 Peers_send_message (const struct GNUNET_PeerIdentity *peer,
1558 struct GNUNET_MQ_Envelope *ev,
1561 struct PendingMessage *pending_msg;
1562 struct GNUNET_MQ_Handle *mq;
1564 pending_msg = insert_pending_message (peer, ev, type);
1566 GNUNET_MQ_notify_sent (ev,
1569 GNUNET_MQ_send (mq, ev);
1573 * @brief Schedule a operation on given peer
1575 * Avoids scheduling an operation twice.
1577 * @param peer the peer we want to schedule the operation for once it gets live
1579 * @return #GNUNET_YES if the operation was scheduled
1580 * #GNUNET_NO otherwise
1583 Peers_schedule_operation (const struct GNUNET_PeerIdentity *peer,
1584 const PeerOp peer_op)
1586 struct PeerPendingOp pending_op;
1587 struct PeerContext *peer_ctx;
1589 if (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity))
1593 GNUNET_assert (GNUNET_YES == Peers_check_peer_known (peer));
1595 //TODO if LIVE/ONLINE execute immediately
1597 if (GNUNET_NO == check_operation_scheduled (peer, peer_op))
1599 peer_ctx = get_peer_ctx (peer);
1600 pending_op.op = peer_op;
1601 pending_op.op_cls = NULL;
1602 GNUNET_array_append (peer_ctx->pending_ops,
1603 peer_ctx->num_pending_ops,
1610 /* end of gnunet-service-rps_peers.c */