src/cadet/gnunet-service-cadet_peer.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2013 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file cadet/gnunet-service-cadet_peer.h
  23  * @brief cadet service; dealing with remote peers
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMP (Gnunet Cadet Peer)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_CADET_PEER_H
  30 #define GNUNET_SERVICE_CADET_PEER_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "platform.h"
  41 #include "gnunet_util_lib.h"
  42
  43 /**
  44  * Struct containing all information regarding a given peer
  45  */
  46 struct CadetPeer;
  47
  48 /**
  49  * Struct containing info about a queued transmission to this peer
  50  */
  51 struct CadetPeerQueue;
  52
  53 #include "gnunet-service-cadet_connection.h"
  54
  55 /**
  56  * Callback called when a queued message is sent.
  57  *
  58  * @param cls Closure.
  59  * @param c Connection this message was on.
  60  * @param sent Was it really sent? (Could have been canceled)
  61  * @param type Type of message sent.
  62  * @param pid Packet ID, or 0 if not applicable (create, destroy, etc).
  63  * @param fwd Was this a FWD going message?
  64  * @param size Size of the message.
  65  * @param wait Time spent waiting for core (only the time for THIS message)
  66  *
  67  * @return #GNUNET_YES if connection was destroyed, #GNUNET_NO otherwise.
  68  */
  69 typedef int (*GCP_sent) (void *cls,
  70                           struct CadetConnection *c, int sent,
  71                           uint16_t type, uint32_t pid, int fwd, size_t size,
  72                           struct GNUNET_TIME_Relative wait);
  73
  74 /******************************************************************************/
  75 /********************************    API    ***********************************/
  76 /******************************************************************************/
  77
  78 /**
  79  * Initialize peer subsystem.
  80  *
  81  * @param c Configuration.
  82  */
  83 void
  84 GCP_init (const struct GNUNET_CONFIGURATION_Handle *c);
  85
  86 /**
  87  * Shut down the peer subsystem.
  88  */
  89 void
  90 GCP_shutdown (void);
  91
  92
  93 /**
  94  * Retrieve the CadetPeer stucture associated with the peer, create one
  95  * and insert it in the appropriate structures if the peer is not known yet.
  96  *
  97  * @param peer_id Full identity of the peer.
  98  *
  99  * @return Existing or newly created peer structure.
 100  */
 101 struct CadetPeer *
 102 GCP_get (const struct GNUNET_PeerIdentity *peer_id);
 103
 104
 105 /**
 106  * Retrieve the CadetPeer stucture associated with the peer, create one
 107  * and insert it in the appropriate structures if the peer is not known yet.
 108  *
 109  * @param peer Short identity of the peer.
 110  *
 111  * @return Existing or newly created peer structure.
 112  */
 113 struct CadetPeer *
 114 GCP_get_short (const GNUNET_PEER_Id peer);
 115
 116 /**
 117  * Try to establish a new connection to this peer (in its tunnel).
 118  * If the peer doesn't have any path to it yet, try to get one.
 119  * If the peer already has some path, send a CREATE CONNECTION towards it.
 120  *
 121  * @param peer Peer to connect to.
 122  */
 123 void
 124 GCP_connect (struct CadetPeer *peer);
 125
 126 /**
 127  * Free a transmission that was already queued with all resources
 128  * associated to the request.
 129  *
 130  * If connection was marked to be destroyed, and this was the last queued
 131  * message on it, the connection will be free'd as a result.
 132  *
 133  * @param queue Queue handler to cancel.
 134  * @param clear_cls Is it necessary to free associated cls?
 135  * @param sent Was it really sent? (Could have been canceled)
 136  * @param pid PID, if relevant (was sent and was a payload message).
 137  *
 138  * @return #GNUNET_YES if connection was destroyed as a result,
 139  *         #GNUNET_NO otherwise.
 140  */
 141 int
 142 GCP_queue_destroy (struct CadetPeerQueue *queue, int clear_cls,
 143                    int sent, uint32_t pid);
 144
 145 /**
 146  * @brief Queue and pass message to core when possible.
 147  *
 148  * @param peer Peer towards which to queue the message.
 149  * @param cls Closure (@c type dependant). It will be used by queue_send to
 150  *            build the message to be sent if not already prebuilt.
 151  * @param type Type of the message, 0 for a raw message.
 152  * @param size Size of the message.
 153  * @param c Connection this message belongs to (cannot be NULL).
 154  * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
 155  * @param cont Continuation to be called once CORE has taken the message.
 156  * @param cont_cls Closure for @c cont.
 157  *
 158  * @return Handle to cancel the message before it is sent. Once cont is called
 159  *         message has been sent and therefore the handle is no longer valid.
 160  */
 161 struct CadetPeerQueue *
 162 GCP_queue_add (struct CadetPeer *peer, void *cls, uint16_t type,
 163                uint16_t payload_type, uint32_t payload_id,
 164                size_t size, struct CadetConnection *c, int fwd,
 165                GCP_sent cont, void *cont_cls);
 166
 167 /**
 168  * Cancel all queued messages to a peer that belong to a certain connection.
 169  *
 170  * @param peer Peer towards whom to cancel.
 171  * @param c Connection whose queued messages to cancel. Might be destroyed by
 172  *          the sent continuation call.
 173  */
 174 void
 175 GCP_queue_cancel (struct CadetPeer *peer, struct CadetConnection *c);
 176
 177 /**
 178  * Get the first message for a connection and unqueue it.
 179  *
 180  * Only tunnel (or higher) level messages are unqueued. Connection specific
 181  * messages are silently destroyed upon encounter.
 182  *
 183  * @param peer Neighboring peer.
 184  * @param c Connection.
 185  * @param destroyed[in/out] Was the connection destroyed as a result?.
 186  *                          Can NOT be NULL.
 187  *
 188  *
 189  * @return First message for this connection.
 190  */
 191 struct GNUNET_MessageHeader *
 192 GCP_connection_pop (struct CadetPeer *peer,
 193                     struct CadetConnection *c,
 194                     int *destroyed);
 195
 196 /**
 197  * Unlock a possibly locked queue for a connection.
 198  *
 199  * If there is a message that can be sent on this connection, call core for it.
 200  * Otherwise (if core transmit is already called or there is no sendable
 201  * message) do nothing.
 202  *
 203  * @param peer Peer who keeps the queue.
 204  * @param c Connection whose messages to unlock.
 205  */
 206 void
 207 GCP_queue_unlock (struct CadetPeer *peer, struct CadetConnection *c);
 208
 209 /**
 210  * Set tunnel.
 211  *
 212  * @param peer Peer.
 213  * @param t Tunnel.
 214  */
 215 void
 216 GCP_set_tunnel (struct CadetPeer *peer, struct CadetTunnel *t);
 217
 218 /**
 219  * Check whether there is a direct (core level)  connection to peer.
 220  *
 221  * @param peer Peer to check.
 222  *
 223  * @return #GNUNET_YES if there is a direct connection.
 224  */
 225 int
 226 GCP_is_neighbor (const struct CadetPeer *peer);
 227
 228 /**
 229  * Create and initialize a new tunnel towards a peer, in case it has none.
 230  *
 231  * Does not generate any traffic, just creates the local data structures.
 232  *
 233  * @param peer Peer towards which to create the tunnel.
 234  */
 235 void
 236 GCP_add_tunnel (struct CadetPeer *peer);
 237
 238 /**
 239  * Add a connection to a neighboring peer.
 240  *
 241  * Store that the peer is the first hop of the connection in one
 242  * direction and that on peer disconnect the connection must be
 243  * notified and destroyed, for it will no longer be valid.
 244  *
 245  * @param peer Peer to add connection to.
 246  * @param c Connection to add.
 247  *
 248  * @return GNUNET_OK on success.
 249  */
 250 int
 251 GCP_add_connection (struct CadetPeer *peer, struct CadetConnection *c);
 252
 253 /**
 254  * Add the path to the peer and update the path used to reach it in case this
 255  * is the shortest.
 256  *
 257  * @param peer Destination peer to add the path to.
 258  * @param path New path to add. Last peer must be the peer in arg 1.
 259  *             Path will be either used of freed if already known.
 260  * @param trusted Do we trust that this path is real?
 261  *
 262  * @return path if path was taken, pointer to existing duplicate if exists
 263  *         NULL on error.
 264  */
 265 struct CadetPeerPath *
 266 GCP_add_path (struct CadetPeer *peer, struct CadetPeerPath *p, int trusted);
 267
 268 /**
 269  * Add the path to the origin peer and update the path used to reach it in case
 270  * this is the shortest.
 271  * The path is given in peer_info -> destination, therefore we turn the path
 272  * upside down first.
 273  *
 274  * @param peer Peer to add the path to, being the origin of the path.
 275  * @param path New path to add after being inversed.
 276  *             Path will be either used or freed.
 277  * @param trusted Do we trust that this path is real?
 278  *
 279  * @return path if path was taken, pointer to existing duplicate if exists
 280  *         NULL on error.
 281  */
 282 struct CadetPeerPath *
 283 GCP_add_path_to_origin (struct CadetPeer *peer,
 284                         struct CadetPeerPath *path,
 285                         int trusted);
 286
 287 /**
 288  * Adds a path to the info of all the peers in the path
 289  *
 290  * @param p Path to process.
 291  * @param confirmed Whether we know if the path works or not.
 292  */
 293 void
 294 GCP_add_path_to_all (const struct CadetPeerPath *p, int confirmed);
 295
 296 /**
 297  * Remove any path to the peer that has the extact same peers as the one given.
 298  *
 299  * @param peer Peer to remove the path from.
 300  * @param path Path to remove. Is always destroyed .
 301  */
 302 void
 303 GCP_remove_path (struct CadetPeer *peer, struct CadetPeerPath *path);
 304
 305 /**
 306  * Remove a connection from a neighboring peer.
 307  *
 308  * @param peer Peer to remove connection from.
 309  * @param c Connection to remove.
 310  *
 311  * @return GNUNET_OK on success.
 312  */
 313 int
 314 GCP_remove_connection (struct CadetPeer *peer, const struct CadetConnection *c);
 315
 316 /**
 317  * Start the DHT search for new paths towards the peer: we don't have
 318  * enough good connections.
 319  *
 320  * @param peer Destination peer.
 321  */
 322 void
 323 GCP_start_search (struct CadetPeer *peer);
 324
 325 /**
 326  * Stop the DHT search for new paths towards the peer: we already have
 327  * enough good connections.
 328  *
 329  * @param peer Destination peer.
 330  */
 331 void
 332 GCP_stop_search (struct CadetPeer *peer);
 333
 334 /**
 335  * Get the Full ID of a peer.
 336  *
 337  * @param peer Peer to get from.
 338  *
 339  * @return Full ID of peer.
 340  */
 341 const struct GNUNET_PeerIdentity *
 342 GCP_get_id (const struct CadetPeer *peer);
 343
 344 /**
 345  * Get the Short ID of a peer.
 346  *
 347  * @param peer Peer to get from.
 348  *
 349  * @return Short ID of peer.
 350  */
 351 GNUNET_PEER_Id
 352 GCP_get_short_id (const struct CadetPeer *peer);
 353
 354 /**
 355  * Get the tunnel towards a peer.
 356  *
 357  * @param peer Peer to get from.
 358  *
 359  * @return Tunnel towards peer.
 360  */
 361 struct CadetTunnel *
 362 GCP_get_tunnel (const struct CadetPeer *peer);
 363
 364 /**
 365  * Set the hello message.
 366  *
 367  * @param peer Peer whose message to set.
 368  * @param hello Hello message.
 369  */
 370 void
 371 GCP_set_hello (struct CadetPeer *peer, const struct GNUNET_HELLO_Message *hello);
 372
 373 /**
 374  * Get the hello message.
 375  *
 376  * @param peer Peer whose message to get.
 377  *
 378  * @return Hello message.
 379  */
 380 struct GNUNET_HELLO_Message *
 381 GCP_get_hello (struct CadetPeer *peer);
 382
 383
 384 /**
 385  * Try to connect to a peer on TRANSPORT level.
 386  *
 387  * @param peer Peer to whom to connect.
 388  */
 389 void
 390 GCP_try_connect (struct CadetPeer *peer);
 391
 392 /**
 393  * Notify a peer that a link between two other peers is broken. If any path
 394  * used that link, eliminate it.
 395  *
 396  * @param peer Peer affected by the change.
 397  * @param peer1 Peer whose link is broken.
 398  * @param peer2 Peer whose link is broken.
 399  */
 400 void
 401 GCP_notify_broken_link (struct CadetPeer *peer,
 402                         struct GNUNET_PeerIdentity *peer1,
 403                         struct GNUNET_PeerIdentity *peer2);
 404
 405 /**
 406  * Count the number of known paths toward the peer.
 407  *
 408  * @param peer Peer to get path info.
 409  *
 410  * @return Number of known paths.
 411  */
 412 unsigned int
 413 GCP_count_paths (const struct CadetPeer *peer);
 414
 415 /**
 416  * Iterate all known peers.
 417  *
 418  * @param iter Iterator.
 419  * @param cls Closure for @c iter.
 420  */
 421 void
 422 GCP_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls);
 423
 424 /**
 425  * Get the static string for a peer ID.
 426  *
 427  * @param peer Peer.
 428  *
 429  * @return Static string for it's ID.
 430  */
 431 const char *
 432 GCP_2s (const struct CadetPeer *peer);
 433
 434 /**
 435  * Log all kinds of info about a peer.
 436  *
 437  * @param peer Peer.
 438  */
 439 void
 440 GCP_debug (const struct CadetPeer *p, enum GNUNET_ErrorType level);
 441
 442
 443 #if 0                           /* keep Emacsens' auto-indent happy */
 444 {
 445 #endif
 446 #ifdef __cplusplus
 447 }
 448 #endif
 449
 450 /* ifndef GNUNET_CADET_SERVICE_PEER_H */
 451 #endif
 452 /* end of gnunet-cadet-service_peer.h */