src/rps/gnunet-service-rps_peers.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file rps/gnunet-service-rps_peers.c
  23  * @brief utilities for managing (information about) peers
  24  * @author Julius Bünger
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_cadet_service.h"
  29 #include <inttypes.h>
  30 #include "rps.h"
  31 #include "gnunet-service-rps_peers.h"
  32
  33
  34
  35 #define LOG(kind, ...) GNUNET_log_from(kind,"rps-peers",__VA_ARGS__)
  36
  37
  38 /**
  39  * Set a peer flag of given peer context.
  40  */
  41 #define set_peer_flag(peer_ctx, mask) ((peer_ctx->peer_flags) |= (mask))
  42
  43 /**
  44  * Get peer flag of given peer context.
  45  */
  46 #define check_peer_flag_set(peer_ctx, mask)\
  47   ((peer_ctx->peer_flags) & (mask) ? GNUNET_YES : GNUNET_NO)
  48
  49 /**
  50  * Unset flag of given peer context.
  51  */
  52 #define unset_peer_flag(peer_ctx, mask) ((peer_ctx->peer_flags) &= ~(mask))
  53
  54 /**
  55  * Set a channel flag of given channel context.
  56  */
  57 #define set_channel_flag(channel_flags, mask) ((*channel_flags) |= (mask))
  58
  59 /**
  60  * Get channel flag of given channel context.
  61  */
  62 #define check_channel_flag_set(channel_flags, mask)\
  63   ((*channel_flags) & (mask) ? GNUNET_YES : GNUNET_NO)
  64
  65 /**
  66  * Unset flag of given channel context.
  67  */
  68 #define unset_channel_flag(channel_flags, mask) ((*channel_flags) &= ~(mask))
  69
  70
  71
  72 /**
  73  * Pending operation on peer consisting of callback and closure
  74  *
  75  * When an operation cannot be executed right now this struct is used to store
  76  * the callback and closure for later execution.
  77  */
  78 struct PeerPendingOp
  79 {
  80   /**
  81    * Callback
  82    */
  83   PeerOp op;
  84
  85   /**
  86    * Closure
  87    */
  88   void *op_cls;
  89 };
  90
  91 /**
  92  * List containing all messages that are yet to be send
  93  *
  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.
  96  */
  97 struct PendingMessage
  98 {
  99   /**
 100    * DLL next, prev
 101    */
 102   struct PendingMessage *next;
 103   struct PendingMessage *prev;
 104
 105   /**
 106    * The envelope to the corresponding message
 107    */
 108   struct GNUNET_MQ_Envelope *ev;
 109
 110   /**
 111    * The corresponding context
 112    */
 113   struct PeerContext *peer_ctx;
 114
 115   /**
 116    * The message type
 117    */
 118   const char *type;
 119 };
 120
 121 /**
 122  * Struct used to keep track of other peer's status
 123  *
 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, ...)
 128  */
 129 struct PeerContext
 130 {
 131   /**
 132    * Message queue open to client
 133    */
 134   struct GNUNET_MQ_Handle *mq;
 135
 136   /**
 137    * Channel open to client.
 138    */
 139   struct GNUNET_CADET_Channel *send_channel;
 140
 141   /**
 142    * Flags to the sending channel
 143    */
 144   uint32_t *send_channel_flags;
 145
 146   /**
 147    * Channel open from client.
 148    */
 149   struct GNUNET_CADET_Channel *recv_channel; // unneeded?
 150
 151   /**
 152    * Flags to the receiving channel
 153    */
 154   uint32_t *recv_channel_flags;
 155
 156   /**
 157    * Array of pending operations on this peer.
 158    */
 159   struct PeerPendingOp *pending_ops;
 160
 161   /**
 162    * Handle to the callback given to cadet_ntfy_tmt_rdy()
 163    *
 164    * To be canceled on shutdown.
 165    */
 166   struct GNUNET_CADET_TransmitHandle *transmit_handle;
 167
 168   /**
 169    * Number of pending operations.
 170    */
 171   unsigned int num_pending_ops;
 172
 173   /**
 174    * Identity of the peer
 175    */
 176   struct GNUNET_PeerIdentity peer_id;
 177
 178   /**
 179    * Flags indicating status of peer
 180    */
 181   uint32_t peer_flags;
 182
 183   /**
 184    * Last time we received something from that peer.
 185    */
 186   struct GNUNET_TIME_Absolute last_message_recv;
 187
 188   /**
 189    * Last time we received a keepalive message.
 190    */
 191   struct GNUNET_TIME_Absolute last_keepalive;
 192
 193   /**
 194    * DLL with all messages that are yet to be sent
 195    */
 196   struct PendingMessage *pending_messages_head;
 197   struct PendingMessage *pending_messages_tail;
 198
 199   /**
 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),
 202    * ...)
 203    */
 204 };
 205
 206 /**
 207  * @brief Closure to #valid_peer_iterator
 208  */
 209 struct PeersIteratorCls
 210 {
 211   /**
 212    * Iterator function
 213    */
 214   PeersIterator iterator;
 215
 216   /**
 217    * Closure to iterator
 218    */
 219   void *cls;
 220 };
 221
 222 /**
 223  * @brief Hashmap of valid peers.
 224  */
 225 static struct GNUNET_CONTAINER_MultiPeerMap *valid_peers;
 226
 227 /**
 228  * @brief Maximum number of valid peers to keep.
 229  * TODO read from config
 230  */
 231 static uint32_t num_valid_peers_max = UINT32_MAX;
 232
 233 /**
 234  * @brief Filename of the file that stores the valid peers persistently.
 235  */
 236 static char *filename_valid_peers;
 237
 238 /**
 239  * Set of all peers to keep track of them.
 240  */
 241 static struct GNUNET_CONTAINER_MultiPeerMap *peer_map;
 242
 243 /**
 244  * Own #GNUNET_PeerIdentity.
 245  */
 246 static const struct GNUNET_PeerIdentity *own_identity;
 247
 248 /**
 249  * Cadet handle.
 250  */
 251 static struct GNUNET_CADET_Handle *cadet_handle;
 252
 253
 254 /**
 255  * @brief Get the #PeerContext associated with a peer
 256  *
 257  * @param peer the peer id
 258  *
 259  * @return the #PeerContext
 260  */
 261 static struct PeerContext *
 262 get_peer_ctx (const struct GNUNET_PeerIdentity *peer)
 263 {
 264   struct PeerContext *ctx;
 265   int ret;
 266
 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);
 271   return ctx;
 272 }
 273
 274 /**
 275  * @brief Create a new #PeerContext and insert it into the peer map
 276  *
 277  * @param peer the peer to create the #PeerContext for
 278  *
 279  * @return the #PeerContext
 280  */
 281 static struct PeerContext *
 282 create_peer_ctx (const struct GNUNET_PeerIdentity *peer)
 283 {
 284   struct PeerContext *ctx;
 285   int ret;
 286
 287   GNUNET_assert (GNUNET_NO == Peers_check_peer_known (peer));
 288
 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);
 296   return ctx;
 297 }
 298
 299 /**
 300  * @brief Create or get a #PeerContext
 301  *
 302  * @param peer the peer to get the associated context to
 303  *
 304  * @return the context
 305  */
 306 static struct PeerContext *
 307 create_or_get_peer_ctx (const struct GNUNET_PeerIdentity *peer)
 308 {
 309   if (GNUNET_NO == Peers_check_peer_known (peer))
 310   {
 311     return create_peer_ctx (peer);
 312   }
 313   return get_peer_ctx (peer);
 314 }
 315
 316 /**
 317  * @brief Check whether we have a connection to this @a peer
 318  *
 319  * Also sets the #Peers_ONLINE flag accordingly
 320  *
 321  * @param peer the peer in question
 322  *
 323  * @return #GNUNET_YES if we are connected
 324  *         #GNUNET_NO  otherwise
 325  */
 326 int
 327 Peers_check_connected (const struct GNUNET_PeerIdentity *peer)
 328 {
 329   const struct PeerContext *peer_ctx;
 330
 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))
 333   {
 334     return GNUNET_NO;
 335   }
 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) )
 341   {
 342     Peers_unset_peer_flag (peer, Peers_ONLINE);
 343     return GNUNET_NO;
 344   }
 345   /* Otherwise (if we have a channel, we know that it's online */
 346   Peers_set_peer_flag (peer, Peers_ONLINE);
 347   return GNUNET_YES;
 348 }
 349
 350 /**
 351  * @brief The closure to #get_rand_peer_iterator.
 352  */
 353 struct GetRandPeerIteratorCls
 354 {
 355   /**
 356    * @brief The index of the peer to return.
 357    * Will be decreased until 0.
 358    * Then current peer is returned.
 359    */
 360   uint32_t index;
 361
 362   /**
 363    * @brief Pointer to peer to return.
 364    */
 365   const struct GNUNET_PeerIdentity *peer;
 366 };
 367
 368 /**
 369  * @brief Iterator function for #get_random_peer_from_peermap.
 370  *
 371  * Implements #GNUNET_CONTAINER_PeerMapIterator.
 372  * Decreases the index until the index is null.
 373  * Then returns the current peer.
 374  *
 375  * @param cls the #GetRandPeerIteratorCls containing index and peer
 376  * @param peer current peer
 377  * @param value unused
 378  *
 379  * @return  #GNUNET_YES if we should continue to
 380  *          iterate,
 381  *          #GNUNET_NO if not.
 382  */
 383 static int
 384 get_rand_peer_iterator (void *cls,
 385                         const struct GNUNET_PeerIdentity *peer,
 386                         void *value)
 387 {
 388   struct GetRandPeerIteratorCls *iterator_cls = cls;
 389   if (0 >= iterator_cls->index)
 390   {
 391     iterator_cls->peer = peer;
 392     return GNUNET_NO;
 393   }
 394   iterator_cls->index--;
 395   return GNUNET_YES;
 396 }
 397
 398 /**
 399  * @brief Get a random peer from @a peer_map
 400  *
 401  * @param peer_map the peer_map to get the peer from
 402  *
 403  * @return a random peer
 404  */
 405 static const struct GNUNET_PeerIdentity *
 406 get_random_peer_from_peermap (const struct
 407                               GNUNET_CONTAINER_MultiPeerMap *peer_map)
 408 {
 409   struct GetRandPeerIteratorCls *iterator_cls;
 410   const struct GNUNET_PeerIdentity *ret;
 411
 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,
 417                                                 iterator_cls);
 418   ret = iterator_cls->peer;
 419   GNUNET_free (iterator_cls);
 420   return ret;
 421 }
 422
 423 /**
 424  * @brief Add a given @a peer to valid peers.
 425  *
 426  * If valid peers are already #num_valid_peers_max, delete a peer previously.
 427  *
 428  * @param peer the peer that is added to the valid peers.
 429  *
 430  * @return #GNUNET_YES if no other peer had to be removed
 431  *         #GNUNET_NO  otherwise
 432  */
 433 static int
 434 add_valid_peer (const struct GNUNET_PeerIdentity *peer)
 435 {
 436   const struct GNUNET_PeerIdentity *rand_peer;
 437   int ret;
 438
 439   ret = GNUNET_YES;
 440   while (GNUNET_CONTAINER_multipeermap_size (valid_peers) >= num_valid_peers_max)
 441   {
 442     rand_peer = get_random_peer_from_peermap (valid_peers);
 443     GNUNET_CONTAINER_multipeermap_remove_all (valid_peers, rand_peer);
 444     ret = GNUNET_NO;
 445   }
 446   (void) GNUNET_CONTAINER_multipeermap_put (valid_peers, peer, NULL,
 447       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
 448   return ret;
 449 }
 450
 451 /**
 452  * @brief Set the peer flag to living and
 453  *        call the pending operations on this peer.
 454  *
 455  * Also adds peer to #valid_peers.
 456  *
 457  * @param peer_ctx the #PeerContext of the peer to set live
 458  */
 459 static void
 460 set_peer_live (struct PeerContext *peer_ctx)
 461 {
 462   struct GNUNET_PeerIdentity *peer;
 463   unsigned int i;
 464
 465   /* Cancle cadet transmit_handle if still scheduled */
 466   if (NULL != peer_ctx->transmit_handle)
 467   {
 468     GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->transmit_handle);
 469     peer_ctx->transmit_handle = NULL;
 470   }
 471
 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",
 477       GNUNET_i2s (peer),
 478       peer_ctx->num_pending_ops);
 479
 480   /* Call pending operations */
 481   for (i = 0; i < peer_ctx->num_pending_ops; i++)
 482   {
 483     peer_ctx->pending_ops[i].op (peer_ctx->pending_ops[i].op_cls, peer);
 484   }
 485   GNUNET_array_grow (peer_ctx->pending_ops, peer_ctx->num_pending_ops, 0);
 486 }
 487
 488 /**
 489  * @brief Get the channel of a peer. If not existing, create.
 490  *
 491  * @param peer the peer id
 492  * @return the #GNUNET_CADET_Channel used to send data to @a peer
 493  */
 494 struct GNUNET_CADET_Channel *
 495 get_channel (const struct GNUNET_PeerIdentity *peer)
 496 {
 497   struct PeerContext *peer_ctx;
 498
 499   peer_ctx = get_peer_ctx (peer);
 500   if (NULL == peer_ctx->send_channel)
 501   {
 502     LOG (GNUNET_ERROR_TYPE_DEBUG,
 503          "Trying to establish channel to peer %s\n",
 504          GNUNET_i2s (peer));
 505     peer_ctx->send_channel =
 506       GNUNET_CADET_channel_create (cadet_handle,
 507                                    peer_ctx->send_channel_flags, /* context */
 508                                    peer,
 509                                    GNUNET_RPS_CADET_PORT,
 510                                    GNUNET_CADET_OPTION_RELIABLE);
 511   }
 512   GNUNET_assert (NULL != peer_ctx->send_channel);
 513   return peer_ctx->send_channel;
 514 }
 515
 516 /**
 517  * Get the message queue (#GNUNET_MQ_Handle) of a specific peer.
 518  *
 519  * If we already have a message queue open to this client,
 520  * simply return it, otherways create one.
 521  *
 522  * @param peer the peer to get the mq to
 523  * @return the #GNUNET_MQ_Handle
 524  */
 525 static struct GNUNET_MQ_Handle *
 526 get_mq (const struct GNUNET_PeerIdentity *peer)
 527 {
 528   struct PeerContext *peer_ctx;
 529
 530   peer_ctx = get_peer_ctx (peer);
 531   GNUNET_assert (NULL == peer_ctx->transmit_handle);
 532
 533   if (NULL == peer_ctx->mq)
 534   {
 535     (void) get_channel (peer);
 536     peer_ctx->mq = GNUNET_CADET_mq_create (peer_ctx->send_channel);
 537   }
 538   return peer_ctx->mq;
 539 }
 540
 541 /**
 542  * @brief Callback that is called when a channel was effectively established.
 543  *
 544  * This is an implementation of #GNUNET_CONNECTION_TransmitReadyNotify and
 545  * given to #GNUNET_CADET_notify_transmit_ready_cancel and called when the
 546  * channel was successfully established.
 547  *
 548  * This function type was originally ment to be called to provide the data to
 549  * be sent. This is called when the connection is ready to queue more data.
 550  * However we use it to get notified about the successful establishement of a
 551  * cadet channel.
 552  *
 553  * @a buf will be NULL and @a size zero if the
 554  * connection was closed for writing in the meantime.
 555  *
 556  * @param cls closure
 557  * @param size number of bytes available in @a buf
 558  * @param buf where the callee should write the message
 559  * @return number of bytes written to @a buf
 560  */
 561 //TODO
 562 static size_t
 563 cadet_notify_transmit_ready_cb (void *cls, size_t size, void *buf)
 564 {
 565   struct PeerContext *peer_ctx = (struct PeerContext *) cls;
 566   // TODO make sure the context is not deleted or the establishing of the
 567   //      channel is cancelled
 568
 569   peer_ctx->transmit_handle = NULL;
 570   LOG (GNUNET_ERROR_TYPE_DEBUG,
 571        "Set ->transmit_handle = NULL for peer %s\n",
 572        GNUNET_i2s (&peer_ctx->peer_id));
 573
 574   if ( (NULL != buf) &&
 575        (0 != size) )
 576   {
 577     set_peer_live (peer_ctx);
 578   }
 579   else
 580   {
 581     LOG (GNUNET_ERROR_TYPE_WARNING,
 582          "Problems establishing a connection to peer %s in order to check liveliness\n",
 583          GNUNET_i2s (&peer_ctx->peer_id));
 584     // TODO reschedule? cleanup?
 585   }
 586   return 0;
 587 }
 588
 589 /**
 590  * Issue a check whether peer is live
 591  *
 592  * @param peer_ctx the context of the peer
 593  */
 594 static void
 595 check_peer_live (struct PeerContext *peer_ctx)
 596 {
 597   LOG (GNUNET_ERROR_TYPE_DEBUG,
 598        "Get informed about peer %s getting live\n",
 599        GNUNET_i2s (&peer_ctx->peer_id));
 600
 601   if (NULL != peer_ctx->transmit_handle)
 602   {
 603     LOG (GNUNET_ERROR_TYPE_DEBUG,
 604          "Already waiting for notification\n");
 605     return;
 606   }
 607   if (NULL != peer_ctx->send_channel)
 608   {
 609     LOG (GNUNET_ERROR_TYPE_DEBUG,
 610          "Already have established channel to peer\n");
 611     return;
 612   }
 613   (void) get_channel (&peer_ctx->peer_id);
 614   peer_ctx->transmit_handle =
 615       GNUNET_CADET_notify_transmit_ready (peer_ctx->send_channel,
 616                                           GNUNET_NO,
 617                                           GNUNET_TIME_UNIT_FOREVER_REL,
 618                                           sizeof (struct GNUNET_MessageHeader),
 619                                           cadet_notify_transmit_ready_cb,
 620                                           peer_ctx);
 621   if (NULL == peer_ctx->transmit_handle)
 622   {
 623     LOG (GNUNET_ERROR_TYPE_WARNING,
 624         "Cadet was not able to queue the request (insufficient memory)\n");
 625     GNUNET_break (0);
 626   }
 627 }
 628
 629 /**
 630  * @brief Add an envelope to a message passed to mq to list of pending messages
 631  *
 632  * @param peer peer the message was sent to
 633  * @param ev envelope to the message
 634  * @param type type of the message to be sent
 635  * @return pointer to pending message
 636  */
 637 static struct PendingMessage *
 638 insert_pending_message (const struct GNUNET_PeerIdentity *peer,
 639                         struct GNUNET_MQ_Envelope *ev,
 640                         const char *type)
 641 {
 642   struct PendingMessage *pending_msg;
 643   struct PeerContext *peer_ctx;
 644
 645   peer_ctx = get_peer_ctx (peer);
 646   pending_msg = GNUNET_new (struct PendingMessage);
 647   pending_msg->ev = ev;
 648   pending_msg->peer_ctx = peer_ctx;
 649   pending_msg->type = type;
 650   GNUNET_CONTAINER_DLL_insert (peer_ctx->pending_messages_head,
 651                                peer_ctx->pending_messages_tail,
 652                                pending_msg);
 653   return pending_msg;
 654 }
 655
 656 /**
 657  * @brief Remove a pending message from the respective DLL
 658  *
 659  * @param pending_msg the pending message to remove
 660  */
 661 static void
 662 remove_pending_message (struct PendingMessage *pending_msg)
 663 {
 664   struct PeerContext *peer_ctx;
 665
 666   peer_ctx = pending_msg->peer_ctx;
 667   GNUNET_CONTAINER_DLL_remove (peer_ctx->pending_messages_head,
 668                                peer_ctx->pending_messages_tail,
 669                                pending_msg);
 670   /* FIXME We are not able to cancel messages as #GNUNET_CADET_mq_create () does
 671    * not set a #GNUNET_MQ_CancelImpl */
 672   /* GNUNET_MQ_send_cancel (peer_ctx->pending_messages_head->ev); */
 673   GNUNET_free (pending_msg);
 674 }
 675
 676 /**
 677  * @brief Check whether function of type #PeerOp was already scheduled
 678  *
 679  * The array with pending operations will probably never grow really big, so
 680  * iterating over it should be ok.
 681  *
 682  * @param peer the peer to check
 683  * @param peer_op the operation (#PeerOp) on the peer
 684  *
 685  * @return #GNUNET_YES if this operation is scheduled on that peer
 686  *         #GNUNET_NO  otherwise
 687  */
 688 static int
 689 check_operation_scheduled (const struct GNUNET_PeerIdentity *peer,
 690                            const PeerOp peer_op)
 691 {
 692   const struct PeerContext *peer_ctx;
 693   unsigned int i;
 694
 695   peer_ctx = get_peer_ctx (peer);
 696   for (i = 0; i < peer_ctx->num_pending_ops; i++)
 697     if (peer_op == peer_ctx->pending_ops[i].op)
 698       return GNUNET_YES;
 699   return GNUNET_NO;
 700 }
 701
 702 /**
 703  * Iterator over hash map entries. Deletes all contexts of peers.
 704  *
 705  * @param cls closure
 706  * @param key current public key
 707  * @param value value in the hash map
 708  * @return #GNUNET_YES if we should continue to iterate,
 709  *         #GNUNET_NO if not.
 710  */
 711 static int
 712 peermap_clear_iterator (void *cls,
 713                         const struct GNUNET_PeerIdentity *key,
 714                         void *value)
 715 {
 716   Peers_remove_peer (key);
 717   return GNUNET_YES;
 718 }
 719
 720 /**
 721  * @brief This is called once a message is sent.
 722  *
 723  * Removes the pending message
 724  *
 725  * @param cls type of the message that was sent
 726  */
 727 static void
 728 mq_notify_sent_cb (void *cls)
 729 {
 730   struct PendingMessage *pending_msg = (struct PendingMessage *) cls;
 731   LOG (GNUNET_ERROR_TYPE_DEBUG,
 732       "%s was sent.\n",
 733       pending_msg->type);
 734   remove_pending_message (pending_msg);
 735 }
 736
 737 /**
 738  * @brief Iterator function for #store_valid_peers.
 739  *
 740  * Implements #GNUNET_CONTAINER_PeerMapIterator.
 741  * Writes single peer to disk.
 742  *
 743  * @param cls the file handle to write to.
 744  * @param peer current peer
 745  * @param value unused
 746  *
 747  * @return  #GNUNET_YES if we should continue to
 748  *          iterate,
 749  *          #GNUNET_NO if not.
 750  */
 751 static int
 752 store_peer_presistently_iterator (void *cls,
 753                                   const struct GNUNET_PeerIdentity *peer,
 754                                   void *value)
 755 {
 756   const struct GNUNET_DISK_FileHandle *fh = cls;
 757   char peer_string[128];
 758   int size;
 759   ssize_t ret;
 760
 761   if (NULL == peer)
 762   {
 763     return GNUNET_YES;
 764   }
 765   size = GNUNET_snprintf (peer_string,
 766                           sizeof (peer_string),
 767                           "%s\n",
 768                           GNUNET_i2s_full (peer));
 769   GNUNET_assert (53 == size);
 770   ret = GNUNET_DISK_file_write (fh,
 771                                 peer_string,
 772                                 size);
 773   GNUNET_assert (size == ret);
 774   return GNUNET_YES;
 775 }
 776
 777 /**
 778  * @brief Store the peers currently in #valid_peers to disk.
 779  */
 780 static void
 781 store_valid_peers ()
 782 {
 783   struct GNUNET_DISK_FileHandle *fh;
 784   uint32_t number_written_peers;
 785
 786   if (GNUNET_OK !=
 787       GNUNET_DISK_directory_create_for_file (filename_valid_peers))
 788   {
 789     GNUNET_break (0);
 790   }
 791   fh = GNUNET_DISK_file_open (filename_valid_peers,
 792                               GNUNET_DISK_OPEN_WRITE |
 793                                   GNUNET_DISK_OPEN_CREATE,
 794                               GNUNET_DISK_PERM_USER_READ |
 795                                   GNUNET_DISK_PERM_USER_WRITE);
 796   if (NULL == fh)
 797   {
 798     LOG (GNUNET_ERROR_TYPE_WARNING,
 799         "Not able to write valid peers to file `%s'\n",
 800         filename_valid_peers);
 801     return;
 802   }
 803   LOG (GNUNET_ERROR_TYPE_DEBUG,
 804       "Writing %u valid peers to disk\n",
 805       GNUNET_CONTAINER_multipeermap_size (valid_peers));
 806   number_written_peers =
 807     GNUNET_CONTAINER_multipeermap_iterate (valid_peers,
 808                                            store_peer_presistently_iterator,
 809                                            fh);
 810   GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
 811   GNUNET_assert (number_written_peers ==
 812       GNUNET_CONTAINER_multipeermap_size (valid_peers));
 813 }
 814
 815 /**
 816  * @brief Convert string representation of peer id to peer id.
 817  *
 818  * Counterpart to #GNUNET_i2s_full.
 819  *
 820  * @param string_repr The string representation of the peer id
 821  *
 822  * @return The peer id
 823  */
 824 static const struct GNUNET_PeerIdentity *
 825 s2i_full (const char *string_repr)
 826 {
 827   struct GNUNET_PeerIdentity *peer;
 828   size_t len;
 829   int ret;
 830
 831   peer = GNUNET_new (struct GNUNET_PeerIdentity);
 832   len = strlen (string_repr);
 833   if (52 > len)
 834   {
 835     LOG (GNUNET_ERROR_TYPE_WARNING,
 836         "Not able to convert string representation of PeerID to PeerID\n"
 837         "Sting representation: %s (len %u) - too short\n",
 838         string_repr,
 839         len);
 840     GNUNET_break (0);
 841   }
 842   else if (52 < len)
 843   {
 844     len = 52;
 845   }
 846   ret = GNUNET_CRYPTO_eddsa_public_key_from_string (string_repr,
 847                                                     len,
 848                                                     &peer->public_key);
 849   if (GNUNET_OK != ret)
 850   {
 851     LOG (GNUNET_ERROR_TYPE_WARNING,
 852         "Not able to convert string representation of PeerID to PeerID\n"
 853         "Sting representation: %s\n",
 854         string_repr);
 855     GNUNET_break (0);
 856   }
 857   return peer;
 858 }
 859
 860 /**
 861  * @brief Restore the peers on disk to #valid_peers.
 862  */
 863 static void
 864 restore_valid_peers ()
 865 {
 866   off_t file_size;
 867   uint32_t num_peers;
 868   struct GNUNET_DISK_FileHandle *fh;
 869   char *buf;
 870   ssize_t size_read;
 871   char *iter_buf;
 872   const char *str_repr;
 873   const struct GNUNET_PeerIdentity *peer;
 874
 875   if (GNUNET_OK != GNUNET_DISK_file_test (filename_valid_peers))
 876   {
 877     return;
 878   }
 879   fh = GNUNET_DISK_file_open (filename_valid_peers,
 880                               GNUNET_DISK_OPEN_READ,
 881                               GNUNET_DISK_PERM_NONE);
 882   GNUNET_assert (NULL != fh);
 883   GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_handle_size (fh, &file_size));
 884   num_peers = file_size / 53;
 885   buf = GNUNET_malloc (file_size);
 886   size_read = GNUNET_DISK_file_read (fh, buf, file_size);
 887   GNUNET_assert (size_read == file_size);
 888   for (iter_buf = buf; iter_buf < buf + file_size - 1; iter_buf += 53)
 889   {
 890     str_repr = GNUNET_strndup (iter_buf, 53);
 891     peer = s2i_full (str_repr);
 892     add_valid_peer (peer);
 893     LOG (GNUNET_ERROR_TYPE_DEBUG,
 894         "Restored valid peer %s from disk\n",
 895         GNUNET_i2s_full (peer));
 896   }
 897   LOG (GNUNET_ERROR_TYPE_DEBUG,
 898       "num_peers: %" PRIu32 ", _size (valid_peers): %u\n",
 899       num_peers,
 900       GNUNET_CONTAINER_multipeermap_size (valid_peers));
 901   GNUNET_assert (num_peers == GNUNET_CONTAINER_multipeermap_size (valid_peers));
 902   GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
 903   LOG (GNUNET_ERROR_TYPE_DEBUG,
 904       "Restored %u valid peers from disk\n",
 905       num_peers);
 906 }
 907
 908 /**
 909  * @brief Initialise storage of peers
 910  *
 911  * @param fn_valid_peers filename of the file used to store valid peer ids
 912  * @param cadet_h cadet handle
 913  * @param own_id own peer identity
 914  */
 915 void
 916 Peers_initialise (char* fn_valid_peers,
 917                   struct GNUNET_CADET_Handle *cadet_h,
 918                   const struct GNUNET_PeerIdentity *own_id)
 919 {
 920   filename_valid_peers = GNUNET_strdup (fn_valid_peers);
 921   cadet_handle = cadet_h;
 922   own_identity = own_id;
 923   peer_map = GNUNET_CONTAINER_multipeermap_create (4, GNUNET_NO);
 924   valid_peers = GNUNET_CONTAINER_multipeermap_create (4, GNUNET_NO);
 925   restore_valid_peers ();
 926 }
 927
 928 /**
 929  * @brief Delete storage of peers that was created with #Peers_initialise ()
 930  */
 931 void
 932 Peers_terminate ()
 933 {
 934   if (GNUNET_SYSERR ==
 935       GNUNET_CONTAINER_multipeermap_iterate (peer_map,
 936                                              peermap_clear_iterator,
 937                                              NULL))
 938   {
 939     LOG (GNUNET_ERROR_TYPE_WARNING,
 940         "Iteration destroying peers was aborted.\n");
 941   }
 942   GNUNET_CONTAINER_multipeermap_destroy (peer_map);
 943   store_valid_peers ();
 944   GNUNET_free (filename_valid_peers);
 945   GNUNET_CONTAINER_multipeermap_destroy (valid_peers);
 946 }
 947
 948
 949 /**
 950  * Iterator over #valid_peers hash map entries.
 951  *
 952  * @param cls closure - unused
 953  * @param peer current peer id
 954  * @param value value in the hash map - unused
 955  * @return #GNUNET_YES if we should continue to
 956  *         iterate,
 957  *         #GNUNET_NO if not.
 958  */
 959 static int
 960 valid_peer_iterator (void *cls,
 961                      const struct GNUNET_PeerIdentity *peer,
 962                      void *value)
 963 {
 964   struct PeersIteratorCls *it_cls = cls;
 965
 966   return it_cls->iterator (it_cls->cls,
 967                            peer);
 968 }
 969
 970
 971 /**
 972  * @brief Get all currently known, valid peer ids.
 973  *
 974  * @param it function to call on each peer id
 975  * @param it_cls extra argument to @a it
 976  * @return the number of key value pairs processed,
 977  *         #GNUNET_SYSERR if it aborted iteration
 978  */
 979 int
 980 Peers_get_valid_peers (PeersIterator iterator,
 981                        void *it_cls)
 982 {
 983   struct PeersIteratorCls *cls;
 984   int ret;
 985
 986   cls = GNUNET_new (struct PeersIteratorCls);
 987   cls->iterator = iterator;
 988   cls->cls = it_cls;
 989   ret = GNUNET_CONTAINER_multipeermap_iterate (valid_peers,
 990                                                valid_peer_iterator,
 991                                                cls);
 992   GNUNET_free (cls);
 993   return ret;
 994 }
 995
 996 /**
 997  * @brief Add peer to known peers.
 998  *
 999  * This function is called on new peer_ids from 'external' sources
1000  * (client seed, cadet get_peers(), ...)
1001  *
1002  * @param peer the new #GNUNET_PeerIdentity
1003  *
1004  * @return #GNUNET_YES if peer was inserted
1005  *         #GNUNET_NO  otherwise (if peer was already known or
1006  *                     peer was #own_identity)
1007  */
1008 int
1009 Peers_insert_peer (const struct GNUNET_PeerIdentity *peer)
1010 {
1011   if ( (GNUNET_YES == Peers_check_peer_known (peer)) ||
1012        (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity)) )
1013   {
1014     return GNUNET_NO; /* We already know this peer - nothing to do */
1015   }
1016   (void) create_peer_ctx (peer);
1017   return GNUNET_YES;
1018 }
1019
1020
1021 /**
1022  * @brief Try connecting to a peer to see whether it is online
1023  *
1024  * If not known yet, insert into known peers
1025  *
1026  * @param peer the peer whose liveliness is to be checked
1027  * @return #GNUNET_YES if peer had to be inserted
1028  *         #GNUNET_NO  otherwise (if peer was already known or
1029  *                     peer was #own_identity)
1030  */
1031 int
1032 Peers_issue_peer_liveliness_check (const struct GNUNET_PeerIdentity *peer)
1033 {
1034   struct PeerContext *peer_ctx;
1035   int ret;
1036
1037   if (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity))
1038   {
1039     return GNUNET_NO;
1040   }
1041   ret = Peers_insert_peer (peer);
1042   peer_ctx = get_peer_ctx (peer);
1043   if (GNUNET_NO == Peers_check_peer_flag (peer, Peers_ONLINE))
1044   {
1045     check_peer_live (peer_ctx);
1046   }
1047   return ret;
1048 }
1049
1050 /**
1051  * @brief Remove unecessary data
1052  *
1053  * If the other peer is not intending to send messages, we have messages pending
1054  * to be sent to this peer and we are not waiting for a reply, remove the
1055  * information about it (its #PeerContext).
1056  *
1057  * @param peer the peer to clean
1058  * @return #GNUNET_YES if peer was removed
1059  *         #GNUNET_NO  otherwise
1060  */
1061 int
1062 Peers_clean_peer (const struct GNUNET_PeerIdentity *peer)
1063 {
1064   struct PeerContext *peer_ctx;
1065
1066   // TODO actually remove unnecessary data
1067
1068   if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
1069   {
1070     return GNUNET_NO;
1071   }
1072
1073   peer_ctx = get_peer_ctx (peer);
1074   if ( (NULL != peer_ctx->recv_channel) ||
1075        (NULL != peer_ctx->pending_messages_head) ||
1076        (GNUNET_NO == check_peer_flag_set (peer_ctx, Peers_PULL_REPLY_PENDING)) )
1077   {
1078     return GNUNET_NO;
1079   }
1080   Peers_remove_peer (peer);
1081   return GNUNET_YES;
1082 }
1083
1084 /**
1085  * @brief Remove peer
1086  *
1087  * @param peer the peer to clean
1088  * @return #GNUNET_YES if peer was removed
1089  *         #GNUNET_NO  otherwise
1090  */
1091 int
1092 Peers_remove_peer (const struct GNUNET_PeerIdentity *peer)
1093 {
1094   struct PeerContext *peer_ctx;
1095
1096   if (GNUNET_NO == GNUNET_CONTAINER_multipeermap_contains (peer_map, peer))
1097   {
1098     return GNUNET_NO;
1099   }
1100
1101   peer_ctx = get_peer_ctx (peer);
1102   set_peer_flag (peer_ctx, Peers_TO_DESTROY);
1103   LOG (GNUNET_ERROR_TYPE_DEBUG,
1104        "Going to remove peer %s\n",
1105        GNUNET_i2s (&peer_ctx->peer_id));
1106   Peers_unset_peer_flag (peer, Peers_ONLINE);
1107
1108   GNUNET_array_grow (peer_ctx->pending_ops, peer_ctx->num_pending_ops, 0);
1109   // TODO delete struct GNUNET_TRANSPORT_TransmitHandle *transmit_handle
1110   /* Cancle messages that have not been sent yet */
1111   while (NULL != peer_ctx->pending_messages_head)
1112   {
1113     LOG (GNUNET_ERROR_TYPE_DEBUG,
1114         "Removing unsent %s\n",
1115         peer_ctx->pending_messages_head->type);
1116     remove_pending_message (peer_ctx->pending_messages_head);
1117   }
1118   /* If we are still waiting for notification whether this peer is live
1119    * cancel the according task */
1120   if (NULL != peer_ctx->transmit_handle)
1121   {
1122     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1123          "Trying to cancle transmit_handle for peer %s\n",
1124          GNUNET_i2s (&peer_ctx->peer_id));
1125     GNUNET_CADET_notify_transmit_ready_cancel (peer_ctx->transmit_handle);
1126     peer_ctx->transmit_handle = NULL;
1127   }
1128   if (NULL != peer_ctx->send_channel)
1129   {
1130     GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1131     peer_ctx->send_channel = NULL;
1132   }
1133   if (NULL != peer_ctx->recv_channel)
1134   {
1135     GNUNET_CADET_channel_destroy (peer_ctx->recv_channel);
1136     peer_ctx->recv_channel = NULL;
1137   }
1138   if (NULL != peer_ctx->mq)
1139   {
1140     GNUNET_MQ_destroy (peer_ctx->mq);
1141     peer_ctx->mq = NULL;
1142   }
1143
1144   GNUNET_free (peer_ctx->send_channel_flags);
1145   GNUNET_free (peer_ctx->recv_channel_flags);
1146
1147   if (GNUNET_YES != GNUNET_CONTAINER_multipeermap_remove_all (peer_map, &peer_ctx->peer_id))
1148   {
1149     LOG (GNUNET_ERROR_TYPE_WARNING, "removing peer from peer_map failed\n");
1150   }
1151   GNUNET_free (peer_ctx);
1152   return GNUNET_YES;
1153 }
1154
1155 /**
1156  * @brief set flags on a given peer.
1157  *
1158  * @param peer the peer to set flags on
1159  * @param flags the flags
1160  */
1161 void
1162 Peers_set_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags)
1163 {
1164   struct PeerContext *peer_ctx;
1165
1166   peer_ctx = get_peer_ctx (peer);
1167   set_peer_flag (peer_ctx, flags);
1168 }
1169
1170 /**
1171  * @brief unset flags on a given peer.
1172  *
1173  * @param peer the peer to unset flags on
1174  * @param flags the flags
1175  */
1176 void
1177 Peers_unset_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags)
1178 {
1179   struct PeerContext *peer_ctx;
1180
1181   peer_ctx = get_peer_ctx (peer);
1182   unset_peer_flag (peer_ctx, flags);
1183 }
1184
1185 /**
1186  * @brief Check whether flags on a peer are set.
1187  *
1188  * @param peer the peer to check the flag of
1189  * @param flags the flags to check
1190  *
1191  * @return #GNUNET_SYSERR if peer is not known
1192  *         #GNUNET_YES    if all given flags are set
1193  *         #GNUNET_NO     otherwise
1194  */
1195 int
1196 Peers_check_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags)
1197 {
1198   struct PeerContext *peer_ctx;
1199
1200   if (GNUNET_NO == Peers_check_peer_known (peer))
1201   {
1202     return GNUNET_SYSERR;
1203   }
1204   peer_ctx = get_peer_ctx (peer);
1205   return check_peer_flag_set (peer_ctx, flags);
1206 }
1207
1208
1209 /**
1210  * @brief set flags on a given channel.
1211  *
1212  * @param channel the channel to set flags on
1213  * @param flags the flags
1214  */
1215 void
1216 Peers_set_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags)
1217 {
1218   set_channel_flag (channel_flags, flags);
1219 }
1220
1221 /**
1222  * @brief unset flags on a given channel.
1223  *
1224  * @param channel the channel to unset flags on
1225  * @param flags the flags
1226  */
1227 void
1228 Peers_unset_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags)
1229 {
1230   unset_channel_flag (channel_flags, flags);
1231 }
1232
1233 /**
1234  * @brief Check whether flags on a channel are set.
1235  *
1236  * @param channel the channel to check the flag of
1237  * @param flags the flags to check
1238  *
1239  * @return #GNUNET_YES if all given flags are set
1240  *         #GNUNET_NO  otherwise
1241  */
1242 int
1243 Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags)
1244 {
1245   return check_channel_flag_set (channel_flags, flags);
1246 }
1247
1248 /**
1249  * @brief Check whether we have information about the given peer.
1250  *
1251  * FIXME probably deprecated. Make this the new _online.
1252  *
1253  * @param peer peer in question
1254  *
1255  * @return #GNUNET_YES if peer is known
1256  *         #GNUNET_NO  if peer is not knwon
1257  */
1258 int
1259 Peers_check_peer_known (const struct GNUNET_PeerIdentity *peer)
1260 {
1261   return GNUNET_CONTAINER_multipeermap_contains (peer_map, peer);
1262 }
1263
1264 /**
1265  * @brief Check whether @a peer is actually a peer.
1266  *
1267  * A valid peer is a peer that we know exists eg. we were connected to once.
1268  *
1269  * @param peer peer in question
1270  *
1271  * @return #GNUNET_YES if peer is valid
1272  *         #GNUNET_NO  if peer is not valid
1273  */
1274 int
1275 Peers_check_peer_valid (const struct GNUNET_PeerIdentity *peer)
1276 {
1277   return GNUNET_CONTAINER_multipeermap_contains (valid_peers, peer);
1278 }
1279
1280 /**
1281  * @brief Indicate that we want to send to the other peer
1282  *
1283  * This establishes a sending channel
1284  *
1285  * @param peer the peer to establish channel to
1286  */
1287 void
1288 Peers_indicate_sending_intention (const struct GNUNET_PeerIdentity *peer)
1289 {
1290   GNUNET_assert (GNUNET_YES == Peers_check_peer_known (peer));
1291   (void) get_channel (peer);
1292 }
1293
1294 /**
1295  * @brief Check whether other peer has the intention to send/opened channel
1296  *        towars us
1297  *
1298  * @param peer the peer in question
1299  *
1300  * @return #GNUNET_YES if peer has the intention to send
1301  *         #GNUNET_NO  otherwise
1302  */
1303 int
1304 Peers_check_peer_send_intention (const struct GNUNET_PeerIdentity *peer)
1305 {
1306   const struct PeerContext *peer_ctx;
1307
1308   peer_ctx = get_peer_ctx (peer);
1309   if (NULL != peer_ctx->recv_channel)
1310   {
1311     return GNUNET_YES;
1312   }
1313   return GNUNET_NO;
1314 }
1315
1316 /**
1317  * Handle the channel a peer opens to us.
1318  *
1319  * @param cls The closure
1320  * @param channel The channel the peer wants to establish
1321  * @param initiator The peer's peer ID
1322  * @param port The port the channel is being established over
1323  * @param options Further options
1324  *
1325  * @return initial channel context for the channel
1326  *         (can be NULL -- that's not an error)
1327  */
1328 void *
1329 Peers_handle_inbound_channel (void *cls,
1330                               struct GNUNET_CADET_Channel *channel,
1331                               const struct GNUNET_PeerIdentity *initiator,
1332                               uint32_t port,
1333                               enum GNUNET_CADET_ChannelOption options)
1334 {
1335   struct PeerContext *peer_ctx;
1336
1337   LOG (GNUNET_ERROR_TYPE_DEBUG,
1338       "New channel was established to us (Peer %s).\n",
1339       GNUNET_i2s (initiator));
1340   GNUNET_assert (NULL != channel); /* according to cadet API */
1341   /* Make sure we 'know' about this peer */
1342   peer_ctx = create_or_get_peer_ctx (initiator);
1343   set_peer_live (peer_ctx);
1344   /* We only accept one incoming channel per peer */
1345   if (GNUNET_YES == Peers_check_peer_send_intention (initiator))
1346   {
1347     set_channel_flag (peer_ctx->recv_channel_flags,
1348                       Peers_CHANNEL_ESTABLISHED_TWICE);
1349     GNUNET_CADET_channel_destroy (channel);
1350     /* return the channel context */
1351     return peer_ctx->recv_channel_flags;
1352   }
1353   peer_ctx->recv_channel = channel;
1354   return peer_ctx->recv_channel_flags;
1355 }
1356
1357 /**
1358  * @brief Check whether a sending channel towards the given peer exists
1359  *
1360  * @param peer the peer to check for
1361  *
1362  * @return #GNUNET_YES if a sending channel towards that peer exists
1363  *         #GNUNET_NO  otherwise
1364  */
1365 int
1366 Peers_check_sending_channel_exists (const struct GNUNET_PeerIdentity *peer)
1367 {
1368   struct PeerContext *peer_ctx;
1369
1370   if (GNUNET_NO == Peers_check_peer_known (peer))
1371   { /* If no such peer exists, there is no channel */
1372     return GNUNET_NO;
1373   }
1374   peer_ctx = get_peer_ctx (peer);
1375   if (NULL == peer_ctx->send_channel)
1376   {
1377     return GNUNET_NO;
1378   }
1379   return GNUNET_YES;
1380 }
1381
1382 /**
1383  * @brief check whether the given channel is the sending channel of the given
1384  *        peer
1385  *
1386  * @param peer the peer in question
1387  * @param channel the channel to check for
1388  * @param role either #Peers_CHANNEL_ROLE_SENDING, or
1389  *                    #Peers_CHANNEL_ROLE_RECEIVING
1390  *
1391  * @return #GNUNET_YES if the given chennel is the sending channel of the peer
1392  *         #GNUNET_NO  otherwise
1393  */
1394 int
1395 Peers_check_channel_role (const struct GNUNET_PeerIdentity *peer,
1396                           const struct GNUNET_CADET_Channel *channel,
1397                           enum Peers_ChannelRole role)
1398 {
1399   const struct PeerContext *peer_ctx;
1400
1401   if (GNUNET_NO == Peers_check_peer_known (peer))
1402   {
1403     return GNUNET_NO;
1404   }
1405   peer_ctx = get_peer_ctx (peer);
1406   if ( (Peers_CHANNEL_ROLE_SENDING == role) &&
1407        (channel == peer_ctx->send_channel) )
1408   {
1409     return GNUNET_YES;
1410   }
1411   if ( (Peers_CHANNEL_ROLE_RECEIVING == role) &&
1412        (channel == peer_ctx->recv_channel) )
1413   {
1414     return GNUNET_YES;
1415   }
1416   return GNUNET_NO;
1417 }
1418
1419 /**
1420  * @brief Destroy the send channel of a peer e.g. stop indicating a sending
1421  *        intention to another peer
1422  *
1423  * If there is also no channel to receive messages from that peer, remove it
1424  * from the peermap.
1425  * TODO really?
1426  *
1427  * @peer the peer identity of the peer whose sending channel to destroy
1428  * @return #GNUNET_YES if channel was destroyed
1429  *         #GNUNET_NO  otherwise
1430  */
1431 int
1432 Peers_destroy_sending_channel (const struct GNUNET_PeerIdentity *peer)
1433 {
1434   struct PeerContext *peer_ctx;
1435
1436   if (GNUNET_NO == Peers_check_peer_known (peer))
1437   {
1438     return GNUNET_NO;
1439   }
1440   peer_ctx = get_peer_ctx (peer);
1441   if (NULL != peer_ctx->send_channel)
1442   {
1443     set_channel_flag (peer_ctx->send_channel_flags, Peers_CHANNEL_CLEAN);
1444     GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1445     peer_ctx->send_channel = NULL;
1446     (void) Peers_check_connected (peer);
1447     return GNUNET_YES;
1448   }
1449   return GNUNET_NO;
1450 }
1451
1452 /**
1453  * This is called when a channel is destroyed.
1454  *
1455  * @param cls The closure
1456  * @param channel The channel being closed
1457  * @param channel_ctx The context associated with this channel
1458  */
1459 void
1460 Peers_cleanup_destroyed_channel (void *cls,
1461                                  const struct GNUNET_CADET_Channel *channel,
1462                                  void *channel_ctx)
1463 {
1464   struct GNUNET_PeerIdentity *peer;
1465   struct PeerContext *peer_ctx;
1466
1467   peer = (struct GNUNET_PeerIdentity *) GNUNET_CADET_channel_get_info (
1468       (struct GNUNET_CADET_Channel *) channel, GNUNET_CADET_OPTION_PEER);
1469        // FIXME wait for cadet to change this function
1470
1471   if (GNUNET_NO == Peers_check_peer_known (peer))
1472   {/* We don't want to implicitly create a context that we're about to kill */
1473   LOG (GNUNET_ERROR_TYPE_DEBUG,
1474        "channel (%s) without associated context was destroyed\n",
1475        GNUNET_i2s (peer));
1476     return;
1477   }
1478   peer_ctx = get_peer_ctx (peer);
1479
1480   /* If our peer issued the destruction of the channel, the #Peers_TO_DESTROY
1481    * flag will be set. In this case simply make sure that the channels are
1482    * cleaned. */
1483   /* FIXME This distinction seems to be redundant */
1484   if (Peers_check_peer_flag (peer, Peers_TO_DESTROY))
1485   {/* We initiatad the destruction of this particular peer */
1486     if (channel == peer_ctx->send_channel)
1487       peer_ctx->send_channel = NULL;
1488     else if (channel == peer_ctx->recv_channel)
1489       peer_ctx->recv_channel = NULL;
1490
1491     if (NULL != peer_ctx->send_channel)
1492     {
1493       GNUNET_CADET_channel_destroy (peer_ctx->send_channel);
1494       peer_ctx->send_channel = NULL;
1495     }
1496     if (NULL != peer_ctx->recv_channel)
1497     {
1498       GNUNET_CADET_channel_destroy (peer_ctx->recv_channel);
1499       peer_ctx->recv_channel = NULL;
1500     }
1501     /* Set the #Peers_ONLINE flag accordingly */
1502     (void) Peers_check_connected (peer);
1503     return;
1504   }
1505
1506   else
1507   { /* We did not initiate the destruction of this peer */
1508     if (channel == peer_ctx->send_channel)
1509     { /* Something (but us) killd the channel - clean up peer */
1510       LOG (GNUNET_ERROR_TYPE_DEBUG,
1511           "send channel (%s) was destroyed - cleaning up\n",
1512           GNUNET_i2s (peer));
1513       peer_ctx->send_channel = NULL;
1514     }
1515     else if (channel == peer_ctx->recv_channel)
1516     { /* Other peer doesn't want to send us messages anymore */
1517       LOG (GNUNET_ERROR_TYPE_DEBUG,
1518            "Peer %s destroyed recv channel - cleaning up channel\n",
1519            GNUNET_i2s (peer));
1520       peer_ctx->recv_channel = NULL;
1521     }
1522     else
1523     {
1524       LOG (GNUNET_ERROR_TYPE_WARNING,
1525            "unknown channel (%s) was destroyed\n",
1526            GNUNET_i2s (peer));
1527     }
1528   }
1529   (void) Peers_check_connected (peer);
1530 }
1531
1532 /**
1533  * @brief Send a message to another peer.
1534  *
1535  * Keeps track about pending messages so they can be properly removed when the
1536  * peer is destroyed.
1537  *
1538  * @param peer receeiver of the message
1539  * @param ev envelope of the message
1540  * @param type type of the message
1541  */
1542 void
1543 Peers_send_message (const struct GNUNET_PeerIdentity *peer,
1544                     struct GNUNET_MQ_Envelope *ev,
1545                     const char *type)
1546 {
1547   struct PendingMessage *pending_msg;
1548   struct GNUNET_MQ_Handle *mq;
1549
1550   pending_msg = insert_pending_message (peer, ev, type);
1551   mq = get_mq (peer);
1552   GNUNET_MQ_notify_sent (ev,
1553                          mq_notify_sent_cb,
1554                          pending_msg);
1555   GNUNET_MQ_send (mq, ev);
1556 }
1557
1558 /**
1559  * @brief Schedule a operation on given peer
1560  *
1561  * Avoids scheduling an operation twice.
1562  *
1563  * @param peer the peer we want to schedule the operation for once it gets live
1564  *
1565  * @return #GNUNET_YES if the operation was scheduled
1566  *         #GNUNET_NO  otherwise
1567  */
1568 int
1569 Peers_schedule_operation (const struct GNUNET_PeerIdentity *peer,
1570                           const PeerOp peer_op)
1571 {
1572   struct PeerPendingOp pending_op;
1573   struct PeerContext *peer_ctx;
1574
1575   if (0 == GNUNET_CRYPTO_cmp_peer_identity (peer, own_identity))
1576   {
1577     return GNUNET_NO;
1578   }
1579   GNUNET_assert (GNUNET_YES == Peers_check_peer_known (peer));
1580
1581   //TODO if LIVE/ONLINE execute immediately
1582
1583   if (GNUNET_NO == check_operation_scheduled (peer, peer_op))
1584   {
1585     peer_ctx = get_peer_ctx (peer);
1586     pending_op.op = peer_op;
1587     pending_op.op_cls = NULL;
1588     GNUNET_array_append (peer_ctx->pending_ops,
1589                          peer_ctx->num_pending_ops,
1590                          pending_op);
1591     return GNUNET_YES;
1592   }
1593   return GNUNET_NO;
1594 }
1595
1596 /* end of gnunet-service-rps_peers.c */