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 Remove unecessary data
 176  *
 177  * If the other peer is not intending to send messages, we have messages pending
 178  * to be sent to this peer and we are not waiting for a reply, remove the
 179  * information about it (its #PeerContext).
 180  *
 181  * @param peer the peer to clean
 182  * @return #GNUNET_YES if peer was removed
 183  *         #GNUNET_NO  otherwise
 184  */
 185 int
 186 Peers_clean_peer (const struct GNUNET_PeerIdentity *peer);
 187
 188 /**
 189  * @brief Remove peer
 190  *
 191  * @param peer the peer to clean
 192  * @return #GNUNET_YES if peer was removed
 193  *         #GNUNET_NO  otherwise
 194  */
 195 int
 196 Peers_remove_peer (const struct GNUNET_PeerIdentity *peer);
 197
 198 /**
 199  * @brief set flags on a given peer.
 200  *
 201  * @param peer the peer to set flags on
 202  * @param flags the flags
 203  */
 204 void
 205 Peers_set_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 206
 207 /**
 208  * @brief unset flags on a given peer.
 209  *
 210  * @param peer the peer to unset flags on
 211  * @param flags the flags
 212  */
 213 void
 214 Peers_unset_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 215
 216 /**
 217  * @brief Check whether flags on a peer are set.
 218  *
 219  * @param peer the peer to check the flag of
 220  * @param flags the flags to check
 221  *
 222  * @return #GNUNET_YES if all given flags are set
 223  *         ##GNUNET_NO  otherwise
 224  */
 225 int
 226 Peers_check_peer_flag (const struct GNUNET_PeerIdentity *peer, enum Peers_PeerFlags flags);
 227
 228
 229 /**
 230  * @brief set flags on a given channel.
 231  *
 232  * @param channel the channel to set flags on
 233  * @param flags the flags
 234  */
 235 void
 236 Peers_set_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 237
 238 /**
 239  * @brief unset flags on a given channel.
 240  *
 241  * @param channel the channel to unset flags on
 242  * @param flags the flags
 243  */
 244 void
 245 Peers_unset_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 246
 247 /**
 248  * @brief Check whether flags on a channel are set.
 249  *
 250  * @param channel the channel to check the flag of
 251  * @param flags the flags to check
 252  *
 253  * @return #GNUNET_YES if all given flags are set
 254  *         #GNUNET_NO  otherwise
 255  */
 256 int
 257 Peers_check_channel_flag (uint32_t *channel_flags, enum Peers_ChannelFlags flags);
 258
 259 /**
 260  * @brief Check whether we have information about the given peer.
 261  *
 262  * FIXME probably deprecated. Make this the new _online.
 263  *
 264  * @param peer peer in question
 265  *
 266  * @return #GNUNET_YES if peer is known
 267  *         #GNUNET_NO  if peer is not knwon
 268  */
 269 int
 270 Peers_check_peer_known (const struct GNUNET_PeerIdentity *peer);
 271
 272 /**
 273  * @brief Check whether @a peer is actually a peer.
 274  *
 275  * A valid peer is a peer that we know exists eg. we were connected to once.
 276  *
 277  * @param peer peer in question
 278  *
 279  * @return #GNUNET_YES if peer is valid
 280  *         #GNUNET_NO  if peer is not valid
 281  */
 282 int
 283 Peers_check_peer_valid (const struct GNUNET_PeerIdentity *peer);
 284
 285 /**
 286  * @brief Indicate that we want to send to the other peer
 287  *
 288  * This establishes a sending channel
 289  *
 290  * @param peer the peer to establish channel to
 291  */
 292 void
 293 Peers_indicate_sending_intention (const struct GNUNET_PeerIdentity *peer);
 294
 295 /**
 296  * @brief Check whether other peer has the intention to send/opened channel
 297  *        towars us
 298  *
 299  * @param peer the peer in question
 300  *
 301  * @return #GNUNET_YES if peer has the intention to send
 302  *         #GNUNET_NO  otherwise
 303  */
 304 int
 305 Peers_check_peer_send_intention (const struct GNUNET_PeerIdentity *peer);
 306
 307 /**
 308  * Handle the channel a peer opens to us.
 309  *
 310  * @param cls The closure
 311  * @param channel The channel the peer wants to establish
 312  * @param initiator The peer's peer ID
 313  * @param port The port the channel is being established over
 314  * @param options Further options
 315  *
 316  * @return initial channel context for the channel
 317  *         (can be NULL -- that's not an error)
 318  */
 319 void *
 320 Peers_handle_inbound_channel (void *cls,
 321                               struct GNUNET_CADET_Channel *channel,
 322                               const struct GNUNET_PeerIdentity *initiator,
 323                               const struct GNUNET_HashCode *port,
 324                               enum GNUNET_CADET_ChannelOption options);
 325
 326 /**
 327  * @brief Check whether a sending channel towards the given peer exists
 328  *
 329  * @param peer the peer to check for
 330  *
 331  * @return #GNUNET_YES if a sending channel towards that peer exists
 332  *         #GNUNET_NO  otherwise
 333  */
 334 int
 335 Peers_check_sending_channel_exists (const struct GNUNET_PeerIdentity *peer);
 336
 337 /**
 338  * @brief check whether the given channel is the sending channel of the given
 339  *        peer
 340  *
 341  * @param peer the peer in question
 342  * @param channel the channel to check for
 343  * @param role either #Peers_CHANNEL_ROLE_SENDING, or
 344  *                    #Peers_CHANNEL_ROLE_RECEIVING
 345  *
 346  * @return #GNUNET_YES if the given chennel is the sending channel of the peer
 347  *         #GNUNET_NO  otherwise
 348  */
 349 int
 350 Peers_check_channel_role (const struct GNUNET_PeerIdentity *peer,
 351                           const struct GNUNET_CADET_Channel *channel,
 352                           enum Peers_ChannelRole role);
 353
 354 /**
 355  * @brief Destroy the send channel of a peer e.g. stop indicating a sending
 356  *        intention to another peer
 357  *
 358  * If there is also no channel to receive messages from that peer, remove it
 359  * from the peermap.
 360  *
 361  * @peer the peer identity of the peer whose sending channel to destroy
 362  * @return #GNUNET_YES if channel was destroyed
 363  *         #GNUNET_NO  otherwise
 364  */
 365 int
 366 Peers_destroy_sending_channel (const struct GNUNET_PeerIdentity *peer);
 367
 368 /**
 369  * This is called when a channel is destroyed.
 370  *
 371  * Removes peer completely from our knowledge if the send_channel was destroyed
 372  * Otherwise simply delete the recv_channel
 373  *
 374  * @param cls The closure
 375  * @param channel The channel being closed
 376  * @param channel_ctx The context associated with this channel
 377  */
 378 void
 379 Peers_cleanup_destroyed_channel (void *cls,
 380                                  const struct GNUNET_CADET_Channel *channel,
 381                                  void *channel_ctx);
 382
 383 /**
 384  * @brief Send a message to another peer.
 385  *
 386  * Keeps track about pending messages so they can be properly removed when the
 387  * peer is destroyed.
 388  *
 389  * @param peer receeiver of the message
 390  * @param ev envelope of the message
 391  * @param type type of the message
 392  */
 393 void
 394 Peers_send_message (const struct GNUNET_PeerIdentity *peer,
 395                     struct GNUNET_MQ_Envelope *ev,
 396                     const char *type);
 397
 398 /**
 399  * @brief Schedule a operation on given peer
 400  *
 401  * Avoids scheduling an operation twice.
 402  *
 403  * @param peer the peer we want to schedule the operation for once it gets live
 404  *
 405  * @return #GNUNET_YES if the operation was scheduled
 406  *         #GNUNET_NO  otherwise
 407  */
 408 int
 409 Peers_schedule_operation (const struct GNUNET_PeerIdentity *peer,
 410                           const PeerOp peer_op);
 411
 412 /* end of gnunet-service-rps_peers.h */