2 This file is part of GNUnet.
3 Copyright (C) 2012, 2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file fs/gnunet-service-fs_cadet_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_cadet_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_cadet.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 cadet to another peer.
54 * Handle for a request that is going out via cadet API.
56 struct GSF_CadetRequest
62 struct GSF_CadetRequest *next;
67 struct GSF_CadetRequest *prev;
70 * Which cadet is this request associated with?
72 struct CadetHandle *mh;
75 * Function to call with the result.
77 GSF_CadetReplyProcessor 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 cadet to another peer.
108 * Head of DLL of pending requests on this cadet.
110 struct GSF_CadetRequest *pending_head;
113 * Tail of DLL of pending requests on this cadet.
115 struct GSF_CadetRequest *pending_tail;
118 * Map from query to `struct GSF_CadetRequest`s waiting for
121 struct GNUNET_CONTAINER_MultiHashMap *waiting_map;
124 * Channel to the other peer.
126 struct GNUNET_CADET_Channel *channel;
129 * Handle for active write operation, or NULL.
131 struct GNUNET_CADET_TransmitHandle *wh;
134 * Which peer does this cadet go to?
136 struct GNUNET_PeerIdentity target;
139 * Task to kill inactive cadets (we keep them around for
140 * a few seconds to give the application a chance to give
143 struct GNUNET_SCHEDULER_Task * timeout_task;
146 * Task to reset cadets that had errors (asynchronously,
147 * as we may not be able to do it immediately during a
148 * callback from the cadet API).
150 struct GNUNET_SCHEDULER_Task * reset_task;
156 * Cadet channel for creating outbound channels.
158 static struct GNUNET_CADET_Handle *cadet_handle;
161 * Map from peer identities to 'struct CadetHandles' with cadet
162 * channels to those peers.
164 static struct GNUNET_CONTAINER_MultiPeerMap *cadet_map;
167 /* ********************* client-side code ************************* */
171 * Transmit pending requests via the cadet.
173 * @param mh cadet to process
176 transmit_pending (struct CadetHandle *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 CadetHandle`
184 * @param key the key of the entry in the map (the query)
185 * @param value the `struct GSF_CadetRequest` 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 CadetHandle *mh = cls;
194 struct GSF_CadetRequest *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 cadet from scratch.
211 * @param mh cadet to reset
214 reset_cadet (struct CadetHandle *mh)
216 struct GNUNET_CADET_Channel *channel = mh->channel;
218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
219 "Resetting cadet channel to %s\n",
220 GNUNET_i2s (&mh->target));
228 GNUNET_CADET_notify_transmit_ready_cancel (mh->wh);
231 GNUNET_CADET_channel_destroy (channel);
233 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
236 mh->channel = GNUNET_CADET_channel_create (cadet_handle,
239 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
240 GNUNET_CADET_OPTION_RELIABLE);
241 transmit_pending (mh);
246 * Task called when it is time to destroy an inactive cadet channel.
248 * @param cls the `struct CadetHandle` to tear down
251 cadet_timeout (void *cls)
253 struct CadetHandle *mh = cls;
254 struct GNUNET_CADET_Channel *tun;
256 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
257 "Timeout on cadet channel to %s\n",
258 GNUNET_i2s (&mh->target));
259 mh->timeout_task = NULL;
263 GNUNET_CADET_channel_destroy (tun);
268 * Task called when it is time to reset an cadet.
270 * @param cls the `struct CadetHandle` to tear down
273 reset_cadet_task (void *cls)
275 struct CadetHandle *mh = cls;
277 mh->reset_task = NULL;
283 * We had a serious error, tear down and re-create cadet from scratch,
284 * but do so asynchronously.
286 * @param mh cadet to reset
289 reset_cadet_async (struct CadetHandle *mh)
291 if (NULL != mh->reset_task)
292 GNUNET_SCHEDULER_cancel (mh->reset_task);
293 mh->reset_task = GNUNET_SCHEDULER_add_now (&reset_cadet_task,
299 * Functions of this signature are called whenever we are ready to transmit
302 * @param cls the struct CadetHandle for which we did the write call
303 * @param size the number of bytes that can be written to @a buf
304 * @param buf where to write the message
305 * @return number of bytes written to @a buf
308 transmit_sqm (void *cls,
312 struct CadetHandle *mh = cls;
313 struct CadetQueryMessage sqm;
314 struct GSF_CadetRequest *sr;
319 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
320 "Cadet channel to %s failed during transmission attempt, rebuilding\n",
321 GNUNET_i2s (&mh->target));
322 reset_cadet_async (mh);
325 sr = mh->pending_head;
328 GNUNET_assert (size >= sizeof (struct CadetQueryMessage));
329 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
332 GNUNET_assert (GNUNET_OK ==
333 GNUNET_CONTAINER_multihashmap_put (mh->waiting_map,
336 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
337 sr->was_transmitted = GNUNET_YES;
338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
339 "Sending query for %s via cadet to %s\n",
340 GNUNET_h2s (&sr->query),
341 GNUNET_i2s (&mh->target));
342 sqm.header.size = htons (sizeof (sqm));
343 sqm.header.type = htons (GNUNET_MESSAGE_TYPE_FS_CADET_QUERY);
344 sqm.type = htonl (sr->type);
345 sqm.query = sr->query;
346 memcpy (buf, &sqm, sizeof (sqm));
347 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
348 "Successfully transmitted %u bytes via cadet to %s\n",
350 GNUNET_i2s (&mh->target));
351 transmit_pending (mh);
357 * Transmit pending requests via the cadet.
359 * @param mh cadet to process
362 transmit_pending (struct CadetHandle *mh)
364 if (NULL == mh->channel)
368 mh->wh = GNUNET_CADET_notify_transmit_ready (mh->channel, GNUNET_YES /* allow cork */,
369 GNUNET_TIME_UNIT_FOREVER_REL,
370 sizeof (struct CadetQueryMessage),
376 * Closure for handle_reply().
378 struct HandleReplyClosure
387 * Expiration time for the block.
389 struct GNUNET_TIME_Absolute expiration;
392 * Number of bytes in 'data'.
399 enum GNUNET_BLOCK_Type type;
402 * Did we have a matching query?
409 * Iterator called on each entry in a waiting map to
412 * @param cls the `struct HandleReplyClosure`
413 * @param key the key of the entry in the map (the query)
414 * @param value the `struct GSF_CadetRequest` to handle result for
415 * @return #GNUNET_YES (continue to iterate)
418 handle_reply (void *cls,
419 const struct GNUNET_HashCode *key,
422 struct HandleReplyClosure *hrc = cls;
423 struct GSF_CadetRequest *sr = value;
425 sr->proc (sr->proc_cls,
431 GSF_cadet_query_cancel (sr);
432 hrc->found = GNUNET_YES;
438 * Functions with this signature are called whenever a complete reply
441 * @param cls closure with the `struct CadetHandle`
442 * @param channel channel handle
443 * @param channel_ctx channel context
444 * @param message the actual message
445 * @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
449 struct GNUNET_CADET_Channel *channel,
451 const struct GNUNET_MessageHeader *message)
453 struct CadetHandle *mh = *channel_ctx;
454 const struct CadetReplyMessage *srm;
455 struct HandleReplyClosure hrc;
457 enum GNUNET_BLOCK_Type type;
458 struct GNUNET_HashCode query;
460 msize = ntohs (message->size);
461 if (sizeof (struct CadetReplyMessage) > msize)
464 reset_cadet_async (mh);
465 return GNUNET_SYSERR;
467 srm = (const struct CadetReplyMessage *) message;
468 msize -= sizeof (struct CadetReplyMessage);
469 type = (enum GNUNET_BLOCK_Type) ntohl (srm->type);
471 GNUNET_BLOCK_get_key (GSF_block_ctx,
473 &srm[1], msize, &query))
476 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
477 "Received bogus reply of type %u with %u bytes via cadet from peer %s\n",
480 GNUNET_i2s (&mh->target));
481 reset_cadet_async (mh);
482 return GNUNET_SYSERR;
484 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
485 "Received reply `%s' via cadet from peer %s\n",
487 GNUNET_i2s (&mh->target));
488 GNUNET_CADET_receive_done (channel);
489 GNUNET_STATISTICS_update (GSF_stats,
490 gettext_noop ("# replies received via cadet"), 1,
493 hrc.data_size = msize;
494 hrc.expiration = GNUNET_TIME_absolute_ntoh (srm->expiration);
496 hrc.found = GNUNET_NO;
497 GNUNET_CONTAINER_multihashmap_get_multiple (mh->waiting_map,
501 if (GNUNET_NO == hrc.found)
503 GNUNET_STATISTICS_update (GSF_stats,
504 gettext_noop ("# replies received via cadet dropped"), 1,
513 * Get (or create) a cadet to talk to the given peer.
515 * @param target peer we want to communicate with
517 static struct CadetHandle *
518 get_cadet (const struct GNUNET_PeerIdentity *target)
520 struct CadetHandle *mh;
522 mh = GNUNET_CONTAINER_multipeermap_get (cadet_map,
526 if (NULL != mh->timeout_task)
528 GNUNET_SCHEDULER_cancel (mh->timeout_task);
529 mh->timeout_task = NULL;
533 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
534 "Creating cadet channel to %s\n",
535 GNUNET_i2s (target));
536 mh = GNUNET_new (struct CadetHandle);
537 mh->reset_task = GNUNET_SCHEDULER_add_delayed (CLIENT_RETRY_TIMEOUT,
540 mh->waiting_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_YES);
541 mh->target = *target;
542 GNUNET_assert (GNUNET_OK ==
543 GNUNET_CONTAINER_multipeermap_put (cadet_map,
546 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
547 mh->channel = GNUNET_CADET_channel_create (cadet_handle,
550 GNUNET_APPLICATION_TYPE_FS_BLOCK_TRANSFER,
551 GNUNET_CADET_OPTION_RELIABLE);
553 GNUNET_CONTAINER_multipeermap_get (cadet_map,
560 * Look for a block by directly contacting a particular peer.
562 * @param target peer that should have the block
563 * @param query hash to query for the block
564 * @param type desired type for the block
565 * @param proc function to call with result
566 * @param proc_cls closure for @a proc
567 * @return handle to cancel the operation
569 struct GSF_CadetRequest *
570 GSF_cadet_query (const struct GNUNET_PeerIdentity *target,
571 const struct GNUNET_HashCode *query,
572 enum GNUNET_BLOCK_Type type,
573 GSF_CadetReplyProcessor proc, void *proc_cls)
575 struct CadetHandle *mh;
576 struct GSF_CadetRequest *sr;
578 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
579 "Preparing to send query for %s via cadet to %s\n",
581 GNUNET_i2s (target));
582 mh = get_cadet (target);
583 sr = GNUNET_new (struct GSF_CadetRequest);
586 sr->proc_cls = proc_cls;
589 GNUNET_CONTAINER_DLL_insert (mh->pending_head,
592 transmit_pending (mh);
598 * Cancel an active request; must not be called after 'proc'
601 * @param sr request to cancel
604 GSF_cadet_query_cancel (struct GSF_CadetRequest *sr)
606 struct CadetHandle *mh = sr->mh;
607 GSF_CadetReplyProcessor p;
613 /* signal failure / cancellation to callback */
614 p (sr->proc_cls, GNUNET_BLOCK_TYPE_ANY,
615 GNUNET_TIME_UNIT_ZERO_ABS,
618 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
619 "Cancelled query for %s via cadet to %s\n",
620 GNUNET_h2s (&sr->query),
621 GNUNET_i2s (&sr->mh->target));
622 if (GNUNET_YES == sr->was_transmitted)
623 GNUNET_assert (GNUNET_OK ==
624 GNUNET_CONTAINER_multihashmap_remove (mh->waiting_map,
628 GNUNET_CONTAINER_DLL_remove (mh->pending_head,
632 if ( (0 == GNUNET_CONTAINER_multihashmap_size (mh->waiting_map)) &&
633 (NULL == mh->pending_head) )
634 mh->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
641 * Iterator called on each entry in a waiting map to
642 * call the 'proc' continuation and release associated
645 * @param cls the `struct CadetHandle`
646 * @param key the key of the entry in the map (the query)
647 * @param value the `struct GSF_CadetRequest` to clean up
648 * @return #GNUNET_YES (continue to iterate)
651 free_waiting_entry (void *cls,
652 const struct GNUNET_HashCode *key,
655 struct GSF_CadetRequest *sr = value;
657 GSF_cadet_query_cancel (sr);
663 * Function called by cadet when a client disconnects.
664 * Cleans up our `struct CadetClient` of that channel.
667 * @param channel channel of the disconnecting client
668 * @param channel_ctx our `struct CadetClient`
671 cleaner_cb (void *cls,
672 const struct GNUNET_CADET_Channel *channel,
675 struct CadetHandle *mh = channel_ctx;
676 struct GSF_CadetRequest *sr;
678 if (NULL == mh->channel)
679 return; /* being destroyed elsewhere */
680 GNUNET_assert (channel == mh->channel);
682 while (NULL != (sr = mh->pending_head))
683 GSF_cadet_query_cancel (sr);
684 /* first remove `mh` from the `cadet_map`, so that if the
685 callback from `free_waiting_entry()` happens to re-issue
686 the request, we don't immediately have it back in the
688 GNUNET_assert (GNUNET_OK ==
689 GNUNET_CONTAINER_multipeermap_remove (cadet_map,
692 GNUNET_CONTAINER_multihashmap_iterate (mh->waiting_map,
696 GNUNET_CADET_notify_transmit_ready_cancel (mh->wh);
697 if (NULL != mh->timeout_task)
698 GNUNET_SCHEDULER_cancel (mh->timeout_task);
699 if (NULL != mh->reset_task)
700 GNUNET_SCHEDULER_cancel (mh->reset_task);
702 GNUNET_CONTAINER_multihashmap_size (mh->waiting_map));
703 GNUNET_CONTAINER_multihashmap_destroy (mh->waiting_map);
709 * Initialize subsystem for non-anonymous file-sharing.
712 GSF_cadet_start_client ()
714 static const struct GNUNET_CADET_MessageHandler handlers[] = {
715 { &reply_cb, GNUNET_MESSAGE_TYPE_FS_CADET_REPLY, 0 },
719 cadet_map = GNUNET_CONTAINER_multipeermap_create (16, GNUNET_YES);
720 cadet_handle = GNUNET_CADET_connect (GSF_cfg,
730 * Function called on each active cadets to shut them down.
733 * @param key target peer, unused
734 * @param value the `struct CadetHandle` to destroy
735 * @return #GNUNET_YES (continue to iterate)
738 release_cadets (void *cls,
739 const struct GNUNET_PeerIdentity *key,
742 struct CadetHandle *mh = value;
744 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
745 "Timeout on cadet channel to %s\n",
746 GNUNET_i2s (&mh->target));
747 if (NULL != mh->channel)
748 GNUNET_CADET_channel_destroy (mh->channel);
754 * Shutdown subsystem for non-anonymous file-sharing.
757 GSF_cadet_stop_client ()
759 GNUNET_CONTAINER_multipeermap_iterate (cadet_map,
762 GNUNET_CONTAINER_multipeermap_destroy (cadet_map);
764 if (NULL != cadet_handle)
766 GNUNET_CADET_disconnect (cadet_handle);
772 /* end of gnunet-service-fs_cadet_client.c */