GNUnet  0.11.x
Data Structures | Macros | Functions | Variables
gnunet-service-fs_cadet_client.c File Reference

non-anonymous file-transfer More...

#include "platform.h"
#include "gnunet_constants.h"
#include "gnunet_util_lib.h"
#include "gnunet_cadet_service.h"
#include "gnunet_protocols.h"
#include "gnunet_applications.h"
#include "gnunet-service-fs.h"
#include "gnunet-service-fs_indexing.h"
#include "gnunet-service-fs_cadet.h"
Include dependency graph for gnunet-service-fs_cadet_client.c:

Go to the source code of this file.

Data Structures

struct  GSF_CadetRequest
 Handle for a request that is going out via cadet API. More...
 
struct  CadetHandle
 Handle for a cadet to another peer. More...
 
struct  HandleReplyClosure
 Closure for handle_reply(). More...
 

Macros

#define CLIENT_RETRY_TIMEOUT    GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
 After how long do we reset connections without replies? More...
 

Functions

static void transmit_pending (void *cls)
 Transmit pending requests via the cadet. More...
 
static int move_to_pending (void *cls, const struct GNUNET_HashCode *key, void *value)
 Iterator called on each entry in a waiting map to move it back to the pending list. More...
 
static int check_reply (void *cls, const struct CadetReplyMessage *srm)
 Functions with this signature are called whenever a complete reply is received. More...
 
static void reset_cadet_task (void *cls)
 Task called when it is time to reset an cadet. More...
 
static void reset_cadet_async (struct CadetHandle *mh)
 We had a serious error, tear down and re-create cadet from scratch, but do so asynchronously. More...
 
static int process_reply (void *cls, const struct GNUNET_HashCode *key, void *value)
 Iterator called on each entry in a waiting map to process a result. More...
 
static int free_waiting_entry (void *cls, const struct GNUNET_HashCode *key, void *value)
 Iterator called on each entry in a waiting map to call the 'proc' continuation and release associated resources. More...
 
static void handle_reply (void *cls, const struct CadetReplyMessage *srm)
 Functions with this signature are called whenever a complete reply is received. More...
 
static void disconnect_cb (void *cls, const struct GNUNET_CADET_Channel *channel)
 Function called by cadet when a client disconnects. More...
 
static void window_change_cb (void *cls, const struct GNUNET_CADET_Channel *channel, int window_size)
 Function called whenever an MQ-channel's transmission window size changes. More...
 
static void reset_cadet (struct CadetHandle *mh)
 We had a serious error, tear down and re-create cadet from scratch. More...
 
static void cadet_timeout (void *cls)
 Task called when it is time to destroy an inactive cadet channel. More...
 
static struct CadetHandleget_cadet (const struct GNUNET_PeerIdentity *target)
 Get (or create) a cadet to talk to the given peer. More...
 
struct GSF_CadetRequestGSF_cadet_query (const struct GNUNET_PeerIdentity *target, const struct GNUNET_HashCode *query, enum GNUNET_BLOCK_Type type, GSF_CadetReplyProcessor proc, void *proc_cls)
 Look for a block by directly contacting a particular peer. More...
 
void GSF_cadet_query_cancel (struct GSF_CadetRequest *sr)
 Cancel an active request; must not be called after 'proc' was called. More...
 
int GSF_cadet_release_clients (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
 Function called on each active cadets to shut them down. More...
 

Variables

struct GNUNET_CADET_Handlecadet_handle
 Cadet channel for creating outbound channels. More...
 
struct GNUNET_CONTAINER_MultiPeerMapcadet_map
 Map from peer identities to 'struct CadetHandles' with cadet channels to those peers. More...
 

Detailed Description

non-anonymous file-transfer

Author
Christian Grothoff

TODO:

Definition in file gnunet-service-fs_cadet_client.c.

Macro Definition Documentation

◆ CLIENT_RETRY_TIMEOUT

#define CLIENT_RETRY_TIMEOUT    GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)

After how long do we reset connections without replies?

Definition at line 44 of file gnunet-service-fs_cadet_client.c.

Function Documentation

◆ transmit_pending()

static void transmit_pending ( void *  cls)
static

Transmit pending requests via the cadet.

Parameters
clsstruct CadetHandle to process

Definition at line 528 of file gnunet-service-fs_cadet_client.c.

529 {
530  struct CadetHandle *mh = cls;
531  struct GNUNET_MQ_Handle *mq = GNUNET_CADET_get_mq (mh->channel);
532  struct GSF_CadetRequest *sr;
533  struct GNUNET_MQ_Envelope *env;
534  struct CadetQueryMessage *sqm;
535 
536  if ((0 != GNUNET_MQ_get_length (mq)) || (NULL == (sr = mh->pending_head)))
537  return;
538  GNUNET_CONTAINER_DLL_remove (mh->pending_head, mh->pending_tail, sr);
540  mh->waiting_map,
541  &sr->query,
542  sr,
546  "Sending query for %s via cadet to %s\n",
547  GNUNET_h2s (&sr->query),
548  GNUNET_i2s (&mh->target));
554  sqm->type = htonl (sr->type);
555  sqm->query = sr->query;
557  GNUNET_MQ_send (mq, env);
558 }
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static struct GNUNET_CADET_Handle * mh
Cadet handle.
Definition: gnunet-cadet.c:92
static void transmit_pending(void *cls)
Transmit pending requests via the cadet.
#define GNUNET_log(kind,...)
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_YES
Definition: gnunet_common.h:97
struct GNUNET_MQ_Handle * GNUNET_CADET_get_mq(const struct GNUNET_CADET_Channel *channel)
Obtain the message queue for a connected peer.
Definition: cadet_api.c:1082
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
int GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE
Allow multiple values with the same key.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
@ GNUNET_ERROR_TYPE_DEBUG
void GNUNET_MQ_env_set_options(struct GNUNET_MQ_Envelope *env, enum GNUNET_MQ_PriorityPreferences pp)
Set application-specific options for this envelope.
Definition: mq.c:1022
unsigned int GNUNET_MQ_get_length(struct GNUNET_MQ_Handle *mq)
Obtain the current length of the message queue.
Definition: mq.c:337
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:355
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:67
void GNUNET_MQ_notify_sent(struct GNUNET_MQ_Envelope *ev, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
Call a callback once the envelope has been sent, that is, sending it can not be canceled anymore.
Definition: mq.c:787
@ GNUNET_MQ_PREF_OUT_OF_ORDER
Flag to indicate that out-of-order delivery is OK.
@ GNUNET_MQ_PREF_CORK_ALLOWED
Flag to indicate that CORKing is acceptable.
@ GNUNET_MQ_PREF_GOODPUT
Flag to indicate that high bandwidth is desired.
#define GNUNET_MESSAGE_TYPE_FS_CADET_QUERY
P2P request for content (one FS to another via a cadet).
Handle for a cadet to another peer.
Query from one peer, asking the other for CHK-data.
struct GNUNET_HashCode query
Query hash from CHK (hash of encrypted block).
uint32_t type
Block type must be DBLOCK or IBLOCK.
Handle to a message queue.
Definition: mq.c:86
Handle for a request that is going out via cadet API.
enum GNUNET_BLOCK_Type type
Desired type for the reply.
int was_transmitted
Did we transmit this request already? GNUNET_YES if we are in the 'waiting_map', GNUNET_NO if we are ...
struct GNUNET_HashCode query
Query to transmit to the other peer.

References env, GNUNET_assert, GNUNET_CADET_get_mq(), GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_i2s(), GNUNET_log, GNUNET_MESSAGE_TYPE_FS_CADET_QUERY, GNUNET_MQ_env_set_options(), GNUNET_MQ_get_length(), GNUNET_MQ_msg, GNUNET_MQ_notify_sent(), GNUNET_MQ_PREF_CORK_ALLOWED, GNUNET_MQ_PREF_GOODPUT, GNUNET_MQ_PREF_OUT_OF_ORDER, GNUNET_MQ_send(), GNUNET_OK, GNUNET_YES, mh, mq, CadetQueryMessage::query, GSF_CadetRequest::query, CadetQueryMessage::type, GSF_CadetRequest::type, and GSF_CadetRequest::was_transmitted.

Referenced by GSF_cadet_query(), reset_cadet(), and window_change_cb().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ move_to_pending()

static int move_to_pending ( void *  cls,
const struct GNUNET_HashCode key,
void *  value 
)
static

Iterator called on each entry in a waiting map to move it back to the pending list.

Parameters
clsthe struct CadetHandle
keythe key of the entry in the map (the query)
valuethe struct GSF_CadetRequest to move to pending
Returns
GNUNET_YES (continue to iterate)

Definition at line 183 of file gnunet-service-fs_cadet_client.c.

184 {
185  struct CadetHandle *mh = cls;
186  struct GSF_CadetRequest *sr = value;
187 
188  GNUNET_assert (
189  GNUNET_YES ==
191  GNUNET_CONTAINER_DLL_insert (mh->pending_head, mh->pending_tail, sr);
193  return GNUNET_YES;
194 }
struct GNUNET_HashCode key
The key used in the DHT.
static char * value
Value of the record to add/remove.
@ GNUNET_NO
Definition: gnunet_common.h:94
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
int GNUNET_CONTAINER_multihashmap_remove(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, const void *value)
Remove the given key-value pair from the map.

References GNUNET_assert, GNUNET_CONTAINER_DLL_insert, GNUNET_CONTAINER_multihashmap_remove(), GNUNET_NO, GNUNET_YES, key, mh, value, and GSF_CadetRequest::was_transmitted.

Referenced by reset_cadet().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ check_reply()

static int check_reply ( void *  cls,
const struct CadetReplyMessage srm 
)
static

Functions with this signature are called whenever a complete reply is received.

Parameters
clsclosure with the struct CadetHandle
srmthe actual message
Returns
GNUNET_OK on success, GNUNET_SYSERR to stop further processing

Definition at line 206 of file gnunet-service-fs_cadet_client.c.

207 {
208  /* We check later... */
209  return GNUNET_OK;
210 }

References GNUNET_OK.

◆ reset_cadet_task()

static void reset_cadet_task ( void *  cls)
static

Task called when it is time to reset an cadet.

Parameters
clsthe struct CadetHandle to tear down

Definition at line 513 of file gnunet-service-fs_cadet_client.c.

514 {
515  struct CadetHandle *mh = cls;
516 
517  mh->reset_task = NULL;
518  reset_cadet (mh);
519 }
static void reset_cadet(struct CadetHandle *mh)
We had a serious error, tear down and re-create cadet from scratch.

References mh, and reset_cadet().

Referenced by get_cadet(), and reset_cadet_async().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reset_cadet_async()

static void reset_cadet_async ( struct CadetHandle mh)
static

We had a serious error, tear down and re-create cadet from scratch, but do so asynchronously.

Parameters
mhcadet to reset

Definition at line 229 of file gnunet-service-fs_cadet_client.c.

230 {
231  if (NULL != mh->reset_task)
232  GNUNET_SCHEDULER_cancel (mh->reset_task);
234 }
static void reset_cadet_task(void *cls)
Task called when it is time to reset an cadet.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1296
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:972

References GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), mh, and reset_cadet_task().

Referenced by handle_reply().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ process_reply()

static int process_reply ( void *  cls,
const struct GNUNET_HashCode key,
void *  value 
)
static

Iterator called on each entry in a waiting map to process a result.

Parameters
clsthe struct HandleReplyClosure
keythe key of the entry in the map (the query)
valuethe struct GSF_CadetRequest to handle result for
Returns
GNUNET_YES (continue to iterate)

Definition at line 279 of file gnunet-service-fs_cadet_client.c.

280 {
281  struct HandleReplyClosure *hrc = cls;
282  struct GSF_CadetRequest *sr = value;
283 
284  sr->proc (sr->proc_cls,
285  hrc->type,
286  hrc->expiration,
287  hrc->data_size,
288  hrc->data);
289  sr->proc = NULL;
291  hrc->found = GNUNET_YES;
292  return GNUNET_YES;
293 }
void GSF_cadet_query_cancel(struct GSF_CadetRequest *sr)
Cancel an active request; must not be called after 'proc' was called.
void * proc_cls
Closure for proc.
GSF_CadetReplyProcessor proc
Function to call with the result.
Closure for handle_reply().
enum GNUNET_BLOCK_Type type
Type of the block.
const void * data
Reply payload.
int found
Did we have a matching query?
size_t data_size
Number of bytes in data.
struct GNUNET_TIME_Absolute expiration
Expiration time for the block.

References HandleReplyClosure::data, HandleReplyClosure::data_size, HandleReplyClosure::expiration, HandleReplyClosure::found, GNUNET_YES, GSF_cadet_query_cancel(), GSF_CadetRequest::proc, GSF_CadetRequest::proc_cls, HandleReplyClosure::type, and value.

Referenced by handle_reply().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ free_waiting_entry()

static int free_waiting_entry ( void *  cls,
const struct GNUNET_HashCode key,
void *  value 
)
static

Iterator called on each entry in a waiting map to call the 'proc' continuation and release associated resources.

Parameters
clsthe struct CadetHandle
keythe key of the entry in the map (the query)
valuethe struct GSF_CadetRequest to clean up
Returns
GNUNET_YES (continue to iterate)

Definition at line 307 of file gnunet-service-fs_cadet_client.c.

308 {
309  struct GSF_CadetRequest *sr = value;
310 
312  return GNUNET_YES;
313 }

References GNUNET_YES, GSF_cadet_query_cancel(), and value.

Referenced by disconnect_cb().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handle_reply()

static void handle_reply ( void *  cls,
const struct CadetReplyMessage srm 
)
static

Functions with this signature are called whenever a complete reply is received.

Parameters
clsclosure with the struct CadetHandle
srmthe actual message

Definition at line 324 of file gnunet-service-fs_cadet_client.c.

325 {
326  struct CadetHandle *mh = cls;
327  struct HandleReplyClosure hrc;
328  uint16_t msize;
329  enum GNUNET_BLOCK_Type type;
330  struct GNUNET_HashCode query;
331 
332  msize = ntohs (srm->header.size) - sizeof(struct CadetReplyMessage);
333  type = (enum GNUNET_BLOCK_Type) ntohl (srm->type);
334  if (GNUNET_YES !=
335  GNUNET_BLOCK_get_key (GSF_block_ctx, type, &srm[1], msize, &query))
336  {
337  GNUNET_break_op (0);
338  GNUNET_log (
340  "Received bogus reply of type %u with %u bytes via cadet from peer %s\n",
341  type,
342  msize,
343  GNUNET_i2s (&mh->target));
345  return;
346  }
348  "Received reply `%s' via cadet from peer %s\n",
349  GNUNET_h2s (&query),
350  GNUNET_i2s (&mh->target));
351  GNUNET_CADET_receive_done (mh->channel);
353  gettext_noop ("# replies received via cadet"),
354  1,
355  GNUNET_NO);
356  hrc.data = &srm[1];
357  hrc.data_size = msize;
359  hrc.type = type;
360  hrc.found = GNUNET_NO;
362  &query,
363  &process_reply,
364  &hrc);
365  if (GNUNET_NO == hrc.found)
366  {
368  gettext_noop (
369  "# replies received via cadet dropped"),
370  1,
371  GNUNET_NO);
372  }
373 }
#define gettext_noop(String)
Definition: gettext.h:69
struct GNUNET_BLOCK_Context * GSF_block_ctx
Our block context.
struct GNUNET_STATISTICS_Handle * GSF_stats
Handle for reporting statistics.
static int process_reply(void *cls, const struct GNUNET_HashCode *key, void *value)
Iterator called on each entry in a waiting map to process a result.
static void reset_cadet_async(struct CadetHandle *mh)
We had a serious error, tear down and re-create cadet from scratch, but do so asynchronously.
int GNUNET_BLOCK_get_key(struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size, struct GNUNET_HashCode *key)
Function called to obtain the key for a block.
Definition: block.c:379
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
void GNUNET_CADET_receive_done(struct GNUNET_CADET_Channel *channel)
Send an ack on the channel to confirm the processing of a message.
Definition: cadet_api.c:888
int GNUNET_CONTAINER_multihashmap_get_multiple(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map that match a particular key.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
@ GNUNET_ERROR_TYPE_WARNING
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_ntoh(struct GNUNET_TIME_AbsoluteNBO a)
Convert absolute time from network byte order.
Definition: time.c:542
Reply to a CadetQueryMessage.
struct GNUNET_TIME_AbsoluteNBO expiration
Expiration time for the block.
struct GNUNET_MessageHeader header
Type is GNUNET_MESSAGE_TYPE_FS_CADET_REPLY.
uint32_t type
Block type must be DBLOCK or IBLOCK.
A 512-bit hashcode.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model

References HandleReplyClosure::data, HandleReplyClosure::data_size, CadetReplyMessage::expiration, HandleReplyClosure::expiration, HandleReplyClosure::found, gettext_noop, GNUNET_BLOCK_get_key(), GNUNET_break_op, GNUNET_CADET_receive_done(), GNUNET_CONTAINER_multihashmap_get_multiple(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_h2s(), GNUNET_i2s(), GNUNET_log, GNUNET_NO, GNUNET_STATISTICS_update(), GNUNET_TIME_absolute_ntoh(), GNUNET_YES, GSF_block_ctx, GSF_stats, CadetReplyMessage::header, mh, process_reply(), reset_cadet_async(), GNUNET_MessageHeader::size, CadetReplyMessage::type, HandleReplyClosure::type, and type.

Here is the call graph for this function:

◆ disconnect_cb()

static void disconnect_cb ( void *  cls,
const struct GNUNET_CADET_Channel channel 
)
static

Function called by cadet when a client disconnects.

Cleans up our struct CadetClient of that channel.

Parameters
clsour struct CadetClient
channelchannel of the disconnecting client

Definition at line 384 of file gnunet-service-fs_cadet_client.c.

385 {
386  struct CadetHandle *mh = cls;
387  struct GSF_CadetRequest *sr;
388 
389  if (NULL == mh->channel)
390  return; /* being destroyed elsewhere */
391  GNUNET_assert (channel == mh->channel);
392  mh->channel = NULL;
393  while (NULL != (sr = mh->pending_head))
395  /* first remove `mh` from the `cadet_map`, so that if the
396  callback from `free_waiting_entry()` happens to re-issue
397  the request, we don't immediately have it back in the
398  `waiting_map`. */
400  &mh->target,
401  mh));
404  mh);
405  if (NULL != mh->timeout_task)
406  GNUNET_SCHEDULER_cancel (mh->timeout_task);
407  if (NULL != mh->reset_task)
408  GNUNET_SCHEDULER_cancel (mh->reset_task);
411  GNUNET_free (mh);
412 }
struct GNUNET_CONTAINER_MultiPeerMap * cadet_map
Map from peer identities to 'struct CadetHandles' with cadet channels to those peers.
static int free_waiting_entry(void *cls, const struct GNUNET_HashCode *key, void *value)
Iterator called on each entry in a waiting map to call the 'proc' continuation and release associated...
unsigned int GNUNET_CONTAINER_multihashmap_size(const struct GNUNET_CONTAINER_MultiHashMap *map)
Get the number of key-value pairs in the map.
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
int GNUNET_CONTAINER_multipeermap_remove(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, const void *value)
Remove the given key-value pair from the map.
#define GNUNET_free(ptr)
Wrapper around free.

References cadet_map, free_waiting_entry(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_CONTAINER_multihashmap_size(), GNUNET_CONTAINER_multipeermap_remove(), GNUNET_free, GNUNET_OK, GNUNET_SCHEDULER_cancel(), GSF_cadet_query_cancel(), and mh.

Referenced by get_cadet(), GNUNET_SERVICE_run_(), GNUNET_SERVICE_start(), and reset_cadet().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ window_change_cb()

static void window_change_cb ( void *  cls,
const struct GNUNET_CADET_Channel channel,
int  window_size 
)
static

Function called whenever an MQ-channel's transmission window size changes.

The first callback in an outgoing channel will be with a non-zero value and will mean the channel is connected to the destination.

For an incoming channel it will be called immediately after the GNUNET_CADET_ConnectEventHandler, also with a non-zero value.

Parameters
clsChannel closure.
channelConnection to the other end (henceforth invalid).
window_sizeNew window size. If the is more messages than buffer size this value will be negative..

Definition at line 430 of file gnunet-service-fs_cadet_client.c.

433 {
434  /* FIXME: for flow control, implement? */
435 #if 0
436  /* Something like this instead of the GNUNET_MQ_notify_sent() in
437  transmit_pending() might be good (once the window change CB works...) */
438  if (0 < window_size) /* test needed? */
440 #endif
441 }

References mh, and transmit_pending().

Referenced by get_cadet(), and reset_cadet().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reset_cadet()

static void reset_cadet ( struct CadetHandle mh)
static

We had a serious error, tear down and re-create cadet from scratch.

Parameters
mhcadet to reset

Definition at line 450 of file gnunet-service-fs_cadet_client.c.

451 {
453  "Resetting cadet channel to %s\n",
454  GNUNET_i2s (&mh->target));
455  if (NULL != mh->channel)
456  {
457  GNUNET_CADET_channel_destroy (mh->channel);
458  mh->channel = NULL;
459  }
461  {
463  { GNUNET_MQ_hd_var_size (reply,
465  struct CadetReplyMessage,
466  mh),
468  struct GNUNET_HashCode port;
469 
472  &port);
474  mh,
475  &mh->target,
476  &port,
478  &disconnect_cb,
479  handlers);
480  }
482 }
static uint16_t port
Port number.
Definition: gnunet-bcd.c:83
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
static void disconnect_cb(void *cls, const struct GNUNET_CADET_Channel *channel)
Function called by cadet when a client disconnects.
static void window_change_cb(void *cls, const struct GNUNET_CADET_Channel *channel, int window_size)
Function called whenever an MQ-channel's transmission window size changes.
struct GNUNET_CADET_Handle * cadet_handle
Cadet channel for creating outbound channels.
static int move_to_pending(void *cls, const struct GNUNET_HashCode *key, void *value)
Iterator called on each entry in a waiting map to move it back to the pending list.
#define GNUNET_APPLICATION_PORT_FS_BLOCK_TRANSFER
Transfer of blocks for non-anonymmous file-sharing.
struct GNUNET_CADET_Channel * GNUNET_CADET_channel_create(struct GNUNET_CADET_Handle *h, void *channel_cls, const struct GNUNET_PeerIdentity *destination, const struct GNUNET_HashCode *port, GNUNET_CADET_WindowSizeEventHandler window_changes, GNUNET_CADET_DisconnectEventHandler disconnects, const struct GNUNET_MQ_MessageHandler *handlers)
Create a new channel towards a remote peer.
Definition: cadet_api.c:1031
void GNUNET_CADET_channel_destroy(struct GNUNET_CADET_Channel *channel)
Destroy an existing channel.
Definition: cadet_api.c:837
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:41
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MESSAGE_TYPE_FS_CADET_REPLY
P2P answer for content (one FS to another via a cadet).
Message handler for a specific message type.

References cadet_handle, disconnect_cb(), GNUNET_APPLICATION_PORT_FS_BLOCK_TRANSFER, GNUNET_CADET_channel_create(), GNUNET_CADET_channel_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_log, GNUNET_MESSAGE_TYPE_FS_CADET_REPLY, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, handlers, mh, move_to_pending(), port, transmit_pending(), and window_change_cb().

Referenced by reset_cadet_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ cadet_timeout()

static void cadet_timeout ( void *  cls)
static

Task called when it is time to destroy an inactive cadet channel.

Parameters
clsthe struct CadetHandle to tear down

Definition at line 491 of file gnunet-service-fs_cadet_client.c.

492 {
493  struct CadetHandle *mh = cls;
494  struct GNUNET_CADET_Channel *tun;
495 
497  "Timeout on cadet channel to %s\n",
498  GNUNET_i2s (&mh->target));
499  mh->timeout_task = NULL;
500  tun = mh->channel;
501  mh->channel = NULL;
502  if (NULL != tun)
504 }
Opaque handle to a channel.
Definition: cadet.h:117

References GNUNET_CADET_channel_destroy(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_log, and mh.

Referenced by GSF_cadet_query_cancel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_cadet()

static struct CadetHandle* get_cadet ( const struct GNUNET_PeerIdentity target)
static

Get (or create) a cadet to talk to the given peer.

Parameters
targetpeer we want to communicate with

Definition at line 567 of file gnunet-service-fs_cadet_client.c.

568 {
569  struct CadetHandle *mh;
570 
572  if (NULL != mh)
573  {
574  if (NULL != mh->timeout_task)
575  {
576  GNUNET_SCHEDULER_cancel (mh->timeout_task);
577  mh->timeout_task = NULL;
578  }
579  return mh;
580  }
582  "Creating cadet channel to %s\n",
583  GNUNET_i2s (target));
584  mh = GNUNET_new (struct CadetHandle);
585  mh->reset_task =
588  mh->target = *target;
591  cadet_map,
592  &mh->target,
593  mh,
595  {
597  { GNUNET_MQ_hd_var_size (reply,
599  struct CadetReplyMessage,
600  mh),
602  struct GNUNET_HashCode port;
603 
606  &port);
608  mh,
609  &mh->target,
610  &port,
612  &disconnect_cb,
613  handlers);
614  }
615  return mh;
616 }
#define CLIENT_RETRY_TIMEOUT
After how long do we reset connections without replies?
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
void * GNUNET_CONTAINER_multipeermap_get(const struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key)
Given a key find a value in the map matching the key.
int GNUNET_CONTAINER_multipeermap_put(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY
There must only be one value per key; storing a value should fail if a value under the same key alrea...
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1269
struct GNUNET_PeerIdentity target
Which peer does this cadet go to?

References cadet_handle, cadet_map, CLIENT_RETRY_TIMEOUT, disconnect_cb(), GNUNET_APPLICATION_PORT_FS_BLOCK_TRANSFER, GNUNET_assert, GNUNET_CADET_channel_create(), GNUNET_CONTAINER_multihashmap_create(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_CONTAINER_multipeermap_get(), GNUNET_CONTAINER_multipeermap_put(), GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_log, GNUNET_MESSAGE_TYPE_FS_CADET_REPLY, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_new, GNUNET_OK, GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_cancel(), GNUNET_YES, handlers, mh, port, reset_cadet_task(), CadetHandle::target, and window_change_cb().

Referenced by GSF_cadet_query().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GSF_cadet_query()

struct GSF_CadetRequest* GSF_cadet_query ( const struct GNUNET_PeerIdentity target,
const struct GNUNET_HashCode query,
enum GNUNET_BLOCK_Type  type,
GSF_CadetReplyProcessor  proc,
void *  proc_cls 
)

Look for a block by directly contacting a particular peer.

Parameters
targetpeer that should have the block
queryhash to query for the block
typedesired type for the block
procfunction to call with result
proc_clsclosure for proc
Returns
handle to cancel the operation

Definition at line 630 of file gnunet-service-fs_cadet_client.c.

635 {
636  struct CadetHandle *mh;
637  struct GSF_CadetRequest *sr;
638 
640  "Preparing to send query for %s via cadet to %s\n",
641  GNUNET_h2s (query),
642  GNUNET_i2s (target));
643  mh = get_cadet (target);
644  sr = GNUNET_new (struct GSF_CadetRequest);
645  sr->mh = mh;
646  sr->proc = proc;
647  sr->proc_cls = proc_cls;
648  sr->type = type;
649  sr->query = *query;
650  GNUNET_CONTAINER_DLL_insert (mh->pending_head, mh->pending_tail, sr);
652  return sr;
653 }
static struct CadetHandle * get_cadet(const struct GNUNET_PeerIdentity *target)
Get (or create) a cadet to talk to the given peer.
struct CadetHandle * mh
Which cadet is this request associated with?

References get_cadet(), GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_i2s(), GNUNET_log, GNUNET_new, mh, GSF_CadetRequest::mh, GSF_CadetRequest::proc, GSF_CadetRequest::proc_cls, GSF_CadetRequest::query, transmit_pending(), GSF_CadetRequest::type, and type.

Referenced by cadet_reply_proc(), and GSF_cadet_lookup_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GSF_cadet_query_cancel()

void GSF_cadet_query_cancel ( struct GSF_CadetRequest sr)

Cancel an active request; must not be called after 'proc' was called.

Parameters
srrequest to cancel

Definition at line 663 of file gnunet-service-fs_cadet_client.c.

664 {
665  struct CadetHandle *mh = sr->mh;
667 
668  p = sr->proc;
669  sr->proc = NULL;
670  if (NULL != p)
671  {
672  /* signal failure / cancellation to callback */
674  }
676  "Cancelled query for %s via cadet to %s\n",
677  GNUNET_h2s (&sr->query),
678  GNUNET_i2s (&sr->mh->target));
679  if (GNUNET_YES == sr->was_transmitted)
680  GNUNET_assert (
681  GNUNET_OK ==
682  GNUNET_CONTAINER_multihashmap_remove (mh->waiting_map, &sr->query, sr));
683  else
684  GNUNET_CONTAINER_DLL_remove (mh->pending_head, mh->pending_tail, sr);
685  GNUNET_free (sr);
686  if ((0 == GNUNET_CONTAINER_multihashmap_size (mh->waiting_map)) &&
687  (NULL == mh->pending_head))
689  &cadet_timeout,
690  mh);
691 }
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
void(* GSF_CadetReplyProcessor)(void *cls, enum GNUNET_BLOCK_Type type, struct GNUNET_TIME_Absolute expiration, size_t data_size, const void *data)
Function called with a reply from the cadet.
static void cadet_timeout(void *cls)
Task called when it is time to destroy an inactive cadet channel.
@ GNUNET_BLOCK_TYPE_ANY
Any type of block, used as a wildcard when searching.
#define GNUNET_TIME_UNIT_SECONDS
One second.
#define GNUNET_TIME_UNIT_ZERO_ABS
Absolute time zero.

References cadet_timeout(), GNUNET_assert, GNUNET_BLOCK_TYPE_ANY, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multihashmap_remove(), GNUNET_CONTAINER_multihashmap_size(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_h2s(), GNUNET_i2s(), GNUNET_log, GNUNET_OK, GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_UNIT_SECONDS, GNUNET_TIME_UNIT_ZERO_ABS, GNUNET_YES, mh, GSF_CadetRequest::mh, p, GSF_CadetRequest::proc, GSF_CadetRequest::proc_cls, GSF_CadetRequest::query, CadetHandle::target, and GSF_CadetRequest::was_transmitted.

Referenced by clean_request(), disconnect_cb(), free_waiting_entry(), GSF_pending_request_cancel_(), and process_reply().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GSF_cadet_release_clients()

int GSF_cadet_release_clients ( void *  cls,
const struct GNUNET_PeerIdentity key,
void *  value 
)

Function called on each active cadets to shut them down.

Parameters
clsNULL
keytarget peer, unused
valuethe struct CadetHandle to destroy
Returns
GNUNET_YES (continue to iterate)

Definition at line 703 of file gnunet-service-fs_cadet_client.c.

706 {
707  struct CadetHandle *mh = value;
708 
710  "Timeout on cadet channel to %s\n",
711  GNUNET_i2s (&mh->target));
712  if (NULL != mh->channel)
713  {
714  struct GNUNET_CADET_Channel *channel = mh->channel;
715 
716  mh->channel = NULL;
718  }
719  if (NULL != mh->reset_task)
720  {
721  GNUNET_SCHEDULER_cancel (mh->reset_task);
722  mh->reset_task = NULL;
723  }
724  return GNUNET_YES;
725 }

References GNUNET_CADET_channel_destroy(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_log, GNUNET_SCHEDULER_cancel(), GNUNET_YES, mh, and value.

Referenced by GSF_cadet_stop_server().

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ cadet_handle

struct GNUNET_CADET_Handle* cadet_handle

Cadet channel for creating outbound channels.

Definition at line 152 of file gnunet-service-fs_cadet_client.c.

Referenced by get_cadet(), and reset_cadet().

◆ cadet_map

struct GNUNET_CONTAINER_MultiPeerMap* cadet_map

Map from peer identities to 'struct CadetHandles' with cadet channels to those peers.

Definition at line 158 of file gnunet-service-fs_cadet_client.c.

Referenced by disconnect_cb(), get_cadet(), GSF_cadet_start_server(), and GSF_cadet_stop_server().