2 This file is part of GNUnet.
3 (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 * (with MAX_DATASTORE_QUEUE = 1 and RETRY_PROBABILITY_INV = 1):
39 * 2: 1700 kb/s, 1372 kb/s
40 * 8: 2117 kb/s, 1284 kb/s, 1112 kb/s
41 * 16: 3500 kb/s, 3200 kb/s, 3388 kb/s
42 * 32: 3441 kb/s, 3163 kb/s, 3277 kb/s
43 * 128: 1700 kb/s; 2010 kb/s, 3383 kb/s, 1156 kb/s
45 * Conclusion: 16 seems to be a pretty good value (stable
46 * and high performance, no excessive memory use).
48 #define MAX_QUEUE_PER_PEER 16
51 * Length of the P2P success tracker. Note that having a very long
52 * list can also hurt performance.
54 #define P2P_SUCCESS_LIST_SIZE 8
57 * Length of the CS-2-P success tracker. Note that
58 * having a very long list can also hurt performance.
60 #define CS2P_SUCCESS_LIST_SIZE 8
64 * Performance data kept for a peer.
66 struct GSF_PeerPerformanceData
70 * Transport performance data.
72 struct GNUNET_ATS_Information *atsi;
75 * List of the last clients for which this peer successfully
78 struct GSF_LocalClient *last_client_replies[CS2P_SUCCESS_LIST_SIZE];
81 * List of the last PIDs for which
82 * this peer successfully answered a query;
83 * We use 0 to indicate no successful reply.
85 GNUNET_PEER_Id last_p2p_replies[P2P_SUCCESS_LIST_SIZE];
88 * Average delay between sending the peer a request and
89 * getting a reply (only calculated over the requests for
90 * which we actually got a reply). Calculated
91 * as a moving average: new_delay = ((n-1)*last_delay+curr_delay) / n
93 struct GNUNET_TIME_Relative avg_reply_delay;
96 * Point in time until which this peer does not want us to migrate content
99 struct GNUNET_TIME_Absolute migration_blocked_until;
102 * Transmission times for the last MAX_QUEUE_PER_PEER
103 * requests for this peer. Used as a ring buffer, current
104 * offset is stored in 'last_request_times_off'. If the
105 * oldest entry is more recent than the 'avg_delay', we should
106 * not send any more requests right now.
108 struct GNUNET_TIME_Absolute last_request_times[MAX_QUEUE_PER_PEER];
111 * How long does it typically take for us to transmit a message
112 * to this peer? (delay between the request being issued and
113 * the callback being invoked).
115 struct GNUNET_LOAD_Value *transmission_delay;
118 * Average priority of successful replies. Calculated
119 * as a moving average: new_avg = ((n-1)*last_avg+curr_prio) / n
124 * The peer's identity.
129 * Trust rating for this peer
134 * Number of pending queries (replies are not counted)
136 unsigned int pending_queries;
139 * Number of pending replies (queries are not counted)
141 unsigned int pending_replies;
147 * Signature of function called on a connected peer.
150 * @param peer identity of the peer
151 * @param cp handle to the connected peer record
152 * @param perf peer performance data
154 typedef void (*GSF_ConnectedPeerIterator) (void *cls,
155 const struct GNUNET_PeerIdentity *
156 peer, struct GSF_ConnectedPeer * cp,
157 const struct GSF_PeerPerformanceData
162 * Function called to get a message for transmission.
165 * @param buf_size number of bytes available in buf
166 * @param buf where to copy the message, NULL on error (peer disconnect)
167 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
169 typedef size_t (*GSF_GetMessageCallback) (void *cls, size_t buf_size,
174 * Signature of function called on a reservation success or failure.
177 * @param cp handle to the connected peer record
178 * @param success GNUNET_YES on success, GNUNET_NO on failure
180 typedef void (*GSF_PeerReserveCallback) (void *cls,
181 struct GSF_ConnectedPeer * cp,
186 * Handle to cancel a transmission request.
188 struct GSF_PeerTransmitHandle;
192 * A peer connected to us. Setup the connected peer
195 * @param peer identity of peer that connected
196 * @param atsi performance data for the connection
197 * @param atsi_count number of records in 'atsi'
198 * @return handle to connected peer entry
200 struct GSF_ConnectedPeer *
201 GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
202 const struct GNUNET_ATS_Information *atsi,
203 unsigned int atsi_count);
207 * Get a handle for a connected peer.
209 * @param peer peer's identity
210 * @return NULL if this peer is not currently connected
212 struct GSF_ConnectedPeer *
213 GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer);
217 * Transmit a message to the given peer as soon as possible.
218 * If the peer disconnects before the transmission can happen,
219 * the callback is invoked with a 'NULL' buffer.
221 * @param cp target peer
222 * @param is_query is this a query (GNUNET_YES) or content (GNUNET_NO)
223 * @param priority how important is this request?
224 * @param timeout when does this request timeout (call gmc with error)
225 * @param size number of bytes we would like to send to the peer
226 * @param gmc function to call to get the message
227 * @param gmc_cls closure for gmc
228 * @return handle to cancel request
230 struct GSF_PeerTransmitHandle *
231 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp, int is_query,
232 uint32_t priority, struct GNUNET_TIME_Relative timeout,
233 size_t size, GSF_GetMessageCallback gmc, void *gmc_cls);
237 * Cancel an earlier request for transmission.
239 * @param pth request to cancel
242 GSF_peer_transmit_cancel_ (struct GSF_PeerTransmitHandle *pth);
246 * Report on receiving a reply; update the performance record of the given peer.
248 * @param cp responding peer (will be updated)
249 * @param request_time time at which the original query was transmitted
250 * @param request_priority priority of the original request
253 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
254 struct GNUNET_TIME_Absolute request_time,
255 uint32_t request_priority);
259 * Report on receiving a reply in response to an initiating client.
260 * Remember that this peer is good for this client.
262 * @param cp responding peer (will be updated)
263 * @param initiator_client local client on responsible for query
266 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
267 struct GSF_LocalClient *initiator_client);
271 * Report on receiving a reply in response to an initiating peer.
272 * Remember that this peer is good for this initiating peer.
274 * @param cp responding peer (will be updated)
275 * @param initiator_peer other peer responsible for query
278 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
279 const struct GSF_ConnectedPeer
284 * Handle P2P "MIGRATION_STOP" message.
286 * @param cls closure, always NULL
287 * @param other the other peer involved (sender or receiver, NULL
288 * for loopback messages where we are both sender and receiver)
289 * @param message the actual message
290 * @param atsi performance information
291 * @param atsi_count number of records in 'atsi'
292 * @return GNUNET_OK to keep the connection open,
293 * GNUNET_SYSERR to close it (signal serious error)
296 GSF_handle_p2p_migration_stop_ (void *cls,
297 const struct GNUNET_PeerIdentity *other,
298 const struct GNUNET_MessageHeader *message,
299 const struct GNUNET_ATS_Information *atsi,
300 unsigned int atsi_count);
304 * Handle P2P "QUERY" message. Only responsible for creating the
305 * request entry itself and setting up reply callback and cancellation
306 * on peer disconnect. Does NOT execute the actual request strategy
307 * (planning) or local database operations.
309 * @param other the other peer involved (sender or receiver, NULL
310 * for loopback messages where we are both sender and receiver)
311 * @param message the actual message
312 * @return pending request handle, NULL on error
314 struct GSF_PendingRequest *
315 GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
316 const struct GNUNET_MessageHeader *message);
320 * Return the performance data record for the given peer
322 * @param cp peer to query
323 * @return performance data record for the peer
325 struct GSF_PeerPerformanceData *
326 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp);
330 * Ask a peer to stop migrating data to us until the given point
333 * @param cp peer to ask
334 * @param block_time until when to block
337 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
338 struct GNUNET_TIME_Absolute block_time);
342 * A peer disconnected from us. Tear down the connected peer
346 * @param peer identity of peer that connected
349 GSF_peer_disconnect_handler_ (void *cls,
350 const struct GNUNET_PeerIdentity *peer);
354 * Notification that a local client disconnected. Clean up all of our
355 * references to the given handle.
357 * @param lc handle to the local client (henceforth invalid)
360 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc);
364 * Notify core about a preference we have for the given peer
365 * (to allocate more resources towards it). The change will
366 * be communicated the next time we reserve bandwidth with
367 * core (not instantly).
369 * @param cp peer to reserve bandwidth from
370 * @param pref preference change
373 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
378 * Obtain the identity of a connected peer.
380 * @param cp peer to reserve bandwidth from
381 * @param id identity to set (written to)
384 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
385 struct GNUNET_PeerIdentity *id);
389 * Iterate over all connected peers.
391 * @param it function to call for each peer
392 * @param it_cls closure for it
395 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it, void *it_cls);
399 * Initialize peer management subsystem.
402 GSF_connected_peer_init_ (void);
406 * Shutdown peer management subsystem.
409 GSF_connected_peer_done_ (void);
413 /* end of gnunet-service-fs_cp.h */