2 This file is part of GNUnet.
3 Copyright (C) 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file fs/gnunet-service-fs_cp.h
23 * @brief API to handle 'connected peers'
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_FS_CP_H
27 #define GNUNET_SERVICE_FS_CP_H
30 #include "gnunet-service-fs.h"
34 * Maximum number of outgoing messages we queue per peer.
36 * Performance measurements for 2 peer setup for 50 MB file
37 * (using perf_gnunet_service_fs_p2p):
39 * 24: 2-3 MB/s # ~ 24 MB RAM
40 * 256: 8 MB/s # ~256 MB RAM
42 * Conclusion: 24 should suffice (reasonable
43 * performance, no excessive memory use).
45 #define MAX_QUEUE_PER_PEER 24
48 * Length of the P2P success tracker. Note that having a very long
49 * list can also hurt performance.
51 #define P2P_SUCCESS_LIST_SIZE 8
54 * Length of the CS-2-P success tracker. Note that
55 * having a very long list can also hurt performance.
57 #define CS2P_SUCCESS_LIST_SIZE 8
61 * Performance data kept for a peer.
63 struct GSF_PeerPerformanceData
67 * List of the last clients for which this peer successfully
70 struct GSF_LocalClient *last_client_replies[CS2P_SUCCESS_LIST_SIZE];
73 * List of the last PIDs for which
74 * this peer successfully answered a query;
75 * We use 0 to indicate no successful reply.
77 GNUNET_PEER_Id last_p2p_replies[P2P_SUCCESS_LIST_SIZE];
80 * Average delay between sending the peer a request and
81 * getting a reply (only calculated over the requests for
82 * which we actually got a reply). Calculated
83 * as a moving average: new_delay = ((n-1)*last_delay+curr_delay) / n
85 struct GNUNET_TIME_Relative avg_reply_delay;
88 * If we get content we already have from this peer, for how
89 * long do we block him? Adjusted based on the fraction of
90 * redundant data we receive, between 1s and 1h.
92 struct GNUNET_TIME_Relative migration_delay;
95 * Point in time until which this peer does not want us to migrate content
98 struct GNUNET_TIME_Absolute migration_blocked_until;
101 * Transmission times for the last MAX_QUEUE_PER_PEER
102 * requests for this peer. Used as a ring buffer, current
103 * offset is stored in 'last_request_times_off'. If the
104 * oldest entry is more recent than the 'avg_delay', we should
105 * not send any more requests right now.
107 struct GNUNET_TIME_Absolute last_request_times[MAX_QUEUE_PER_PEER];
110 * How long does it typically take for us to transmit a message
111 * to this peer? (delay between the request being issued and
112 * the callback being invoked).
114 struct GNUNET_LOAD_Value *transmission_delay;
117 * Average priority of successful replies. Calculated
118 * as a moving average: new_avg = ((n-1)*last_avg+curr_prio) / n
123 * The peer's identity.
128 * Respect rating for this peer
133 * Number of pending queries (replies are not counted)
135 unsigned int pending_queries;
138 * Number of pending replies (queries are not counted)
140 unsigned int pending_replies;
146 * Signature of function called on a connected peer.
149 * @param peer identity of the peer
150 * @param cp handle to the connected peer record
151 * @param perf peer performance data
154 (*GSF_ConnectedPeerIterator) (void *cls,
155 const struct GNUNET_PeerIdentity *peer,
156 struct GSF_ConnectedPeer *cp,
157 const struct GSF_PeerPerformanceData *ppd);
161 * Function called to get a message for transmission.
164 * @param buf_size number of bytes available in @a buf
165 * @param buf where to copy the message, NULL on error (peer disconnect)
166 * @return number of bytes copied to @a buf, can be 0 (without indicating an error)
169 (*GSF_GetMessageCallback) (void *cls,
175 * Signature of function called on a reservation success or failure.
178 * @param cp handle to the connected peer record
179 * @param success #GNUNET_YES on success, #GNUNET_NO on failure
182 (*GSF_PeerReserveCallback) (void *cls,
183 struct GSF_ConnectedPeer *cp,
188 * Function called after the creation of a connected peer record is complete.
191 * @param cp handle to the newly created connected peer record
194 (*GSF_ConnectedPeerCreationCallback) (void *cls,
195 struct GSF_ConnectedPeer *cp);
199 * Handle to cancel a transmission request.
201 struct GSF_PeerTransmitHandle;
205 * A peer connected to us. Setup the connected peer
208 * @param peer identity of peer that connected
209 * @param creation_cb callback function when the record is created.
210 * @param creation_cb_cls closure for @creation_cb
213 GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
214 GSF_ConnectedPeerCreationCallback creation_cb,
215 void *creation_cb_cls);
219 * Get a handle for a connected peer.
221 * @param peer peer's identity
222 * @return NULL if this peer is not currently connected
224 struct GSF_ConnectedPeer *
225 GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer);
229 * Update the latency information kept for the given peer.
231 * @param id peer record to update
232 * @param latency current latency value
235 GSF_update_peer_latency_ (const struct GNUNET_PeerIdentity *id,
236 struct GNUNET_TIME_Relative latency);
240 * Transmit a message to the given peer as soon as possible.
241 * If the peer disconnects before the transmission can happen,
242 * the callback is invoked with a 'NULL' buffer.
244 * @param cp target peer
245 * @param is_query is this a query (GNUNET_YES) or content (GNUNET_NO)
246 * @param priority how important is this request?
247 * @param timeout when does this request timeout (call gmc with error)
248 * @param size number of bytes we would like to send to the peer
249 * @param gmc function to call to get the message
250 * @param gmc_cls closure for gmc
251 * @return handle to cancel request
253 struct GSF_PeerTransmitHandle *
254 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
257 struct GNUNET_TIME_Relative timeout,
258 size_t size, GSF_GetMessageCallback gmc,
263 * Cancel an earlier request for transmission.
265 * @param pth request to cancel
268 GSF_peer_transmit_cancel_ (struct GSF_PeerTransmitHandle *pth);
272 * Report on receiving a reply; update the performance record of the given peer.
274 * @param cp responding peer (will be updated)
275 * @param request_time time at which the original query was transmitted
276 * @param request_priority priority of the original request
279 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
280 struct GNUNET_TIME_Absolute request_time,
281 uint32_t request_priority);
285 * Report on receiving a reply in response to an initiating client.
286 * Remember that this peer is good for this client.
288 * @param cp responding peer (will be updated)
289 * @param initiator_client local client on responsible for query
292 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
293 struct GSF_LocalClient *initiator_client);
297 * Report on receiving a reply in response to an initiating peer.
298 * Remember that this peer is good for this initiating peer.
300 * @param cp responding peer (will be updated)
301 * @param initiator_peer other peer responsible for query
304 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
305 const struct GSF_ConnectedPeer
310 * Handle P2P "MIGRATION_STOP" message.
312 * @param cls closure, always NULL
313 * @param other the other peer involved (sender or receiver, NULL
314 * for loopback messages where we are both sender and receiver)
315 * @param message the actual message
316 * @return #GNUNET_OK to keep the connection open,
317 * #GNUNET_SYSERR to close it (signal serious error)
320 GSF_handle_p2p_migration_stop_ (void *cls,
321 const struct GNUNET_PeerIdentity *other,
322 const struct GNUNET_MessageHeader *message);
326 * Handle P2P "QUERY" message. Only responsible for creating the
327 * request entry itself and setting up reply callback and cancellation
328 * on peer disconnect. Does NOT execute the actual request strategy
329 * (planning) or local database operations.
331 * @param other the other peer involved (sender or receiver, NULL
332 * for loopback messages where we are both sender and receiver)
333 * @param message the actual message
334 * @return pending request handle, NULL on error
336 struct GSF_PendingRequest *
337 GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
338 const struct GNUNET_MessageHeader *message);
342 * Return the performance data record for the given peer
344 * @param cp peer to query
345 * @return performance data record for the peer
347 struct GSF_PeerPerformanceData *
348 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp);
352 * Ask a peer to stop migrating data to us until the given point
355 * @param cp peer to ask
356 * @param block_time until when to block
359 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
360 struct GNUNET_TIME_Absolute block_time);
364 * A peer disconnected from us. Tear down the connected peer
368 * @param peer identity of peer that connected
371 GSF_peer_disconnect_handler_ (void *cls,
372 const struct GNUNET_PeerIdentity *peer);
376 * Notification that a local client disconnected. Clean up all of our
377 * references to the given handle.
379 * @param lc handle to the local client (henceforth invalid)
382 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc);
386 * Notify core about a preference we have for the given peer
387 * (to allocate more resources towards it). The change will
388 * be communicated the next time we reserve bandwidth with
389 * core (not instantly).
391 * @param cp peer to reserve bandwidth from
392 * @param pref preference change
395 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
400 * Obtain the identity of a connected peer.
402 * @param cp peer to get identity of
403 * @param id identity to set (written to)
406 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
407 struct GNUNET_PeerIdentity *id);
411 * Obtain the identity of a connected peer.
413 * @param cp peer to get identity of
414 * @return reference to peer identity, valid until peer disconnects (!)
416 const struct GNUNET_PeerIdentity *
417 GSF_connected_peer_get_identity2_ (const struct GSF_ConnectedPeer *cp);
422 * Iterate over all connected peers.
424 * @param it function to call for each peer
425 * @param it_cls closure for it
428 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it, void *it_cls);
432 * Initialize peer management subsystem.
435 GSF_connected_peer_init_ (void);
439 * Shutdown peer management subsystem.
442 GSF_connected_peer_done_ (void);
446 /* end of gnunet-service-fs_cp.h */