src/fs/gnunet-service-fs_cp.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 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 fs/gnunet-service-fs_cp.h
  23  * @brief API to handle 'connected peers'
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_FS_CP_H
  27 #define GNUNET_SERVICE_FS_CP_H
  28
  29 #include "fs.h"
  30 #include "gnunet-service-fs.h"
  31
  32
  33 /**
  34  * Performance data kept for a peer.
  35  */
  36 struct GSF_PeerPerformanceData
  37 {
  38
  39   /**
  40    * Transport performance data.
  41    */
  42   struct GNUNET_TRANSPORT_ATS_Information *atsi;
  43
  44   /**
  45    * List of the last clients for which this peer successfully
  46    * answered a query.
  47    */
  48   struct GSF_LocalClient *last_client_replies[CS2P_SUCCESS_LIST_SIZE];
  49
  50   /**
  51    * List of the last PIDs for which
  52    * this peer successfully answered a query;
  53    * We use 0 to indicate no successful reply.
  54    */
  55   GNUNET_PEER_Id last_p2p_replies[P2P_SUCCESS_LIST_SIZE];
  56
  57   /**
  58    * Average delay between sending the peer a request and
  59    * getting a reply (only calculated over the requests for
  60    * which we actually got a reply).   Calculated
  61    * as a moving average: new_delay = ((n-1)*last_delay+curr_delay) / n
  62    */
  63   struct GNUNET_TIME_Relative avg_reply_delay;
  64
  65   /**
  66    * Point in time until which this peer does not want us to migrate content
  67    * to it.
  68    */
  69   struct GNUNET_TIME_Absolute migration_blocked_until;
  70
  71   /**
  72    * Transmission times for the last MAX_QUEUE_PER_PEER
  73    * requests for this peer.  Used as a ring buffer, current
  74    * offset is stored in 'last_request_times_off'.  If the
  75    * oldest entry is more recent than the 'avg_delay', we should
  76    * not send any more requests right now.
  77    */
  78   struct GNUNET_TIME_Absolute last_request_times[MAX_QUEUE_PER_PEER];
  79
  80   /**
  81    * How long does it typically take for us to transmit a message
  82    * to this peer?  (delay between the request being issued and
  83    * the callback being invoked).
  84    */
  85   struct GNUNET_LOAD_Value *transmission_delay;
  86
  87   /**
  88    * Average priority of successful replies.  Calculated
  89    * as a moving average: new_avg = ((n-1)*last_avg+curr_prio) / n
  90    */
  91   double avg_priority;
  92
  93   /**
  94    * The peer's identity.
  95    */
  96   GNUNET_PEER_Id pid;
  97
  98   /**
  99    * Trust rating for this peer
 100    */
 101   uint32_t trust;
 102
 103   /**
 104    * Number of pending queries (replies are not counted)
 105    */
 106   unsigned int pending_queries;
 107
 108   /**
 109    * Number of pending replies (queries are not counted)
 110    */
 111   unsigned int pending_replies;
 112
 113 };
 114
 115
 116 /**
 117  * Signature of function called on a connected peer.
 118  *
 119  * @param cls closure
 120  * @param peer identity of the peer
 121  * @param cp handle to the connected peer record
 122  * @param perf peer performance data
 123  */
 124 typedef void (*GSF_ConnectedPeerIterator)(void *cls,
 125                                           const struct GNUNET_PeerIdentity *peer,
 126                                           struct GSF_ConnectedPeer *cp,
 127                                           const struct GSF_PeerPerformanceData *ppd);
 128
 129
 130 /**
 131  * Function called to get a message for transmission.
 132  *
 133  * @param cls closure
 134  * @param buf_size number of bytes available in buf
 135  * @param buf where to copy the message, NULL on error (peer disconnect)
 136  * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
 137  */
 138 typedef size_t (*GSF_GetMessageCallback)(void *cls,
 139                                          size_t buf_size,
 140                                          void *buf);
 141
 142
 143 /**
 144  * Signature of function called on a reservation success or failure.
 145  *
 146  * @param cls closure
 147  * @param cp handle to the connected peer record
 148  * @param success GNUNET_YES on success, GNUNET_NO on failure
 149  */
 150 typedef void (*GSF_PeerReserveCallback)(void *cls,
 151                                         struct GSF_ConnectedPeer *cp,
 152                                         int success);
 153
 154
 155 /**
 156  * Handle to cancel a transmission request.
 157  */
 158 struct GSF_PeerTransmitHandle;
 159
 160
 161 /**
 162  * A peer connected to us.  Setup the connected peer
 163  * records.
 164  *
 165  * @param peer identity of peer that connected
 166  * @param atsi performance data for the connection
 167  * @return handle to connected peer entry
 168  */
 169 struct GSF_ConnectedPeer *
 170 GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
 171                            const struct GNUNET_TRANSPORT_ATS_Information *atsi);
 172
 173
 174 /**
 175  * Get a handle for a connected peer.
 176  *
 177  * @param peer peer's identity
 178  */
 179 struct GSF_ConnectedPeer *
 180 GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer);
 181
 182
 183 /**
 184  * Transmit a message to the given peer as soon as possible.
 185  * If the peer disconnects before the transmission can happen,
 186  * the callback is invoked with a 'NULL' buffer.
 187  *
 188  * @param cp target peer
 189  * @param is_query is this a query (GNUNET_YES) or content (GNUNET_NO)
 190  * @param priority how important is this request?
 191  * @param timeout when does this request timeout (call gmc with error)
 192  * @param size number of bytes we would like to send to the peer
 193  * @param gmc function to call to get the message
 194  * @param gmc_cls closure for gmc
 195  * @return handle to cancel request
 196  */
 197 struct GSF_PeerTransmitHandle *
 198 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
 199                     int is_query,
 200                     uint32_t priority,
 201                     struct GNUNET_TIME_Relative timeout,
 202                     size_t size,
 203                     GSF_GetMessageCallback gmc,
 204                     void *gmc_cls);
 205
 206
 207 /**
 208  * Cancel an earlier request for transmission.
 209  *
 210  * @param pth request to cancel
 211  */
 212 void
 213 GSF_peer_transmit_cancel_ (struct GSF_PeerTransmitHandle *pth);
 214
 215
 216 /**
 217  * Report on receiving a reply; update the performance record of the given peer.
 218  *
 219  * @param cp responding peer (will be updated)
 220  * @param request_time time at which the original query was transmitted
 221  * @param request_priority priority of the original request
 222  */
 223 void
 224 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
 225                               struct GNUNET_TIME_Absolute request_time,
 226                               uint32_t request_priority);
 227
 228
 229 /**
 230  * Report on receiving a reply in response to an initiating client.
 231  * Remember that this peer is good for this client.
 232  *
 233  * @param cp responding peer (will be updated)
 234  * @param initiator_client local client on responsible for query
 235  */
 236 void
 237 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
 238                                    struct GSF_LocalClient *initiator_client);
 239
 240
 241 /**
 242  * Report on receiving a reply in response to an initiating peer.
 243  * Remember that this peer is good for this initiating peer.
 244  *
 245  * @param cp responding peer (will be updated)
 246  * @param initiator_peer other peer responsible for query
 247  */
 248 void
 249 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
 250                                  const struct GSF_ConnectedPeer *initiator_peer);
 251
 252
 253 /**
 254  * Method called whenever a given peer has a status change.
 255  *
 256  * @param cls closure
 257  * @param peer peer identity this notification is about
 258  * @param bandwidth_in available amount of inbound bandwidth
 259  * @param bandwidth_out available amount of outbound bandwidth
 260  * @param timeout absolute time when this peer will time out
 261  *        unless we see some further activity from it
 262  * @param atsi status information
 263  */
 264 void
 265 GSF_peer_status_handler_ (void *cls,
 266                           const struct GNUNET_PeerIdentity *peer,
 267                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 268                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 269                           struct GNUNET_TIME_Absolute timeout,
 270                           const struct GNUNET_TRANSPORT_ATS_Information *atsi);
 271
 272
 273 /**
 274  * Handle P2P "MIGRATION_STOP" message.
 275  *
 276  * @param cls closure, always NULL
 277  * @param other the other peer involved (sender or receiver, NULL
 278  *        for loopback messages where we are both sender and receiver)
 279  * @param message the actual message
 280  * @param atsi performance information
 281  * @return GNUNET_OK to keep the connection open,
 282  *         GNUNET_SYSERR to close it (signal serious error)
 283  */
 284 int
 285 GSF_handle_p2p_migration_stop_ (void *cls,
 286                                 const struct GNUNET_PeerIdentity *other,
 287                                 const struct GNUNET_MessageHeader *message,
 288                                 const struct GNUNET_TRANSPORT_ATS_Information *atsi);
 289
 290
 291 /**
 292  * Handle P2P "QUERY" message.  Only responsible for creating the
 293  * request entry itself and setting up reply callback and cancellation
 294  * on peer disconnect.  Does NOT execute the actual request strategy
 295  * (planning) or local database operations.
 296  *
 297  * @param other the other peer involved (sender or receiver, NULL
 298  *        for loopback messages where we are both sender and receiver)
 299  * @param message the actual message
 300  * @return pending request handle, NULL on error
 301  */
 302 struct GSF_PendingRequest *
 303 GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
 304                        const struct GNUNET_MessageHeader *message);
 305
 306
 307 /**
 308  * Return the performance data record for the given peer
 309  *
 310  * @param cp peer to query
 311  * @return performance data record for the peer
 312  */
 313 struct GSF_PeerPerformanceData *
 314 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp);
 315
 316
 317 /**
 318  * Ask a peer to stop migrating data to us until the given point
 319  * in time.
 320  *
 321  * @param cp peer to ask
 322  * @param block_time until when to block
 323  */
 324 void
 325 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
 326                            struct GNUNET_TIME_Relative block_time);
 327
 328
 329 /**
 330  * A peer disconnected from us.  Tear down the connected peer
 331  * record.
 332  *
 333  * @param cls unused
 334  * @param peer identity of peer that connected
 335  */
 336 void
 337 GSF_peer_disconnect_handler_ (void *cls,
 338                               const struct GNUNET_PeerIdentity *peer);
 339
 340
 341 /**
 342  * Notification that a local client disconnected.  Clean up all of our
 343  * references to the given handle.
 344  *
 345  * @param lc handle to the local client (henceforth invalid)
 346  */
 347 void
 348 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc);
 349
 350
 351 /**
 352  * Notify core about a preference we have for the given peer
 353  * (to allocate more resources towards it).  The change will
 354  * be communicated the next time we reserve bandwidth with
 355  * core (not instantly).
 356  *
 357  * @param cp peer to reserve bandwidth from
 358  * @param pref preference change
 359  */
 360 void
 361 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
 362                                        uint64_t pref);
 363
 364
 365 /**
 366  * Obtain the identity of a connected peer.
 367  *
 368  * @param cp peer to reserve bandwidth from
 369  * @param id identity to set (written to)
 370  */
 371 void
 372 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
 373                                   struct GNUNET_PeerIdentity *id);
 374
 375
 376 /**
 377  * Iterate over all connected peers.
 378  *
 379  * @param it function to call for each peer
 380  * @param it_cls closure for it
 381  */
 382 void
 383 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
 384                               void *it_cls);
 385
 386
 387 /**
 388  * Initialize peer management subsystem.
 389  */
 390 void
 391 GSF_connected_peer_init_ (void);
 392
 393
 394 /**
 395  * Shutdown peer management subsystem.
 396  */
 397 void
 398 GSF_connected_peer_done_ (void);
 399
 400
 401 #endif
 402 /* end of gnunet-service-fs_cp.h */