src/rps/gnunet-service-rps_peers.h

   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.h
  23  * @brief utilities for managing (information about) peers
  24  * @author Julius Bünger
  25  */
  26 #include "gnunet_util_lib.h"
  27 #include <inttypes.h>
  28 #include "gnunet_cadet_service.h"
  29
  30
  31 /**
  32  * Different flags indicating the status of another peer.
  33  */
  34 enum Peers_PeerFlags
  35 {
  36   /**
  37    * If we are waiting for a reply from that peer (sent a pull request).
  38    */
  39   Peers_PULL_REPLY_PENDING   = 0x01,
  40
  41   /* IN_OTHER_GOSSIP_LIST = 0x02, unneeded? */
  42   /* IN_OWN_SAMPLER_LIST  = 0x04, unneeded? */
  43   /* IN_OWN_GOSSIP_LIST   = 0x08, unneeded? */
  44
  45   /**
  46    * We set this bit when we know the peer is online.
  47    */
  48   Peers_ONLINE               = 0x20,
  49
  50   /**
  51    * We set this bit when we are going to destroy the channel to this peer.
  52    * When cleanup_channel is called, we know that we wanted to destroy it.
  53    * Otherwise the channel to the other peer was destroyed.
  54    */
  55   Peers_TO_DESTROY           = 0x40,
  56 };
  57
  58 /**
  59  * Keep track of the status of a channel.
  60  *
  61  * This is needed in order to know what to do with a channel when it's
  62  * destroyed.
  63  */
  64 enum Peers_ChannelFlags
  65 {
  66   /**
  67    * We destroyed the channel because the other peer established a second one.
  68    */
  69   Peers_CHANNEL_ESTABLISHED_TWICE = 0x1,
  70
  71   /**
  72    * The channel was removed because it was not needed any more. This should be
  73    * the sending channel.
  74    */
  75   Peers_CHANNEL_CLEAN = 0x2,
  76 };
  77
  78 /**
  79  * @brief The role of a channel. Sending or receiving.
  80  */
  81 enum Peers_ChannelRole
  82 {
  83   /**
  84    * Channel is used for sending
  85    */
  86   Peers_CHANNEL_ROLE_SENDING   = 0x01,
  87
  88   /**
  89    * Channel is used for receiving
  90    */
  91   Peers_CHANNEL_ROLE_RECEIVING = 0x02,
  92 };
  93
  94 /**
  95  * @brief Functions of this type can be used to be stored at a peer for later execution.
  96  *
  97  * @param cls closure
  98  * @param peer peer to execute function on
  99  */
 100 typedef void (* PeerOp) (void *cls, const struct GNUNET_PeerIdentity *peer);
 101
 102 /**
 103  * @brief Iterator over valid peers.
 104  *
 105  * @param cls closure
 106  * @param peer current public peer id
 107  * @return #GNUNET_YES if we should continue to
 108  *         iterate,
 109  *         #GNUNET_NO if not.
 110  */
 111 typedef int
 112 (*PeersIterator) (void *cls,
 113                   const struct GNUNET_PeerIdentity *peer);
 114
 115 /**
 116  * @brief Initialise storage of peers
 117  *
 118  * @param fn_valid_peers filename of the file used to store valid peer ids
 119  * @param cadet_h cadet handle
 120  * @param own_id own peer identity
 121  */
 122 void
 123 Peers_initialise (char* fn_valid_peers,
 124                   struct GNUNET_CADET_Handle *cadet_h,
 125                   const struct GNUNET_PeerIdentity *own_id);
 126
 127 /**
 128  * @brief Delete storage of peers that was created with #Peers_initialise ()
 129  */
 130 void
 131 Peers_terminate ();
 132
 133
 134 /**
 135  * @brief Get all currently known, valid peer ids.
 136  *
 137  * @param it function to call on each peer id
 138  * @param it_cls extra argument to @a it
 139  * @return the number of key value pairs processed,
 140  *         #GNUNET_SYSERR if it aborted iteration
 141  */
 142 int
 143 Peers_get_valid_peers (PeersIterator iterator,
 144                        void *it_cls);
 145
 146 /**
 147  * @brief Add peer to known peers.
 148  *
 149  * This function is called on new peer_ids from 'external' sources
 150  * (client seed, cadet get_peers(), ...)
 151  *
 152  * @param peer the new #GNUNET_PeerIdentity
 153  *
 154  * @return #GNUNET_YES if peer was inserted
 155  *         #GNUNET_NO  otherwise (if peer was already known or
 156  *                     peer was #own_identity)
 157  */
 158 int
 159 Peers_insert_peer (const struct GNUNET_PeerIdentity *peer);
 160
 161 /**
 162  * @brief Try connecting to a peer to see whether it is online
 163  *
 164  * If not known yet, insert into known peers
 165  *
 166  * @param peer the peer whose liveliness is to be checked
 167  * @return #GNUNET_YES if peer had to be inserted
 168  *         #GNUNET_NO  otherwise (if peer was already known or
 169  *                     peer was #own_identity)
 170  */
 171 int
 172 Peers_issue_peer_liveliness_check (const struct GNUNET_PeerIdentity *peer);
 173
 174 /**
 175  * @brief Check if peer is removable.
 176  *
 177  * Check if
 178  *  - a recv channel exists
 179  *  - there are pending messages
 180  *  - there is no pending pull reply
 181  *
 182  * @param peer the peer in question
 183  * @return #GNUNET_YES    if peer is removable
 184  *         #GNUNET_NO     if peer is NOT removable
 185  *         #GNUNET_SYSERR if peer is not known
 186  */
 187 int
 188 Peers_check_removable (const struct GNUNET_PeerIdentity *peer);
 189
 190 /**
 191  * @brief Remove peer
 192  *
 193  * @param peer the peer to clean
 194  * @return #GNUNET_YES if peer was removed
 195  *         #GNUNET_NO  otherwise
 196  */
 197 int
 198 Peers_remove_peer (const struct GNUNET_PeerIdentity *peer);
 199
 200 /**
 201  * @brief set flags on a given peer.
 202  *
 203  * @param peer the peer to set flags on
 204  * @param flags the flags
 205  */
 206 void
 207 Peers_set_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 208
 209 /**
 210  * @brief unset flags on a given peer.
 211  *
 212  * @param peer the peer to unset flags on
 213  * @param flags the flags
 214  */
 215 void
 216 Peers_unset_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 217
 218 /**
 219  * @brief Check whether flags on a peer are set.
 220  *
 221  * @param peer the peer to check the flag of
 222  * @param flags the flags to check
 223  *
 224  * @return #GNUNET_YES if all given flags are set
 225  *         ##GNUNET_NO  otherwise
 226  */
 227 int
 228 Peers_check_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 229
 230
 231 /**
 232  * @brief set flags on a given channel.
 233  *
 234  * @param channel the channel to set flags on
 235  * @param flags the flags
 236  */
 237 void
 238 Peers_set_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 239
 240 /**
 241  * @brief unset flags on a given channel.
 242  *
 243  * @param channel the channel to unset flags on
 244  * @param flags the flags
 245  */
 246 void
 247 Peers_unset_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 248
 249 /**
 250  * @brief Check whether flags on a channel are set.
 251  *
 252  * @param channel the channel to check the flag of
 253  * @param flags the flags to check
 254  *
 255  * @return #GNUNET_YES if all given flags are set
 256  *         #GNUNET_NO  otherwise
 257  */
 258 int
 259 Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 260
 261 /**
 262  * @brief Check whether we have information about the given peer.
 263  *
 264  * FIXME probably deprecated. Make this the new _online.
 265  *
 266  * @param peer peer in question
 267  *
 268  * @return #GNUNET_YES if peer is known
 269  *         #GNUNET_NO  if peer is not knwon
 270  */
 271 int
 272 Peers_check_peer_known (const struct GNUNET_PeerIdentity *peer);
 273
 274 /**
 275  * @brief Check whether @a peer is actually a peer.
 276  *
 277  * A valid peer is a peer that we know exists eg. we were connected to once.
 278  *
 279  * @param peer peer in question
 280  *
 281  * @return #GNUNET_YES if peer is valid
 282  *         #GNUNET_NO  if peer is not valid
 283  */
 284 int
 285 Peers_check_peer_valid (const struct GNUNET_PeerIdentity *peer);
 286
 287 /**
 288  * @brief Indicate that we want to send to the other peer
 289  *
 290  * This establishes a sending channel
 291  *
 292  * @param peer the peer to establish channel to
 293  */
 294 void
 295 Peers_indicate_sending_intention (const struct GNUNET_PeerIdentity *peer);
 296
 297 /**
 298  * @brief Check whether other peer has the intention to send/opened channel
 299  *        towars us
 300  *
 301  * @param peer the peer in question
 302  *
 303  * @return #GNUNET_YES if peer has the intention to send
 304  *         #GNUNET_NO  otherwise
 305  */
 306 int
 307 Peers_check_peer_send_intention (const struct GNUNET_PeerIdentity *peer);
 308
 309 /**
 310  * Handle the channel a peer opens to us.
 311  *
 312  * @param cls The closure
 313  * @param channel The channel the peer wants to establish
 314  * @param initiator The peer's peer ID
 315  * @param port The port the channel is being established over
 316  * @param options Further options
 317  *
 318  * @return initial channel context for the channel
 319  *         (can be NULL -- that's not an error)
 320  */
 321 void *
 322 Peers_handle_inbound_channel (void *cls,
 323                               struct GNUNET_CADET_Channel *channel,
 324                               const struct GNUNET_PeerIdentity *initiator,
 325                               const struct GNUNET_HashCode *port,
 326                               enum GNUNET_CADET_ChannelOption options);
 327
 328 /**
 329  * @brief Check whether a sending channel towards the given peer exists
 330  *
 331  * @param peer the peer to check for
 332  *
 333  * @return #GNUNET_YES if a sending channel towards that peer exists
 334  *         #GNUNET_NO  otherwise
 335  */
 336 int
 337 Peers_check_sending_channel_exists (const struct GNUNET_PeerIdentity *peer);
 338
 339 /**
 340  * @brief check whether the given channel is the sending channel of the given
 341  *        peer
 342  *
 343  * @param peer the peer in question
 344  * @param channel the channel to check for
 345  * @param role either #Peers_CHANNEL_ROLE_SENDING, or
 346  *                    #Peers_CHANNEL_ROLE_RECEIVING
 347  *
 348  * @return #GNUNET_YES if the given chennel is the sending channel of the peer
 349  *         #GNUNET_NO  otherwise
 350  */
 351 int
 352 Peers_check_channel_role (const struct GNUNET_PeerIdentity *peer,
 353                           const struct GNUNET_CADET_Channel *channel,
 354                           enum Peers_ChannelRole role);
 355
 356 /**
 357  * @brief Destroy the send channel of a peer e.g. stop indicating a sending
 358  *        intention to another peer
 359  *
 360  * If there is also no channel to receive messages from that peer, remove it
 361  * from the peermap.
 362  *
 363  * @peer the peer identity of the peer whose sending channel to destroy
 364  * @return #GNUNET_YES if channel was destroyed
 365  *         #GNUNET_NO  otherwise
 366  */
 367 int
 368 Peers_destroy_sending_channel (const struct GNUNET_PeerIdentity *peer);
 369
 370 /**
 371  * This is called when a channel is destroyed.
 372  *
 373  * Removes peer completely from our knowledge if the send_channel was destroyed
 374  * Otherwise simply delete the recv_channel
 375  *
 376  * @param cls The closure
 377  * @param channel The channel being closed
 378  * @param channel_ctx The context associated with this channel
 379  */
 380 void
 381 Peers_cleanup_destroyed_channel (void *cls,
 382                                  const struct GNUNET_CADET_Channel *channel,
 383                                  void *channel_ctx);
 384
 385 /**
 386  * @brief Send a message to another peer.
 387  *
 388  * Keeps track about pending messages so they can be properly removed when the
 389  * peer is destroyed.
 390  *
 391  * @param peer receeiver of the message
 392  * @param ev envelope of the message
 393  * @param type type of the message
 394  */
 395 void
 396 Peers_send_message (const struct GNUNET_PeerIdentity *peer,
 397                     struct GNUNET_MQ_Envelope *ev,
 398                     const char *type);
 399
 400 /**
 401  * @brief Schedule a operation on given peer
 402  *
 403  * Avoids scheduling an operation twice.
 404  *
 405  * @param peer the peer we want to schedule the operation for once it gets live
 406  *
 407  * @return #GNUNET_YES if the operation was scheduled
 408  *         #GNUNET_NO  otherwise
 409  */
 410 int
 411 Peers_schedule_operation (const struct GNUNET_PeerIdentity *peer,
 412                           const PeerOp peer_op);
 413
 414 /* end of gnunet-service-rps_peers.h */