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_map', 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_handle;
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_handle_destroy (mh->tunnel);
220 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
223 mh->tunnel = GNUNET_mesh_handle_create (mesh_handle,
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_Handle *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_handle_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;
309 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
310 "Mesh tunnel to %s failed during transmission attempt, rebuilding\n",
311 GNUNET_i2s (&mh->target));
315 sr = mh->pending_head;
318 GNUNET_assert (size >= sizeof (struct MeshQueryMessage));
319 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
322 GNUNET_assert (GNUNET_OK ==
323 GNUNET_CONTAINER_multihashmap_put (mh->waiting_map,
326 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
327 sr->was_transmitted = GNUNET_YES;
328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
329 "Sending query for %s via mesh to %s\n",
330 GNUNET_h2s (&sr->query),
331 GNUNET_i2s (&mh->target));
332 sqm.header.size = htons (sizeof (sqm));
333 sqm.header.type = htons (GNUNET_MESSAGE_TYPE_FS_MESH_QUERY);
334 sqm.type = htonl (sr->type);
335 sqm.query = sr->query;
336 memcpy (buf, &sqm, sizeof (sqm));
337 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
338 "Successfully transmitted %u bytes via mesh to %s\n",
340 GNUNET_i2s (&mh->target));
341 transmit_pending (mh);
347 * Transmit pending requests via the mesh.
349 * @param mh mesh to process
352 transmit_pending (struct MeshHandle *mh)
356 mh->wh = GNUNET_MESH_notify_transmit_ready (mh->tunnel, GNUNET_YES /* allow cork */,
357 GNUNET_TIME_UNIT_FOREVER_REL,
358 sizeof (struct MeshQueryMessage),
364 * Closure for 'handle_reply'.
366 struct HandleReplyClosure
375 * Expiration time for the block.
377 struct GNUNET_TIME_Absolute expiration;
380 * Number of bytes in 'data'.
387 enum GNUNET_BLOCK_Type type;
390 * Did we have a matching query?
397 * Iterator called on each entry in a waiting map to
400 * @param cls the 'struct HandleReplyClosure'
401 * @param key the key of the entry in the map (the query)
402 * @param value the 'struct GSF_MeshRequest' to handle result for
403 * @return GNUNET_YES (continue to iterate)
406 handle_reply (void *cls,
407 const struct GNUNET_HashCode *key,
410 struct HandleReplyClosure *hrc = cls;
411 struct GSF_MeshRequest *sr = value;
413 sr->proc (sr->proc_cls,
418 GSF_mesh_query_cancel (sr);
419 hrc->found = GNUNET_YES;
425 * Functions with this signature are called whenever a complete reply
428 * @param cls closure with the 'struct MeshHandle'
429 * @param tunnel tunnel handle
430 * @param tunnel_ctx tunnel context
431 * @param message the actual message
432 * @return GNUNET_OK on success, GNUNET_SYSERR to stop further processing
436 struct GNUNET_Mesh_Handle *tunnel,
438 const struct GNUNET_MessageHeader *message)
440 struct MeshHandle *mh = *tunnel_ctx;
441 const struct MeshReplyMessage *srm;
442 struct HandleReplyClosure hrc;
444 enum GNUNET_BLOCK_Type type;
445 struct GNUNET_HashCode query;
447 msize = ntohs (message->size);
448 if (sizeof (struct MeshReplyMessage) > msize)
451 reset_mesh_async (mh);
452 return GNUNET_SYSERR;
454 srm = (const struct MeshReplyMessage *) message;
455 msize -= sizeof (struct MeshReplyMessage);
456 type = (enum GNUNET_BLOCK_Type) ntohl (srm->type);
458 GNUNET_BLOCK_get_key (GSF_block_ctx,
460 &srm[1], msize, &query))
463 reset_mesh_async (mh);
464 return GNUNET_SYSERR;
466 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
467 "Received reply `%s' via mesh from peer %s\n",
469 GNUNET_i2s (&mh->target));
470 GNUNET_MESH_receive_done (tunnel);
471 GNUNET_STATISTICS_update (GSF_stats,
472 gettext_noop ("# replies received via mesh"), 1,
475 hrc.data_size = msize;
476 hrc.expiration = GNUNET_TIME_absolute_ntoh (srm->expiration);
478 hrc.found = GNUNET_NO;
479 GNUNET_CONTAINER_multihashmap_get_multiple (mh->waiting_map,
483 if (GNUNET_NO == hrc.found)
485 GNUNET_STATISTICS_update (GSF_stats,
486 gettext_noop ("# replies received via mesh dropped"), 1,
495 * Get (or create) a mesh to talk to the given peer.
497 * @param target peer we want to communicate with
499 static struct MeshHandle *
500 get_mesh (const struct GNUNET_PeerIdentity *target)
502 struct MeshHandle *mh;
504 mh = GNUNET_CONTAINER_multihashmap_get (mesh_map,
505 &target->hashPubKey);
508 if (GNUNET_SCHEDULER_NO_TASK != mh->timeout_task)
510 GNUNET_SCHEDULER_cancel (mh->timeout_task);
511 mh->timeout_task = GNUNET_SCHEDULER_NO_TASK;
515 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
516 "Creating mesh tunnel to %s\n",
517 GNUNET_i2s (target));
518 mh = GNUNET_new (struct MeshHandle);
519 mh->reset_task = GNUNET_SCHEDULER_add_delayed (CLIENT_RETRY_TIMEOUT,
522 mh->waiting_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_YES);
523 mh->target = *target;
524 mh->tunnel = GNUNET_mesh_handle_create (mesh_handle,
527 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
530 GNUNET_assert (GNUNET_OK ==
531 GNUNET_CONTAINER_multihashmap_put (mesh_map,
532 &mh->target.hashPubKey,
534 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
540 * Look for a block by directly contacting a particular peer.
542 * @param target peer that should have the block
543 * @param query hash to query for the block
544 * @param type desired type for the block
545 * @param proc function to call with result
546 * @param proc_cls closure for 'proc'
547 * @return handle to cancel the operation
549 struct GSF_MeshRequest *
550 GSF_mesh_query (const struct GNUNET_PeerIdentity *target,
551 const struct GNUNET_HashCode *query,
552 enum GNUNET_BLOCK_Type type,
553 GSF_MeshReplyProcessor proc, void *proc_cls)
555 struct MeshHandle *mh;
556 struct GSF_MeshRequest *sr;
558 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
559 "Preparing to send query for %s via mesh to %s\n",
561 GNUNET_i2s (target));
562 mh = get_mesh (target);
563 sr = GNUNET_new (struct GSF_MeshRequest);
566 sr->proc_cls = proc_cls;
569 GNUNET_CONTAINER_DLL_insert (mh->pending_head,
572 transmit_pending (mh);
578 * Cancel an active request; must not be called after 'proc'
581 * @param sr request to cancel
584 GSF_mesh_query_cancel (struct GSF_MeshRequest *sr)
586 struct MeshHandle *mh = sr->mh;
588 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
589 "Cancelled query for %s via mesh to %s\n",
590 GNUNET_h2s (&sr->query),
591 GNUNET_i2s (&sr->mh->target));
592 if (GNUNET_YES == sr->was_transmitted)
593 GNUNET_assert (GNUNET_OK ==
594 GNUNET_CONTAINER_multihashmap_remove (mh->waiting_map,
598 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
602 if ( (0 == GNUNET_CONTAINER_multihashmap_size (mh->waiting_map)) &&
603 (NULL == mh->pending_head) )
604 mh->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
611 * Iterator called on each entry in a waiting map to
612 * call the 'proc' continuation and release associated
615 * @param cls the 'struct MeshHandle'
616 * @param key the key of the entry in the map (the query)
617 * @param value the 'struct GSF_MeshRequest' to clean up
618 * @return GNUNET_YES (continue to iterate)
621 free_waiting_entry (void *cls,
622 const struct GNUNET_HashCode *key,
625 struct GSF_MeshRequest *sr = value;
627 sr->proc (sr->proc_cls, GNUNET_BLOCK_TYPE_ANY,
628 GNUNET_TIME_UNIT_FOREVER_ABS,
630 GSF_mesh_query_cancel (sr);
636 * Function called by mesh when a client disconnects.
637 * Cleans up our 'struct MeshClient' of that tunnel.
640 * @param tunnel tunnel of the disconnecting client
641 * @param tunnel_ctx our 'struct MeshClient'
644 cleaner_cb (void *cls,
645 const struct GNUNET_Mesh_Handle *tunnel,
648 struct MeshHandle *mh = tunnel_ctx;
649 struct GSF_MeshRequest *sr;
652 while (NULL != (sr = mh->pending_head))
654 sr->proc (sr->proc_cls, GNUNET_BLOCK_TYPE_ANY,
655 GNUNET_TIME_UNIT_FOREVER_ABS,
657 GSF_mesh_query_cancel (sr);
659 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
663 GNUNET_MESH_notify_transmit_ready_cancel (mh->wh);
664 if (GNUNET_SCHEDULER_NO_TASK != mh->timeout_task)
665 GNUNET_SCHEDULER_cancel (mh->timeout_task);
666 if (GNUNET_SCHEDULER_NO_TASK != mh->reset_task)
667 GNUNET_SCHEDULER_cancel (mh->reset_task);
668 GNUNET_assert (GNUNET_OK ==
669 GNUNET_CONTAINER_multihashmap_remove (mesh_map,
670 &mh->target.hashPubKey,
672 GNUNET_CONTAINER_multihashmap_destroy (mh->waiting_map);
678 * Initialize subsystem for non-anonymous file-sharing.
681 GSF_mesh_start_client ()
683 static const struct GNUNET_MESH_MessageHandler handlers[] = {
684 { &reply_cb, GNUNET_MESSAGE_TYPE_FS_MESH_REPLY, 0 },
688 mesh_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_YES);
689 mesh_handle = GNUNET_MESH_connect (GSF_cfg,
699 * Function called on each active meshs to shut them down.
702 * @param key target peer, unused
703 * @param value the 'struct MeshHandle' to destroy
704 * @return GNUNET_YES (continue to iterate)
707 release_meshs (void *cls,
708 const struct GNUNET_HashCode *key,
711 struct MeshHandle *mh = value;
712 struct GNUNET_Mesh_Handle *tun;
714 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
715 "Timeout on mesh tunnel to %s\n",
716 GNUNET_i2s (&mh->target));
720 GNUNET_mesh_handle_destroy (tun);
726 * Shutdown subsystem for non-anonymous file-sharing.
729 GSF_mesh_stop_client ()
731 GNUNET_CONTAINER_multihashmap_iterate (mesh_map,
734 GNUNET_CONTAINER_multihashmap_destroy (mesh_map);
736 if (NULL != mesh_handle)
738 GNUNET_MESH_disconnect (mesh_handle);
744 /* end of gnunet-service-fs_mesh_client.c */