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? #GNUNET_YES if we are
96 * in the 'waiting_map', #GNUNET_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 * Channel to the other peer.
126 struct GNUNET_MESH_Channel *channel;
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 channel for creating outbound channels.
158 static struct GNUNET_MESH_Handle *mesh_handle;
161 * Map from peer identities to 'struct MeshHandles' with mesh
162 * channels to those peers.
164 static struct GNUNET_CONTAINER_MultiPeerMap *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 struct GNUNET_MESH_Channel *channel = mh->channel;
218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
219 "Resetting mesh channel to %s\n",
220 GNUNET_i2s (&mh->target));
223 GNUNET_MESH_channel_destroy (channel);
224 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
227 mh->channel = GNUNET_MESH_channel_create (mesh_handle,
230 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
233 transmit_pending (mh);
238 * Task called when it is time to destroy an inactive mesh channel.
240 * @param cls the `struct MeshHandle` to tear down
241 * @param tc scheduler context, unused
244 mesh_timeout (void *cls,
245 const struct GNUNET_SCHEDULER_TaskContext *tc)
247 struct MeshHandle *mh = cls;
248 struct GNUNET_MESH_Channel *tun;
250 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
251 "Timeout on mesh channel to %s\n",
252 GNUNET_i2s (&mh->target));
253 mh->timeout_task = GNUNET_SCHEDULER_NO_TASK;
256 GNUNET_MESH_channel_destroy (tun);
261 * Task called when it is time to reset an mesh.
263 * @param cls the `struct MeshHandle` to tear down
264 * @param tc scheduler context, unused
267 reset_mesh_task (void *cls,
268 const struct GNUNET_SCHEDULER_TaskContext *tc)
270 struct MeshHandle *mh = cls;
272 mh->reset_task = GNUNET_SCHEDULER_NO_TASK;
278 * We had a serious error, tear down and re-create mesh from scratch,
279 * but do so asynchronously.
281 * @param mh mesh to reset
284 reset_mesh_async (struct MeshHandle *mh)
286 if (GNUNET_SCHEDULER_NO_TASK != mh->reset_task)
287 GNUNET_SCHEDULER_cancel (mh->reset_task);
288 mh->reset_task = GNUNET_SCHEDULER_add_now (&reset_mesh_task,
294 * Functions of this signature are called whenever we are ready to transmit
297 * @param cls the struct MeshHandle for which we did the write call
298 * @param size the number of bytes that can be written to @a buf
299 * @param buf where to write the message
300 * @return number of bytes written to @a buf
303 transmit_sqm (void *cls,
307 struct MeshHandle *mh = cls;
308 struct MeshQueryMessage sqm;
309 struct GSF_MeshRequest *sr;
314 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
315 "Mesh channel to %s failed during transmission attempt, rebuilding\n",
316 GNUNET_i2s (&mh->target));
317 reset_mesh_async (mh);
320 sr = mh->pending_head;
323 GNUNET_assert (size >= sizeof (struct MeshQueryMessage));
324 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
327 GNUNET_assert (GNUNET_OK ==
328 GNUNET_CONTAINER_multihashmap_put (mh->waiting_map,
331 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
332 sr->was_transmitted = GNUNET_YES;
333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
334 "Sending query for %s via mesh to %s\n",
335 GNUNET_h2s (&sr->query),
336 GNUNET_i2s (&mh->target));
337 sqm.header.size = htons (sizeof (sqm));
338 sqm.header.type = htons (GNUNET_MESSAGE_TYPE_FS_MESH_QUERY);
339 sqm.type = htonl (sr->type);
340 sqm.query = sr->query;
341 memcpy (buf, &sqm, sizeof (sqm));
342 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
343 "Successfully transmitted %u bytes via mesh to %s\n",
345 GNUNET_i2s (&mh->target));
346 transmit_pending (mh);
352 * Transmit pending requests via the mesh.
354 * @param mh mesh to process
357 transmit_pending (struct MeshHandle *mh)
359 if (NULL == mh->channel)
363 mh->wh = GNUNET_MESH_notify_transmit_ready (mh->channel, GNUNET_YES /* allow cork */,
364 GNUNET_TIME_UNIT_FOREVER_REL,
365 sizeof (struct MeshQueryMessage),
371 * Closure for 'handle_reply'.
373 struct HandleReplyClosure
382 * Expiration time for the block.
384 struct GNUNET_TIME_Absolute expiration;
387 * Number of bytes in 'data'.
394 enum GNUNET_BLOCK_Type type;
397 * Did we have a matching query?
404 * Iterator called on each entry in a waiting map to
407 * @param cls the `struct HandleReplyClosure`
408 * @param key the key of the entry in the map (the query)
409 * @param value the `struct GSF_MeshRequest` to handle result for
410 * @return #GNUNET_YES (continue to iterate)
413 handle_reply (void *cls,
414 const struct GNUNET_HashCode *key,
417 struct HandleReplyClosure *hrc = cls;
418 struct GSF_MeshRequest *sr = value;
420 sr->proc (sr->proc_cls,
426 GSF_mesh_query_cancel (sr);
427 hrc->found = GNUNET_YES;
433 * Functions with this signature are called whenever a complete reply
436 * @param cls closure with the `struct MeshHandle`
437 * @param channel channel handle
438 * @param channel_ctx channel context
439 * @param message the actual message
440 * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
444 struct GNUNET_MESH_Channel *channel,
446 const struct GNUNET_MessageHeader *message)
448 struct MeshHandle *mh = *channel_ctx;
449 const struct MeshReplyMessage *srm;
450 struct HandleReplyClosure hrc;
452 enum GNUNET_BLOCK_Type type;
453 struct GNUNET_HashCode query;
455 msize = ntohs (message->size);
456 if (sizeof (struct MeshReplyMessage) > msize)
459 reset_mesh_async (mh);
460 return GNUNET_SYSERR;
462 srm = (const struct MeshReplyMessage *) message;
463 msize -= sizeof (struct MeshReplyMessage);
464 type = (enum GNUNET_BLOCK_Type) ntohl (srm->type);
466 GNUNET_BLOCK_get_key (GSF_block_ctx,
468 &srm[1], msize, &query))
471 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
472 "Received bogus reply of type %u with %u bytes via mesh from peer %s\n",
475 GNUNET_i2s (&mh->target));
476 reset_mesh_async (mh);
477 return GNUNET_SYSERR;
479 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
480 "Received reply `%s' via mesh from peer %s\n",
482 GNUNET_i2s (&mh->target));
483 GNUNET_MESH_receive_done (channel);
484 GNUNET_STATISTICS_update (GSF_stats,
485 gettext_noop ("# replies received via mesh"), 1,
488 hrc.data_size = msize;
489 hrc.expiration = GNUNET_TIME_absolute_ntoh (srm->expiration);
491 hrc.found = GNUNET_NO;
492 GNUNET_CONTAINER_multihashmap_get_multiple (mh->waiting_map,
496 if (GNUNET_NO == hrc.found)
498 GNUNET_STATISTICS_update (GSF_stats,
499 gettext_noop ("# replies received via mesh dropped"), 1,
508 * Get (or create) a mesh to talk to the given peer.
510 * @param target peer we want to communicate with
512 static struct MeshHandle *
513 get_mesh (const struct GNUNET_PeerIdentity *target)
515 struct MeshHandle *mh;
517 mh = GNUNET_CONTAINER_multipeermap_get (mesh_map,
521 if (GNUNET_SCHEDULER_NO_TASK != mh->timeout_task)
523 GNUNET_SCHEDULER_cancel (mh->timeout_task);
524 mh->timeout_task = GNUNET_SCHEDULER_NO_TASK;
528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
529 "Creating mesh channel to %s\n",
530 GNUNET_i2s (target));
531 mh = GNUNET_new (struct MeshHandle);
532 mh->reset_task = GNUNET_SCHEDULER_add_delayed (CLIENT_RETRY_TIMEOUT,
535 mh->waiting_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_YES);
536 mh->target = *target;
537 GNUNET_assert (GNUNET_OK ==
538 GNUNET_CONTAINER_multipeermap_put (mesh_map,
541 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
542 mh->channel = GNUNET_MESH_channel_create (mesh_handle,
545 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
549 GNUNET_CONTAINER_multipeermap_get (mesh_map,
556 * Look for a block by directly contacting a particular peer.
558 * @param target peer that should have the block
559 * @param query hash to query for the block
560 * @param type desired type for the block
561 * @param proc function to call with result
562 * @param proc_cls closure for @a proc
563 * @return handle to cancel the operation
565 struct GSF_MeshRequest *
566 GSF_mesh_query (const struct GNUNET_PeerIdentity *target,
567 const struct GNUNET_HashCode *query,
568 enum GNUNET_BLOCK_Type type,
569 GSF_MeshReplyProcessor proc, void *proc_cls)
571 struct MeshHandle *mh;
572 struct GSF_MeshRequest *sr;
574 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
575 "Preparing to send query for %s via mesh to %s\n",
577 GNUNET_i2s (target));
578 mh = get_mesh (target);
579 sr = GNUNET_new (struct GSF_MeshRequest);
582 sr->proc_cls = proc_cls;
585 GNUNET_CONTAINER_DLL_insert (mh->pending_head,
588 transmit_pending (mh);
594 * Cancel an active request; must not be called after 'proc'
597 * @param sr request to cancel
600 GSF_mesh_query_cancel (struct GSF_MeshRequest *sr)
602 struct MeshHandle *mh = sr->mh;
603 GSF_MeshReplyProcessor p;
609 /* signal failure / cancellation to callback */
610 p (sr->proc_cls, GNUNET_BLOCK_TYPE_ANY,
611 GNUNET_TIME_UNIT_ZERO_ABS,
614 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
615 "Cancelled query for %s via mesh to %s\n",
616 GNUNET_h2s (&sr->query),
617 GNUNET_i2s (&sr->mh->target));
618 if (GNUNET_YES == sr->was_transmitted)
619 GNUNET_assert (GNUNET_OK ==
620 GNUNET_CONTAINER_multihashmap_remove (mh->waiting_map,
624 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
628 if ( (0 == GNUNET_CONTAINER_multihashmap_size (mh->waiting_map)) &&
629 (NULL == mh->pending_head) )
630 mh->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
637 * Iterator called on each entry in a waiting map to
638 * call the 'proc' continuation and release associated
641 * @param cls the `struct MeshHandle`
642 * @param key the key of the entry in the map (the query)
643 * @param value the `struct GSF_MeshRequest` to clean up
644 * @return #GNUNET_YES (continue to iterate)
647 free_waiting_entry (void *cls,
648 const struct GNUNET_HashCode *key,
651 struct GSF_MeshRequest *sr = value;
653 GSF_mesh_query_cancel (sr);
659 * Function called by mesh when a client disconnects.
660 * Cleans up our `struct MeshClient` of that channel.
663 * @param channel channel of the disconnecting client
664 * @param channel_ctx our `struct MeshClient`
667 cleaner_cb (void *cls,
668 const struct GNUNET_MESH_Channel *channel,
671 struct MeshHandle *mh = channel_ctx;
672 struct GSF_MeshRequest *sr;
674 if (NULL == mh->channel)
675 return; /* being destroyed elsewhere */
676 GNUNET_assert (channel == mh->channel);
678 while (NULL != (sr = mh->pending_head))
679 GSF_mesh_query_cancel (sr);
680 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
684 GNUNET_MESH_notify_transmit_ready_cancel (mh->wh);
685 if (GNUNET_SCHEDULER_NO_TASK != mh->timeout_task)
686 GNUNET_SCHEDULER_cancel (mh->timeout_task);
687 if (GNUNET_SCHEDULER_NO_TASK != mh->reset_task)
688 GNUNET_SCHEDULER_cancel (mh->reset_task);
689 GNUNET_assert (GNUNET_OK ==
690 GNUNET_CONTAINER_multipeermap_remove (mesh_map,
693 GNUNET_CONTAINER_multihashmap_destroy (mh->waiting_map);
699 * Initialize subsystem for non-anonymous file-sharing.
702 GSF_mesh_start_client ()
704 static const struct GNUNET_MESH_MessageHandler handlers[] = {
705 { &reply_cb, GNUNET_MESSAGE_TYPE_FS_MESH_REPLY, 0 },
709 mesh_map = GNUNET_CONTAINER_multipeermap_create (16, GNUNET_YES);
710 mesh_handle = GNUNET_MESH_connect (GSF_cfg,
720 * Function called on each active meshs to shut them down.
723 * @param key target peer, unused
724 * @param value the `struct MeshHandle` to destroy
725 * @return #GNUNET_YES (continue to iterate)
728 release_meshs (void *cls,
729 const struct GNUNET_PeerIdentity *key,
732 struct MeshHandle *mh = value;
734 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
735 "Timeout on mesh channel to %s\n",
736 GNUNET_i2s (&mh->target));
737 if (NULL != mh->channel)
738 GNUNET_MESH_channel_destroy (mh->channel);
744 * Shutdown subsystem for non-anonymous file-sharing.
747 GSF_mesh_stop_client ()
749 GNUNET_CONTAINER_multipeermap_iterate (mesh_map,
752 GNUNET_CONTAINER_multipeermap_destroy (mesh_map);
754 if (NULL != mesh_handle)
756 GNUNET_MESH_disconnect (mesh_handle);
762 /* end of gnunet-service-fs_mesh_client.c */