src/mesh/gnunet-service-mesh_connection.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 mesh/gnunet-service-mesh_connection.h
  23  * @brief mesh service; dealing with connections
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMC (Gnunet Mesh Connection)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_MESH_CONNECTION_H
  30 #define GNUNET_SERVICE_MESH_CONNECTION_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 "gnunet_util_lib.h"
  41
  42
  43 /**
  44  * All the states a connection can be in.
  45  */
  46 enum MeshConnectionState
  47 {
  48   /**
  49    * Uninitialized status, should never appear in operation.
  50    */
  51   MESH_CONNECTION_NEW,
  52
  53   /**
  54    * Connection create message sent, waiting for ACK.
  55    */
  56   MESH_CONNECTION_SENT,
  57
  58   /**
  59    * Connection ACK sent, waiting for ACK.
  60    */
  61   MESH_CONNECTION_ACK,
  62
  63   /**
  64    * Connection confirmed, ready to carry traffic.
  65    */
  66   MESH_CONNECTION_READY,
  67 };
  68
  69
  70 /**
  71  * Struct containing all information regarding a connection to a peer.
  72  */
  73 struct MeshConnection;
  74
  75 #include "mesh_path.h"
  76 #include "gnunet-service-mesh_channel.h"
  77 #include "gnunet-service-mesh_peer.h"
  78
  79
  80
  81 /**
  82  * Core handler for connection creation.
  83  *
  84  * @param cls Closure (unused).
  85  * @param peer Sender (neighbor).
  86  * @param message Message.
  87  *
  88  * @return GNUNET_OK to keep the connection open,
  89  *         GNUNET_SYSERR to close it (signal serious error)
  90  */
  91 int
  92 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
  93                    const struct GNUNET_MessageHeader *message);
  94
  95 /**
  96  * Core handler for path confirmations.
  97  *
  98  * @param cls closure
  99  * @param message message
 100  * @param peer peer identity this notification is about
 101  *
 102  * @return GNUNET_OK to keep the connection open,
 103  *         GNUNET_SYSERR to close it (signal serious error)
 104  */
 105 int
 106 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
 107                     const struct GNUNET_MessageHeader *message);
 108
 109 /**
 110  * Core handler for notifications of broken paths
 111  *
 112  * @param cls Closure (unused).
 113  * @param id Peer identity of sending neighbor.
 114  * @param message Message.
 115  *
 116  * @return GNUNET_OK to keep the connection open,
 117  *         GNUNET_SYSERR to close it (signal serious error)
 118  */
 119 int
 120 GMC_handle_broken (void* cls,
 121                    const struct GNUNET_PeerIdentity* id,
 122                    const struct GNUNET_MessageHeader* message);
 123
 124 /**
 125  * Core handler for tunnel destruction
 126  *
 127  * @param cls Closure (unused).
 128  * @param peer Peer identity of sending neighbor.
 129  * @param message Message.
 130  *
 131  * @return GNUNET_OK to keep the connection open,
 132  *         GNUNET_SYSERR to close it (signal serious error)
 133  */
 134 int
 135 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
 136                     const struct GNUNET_MessageHeader *message);
 137
 138 /**
 139  * Core handler for encrypted mesh network traffic (channel mgmt, data).
 140  *
 141  * @param cls Closure (unused).
 142  * @param message Message received.
 143  * @param peer Peer who sent the message.
 144  *
 145  * @return GNUNET_OK to keep the connection open,
 146  *         GNUNET_SYSERR to close it (signal serious error)
 147  */
 148 int
 149 GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
 150                       const struct GNUNET_MessageHeader *message);
 151
 152 /**
 153  * Core handler for mesh network traffic point-to-point acks.
 154  *
 155  * @param cls closure
 156  * @param message message
 157  * @param peer peer identity this notification is about
 158  *
 159  * @return GNUNET_OK to keep the connection open,
 160  *         GNUNET_SYSERR to close it (signal serious error)
 161  */
 162 int
 163 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
 164                 const struct GNUNET_MessageHeader *message);
 165
 166 /**
 167  * Core handler for mesh network traffic point-to-point ack polls.
 168  *
 169  * @param cls closure
 170  * @param message message
 171  * @param peer peer identity this notification is about
 172  *
 173  * @return GNUNET_OK to keep the connection open,
 174  *         GNUNET_SYSERR to close it (signal serious error)
 175  */
 176 int
 177 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
 178                  const struct GNUNET_MessageHeader *message);
 179
 180 /**
 181  * Core handler for mesh keepalives.
 182  *
 183  * @param cls closure
 184  * @param message message
 185  * @param peer peer identity this notification is about
 186  * @return GNUNET_OK to keep the connection open,
 187  *         GNUNET_SYSERR to close it (signal serious error)
 188  *
 189  * TODO: Check who we got this from, to validate route.
 190  */
 191 int
 192 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
 193                       const struct GNUNET_MessageHeader *message);
 194
 195 /**
 196  * Send an ACK on the appropriate connection/channel, depending on
 197  * the direction and the position of the peer.
 198  *
 199  * @param c Which connection to send the hop-by-hop ACK.
 200  * @param ch Channel, if any.
 201  * @param fwd Is this a fwd ACK? (will go dest->root)
 202  */
 203 void
 204 GMC_send_ack (struct MeshConnection *c, struct MeshChannel *ch, int fwd);
 205
 206 /**
 207  * Initialize the connections subsystem
 208  *
 209  * @param c Configuration handle.
 210  */
 211 void
 212 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c);
 213
 214 /**
 215  * Shut down the connections subsystem.
 216  */
 217 void
 218 GMC_shutdown (void);
 219
 220 /**
 221  * Create a connection.
 222  *
 223  * @param cid Connection ID (either created locally or imposed remotely).
 224  * @param t Tunnel this connection belongs to (or NULL);
 225  * @param p Path this connection has to use.
 226  * @param own_pos Own position in the @c p path.
 227  */
 228 struct MeshConnection *
 229 GMC_new (const struct GNUNET_HashCode *cid,
 230          struct MeshTunnel3 *t,
 231          struct MeshPeerPath *p,
 232          unsigned int own_pos);
 233
 234 /**
 235  * Connection is no longer needed: destroy it and remove from tunnel.
 236  *
 237  * @param c Connection to destroy.
 238  */
 239 void
 240 GMC_destroy (struct MeshConnection *c);
 241
 242 /**
 243  * Get the connection ID.
 244  *
 245  * @param c Connection to get the ID from.
 246  *
 247  * @return ID of the connection.
 248  */
 249 const struct GNUNET_HashCode *
 250 GMC_get_id (const struct MeshConnection *c);
 251
 252 /**
 253  * Get the connection path.
 254  *
 255  * @param c Connection to get the path from.
 256  *
 257  * @return path used by the connection.
 258  */
 259 const struct MeshPeerPath *
 260 GMC_get_path (const struct MeshConnection *c);
 261
 262 /**
 263  * Get the connection state.
 264  *
 265  * @param c Connection to get the state from.
 266  *
 267  * @return state of the connection.
 268  */
 269 enum MeshConnectionState
 270 GMC_get_state (const struct MeshConnection *c);
 271
 272 /**
 273  * Get the connection tunnel.
 274  *
 275  * @param c Connection to get the tunnel from.
 276  *
 277  * @return tunnel of the connection.
 278  */
 279 struct MeshTunnel3 *
 280 GMC_get_tunnel (const struct MeshConnection *c);
 281
 282 /**
 283  * Get free buffer space in a connection.
 284  *
 285  * @param c Connection.
 286  * @param fwd Is query about FWD traffic?
 287  *
 288  * @return Free buffer space [0 - max_msgs_queue/max_connections]
 289  */
 290 unsigned int
 291 GMC_get_buffer (struct MeshConnection *c, int fwd);
 292
 293 /**
 294  * Get how many messages have we allowed to send to us from a direction..
 295  *
 296  * @param c Connection.
 297  * @param fwd Are we asking about traffic from FWD (BCK messages)?
 298  *
 299  * @return last_ack_sent - last_pid_recv
 300  */
 301 unsigned int
 302 GMC_get_allowed (struct MeshConnection *c, int fwd);
 303
 304 /**
 305  * Get messages queued in a connection.
 306  *
 307  * @param c Connection.
 308  * @param fwd Is query about FWD traffic?
 309  *
 310  * @return Number of messages queued.
 311  */
 312 unsigned int
 313 GMC_get_qn (struct MeshConnection *c, int fwd);
 314
 315 /**
 316  * Allow the connection to advertise a buffer of the given size.
 317  *
 318  * The connection will send an @c fwd ACK message (so: in direction !fwd)
 319  * allowing up to last_pid_recv + buffer.
 320  *
 321  * @param c Connection.
 322  * @param buffer How many more messages the connection can accept.
 323  * @param fwd Is this about FWD traffic? (The ack will go dest->root).
 324  */
 325 void
 326 GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd);
 327
 328 /**
 329  * Send FWD keepalive packets for a connection.
 330  *
 331  * @param cls Closure (connection for which to send the keepalive).
 332  * @param tc Notification context.
 333  */
 334 void
 335 GMC_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 336
 337 /**
 338  * Send BCK keepalive packets for a connection.
 339  *
 340  * @param cls Closure (connection for which to send the keepalive).
 341  * @param tc Notification context.
 342  */
 343 void
 344 GMC_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 345
 346
 347 /**
 348  * Notify other peers on a connection of a broken link. Mark connections
 349  * to destroy after all traffic has been sent.
 350  *
 351  * @param c Connection on which there has been a disconnection.
 352  * @param peer Peer that disconnected.
 353  */
 354 void
 355 GMC_notify_broken (struct MeshConnection *c,
 356                    struct MeshPeer *peer);
 357
 358 /**
 359  * Is this peer the first one on the connection?
 360  *
 361  * @param c Connection.
 362  * @param fwd Is this about fwd traffic?
 363  *
 364  * @return GNUNET_YES if origin, GNUNET_NO if relay/terminal.
 365  */
 366 int
 367 GMC_is_origin (struct MeshConnection *c, int fwd);
 368
 369 /**
 370  * Is this peer the last one on the connection?
 371  *
 372  * @param c Connection.
 373  * @param fwd Is this about fwd traffic?
 374  *            Note that the ROOT is the terminal for BCK traffic!
 375  *
 376  * @return GNUNET_YES if terminal, GNUNET_NO if relay/origin.
 377  */
 378 int
 379 GMC_is_terminal (struct MeshConnection *c, int fwd);
 380
 381 /**
 382  * See if we are allowed to send by the next hop in the given direction.
 383  *
 384  * @param c Connection.
 385  * @param fwd Is this about fwd traffic?
 386  *
 387  * @return GNUNET_YES in case it's OK.
 388  */
 389 int
 390 GMC_is_sendable (struct MeshConnection *c, int fwd);
 391
 392 /**
 393  * Sends an already built message on a connection, properly registering
 394  * all used resources.
 395  *
 396  * @param message Message to send. Function makes a copy of it.
 397  *                If message is not hop-by-hop, decrements TTL of copy.
 398  * @param c Connection on which this message is transmitted.
 399  * @param ch Channel on which this message is transmitted, or NULL.
 400  * @param fwd Is this a fwd message?
 401  */
 402 void
 403 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
 404                            struct MeshConnection *c,
 405                            struct MeshChannel *ch,
 406                            int fwd);
 407
 408 /**
 409  * Sends a CREATE CONNECTION message for a path to a peer.
 410  * Changes the connection and tunnel states if necessary.
 411  *
 412  * @param connection Connection to create.
 413  */
 414 void
 415 GMC_send_create (struct MeshConnection *connection);
 416
 417 /**
 418  * Send a message to all peers in this connection that the connection
 419  * is no longer valid.
 420  *
 421  * If some peer should not receive the message, it should be zero'ed out
 422  * before calling this function.
 423  *
 424  * @param c The connection whose peers to notify.
 425  */
 426 void
 427 GMC_send_destroy (struct MeshConnection *c);
 428
 429 /**
 430  * @brief Start a polling timer for the connection.
 431  *
 432  * When a neighbor does not accept more traffic on the connection it could be
 433  * caused by a simple congestion or by a lost ACK. Polling enables to check
 434  * for the lastest ACK status for a connection.
 435  *
 436  * @param c Connection.
 437  * @param fwd Should we poll in the FWD direction?
 438  */
 439 void
 440 GMC_start_poll (struct MeshConnection *c, int fwd);
 441
 442
 443 /**
 444  * @brief Stop polling a connection for ACKs.
 445  *
 446  * Once we have enough ACKs for future traffic, polls are no longer necessary.
 447  *
 448  * @param c Connection.
 449  * @param fwd Should we stop the poll in the FWD direction?
 450  */
 451 void
 452 GMC_stop_poll (struct MeshConnection *c, int fwd);
 453
 454 #if 0                           /* keep Emacsens' auto-indent happy */
 455 {
 456 #endif
 457 #ifdef __cplusplus
 458 }
 459 #endif
 460
 461 /* ifndef GNUNET_SERVICE_MESH_CONNECTION_H */
 462 #endif
 463 /* end of gnunet-service-mesh_connection.h */