correct and better to understand
[oweals/gnunet.git] / src / transport / plugin_transport.h
1 /*
2      This file is part of GNUnet
3      (C) 2009, 2010 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 transport/plugin_transport.h
23  * @brief API for the transport services.  This header
24  *        specifies the struct that is given to the plugin's entry
25  *        method and the other struct that must be returned.
26  *        Note that the destructors of transport plugins will
27  *        be given the value returned by the constructor
28  *        and is expected to return a NULL pointer.
29  * @author Christian Grothoff
30  */
31 #ifndef PLUGIN_TRANSPORT_H
32 #define PLUGIN_TRANSPORT_H
33
34 #include "gnunet_configuration_lib.h"
35 #include "gnunet_scheduler_lib.h"
36 #include "gnunet_statistics_service.h"
37 #include "gnunet_transport_service.h"
38 #include "transport_selection.h"
39
40
41 /**
42  * Opaque pointer that plugins can use to distinguish specific
43  * connections to a given peer.  Typically used by stateful plugins to
44  * allow the service to refer to specific streams instead of a more
45  * general notion of "some connection" to the given peer.  This is
46  * useful since sometimes (i.e. for inbound TCP connections) a
47  * connection may not have an address that can be used for meaningful
48  * distinction between sessions to the same peer.
49  */
50 struct Session;
51
52 /**
53  * Every 'struct Session' must begin with this header.
54  */
55 struct SessionHeader
56 {
57
58   /**
59    * Cached signature for PONG generation for the session.  Do not use
60    * in the plugin!
61    */
62   struct GNUNET_CRYPTO_RsaSignature pong_signature;
63
64   /**
65    * Expiration time for signature.  Do not use in the plugin!
66    */
67   struct GNUNET_TIME_Absolute pong_sig_expires;
68   
69 };
70
71 /**
72  * Function that will be called whenever the plugin internally
73  * cleans up a session pointer and hence the service needs to
74  * discard all of those sessions as well.  Plugins that do not
75  * use sessions can simply omit calling this function and always
76  * use NULL wherever a session pointer is needed.
77  * 
78  * @param cls closure
79  * @param peer which peer was the session for 
80  * @param session which session is being destoyed
81  */
82 typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
83                                              const struct GNUNET_PeerIdentity *peer,
84                                              struct Session *session);
85
86
87 /**
88  * Function called by the transport for each received message.
89  * This function should also be called with "NULL" for the
90  * message to signal that the other peer disconnected.
91  *
92  * @param cls closure
93  * @param peer (claimed) identity of the other peer
94  * @param message the message, NULL if we only care about
95  *                learning about the delay until we should receive again -- FIXME!
96  * @param distance in overlay hops; use 1 unless DV (or 0 if message == NULL)
97  * @param session identifier used for this session (NULL for plugins
98  *                that do not offer bi-directional communication to the sender
99  *                using the same "connection")
100  * @param sender_address binary address of the sender (if we established the
101  *                connection or are otherwise sure of it; should be NULL
102  *                for inbound TCP/UDP connections since it it not clear
103  *                that we could establish ourselves a connection to that
104  *                IP address and get the same system)
105  * @param sender_address_len number of bytes in sender_address
106  * @return how long the plugin should wait until receiving more data
107  *         (plugins that do not support this, can ignore the return value)
108  */
109 typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
110                                                                                const struct
111                                                                                GNUNET_PeerIdentity *
112                                                                                peer,
113                                                                                const struct
114                                                                                GNUNET_MessageHeader *
115                                                                                message,
116                                                                                uint32_t distance,
117                                                                                struct Session *session,
118                                                                                const char *sender_address,
119                                                                                uint16_t sender_address_len);
120
121
122 /**
123  * Function that will be called for each address the transport
124  * is aware that it might be reachable under.
125  *
126  * @param cls closure
127  * @param name name of the transport that generated the address
128  * @param addr one of the addresses of the host, NULL for the last address
129  *        the specific address format depends on the transport
130  * @param addrlen length of the address
131  * @param expires when should this address automatically expire?
132  */
133 typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
134                                                       const char *name,
135                                                       const void *addr,
136                                                       uint16_t addrlen,
137                                                       struct
138                                                       GNUNET_TIME_Relative
139                                                       expires);
140
141 /**
142  * Function called whenever the plugin has to notify ATS about costs for using this transport
143  *
144  * The cost will be passed as struct GNUNET_ATS_Cost_Information[]
145  * This array is 0-terminated, so the last element will be a pair:
146  * ((cost->cost_type==GNUNET_ATS_ARRAY_TERMINATOR) && cost->cost_value==0))
147  *
148  * @param cls closure
149  * @param peer peer
150  * @param addr peer address
151  * @param addrlen address length
152  * @param cost pointer to the first element of struct GNUNET_ATS_Cost_Information[]
153  */
154 typedef void (*GNUNET_TRANSPORT_CostReport) (void *cls,
155                                                                                          const struct GNUNET_PeerIdentity *peer,
156                                              const void *addr,
157                                              uint16_t addrlen,
158                                                                                          struct GNUNET_ATS_Cost_Information * cost);
159
160 /**
161  * The transport service will pass a pointer to a struct
162  * of this type as the first and only argument to the
163  * entry point of each transport plugin.
164  */
165 struct GNUNET_TRANSPORT_PluginEnvironment
166 {
167   /**
168    * Configuration to use.
169    */
170   const struct GNUNET_CONFIGURATION_Handle *cfg;
171
172   /**
173    * Scheduler to use.
174    */
175   struct GNUNET_SCHEDULER_Handle *sched;
176
177   /**
178    * Identity of this peer.
179    */
180   const struct GNUNET_PeerIdentity *my_identity;
181
182   /**
183    * Pointer (!) to our HELLO message.  Note that the address
184    * referred to "*our_hello" might change over time.
185    */
186   struct GNUNET_HELLO_Message *const*our_hello;
187
188   /**
189    * Closure for the various callbacks.
190    */
191   void *cls;
192
193   /**
194    * Handle for reporting statistics.
195    */
196   struct GNUNET_STATISTICS_Handle *stats;
197
198   /**
199    * Function that should be called by the transport plugin
200    * whenever a message is received.
201    */
202   GNUNET_TRANSPORT_PluginReceiveCallback receive;
203
204   /**
205    * Function that must be called by each plugin to notify the
206    * transport service about the addresses under which the transport
207    * provided by the plugin can be reached.
208    */
209   GNUNET_TRANSPORT_AddressNotification notify_address;
210
211   /**
212    * Inform service about traffic received, get information
213    * about when we might be willing to receive more.
214    */
215   GNUNET_TRANSPORT_TrafficReport traffic_report;
216
217   /**
218    * Function that must be called by the plugin when a non-NULL
219    * session handle stops being valid (is destroyed).
220    */
221   GNUNET_TRANSPORT_SessionEnd session_end;
222
223   /**
224    * Inform service about costs for using this transport plugin
225    */
226   GNUNET_TRANSPORT_CostReport cost_report;
227
228   /**
229    * What is the maximum number of connections that this transport
230    * should allow?  Transports that do not have sessions (such as
231    * UDP) can ignore this value.
232    */
233   uint32_t max_connections;
234
235 };
236
237
238 /**
239  * Function called by the GNUNET_TRANSPORT_TransmitFunction
240  * upon "completion".
241  *
242  * @param cls closure
243  * @param target who was the recipient of the message?
244  * @param result GNUNET_OK on success
245  *               GNUNET_SYSERR if the target disconnected;
246  *               disconnect will ALSO be signalled using
247  *               the ReceiveCallback.
248  */
249 typedef void
250   (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
251                                             const struct GNUNET_PeerIdentity *
252                                             target, int result);
253
254
255 /**
256  * Function that can be used by the transport service to transmit
257  * a message using the plugin.   Note that in the case of a
258  * peer disconnecting, the continuation MUST be called
259  * prior to the disconnect notification itself.  This function
260  * will be called with this peer's HELLO message to initiate
261  * a fresh connection to another peer.
262  *
263  * @param cls closure
264  * @param target who should receive this message
265  * @param msgbuf the message to transmit
266  * @param msgbuf_size number of bytes in 'msgbuf'
267  * @param priority how important is the message (most plugins will
268  *                 ignore message priority and just FIFO)
269  * @param timeout how long to wait at most for the transmission (does not
270  *                require plugins to discard the message after the timeout,
271  *                just advisory for the desired delay; most plugins will ignore
272  *                this as well)
273  * @param session which session must be used (or NULL for "any")
274  * @param addr the address to use (can be NULL if the plugin
275  *                is "on its own" (i.e. re-use existing TCP connection))
276  * @param addrlen length of the address in bytes
277  * @param force_address GNUNET_YES if the plugin MUST use the given address,
278  *                GNUNET_NO means the plugin may use any other address and
279  *                GNUNET_SYSERR means that only reliable existing
280  *                bi-directional connections should be used (regardless
281  *                of address)
282  * @param cont continuation to call once the message has
283  *        been transmitted (or if the transport is ready
284  *        for the next transmission call; or if the
285  *        peer disconnected...); can be NULL
286  * @param cont_cls closure for cont
287  * @return number of bytes used (on the physical network, with overheads);
288  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
289  *         and does NOT mean that the message was not transmitted (DV)
290  */
291 typedef ssize_t
292   (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
293                                         const struct GNUNET_PeerIdentity *
294                                         target,
295                                         const char *msgbuf,
296                                         size_t msgbuf_size,
297                                         uint32_t priority,
298                                         struct GNUNET_TIME_Relative timeout,
299                                         struct Session *session,
300                                         const void *addr,
301                                         size_t addrlen,
302                                         int force_address,
303                                         GNUNET_TRANSPORT_TransmitContinuation
304                                         cont, void *cont_cls);
305
306
307 /**
308  * Function that can be called to force a disconnect from the
309  * specified neighbour.  This should also cancel all previously
310  * scheduled transmissions.  Obviously the transmission may have been
311  * partially completed already, which is OK.  The plugin is supposed
312  * to close the connection (if applicable) and no longer call the
313  * transmit continuation(s).
314  *
315  * Finally, plugin MUST NOT call the services's receive function to
316  * notify the service that the connection to the specified target was
317  * closed after a getting this call.
318  *
319  * @param cls closure
320  * @param target peer for which the last transmission is
321  *        to be cancelled
322  */
323 typedef void
324   (*GNUNET_TRANSPORT_DisconnectFunction) (void *cls,
325                                           const struct GNUNET_PeerIdentity *
326                                           target);
327
328
329 /**
330  * Function called by the pretty printer for the resolved address for
331  * each human-readable address obtained.
332  *
333  * @param cls closure
334  * @param hostname one of the names for the host, NULL
335  *        on the last call to the callback
336  */
337 typedef void (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
338                                                         const char *address);
339
340
341 /**
342  * Convert the transports address to a nice, human-readable
343  * format.
344  *
345  * @param cls closure
346  * @param name name of the transport that generated the address
347  * @param addr one of the addresses of the host, NULL for the last address
348  *        the specific address format depends on the transport
349  * @param addrlen length of the address
350  * @param numeric should (IP) addresses be displayed in numeric form?
351  * @param timeout after how long should we give up?
352  * @param asc function to call on each string
353  * @param asc_cls closure for asc
354  */
355 typedef void
356   (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
357                                             const char *type,
358                                             const void *addr,
359                                             size_t addrlen,
360                                             int numeric,
361                                             struct GNUNET_TIME_Relative
362                                             timeout,
363                                             GNUNET_TRANSPORT_AddressStringCallback
364                                             asc, void *asc_cls);
365
366
367 /**
368  * Another peer has suggested an address for this peer and transport
369  * plugin.  Check that this could be a valid address.  This function
370  * is not expected to 'validate' the address in the sense of trying to
371  * connect to it but simply to see if the binary format is technically
372  * legal for establishing a connection to this peer (and make sure that
373  * the address really corresponds to our network connection/settings
374  * and not some potential man-in-the-middle).
375  *
376  * @param addr pointer to the address
377  * @param addrlen length of addr
378  * @return GNUNET_OK if this is a plausible address for this peer
379  *         and transport, GNUNET_SYSERR if not
380  */
381 typedef int
382 (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
383                                   const void *addr, size_t addrlen);
384
385
386 /**
387  * Function called for a quick conversion of the binary address to
388  * a numeric address.  Note that the caller must not free the 
389  * address and that the next call to this function is allowed
390  * to override the address again.
391  *
392  * @param cls closure
393  * @param addr binary address
394  * @param addr_len length of the address
395  * @return string representing the same address 
396  */
397 typedef const char* (*GNUNET_TRANSPORT_AddressToString) (void *cls,
398                                                          const void *addr,
399                                                          size_t addrlen);
400
401
402 /**
403  * Each plugin is required to return a pointer to a struct of this
404  * type as the return value from its entry point.
405  */
406 struct GNUNET_TRANSPORT_PluginFunctions
407 {
408
409   /**
410    * Closure for all of the callbacks.
411    */
412   void *cls;
413
414   /**
415    * Function that the transport service will use to transmit data to
416    * another peer.  May be NULL for plugins that only support
417    * receiving data.  After this call, the plugin call the specified
418    * continuation with success or error before notifying us about the
419    * target having disconnected.
420    */
421   GNUNET_TRANSPORT_TransmitFunction send;
422
423   /**
424    * Function that can be used to force the plugin to disconnect from
425    * the given peer and cancel all previous transmissions (and their
426    * continuations).  Note that if the transport does not have
427    * sessions / persistent connections (for example, UDP), this
428    * function may very well do nothing.
429    */
430   GNUNET_TRANSPORT_DisconnectFunction disconnect;
431
432   /**
433    * Function to pretty-print addresses.  NOTE: this function is not
434    * yet used by transport-service, but will be used in the future
435    * once the transport-API has been completed.
436    */
437   GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
438
439   /**
440    * Function that will be called to check if a binary address
441    * for this plugin is well-formed and corresponds to an
442    * address for THIS peer (as per our configuration).  Naturally,
443    * if absolutely necessary, plugins can be a bit conservative in
444    * their answer, but in general plugins should make sure that the
445    * address does not redirect traffic to a 3rd party that might
446    * try to man-in-the-middle our traffic.
447    */
448   GNUNET_TRANSPORT_CheckAddress check_address;
449
450   /**
451    * Function that will be called to convert a binary address
452    * to a string (numeric conversion only).
453    */
454   GNUNET_TRANSPORT_AddressToString address_to_string;
455
456 };
457
458
459 #endif