2 This file is part of GNUnet
3 (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 2, 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 dv/plugin_transport_dv.c
23 * @brief DV transport service, takes incoming DV requests and deals with
25 * @author Nathan Evans
26 * @author Christian Grothoff
30 #include "gnunet_protocols.h"
31 #include "gnunet_connection_lib.h"
32 #include "gnunet_server_lib.h"
33 #include "gnunet_service_lib.h"
34 #include "gnunet_statistics_service.h"
35 #include "gnunet_dv_service.h"
36 #include "gnunet_transport_service.h"
37 #include "../transport/plugin_transport.h"
40 #define DEBUG_TEMPLATE GNUNET_NO
43 * Encapsulation of all of the state of the plugin.
49 * Session handle for connections.
55 * Stored in a linked list.
60 * Pointer to the global plugin struct.
62 struct Plugin *plugin;
65 * The client (used to identify this connection)
70 * Continuation function to call once the transmission buffer
71 * has again space available. NULL if there is no
72 * continuation to call.
74 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
77 * Closure for transmit_cont.
79 void *transmit_cont_cls;
82 * To whom are we talking to (set to our identity
83 * if we are still waiting for the welcome message)
85 struct GNUNET_PeerIdentity sender;
88 * At what time did we reset last_received last?
90 struct GNUNET_TIME_Absolute last_quota_update;
93 * How many bytes have we received since the "last_quota_update"
96 uint64_t last_received;
99 * Number of bytes per ms that this peer is allowed
107 * Encapsulation of all of the state of the plugin.
114 struct GNUNET_TRANSPORT_PluginEnvironment *env;
117 * List of open sessions.
119 struct Session *sessions;
124 //struct GNUNET_SERVER_Handle *server;
127 * Handle to the running service.
129 //struct GNUNET_SERVICE_Context *service;
132 * Copy of the handler array where the closures are
133 * set to this struct's instance.
135 struct GNUNET_SERVER_MessageHandler *handlers;
138 * Handle to the DV service
140 struct GNUNET_DV_Handle *dv_handle;
145 * Handler for messages received from the DV service.
147 void handle_dv_message_received (void *cls,
148 struct GNUNET_PeerIdentity *sender,
152 char *sender_address,
153 size_t sender_address_len)
155 struct Plugin *plugin = cls;
156 #if DEBUG_DV_MESSAGES
158 my_id = GNUNET_strdup(GNUNET_i2s(plugin->env->my_identity));
159 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
160 "plugin_transport_dv",
161 _("%s Received message from %s) of type %d, distance %u!\n"),
162 my_id, GNUNET_i2s(sender), ntohs(((struct GNUNET_MessageHeader *)msg)->type), distance);
163 GNUNET_free_non_null(my_id);
165 plugin->env->receive(plugin->env->cls,
167 (struct GNUNET_MessageHeader *)msg,
176 /* Question: how does the transport service learn of a newly connected (gossipped about)
177 * DV peer? Should the plugin (here) create a HELLO for that peer and send it along,
178 * or should the DV service create a HELLO and send it to us via the other part?
182 * Function that can be used by the transport service to transmit
183 * a message using the plugin.
186 * @param target who should receive this message
187 * @param priority how important is the message
188 * @param msgbuf the message to transmit
189 * @param msgbuf_size number of bytes in 'msgbuf'
190 * @param timeout when should we time out
191 * @param session the session used
192 * @param addr the address to use (can be NULL if the plugin
193 * is "on its own" (i.e. re-use existing TCP connection))
194 * @param addrlen length of the address in bytes
195 * @param force_address GNUNET_YES if the plugin MUST use the given address,
196 * otherwise the plugin may use other addresses or
197 * existing connections (if available)
198 * @param cont continuation to call once the message has
199 * been transmitted (or if the transport is ready
200 * for the next transmission call; or if the
201 * peer disconnected...)
202 * @param cont_cls closure for cont
203 * @return number of bytes used (on the physical network, with overheads);
204 * -1 on hard errors (i.e. address invalid); 0 is a legal value
205 * and does NOT mean that the message was not transmitted (DV)
208 dv_plugin_send (void *cls,
209 const struct GNUNET_PeerIdentity *target,
212 unsigned int priority,
213 struct GNUNET_TIME_Relative timeout,
214 struct Session *session,
218 GNUNET_TRANSPORT_TransmitContinuation
219 cont, void *cont_cls)
222 struct Plugin *plugin = cls;
224 ret = GNUNET_DV_send(plugin->dv_handle,
235 GNUNET_free_non_null(my_identity);
244 * Function that can be used to force the plugin to disconnect
245 * from the given peer and cancel all previous transmissions
246 * (and their continuations).
249 * @param target peer from which to disconnect
252 dv_plugin_disconnect (void *cls,
253 const struct GNUNET_PeerIdentity *target)
255 // struct Plugin *plugin = cls;
256 // TODO: Add message type to send to dv service to "disconnect" a peer
261 * Convert the transports address to a nice, human-readable
265 * @param type name of the transport that generated the address
266 * @param addr one of the addresses of the host, NULL for the last address
267 * the specific address format depends on the transport
268 * @param addrlen length of the address
269 * @param numeric should (IP) addresses be displayed in numeric form?
270 * @param timeout after how long should we give up?
271 * @param asc function to call on each string
272 * @param asc_cls closure for asc
275 dv_plugin_address_pretty_printer (void *cls,
280 struct GNUNET_TIME_Relative timeout,
281 GNUNET_TRANSPORT_AddressStringCallback
287 char *addr_buf = (char *)addr;
289 if (addrlen != sizeof(struct GNUNET_PeerIdentity) * 2)
295 dest_peer = GNUNET_strdup(GNUNET_i2s((struct GNUNET_PeerIdentity *)addr));
296 via_peer = GNUNET_strdup(GNUNET_i2s((struct GNUNET_PeerIdentity *)&addr_buf[sizeof(struct GNUNET_PeerIdentity)]));
297 GNUNET_asprintf(&print_string, "DV Peer `%s' via peer`%s'", dest_peer, via_peer);
298 asc (asc_cls, print_string);
300 GNUNET_free(via_peer);
301 GNUNET_free(dest_peer);
302 GNUNET_free(print_string);
307 * Convert the DV address to a pretty string.
310 * @param addr the (hopefully) DV address
311 * @param addrlen the length of the address
313 * @return string representing the DV address
315 static const char *address_to_string (void *cls,
319 static char return_buffer[2 * 4 + 2]; // Two four character peer identity prefixes a ':' and '\0'
321 struct GNUNET_CRYPTO_HashAsciiEncoded peer_hash;
322 struct GNUNET_CRYPTO_HashAsciiEncoded via_hash;
323 struct GNUNET_PeerIdentity *peer;
324 struct GNUNET_PeerIdentity *via;
325 char *addr_buf = (char *)addr;
327 if (addrlen == (2 * sizeof(struct GNUNET_PeerIdentity)))
329 peer = (struct GNUNET_PeerIdentity *)addr_buf;
330 via = (struct GNUNET_PeerIdentity *)&addr_buf[sizeof(struct GNUNET_PeerIdentity)];
332 GNUNET_CRYPTO_hash_to_enc (&peer->hashPubKey, &peer_hash);
333 peer_hash.encoding[4] = '\0';
334 GNUNET_CRYPTO_hash_to_enc (&via->hashPubKey, &via_hash);
335 via_hash.encoding[4] = '\0';
336 GNUNET_snprintf (return_buffer,
337 sizeof (return_buffer),
345 return return_buffer;
349 * Another peer has suggested an address for this
350 * peer and transport plugin. Check that this could be a valid
351 * address. If so, consider adding it to the list
355 * @param addr pointer to the address
356 * @param addrlen length of addr
357 * @return GNUNET_OK if this is a plausible address for this peer
360 * FIXME: does this mean anything for the DV plugin?
363 dv_plugin_address_suggested (void *cls,
364 void *addr, size_t addrlen)
366 /* struct Plugin *plugin = cls; */
368 /* check if the address is plausible; if so,
369 add it to our list! */
375 * Entry point for the plugin.
378 libgnunet_plugin_transport_dv_init (void *cls)
380 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
381 struct GNUNET_TRANSPORT_PluginFunctions *api;
382 struct Plugin *plugin;
384 plugin = GNUNET_malloc (sizeof (struct Plugin));
387 plugin->dv_handle = GNUNET_DV_connect(env->sched, env->cfg, &handle_dv_message_received, plugin);
389 if (plugin->dv_handle == NULL)
395 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
397 api->send = &dv_plugin_send;
398 api->disconnect = &dv_plugin_disconnect;
399 api->address_pretty_printer = &dv_plugin_address_pretty_printer;
400 api->check_address = &dv_plugin_address_suggested;
401 api->address_to_string = &address_to_string;
407 * Exit point from the plugin.
410 libgnunet_plugin_transport_dv_done (void *cls)
412 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
413 struct Plugin *plugin = api->cls;
415 if (plugin->dv_handle != NULL)
416 GNUNET_DV_disconnect(plugin->dv_handle);
418 GNUNET_free (plugin);
423 /* end of plugin_transport_template.c */