2 This file is part of GNUnet.
3 (C) 2012, 2013 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_mesh_client.c
23 * @brief non-anonymous file-transfer
24 * @author Christian Grothoff
27 * - PORT is set to old application type, unsure if we should keep
28 * it that way (fine for now)
31 #include "gnunet_constants.h"
32 #include "gnunet_util_lib.h"
33 #include "gnunet_mesh_service.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_applications.h"
36 #include "gnunet-service-fs.h"
37 #include "gnunet-service-fs_indexing.h"
38 #include "gnunet-service-fs_mesh.h"
42 * After how long do we reset connections without replies?
44 #define CLIENT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
48 * Handle for a mesh to another peer.
54 * Handle for a request that is going out via mesh API.
56 struct GSF_MeshRequest
62 struct GSF_MeshRequest *next;
67 struct GSF_MeshRequest *prev;
70 * Which mesh is this request associated with?
72 struct MeshHandle *mh;
75 * Function to call with the result.
77 GSF_MeshReplyProcessor proc;
85 * Query to transmit to the other peer.
87 struct GNUNET_HashCode query;
90 * Desired type for the reply.
92 enum GNUNET_BLOCK_Type type;
95 * Did we transmit this request already? YES if we are
96 * in the 'waiting' DLL, NO if we are in the 'pending' DLL.
103 * Handle for a mesh to another peer.
108 * Head of DLL of pending requests on this mesh.
110 struct GSF_MeshRequest *pending_head;
113 * Tail of DLL of pending requests on this mesh.
115 struct GSF_MeshRequest *pending_tail;
118 * Map from query to 'struct GSF_MeshRequest's waiting for
121 struct GNUNET_CONTAINER_MultiHashMap *waiting_map;
124 * Tunnel to the other peer.
126 struct GNUNET_MESH_Tunnel *tunnel;
129 * Handle for active write operation, or NULL.
131 struct GNUNET_MESH_TransmitHandle *wh;
134 * Which peer does this mesh go to?
136 struct GNUNET_PeerIdentity target;
139 * Task to kill inactive meshs (we keep them around for
140 * a few seconds to give the application a chance to give
143 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
146 * Task to reset meshs that had errors (asynchronously,
147 * as we may not be able to do it immediately during a
148 * callback from the mesh API).
150 GNUNET_SCHEDULER_TaskIdentifier reset_task;
156 * Mesh tunnel for creating outbound tunnels.
158 static struct GNUNET_MESH_Handle *mesh_tunnel;
161 * Map from peer identities to 'struct MeshHandles' with mesh
162 * tunnels to those peers.
164 static struct GNUNET_CONTAINER_MultiHashMap *mesh_map;
167 /* ********************* client-side code ************************* */
171 * Transmit pending requests via the mesh.
173 * @param mh mesh to process
176 transmit_pending (struct MeshHandle *mh);
180 * Iterator called on each entry in a waiting map to
181 * move it back to the pending list.
183 * @param cls the 'struct MeshHandle'
184 * @param key the key of the entry in the map (the query)
185 * @param value the 'struct GSF_MeshRequest' to move to pending
186 * @return GNUNET_YES (continue to iterate)
189 move_to_pending (void *cls,
190 const struct GNUNET_HashCode *key,
193 struct MeshHandle *mh = cls;
194 struct GSF_MeshRequest *sr = value;
196 GNUNET_assert (GNUNET_YES ==
197 GNUNET_CONTAINER_multihashmap_remove (mh->waiting_map,
200 GNUNET_CONTAINER_DLL_insert (mh->pending_head,
203 sr->was_transmitted = GNUNET_NO;
209 * We had a serious error, tear down and re-create mesh from scratch.
211 * @param mh mesh to reset
214 reset_mesh (struct MeshHandle *mh)
216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
217 "Resetting mesh tunnel to %s\n",
218 GNUNET_i2s (&mh->target));
219 GNUNET_MESH_tunnel_destroy (mh->tunnel);
220 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
223 mh->tunnel = GNUNET_MESH_tunnel_create (mesh_tunnel,
226 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
233 * Task called when it is time to destroy an inactive mesh tunnel.
235 * @param cls the 'struct MeshHandle' to tear down
236 * @param tc scheduler context, unused
239 mesh_timeout (void *cls,
240 const struct GNUNET_SCHEDULER_TaskContext *tc)
242 struct MeshHandle *mh = cls;
243 struct GNUNET_MESH_Tunnel *tun;
245 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
246 "Timeout on mesh tunnel to %s\n",
247 GNUNET_i2s (&mh->target));
248 mh->timeout_task = GNUNET_SCHEDULER_NO_TASK;
251 GNUNET_MESH_tunnel_destroy (tun);
256 * Task called when it is time to reset an mesh.
258 * @param cls the 'struct MeshHandle' to tear down
259 * @param tc scheduler context, unused
262 reset_mesh_task (void *cls,
263 const struct GNUNET_SCHEDULER_TaskContext *tc)
265 struct MeshHandle *mh = cls;
267 mh->reset_task = GNUNET_SCHEDULER_NO_TASK;
273 * We had a serious error, tear down and re-create mesh from scratch,
274 * but do so asynchronously.
276 * @param mh mesh to reset
279 reset_mesh_async (struct MeshHandle *mh)
281 if (GNUNET_SCHEDULER_NO_TASK != mh->reset_task)
282 GNUNET_SCHEDULER_cancel (mh->reset_task);
283 mh->reset_task = GNUNET_SCHEDULER_add_now (&reset_mesh_task,
289 * Functions of this signature are called whenever we are ready to transmit
292 * @param cls the struct MeshHandle for which we did the write call
293 * @param size the number of bytes that can be written to 'buf'
294 * @param buf where to write the message
295 * @return number of bytes written to 'buf'
298 transmit_sqm (void *cls,
302 struct MeshHandle *mh = cls;
303 struct MeshQueryMessage sqm;
304 struct GSF_MeshRequest *sr;
312 sr = mh->pending_head;
315 GNUNET_assert (size >= sizeof (struct MeshQueryMessage));
316 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
319 GNUNET_CONTAINER_multihashmap_put (mh->waiting_map,
322 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
323 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
324 "Sending query for %s via mesh to %s\n",
325 GNUNET_h2s (&sr->query),
326 GNUNET_i2s (&mh->target));
327 sr->was_transmitted = GNUNET_YES;
328 sqm.header.size = htons (sizeof (sqm));
329 sqm.header.type = htons (GNUNET_MESSAGE_TYPE_FS_MESH_QUERY);
330 sqm.type = htonl (sr->type);
331 sqm.query = sr->query;
332 memcpy (buf, &sqm, sizeof (sqm));
333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
334 "Successfully transmitted %u bytes via mesh to %s\n",
336 GNUNET_i2s (&mh->target));
337 transmit_pending (mh);
343 * Transmit pending requests via the mesh.
345 * @param mh mesh to process
348 transmit_pending (struct MeshHandle *mh)
352 mh->wh = GNUNET_MESH_notify_transmit_ready (mh->tunnel, GNUNET_YES /* allow cork */,
353 GNUNET_TIME_UNIT_FOREVER_REL,
354 sizeof (struct MeshQueryMessage),
360 * Closure for 'handle_reply'.
362 struct HandleReplyClosure
371 * Expiration time for the block.
373 struct GNUNET_TIME_Absolute expiration;
376 * Number of bytes in 'data'.
383 enum GNUNET_BLOCK_Type type;
386 * Did we have a matching query?
393 * Iterator called on each entry in a waiting map to
396 * @param cls the 'struct HandleReplyClosure'
397 * @param key the key of the entry in the map (the query)
398 * @param value the 'struct GSF_MeshRequest' to handle result for
399 * @return GNUNET_YES (continue to iterate)
402 handle_reply (void *cls,
403 const struct GNUNET_HashCode *key,
406 struct HandleReplyClosure *hrc = cls;
407 struct GSF_MeshRequest *sr = value;
409 sr->proc (sr->proc_cls,
414 GSF_mesh_query_cancel (sr);
415 hrc->found = GNUNET_YES;
421 * Functions with this signature are called whenever a complete reply
424 * @param cls closure with the 'struct MeshHandle'
425 * @param tunnel tunnel handle
426 * @param tunnel_ctx tunnel context
427 * @param message the actual message
428 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
432 struct GNUNET_MESH_Tunnel *tunnel,
434 const struct GNUNET_MessageHeader *message)
436 struct MeshHandle *mh = *tunnel_ctx;
437 const struct MeshReplyMessage *srm;
438 struct HandleReplyClosure hrc;
440 enum GNUNET_BLOCK_Type type;
441 struct GNUNET_HashCode query;
443 msize = ntohs (message->size);
444 if (sizeof (struct MeshReplyMessage) > msize)
447 reset_mesh_async (mh);
448 return GNUNET_SYSERR;
450 srm = (const struct MeshReplyMessage *) message;
451 msize -= sizeof (struct MeshReplyMessage);
452 type = (enum GNUNET_BLOCK_Type) ntohl (srm->type);
454 GNUNET_BLOCK_get_key (GSF_block_ctx,
456 &srm[1], msize, &query))
459 reset_mesh_async (mh);
460 return GNUNET_SYSERR;
462 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
463 "Received reply `%s' via mesh from peer %s\n",
465 GNUNET_i2s (&mh->target));
466 GNUNET_STATISTICS_update (GSF_stats,
467 gettext_noop ("# replies received via mesh"), 1,
470 hrc.data_size = msize;
471 hrc.expiration = GNUNET_TIME_absolute_ntoh (srm->expiration);
473 hrc.found = GNUNET_NO;
474 GNUNET_CONTAINER_multihashmap_get_multiple (mh->waiting_map,
478 if (GNUNET_NO == hrc.found)
480 GNUNET_STATISTICS_update (GSF_stats,
481 gettext_noop ("# replies received via mesh dropped"), 1,
490 * Get (or create) a mesh to talk to the given peer.
492 * @param target peer we want to communicate with
494 static struct MeshHandle *
495 get_mesh (const struct GNUNET_PeerIdentity *target)
497 struct MeshHandle *mh;
499 mh = GNUNET_CONTAINER_multihashmap_get (mesh_map,
500 &target->hashPubKey);
503 if (GNUNET_SCHEDULER_NO_TASK != mh->timeout_task)
505 GNUNET_SCHEDULER_cancel (mh->timeout_task);
506 mh->timeout_task = GNUNET_SCHEDULER_NO_TASK;
510 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
511 "Creating mesh tunnel to %s\n",
512 GNUNET_i2s (target));
513 mh = GNUNET_new (struct MeshHandle);
514 mh->reset_task = GNUNET_SCHEDULER_add_delayed (CLIENT_RETRY_TIMEOUT,
517 mh->waiting_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_YES);
518 mh->target = *target;
519 mh->tunnel = GNUNET_MESH_tunnel_create (mesh_tunnel,
522 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
525 GNUNET_assert (GNUNET_OK ==
526 GNUNET_CONTAINER_multihashmap_put (mesh_map,
527 &mh->target.hashPubKey,
529 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
535 * Look for a block by directly contacting a particular peer.
537 * @param target peer that should have the block
538 * @param query hash to query for the block
539 * @param type desired type for the block
540 * @param proc function to call with result
541 * @param proc_cls closure for 'proc'
542 * @return handle to cancel the operation
544 struct GSF_MeshRequest *
545 GSF_mesh_query (const struct GNUNET_PeerIdentity *target,
546 const struct GNUNET_HashCode *query,
547 enum GNUNET_BLOCK_Type type,
548 GSF_MeshReplyProcessor proc, void *proc_cls)
550 struct MeshHandle *mh;
551 struct GSF_MeshRequest *sr;
553 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
554 "Preparing to send query for %s via mesh to %s\n",
556 GNUNET_i2s (target));
557 mh = get_mesh (target);
558 sr = GNUNET_new (struct GSF_MeshRequest);
561 sr->proc_cls = proc_cls;
564 GNUNET_CONTAINER_DLL_insert (mh->pending_head,
567 transmit_pending (mh);
573 * Cancel an active request; must not be called after 'proc'
576 * @param sr request to cancel
579 GSF_mesh_query_cancel (struct GSF_MeshRequest *sr)
581 struct MeshHandle *mh = sr->mh;
583 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
584 "Cancelled query for %s via mesh to %s\n",
585 GNUNET_h2s (&sr->query),
586 GNUNET_i2s (&sr->mh->target));
587 if (GNUNET_YES == sr->was_transmitted)
588 GNUNET_assert (GNUNET_OK ==
589 GNUNET_CONTAINER_multihashmap_remove (mh->waiting_map,
593 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
597 if ( (0 == GNUNET_CONTAINER_multihashmap_size (mh->waiting_map)) &&
598 (NULL == mh->pending_head) )
599 mh->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
606 * Iterator called on each entry in a waiting map to
607 * call the 'proc' continuation and release associated
610 * @param cls the 'struct MeshHandle'
611 * @param key the key of the entry in the map (the query)
612 * @param value the 'struct GSF_MeshRequest' to clean up
613 * @return GNUNET_YES (continue to iterate)
616 free_waiting_entry (void *cls,
617 const struct GNUNET_HashCode *key,
620 struct GSF_MeshRequest *sr = value;
622 sr->proc (sr->proc_cls, GNUNET_BLOCK_TYPE_ANY,
623 GNUNET_TIME_UNIT_FOREVER_ABS,
625 GSF_mesh_query_cancel (sr);
631 * Function called by mesh when a client disconnects.
632 * Cleans up our 'struct MeshClient' of that tunnel.
635 * @param tunnel tunnel of the disconnecting client
636 * @param tunnel_ctx our 'struct MeshClient'
639 cleaner_cb (void *cls,
640 const struct GNUNET_MESH_Tunnel *tunnel,
643 struct MeshHandle *mh = tunnel_ctx;
644 struct GSF_MeshRequest *sr;
647 while (NULL != (sr = mh->pending_head))
649 sr->proc (sr->proc_cls, GNUNET_BLOCK_TYPE_ANY,
650 GNUNET_TIME_UNIT_FOREVER_ABS,
652 GSF_mesh_query_cancel (sr);
654 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
658 GNUNET_MESH_notify_transmit_ready_cancel (mh->wh);
659 if (GNUNET_SCHEDULER_NO_TASK != mh->timeout_task)
660 GNUNET_SCHEDULER_cancel (mh->timeout_task);
661 if (GNUNET_SCHEDULER_NO_TASK != mh->reset_task)
662 GNUNET_SCHEDULER_cancel (mh->reset_task);
663 GNUNET_assert (GNUNET_OK ==
664 GNUNET_CONTAINER_multihashmap_remove (mesh_map,
665 &mh->target.hashPubKey,
667 GNUNET_CONTAINER_multihashmap_destroy (mh->waiting_map);
673 * Initialize subsystem for non-anonymous file-sharing.
676 GSF_mesh_start_client ()
678 static const struct GNUNET_MESH_MessageHandler handlers[] = {
679 { &reply_cb, GNUNET_MESSAGE_TYPE_FS_MESH_REPLY, 0 },
682 static const uint32_t ports[] = {
683 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
687 mesh_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_YES);
688 mesh_tunnel = GNUNET_MESH_connect (GSF_cfg,
698 * Function called on each active meshs to shut them down.
701 * @param key target peer, unused
702 * @param value the 'struct MeshHandle' to destroy
703 * @return GNUNET_YES (continue to iterate)
706 release_meshs (void *cls,
707 const struct GNUNET_HashCode *key,
710 struct MeshHandle *mh = value;
711 struct GNUNET_MESH_Tunnel *tun;
713 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
714 "Timeout on mesh tunnel to %s\n",
715 GNUNET_i2s (&mh->target));
719 GNUNET_MESH_tunnel_destroy (tun);
725 * Shutdown subsystem for non-anonymous file-sharing.
728 GSF_mesh_stop_client ()
730 GNUNET_CONTAINER_multihashmap_iterate (mesh_map,
733 GNUNET_CONTAINER_multihashmap_destroy (mesh_map);
735 if (NULL != mesh_tunnel)
737 GNUNET_MESH_disconnect (mesh_tunnel);
743 /* end of gnunet-service-fs_mesh_client.c */