GNUnet  0.10.x
Data Structures | Macros | Functions | Variables
gnunet-communicator-unix.c File Reference

Transport plugin using unix domain sockets (!) Clearly, can only be used locally on Unix/Linux hosts... More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_constants.h"
#include "gnunet_nt_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_transport_communication_service.h"
Include dependency graph for gnunet-communicator-unix.c:

Go to the source code of this file.

Data Structures

struct  UNIXMessage
 UNIX Message-Packet header. More...
 
struct  Queue
 Handle for a queue. More...
 
struct  LookupCtx
 Closure to lookup_queue_it(). More...
 

Macros

#define DEFAULT_MAX_QUEUE_LENGTH   8
 How many messages do we keep at most in the queue to the transport service before we start to drop (default, can be changed via the configuration file). More...
 
#define COMMUNICATOR_ADDRESS_PREFIX   "unix"
 Address prefix used by the communicator. More...
 
#define COMMUNICATOR_CONFIG_SECTION   "communicator-unix"
 Configuration section used by the communicator. More...
 
#define UNIX_MTU   UINT16_MAX
 Our MTU. More...
 

Functions

static void queue_destroy (struct Queue *queue)
 Functions with this signature are called whenever we need to close a queue due to a disconnect or failure to establish a connection. More...
 
static void queue_timeout (void *cls)
 Queue was idle for too long, so disconnect it. More...
 
static void reschedule_queue_timeout (struct Queue *queue)
 Increment queue timeout due to activity. More...
 
static struct sockaddr_un * unix_address_to_sockaddr (const char *unixpath, socklen_t *sock_len)
 Convert unix path to a struct sockaddr_un * More...
 
static int lookup_queue_it (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
 Function called to find a queue by address. More...
 
static struct Queuelookup_queue (const struct GNUNET_PeerIdentity *peer, const struct sockaddr_un *un, socklen_t un_len)
 Find an existing queue by address. More...
 
static void select_write_cb (void *cls)
 We have been notified that our socket is ready to write. More...
 
static void mq_send (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)
 Signature of functions implementing the sending functionality of a message queue. More...
 
static void mq_destroy (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Signature of functions implementing the destruction of a message queue. More...
 
static void mq_cancel (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Implementation function that cancels the currently sent message. More...
 
static void mq_error (void *cls, enum GNUNET_MQ_Error error)
 Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue. More...
 
static struct Queuesetup_queue (const struct GNUNET_PeerIdentity *target, enum GNUNET_TRANSPORT_ConnectionStatus cs, const struct sockaddr_un *un, socklen_t un_len)
 Creates a new outbound queue the transport service will use to send data to another peer. More...
 
static void select_read_cb (void *cls)
 We have been notified that our socket has something to read. More...
 
static void receive_complete_cb (void *cls, int success)
 Function called when message was successfully passed to transport service. More...
 
static int mq_init (void *cls, const struct GNUNET_PeerIdentity *peer, const char *address)
 Function called by the transport service to initialize a message queue given address information about another peer. More...
 
static int get_queue_delete_it (void *cls, const struct GNUNET_PeerIdentity *target, void *value)
 Iterator over all message queues to clean up. More...
 
static void do_shutdown (void *cls)
 Shutdown the UNIX communicator. More...
 
static void enc_notify_cb (void *cls, const struct GNUNET_PeerIdentity *sender, const struct GNUNET_MessageHeader *msg)
 Function called when the transport service has received an acknowledgement for this communicator (!) via a different return path. More...
 
static void run (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
 Setup communicator and launch network interactions. More...
 
int main (int argc, char *const *argv)
 The main function for the UNIX communicator. More...
 

Variables

static struct GNUNET_SCHEDULER_Taskread_task
 ID of read task. More...
 
static struct GNUNET_SCHEDULER_Taskwrite_task
 ID of write task. More...
 
static unsigned long long delivering_messages
 Number of messages we currently have in our queues towards the transport service. More...
 
static unsigned long long max_queue_length
 Maximum queue length before we stop reading towards the transport service. More...
 
static struct GNUNET_STATISTICS_Handlestats
 For logging statistics. More...
 
static struct GNUNET_TRANSPORT_CommunicatorHandlech
 Our environment. More...
 
static struct GNUNET_CONTAINER_MultiPeerMapqueue_map
 Queues (map from peer identity to struct Queue) More...
 
static struct Queuequeue_head
 Head of queue of messages to transmit. More...
 
static struct Queuequeue_tail
 Tail of queue of messages to transmit. More...
 
static struct GNUNET_NETWORK_Handleunix_sock
 socket that we transmit all data with More...
 
static struct GNUNET_TRANSPORT_AddressIdentifierai
 Handle to the operation that publishes our address. More...
 

Detailed Description

Transport plugin using unix domain sockets (!) Clearly, can only be used locally on Unix/Linux hosts...

ONLY INTENDED FOR TESTING!!!

Author
Christian Grothoff
Nathan Evans

Definition in file gnunet-communicator-unix.c.

Macro Definition Documentation

◆ DEFAULT_MAX_QUEUE_LENGTH

#define DEFAULT_MAX_QUEUE_LENGTH   8

How many messages do we keep at most in the queue to the transport service before we start to drop (default, can be changed via the configuration file).

Should be below the level of the communicator API, as otherwise we may read messages just to have them dropped by the communicator API.

Definition at line 45 of file gnunet-communicator-unix.c.

Referenced by run().

◆ COMMUNICATOR_ADDRESS_PREFIX

#define COMMUNICATOR_ADDRESS_PREFIX   "unix"

Address prefix used by the communicator.

Definition at line 50 of file gnunet-communicator-unix.c.

Referenced by mq_init(), run(), and setup_queue().

◆ COMMUNICATOR_CONFIG_SECTION

#define COMMUNICATOR_CONFIG_SECTION   "communicator-unix"

Configuration section used by the communicator.

Definition at line 55 of file gnunet-communicator-unix.c.

Referenced by run().

◆ UNIX_MTU

#define UNIX_MTU   UINT16_MAX

Our MTU.

Definition at line 60 of file gnunet-communicator-unix.c.

Referenced by setup_queue().

Function Documentation

◆ queue_destroy()

static void queue_destroy ( struct Queue queue)
static

Functions with this signature are called whenever we need to close a queue due to a disconnect or failure to establish a connection.

Parameters
queuequeue to close down

Definition at line 208 of file gnunet-communicator-unix.c.

References Queue::address, Queue::bytes_in_queue, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multipeermap_remove(), GNUNET_CONTAINER_multipeermap_size(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_i2s(), GNUNET_log, GNUNET_MQ_destroy(), GNUNET_NO, GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_set(), GNUNET_YES, mq, Queue::mq, Queue::target, and Queue::timeout_task.

Referenced by get_queue_delete_it(), mq_destroy(), mq_error(), and queue_timeout().

209 {
210  struct GNUNET_MQ_Handle *mq;
211 
213  "Disconnecting queue for peer `%s'\n",
214  GNUNET_i2s(&queue->target));
215  if (0 != queue->bytes_in_queue)
216  {
218  queue->bytes_in_queue = 0;
219  }
220  if (NULL != (mq = queue->mq))
221  {
222  queue->mq = NULL;
223  GNUNET_MQ_destroy(mq);
224  }
226  GNUNET_YES ==
229  "# queues active",
231  GNUNET_NO);
232  if (NULL != queue->timeout_task)
233  {
235  queue->timeout_task = NULL;
236  }
237  GNUNET_free(queue->address);
238  GNUNET_free(queue);
239 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
struct GNUNET_PeerIdentity target
To whom are we talking to.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
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_NO
Definition: gnunet_common.h:78
struct GNUNET_MQ_Handle * mq
Message queue we are providing for the ch.
struct GNUNET_SCHEDULER_Task * timeout_task
Queue timeout task.
unsigned long long bytes_in_queue
Number of bytes we currently have in our write queue.
static struct Queue * queue_head
Head of queue of messages to transmit.
static struct GNUNET_STATISTICS_Handle * stats
For logging statistics.
void GNUNET_STATISTICS_set(struct GNUNET_STATISTICS_Handle *handle, const char *name, uint64_t value, int make_persistent)
Set statistic value for the peer.
Handle to a message queue.
Definition: mq.c:84
struct sockaddr * address
Address of the other peer.
static struct GNUNET_CONTAINER_MultiPeerMap * queue_map
Queues (map from peer identity to struct Queue)
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
#define GNUNET_log(kind,...)
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:821
#define GNUNET_YES
Definition: gnunet_common.h:77
unsigned int GNUNET_CONTAINER_multipeermap_size(const struct GNUNET_CONTAINER_MultiPeerMap *map)
Get the number of key-value pairs in the map.
static struct Queue * queue_tail
Tail of queue of messages to transmit.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ queue_timeout()

static void queue_timeout ( void *  cls)
static

Queue was idle for too long, so disconnect it.

Parameters
clsthe struct Queue * to disconnect

Definition at line 248 of file gnunet-communicator-unix.c.

References GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_SCHEDULER_add_delayed(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get_remaining(), GNUNET_YES, queue(), queue_destroy(), GNUNET_TIME_Relative::rel_value_us, Queue::timeout, and Queue::timeout_task.

Referenced by setup_queue().

249 {
250  struct Queue *queue = cls;
251  struct GNUNET_TIME_Relative left;
252 
253  queue->timeout_task = NULL;
255  if (0 != left.rel_value_us)
256  {
257  /* not actually our turn yet, but let's at least update
258  the monitor, it may think we're about to die ... */
259  queue->timeout_task =
261  return;
262  }
264  "Queue %p was idle for %s, disconnecting\n",
265  queue,
268  GNUNET_YES));
269  queue_destroy(queue);
270 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
static void queue_destroy(struct Queue *queue)
Functions with this signature are called whenever we need to close a queue due to a disconnect or fai...
struct GNUNET_SCHEDULER_Task * timeout_task
Queue timeout task.
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:1237
Handle for a queue.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
static void queue_timeout(void *cls)
Queue was idle for too long, so disconnect it.
#define GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
After how long do we consider a connection to a peer dead if we don't receive messages from the peer...
#define GNUNET_log(kind,...)
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_TIME_Absolute timeout
Timeout for this queue.
Time for relative time used by GNUnet, in microseconds.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ reschedule_queue_timeout()

static void reschedule_queue_timeout ( struct Queue queue)
static

Increment queue timeout due to activity.

We do not immediately notify the monitor here as that might generate excessive signalling.

Parameters
queuequeue for which the timeout should be rescheduled

Definition at line 281 of file gnunet-communicator-unix.c.

References GNUNET_assert, GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, GNUNET_TIME_relative_to_absolute(), Queue::timeout, and Queue::timeout_task.

Referenced by select_read_cb(), and select_write_cb().

282 {
283  GNUNET_assert(NULL != queue->timeout_task);
284  queue->timeout =
286 }
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:246
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_SCHEDULER_Task * timeout_task
Queue timeout task.
#define GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
After how long do we consider a connection to a peer dead if we don't receive messages from the peer...
struct GNUNET_TIME_Absolute timeout
Timeout for this queue.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ unix_address_to_sockaddr()

static struct sockaddr_un* unix_address_to_sockaddr ( const char *  unixpath,
socklen_t *  sock_len 
)
static

Convert unix path to a struct sockaddr_un *

Parameters
unixpathpath to convert
[out]sock_lenset to the length of the address
is_abstractis this an abstract unixpath
Returns
converted unix path

Definition at line 298 of file gnunet-communicator-unix.c.

References GNUNET_assert, GNUNET_memcpy, and GNUNET_new.

Referenced by mq_init(), and run().

299 {
300  struct sockaddr_un *un;
301  size_t slen;
302 
303  GNUNET_assert(0 < strlen(unixpath)); /* sanity check */
304  un = GNUNET_new(struct sockaddr_un);
305  un->sun_family = AF_UNIX;
306  slen = strlen(unixpath);
307  if (slen >= sizeof(un->sun_path))
308  slen = sizeof(un->sun_path) - 1;
309  GNUNET_memcpy(un->sun_path, unixpath, slen);
310  un->sun_path[slen] = '\0';
311  slen = sizeof(struct sockaddr_un);
312 #if HAVE_SOCKADDR_UN_SUN_LEN
313  un->sun_len = (u_char)slen;
314 #endif
315  (*sock_len) = slen;
316  if ('@' == un->sun_path[0])
317  un->sun_path[0] = '\0';
318  return un;
319 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Here is the caller graph for this function:

◆ lookup_queue_it()

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

Function called to find a queue by address.

Parameters
clsthe struct LookupCtx *
keypeer we are looking for (unused)
valuea queue
Returns
GNUNET_YES if not found (continue looking), GNUNET_NO on success

Definition at line 352 of file gnunet-communicator-unix.c.

References Queue::address, Queue::address_len, GNUNET_NO, GNUNET_YES, queue(), LookupCtx::res, LookupCtx::un, LookupCtx::un_len, and value.

Referenced by lookup_queue().

353 {
354  struct LookupCtx *lctx = cls;
355  struct Queue *queue = value;
356 
357  if ((queue->address_len = lctx->un_len) &&
358  (0 == memcmp(lctx->un, queue->address, queue->address_len)))
359  {
360  lctx->res = queue;
361  return GNUNET_NO;
362  }
363  return GNUNET_YES;
364 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
socklen_t un_len
Number of bytes in un.
socklen_t address_len
Length of the address.
Closure to lookup_queue_it().
#define GNUNET_NO
Definition: gnunet_common.h:78
static char * value
Value of the record to add/remove.
Handle for a queue.
const struct sockaddr_un * un
Address we are looking for.
struct sockaddr * address
Address of the other peer.
struct Queue * res
Location to store the queue, if found.
#define GNUNET_YES
Definition: gnunet_common.h:77
Here is the call graph for this function:
Here is the caller graph for this function:

◆ lookup_queue()

static struct Queue* lookup_queue ( const struct GNUNET_PeerIdentity peer,
const struct sockaddr_un *  un,
socklen_t  un_len 
)
static

Find an existing queue by address.

Parameters
pluginthe plugin
addressthe address to find
Returns
NULL if queue was not found

Definition at line 375 of file gnunet-communicator-unix.c.

References GNUNET_CONTAINER_multipeermap_get_multiple(), lookup_queue_it(), LookupCtx::res, LookupCtx::un, and LookupCtx::un_len.

Referenced by mq_init(), and select_read_cb().

378 {
379  struct LookupCtx lctx;
380 
381  lctx.un = un;
382  lctx.un_len = un_len;
384  peer,
386  &lctx);
387  return lctx.res;
388 }
static int lookup_queue_it(void *cls, const struct GNUNET_PeerIdentity *key, void *value)
Function called to find a queue by address.
socklen_t un_len
Number of bytes in un.
Closure to lookup_queue_it().
const struct sockaddr_un * un
Address we are looking for.
static struct GNUNET_CONTAINER_MultiPeerMap * queue_map
Queues (map from peer identity to struct Queue)
int GNUNET_CONTAINER_multipeermap_get_multiple(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map that match a particular key.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ select_write_cb()

static void select_write_cb ( void *  cls)
static

We have been notified that our socket is ready to write.

Then reschedule this function to be called again once more is available.

Parameters
clsNULL

Definition at line 398 of file gnunet-communicator-unix.c.

References Queue::address, Queue::address_len, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_i2s(), GNUNET_log, GNUNET_log_strerror, GNUNET_MQ_impl_send_continue(), GNUNET_NETWORK_socket_getsockopt(), GNUNET_NETWORK_socket_sendto(), GNUNET_NETWORK_socket_setsockopt(), GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_write_net(), GNUNET_STATISTICS_update(), GNUNET_TIME_UNIT_FOREVER_REL, len, Queue::mq, msg, Queue::msg, queue(), queue_tail, reschedule_queue_timeout(), size, GNUNET_MessageHeader::size, and Queue::target.

Referenced by mq_send().

399 {
400  struct Queue *queue = queue_tail;
401  const struct GNUNET_MessageHeader *msg = queue->msg;
402  size_t msg_size = ntohs(msg->size);
403  ssize_t sent;
404 
405  /* take queue of the ready list */
406  write_task = NULL;
408  if (NULL != queue_head)
410  unix_sock,
412  NULL);
413 
414  /* send 'msg' */
415  queue->msg = NULL;
417 resend:
418  /* Send the data */
420  msg,
421  msg_size,
422  (const struct sockaddr *)queue->address,
423  queue->address_len);
425  "UNIX transmitted message to %s (%d/%u: %s)\n",
426  GNUNET_i2s(&queue->target),
427  (int)sent,
428  (unsigned int)msg_size,
429  (sent < 0) ? strerror(errno) : "ok");
430  if (-1 != sent)
431  {
433  "# bytes sent",
434  (long long)sent,
435  GNUNET_NO);
437  return; /* all good */
438  }
440  "# network transmission failures",
441  1,
442  GNUNET_NO);
443  switch (errno)
444  {
445  case EAGAIN:
446  case ENOBUFS:
447  /* We should retry later... */
449  return;
450 
451  case EMSGSIZE: {
452  socklen_t size = 0;
453  socklen_t len = sizeof(size);
454 
456  SOL_SOCKET,
457  SO_SNDBUF,
458  &size,
459  &len);
460  if (size > ntohs(msg->size))
461  {
462  /* Buffer is bigger than message: error, no retry
463  * This should never happen!*/
464  GNUNET_break(0);
465  return;
466  }
467  GNUNET_log(
469  "Trying to increase socket buffer size from %u to %u for message size %u\n",
470  (unsigned int)size,
471  (unsigned int)((msg_size / 1000) + 2) * 1000,
472  (unsigned int)msg_size);
473  size = ((msg_size / 1000) + 2) * 1000;
475  SOL_SOCKET,
476  SO_SNDBUF,
477  &size,
478  sizeof(size)))
479  goto resend; /* Increased buffer size, retry sending */
480  /* Ok, then just try very modest increase */
481  size = msg_size;
483  SOL_SOCKET,
484  SO_SNDBUF,
485  &size,
486  sizeof(size)))
487  goto resend; /* Increased buffer size, retry sending */
488  /* Could not increase buffer size: error, no retry */
490  return;
491  }
492 
493  default:
495  return;
496  }
497 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
int GNUNET_NETWORK_socket_setsockopt(struct GNUNET_NETWORK_Handle *fd, int level, int option_name, const void *option_value, socklen_t option_len)
Set socket option.
Definition: network.c:871
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
struct GNUNET_PeerIdentity target
To whom are we talking to.
socklen_t address_len
Length of the address.
static struct GNUNET_SCHEDULER_Task * write_task
ID of write task.
int GNUNET_NETWORK_socket_getsockopt(const struct GNUNET_NETWORK_Handle *desc, int level, int optname, void *optval, socklen_t *optlen)
Get socket options.
Definition: network.c:671
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_write_net(struct GNUNET_TIME_Relative delay, struct GNUNET_NETWORK_Handle *wfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1537
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format...
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
static void reschedule_queue_timeout(struct Queue *queue)
Increment queue timeout due to activity.
struct GNUNET_MQ_Handle * mq
Message queue we are providing for the ch.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
static struct Queue * queue_head
Head of queue of messages to transmit.
static struct GNUNET_STATISTICS_Handle * stats
For logging statistics.
Handle for a queue.
ssize_t GNUNET_NETWORK_socket_sendto(const struct GNUNET_NETWORK_Handle *desc, const void *message, size_t length, const struct sockaddr *dest_addr, socklen_t dest_len)
Send data to a particular destination (always non-blocking).
Definition: network.c:838
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
static void select_write_cb(void *cls)
We have been notified that our socket is ready to write.
static unsigned int size
Size of the "table".
Definition: peer.c:66
const struct GNUNET_MessageHeader * msg
Message currently scheduled for transmission, non-NULL if and only if this queue is in the queue_head...
struct sockaddr * address
Address of the other peer.
static struct GNUNET_NETWORK_Handle * unix_sock
socket that we transmit all data with
#define GNUNET_log(kind,...)
Header for all communications.
static struct Queue * queue_tail
Tail of queue of messages to transmit.
void GNUNET_MQ_impl_send_continue(struct GNUNET_MQ_Handle *mq)
Call the send implementation for the next queued message, if any.
Definition: mq.c:484
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ mq_send()

static void mq_send ( struct GNUNET_MQ_Handle mq,
const struct GNUNET_MessageHeader msg,
void *  impl_state 
)
static

Signature of functions implementing the sending functionality of a message queue.

Parameters
mqthe message queue
msgthe message to send
impl_stateour struct Queue

Definition at line 509 of file gnunet-communicator-unix.c.

References GNUNET_assert, GNUNET_CONTAINER_DLL_insert, GNUNET_SCHEDULER_add_write_net(), GNUNET_TIME_UNIT_FOREVER_REL, Queue::mq, msg, Queue::msg, queue(), and select_write_cb().

Referenced by setup_queue().

512 {
513  struct Queue *queue = impl_state;
514 
515  GNUNET_assert(mq == queue->mq);
516  GNUNET_assert(NULL == queue->msg);
517  queue->msg = msg;
519  GNUNET_assert(NULL != unix_sock);
520  if (NULL == write_task)
522  unix_sock,
524  NULL);
525 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
static struct GNUNET_SCHEDULER_Task * write_task
ID of write task.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_write_net(struct GNUNET_TIME_Relative delay, struct GNUNET_NETWORK_Handle *wfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1537
struct GNUNET_MQ_Handle * mq
Message queue we are providing for the ch.
static struct Queue * queue_head
Head of queue of messages to transmit.
Handle for a queue.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
static void select_write_cb(void *cls)
We have been notified that our socket is ready to write.
const struct GNUNET_MessageHeader * msg
Message currently scheduled for transmission, non-NULL if and only if this queue is in the queue_head...
static struct GNUNET_NETWORK_Handle * unix_sock
socket that we transmit all data with
static struct Queue * queue_tail
Tail of queue of messages to transmit.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ mq_destroy()

static void mq_destroy ( struct GNUNET_MQ_Handle mq,
void *  impl_state 
)
static

Signature of functions implementing the destruction of a message queue.

Implementations must not free mq, but should take care of impl_state.

Parameters
mqthe message queue to destroy
impl_stateour struct Queue

Definition at line 537 of file gnunet-communicator-unix.c.

References Queue::mq, queue(), and queue_destroy().

Referenced by setup_queue().

538 {
539  struct Queue *queue = impl_state;
540 
541  if (mq == queue->mq)
542  {
543  queue->mq = NULL;
544  queue_destroy(queue);
545  }
546 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
static void queue_destroy(struct Queue *queue)
Functions with this signature are called whenever we need to close a queue due to a disconnect or fai...
struct GNUNET_MQ_Handle * mq
Message queue we are providing for the ch.
Handle for a queue.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ mq_cancel()

static void mq_cancel ( struct GNUNET_MQ_Handle mq,
void *  impl_state 
)
static

Implementation function that cancels the currently sent message.

Parameters
mqmessage queue
impl_stateour struct Queue

Definition at line 556 of file gnunet-communicator-unix.c.

References GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_SCHEDULER_cancel(), Queue::msg, and queue().

Referenced by setup_queue().

557 {
558  struct Queue *queue = impl_state;
559 
560  GNUNET_assert(NULL != queue->msg);
561  queue->msg = NULL;
563  GNUNET_assert(NULL != write_task);
564  if (NULL == queue_head)
565  {
567  write_task = NULL;
568  }
569 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
static struct GNUNET_SCHEDULER_Task * write_task
ID of write task.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static struct Queue * queue_head
Head of queue of messages to transmit.
Handle for a queue.
const struct GNUNET_MessageHeader * msg
Message currently scheduled for transmission, non-NULL if and only if this queue is in the queue_head...
static struct Queue * queue_tail
Tail of queue of messages to transmit.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ mq_error()

static void mq_error ( void *  cls,
enum GNUNET_MQ_Error  error 
)
static

Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.

Not every message queue implementation supports an error handler.

Parameters
clsour struct Queue
errorerror code

Definition at line 582 of file gnunet-communicator-unix.c.

References GNUNET_ERROR_TYPE_ERROR, GNUNET_i2s(), GNUNET_log, queue(), queue_destroy(), and Queue::target.

Referenced by setup_queue().

583 {
584  struct Queue *queue = cls;
585 
587  "UNIX MQ error in queue to %s: %d\n",
588  GNUNET_i2s(&queue->target),
589  (int)error);
590  queue_destroy(queue);
591 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
struct GNUNET_PeerIdentity target
To whom are we talking to.
static void queue_destroy(struct Queue *queue)
Functions with this signature are called whenever we need to close a queue due to a disconnect or fai...
Handle for a queue.
#define GNUNET_log(kind,...)
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
Here is the call graph for this function:
Here is the caller graph for this function:

◆ setup_queue()

static struct Queue* setup_queue ( const struct GNUNET_PeerIdentity target,
enum GNUNET_TRANSPORT_ConnectionStatus  cs,
const struct sockaddr_un *  un,
socklen_t  un_len 
)
static

Creates a new outbound queue the transport service will use to send data to another peer.

Parameters
peerthe target peer
csinbound or outbound queue
unthe address
un_lennumber of bytes in un
Returns
the queue or NULL of max connections exceeded

Definition at line 605 of file gnunet-communicator-unix.c.

References Queue::address, Queue::address_len, COMMUNICATOR_ADDRESS_PREFIX, GNUNET_asprintf(), GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE, GNUNET_CONTAINER_multipeermap_put(), GNUNET_CONTAINER_multipeermap_size(), GNUNET_free, GNUNET_memdup, GNUNET_MQ_queue_for_callbacks(), GNUNET_new, GNUNET_NO, GNUNET_NT_LOOPBACK, GNUNET_SCHEDULER_add_delayed(), GNUNET_STATISTICS_set(), GNUNET_TIME_relative_to_absolute(), GNUNET_TRANSPORT_communicator_mq_add(), Queue::mq, mq_cancel(), mq_destroy(), mq_error(), mq_send(), Queue::qh, queue(), queue_timeout(), select_read_cb(), Queue::target, Queue::timeout, Queue::timeout_task, and UNIX_MTU.

Referenced by mq_init(), and select_read_cb().

609 {
610  struct Queue *queue;
611 
612  queue = GNUNET_new(struct Queue);
613  queue->target = *target;
614  queue->address = GNUNET_memdup(un, un_len);
615  queue->address_len = un_len;
617  queue_map,
618  &queue->target,
619  queue,
622  "# queues active",
624  GNUNET_NO);
625  queue->timeout =
627  queue->timeout_task =
629  &queue_timeout,
630  queue);
632  &mq_destroy,
633  &mq_cancel,
634  queue,
635  NULL,
636  &mq_error,
637  queue);
638  {
639  char *foreign_addr;
640 
641  if ('\0' == un->sun_path[0])
642  GNUNET_asprintf(&foreign_addr,
643  "%s-@%s",
645  &un->sun_path[1]);
646  else
647  GNUNET_asprintf(&foreign_addr,
648  "%s-%s",
650  un->sun_path);
652  &queue->target,
653  foreign_addr,
654  UNIX_MTU,
656  cs,
657  queue->mq);
658  GNUNET_free(foreign_addr);
659  }
660  return queue;
661 }
static void mq_send(struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)
Signature of functions implementing the sending functionality of a message queue. ...
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
struct GNUNET_PeerIdentity target
To whom are we talking to.
socklen_t address_len
Length of the address.
static struct GNUNET_TRANSPORT_CommunicatorHandle * ch
Our environment.
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:246
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_memdup(buf, size)
Allocate and initialize a block of memory.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_MQ_Handle * mq
Message queue we are providing for the ch.
struct GNUNET_SCHEDULER_Task * timeout_task
Queue timeout task.
#define UNIX_MTU
Our MTU.
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
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:1237
#define COMMUNICATOR_ADDRESS_PREFIX
Address prefix used by the communicator.
struct GNUNET_MQ_Handle * GNUNET_MQ_queue_for_callbacks(GNUNET_MQ_SendImpl send, GNUNET_MQ_DestroyImpl destroy, GNUNET_MQ_CancelImpl cancel, void *impl_state, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *cls)
Create a message queue for the specified handlers.
Definition: mq.c:550
static struct GNUNET_STATISTICS_Handle * stats
For logging statistics.
Handle for a queue.
void GNUNET_STATISTICS_set(struct GNUNET_STATISTICS_Handle *handle, const char *name, uint64_t value, int make_persistent)
Set statistic value for the peer.
static void mq_destroy(struct GNUNET_MQ_Handle *mq, void *impl_state)
Signature of functions implementing the destruction of a message queue.
static void mq_cancel(struct GNUNET_MQ_Handle *mq, void *impl_state)
Implementation function that cancels the currently sent message.
Loopback (same host).
Definition: gnunet_nt_lib.h:44
static void queue_timeout(void *cls)
Queue was idle for too long, so disconnect it.
Allow multiple values with the same key.
#define GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
After how long do we consider a connection to a peer dead if we don&#39;t receive messages from the peer...
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.
struct sockaddr * address
Address of the other peer.
static struct GNUNET_CONTAINER_MultiPeerMap * queue_map
Queues (map from peer identity to struct Queue)
enum GNUNET_TRANSPORT_ConnectionStatus cs
Connection status for this queue.
static void mq_error(void *cls, enum GNUNET_MQ_Error error)
Generic error handler, called with the appropriate error code and the same closure specified at the c...
struct GNUNET_TRANSPORT_QueueHandle * GNUNET_TRANSPORT_communicator_mq_add(struct GNUNET_TRANSPORT_CommunicatorHandle *ch, const struct GNUNET_PeerIdentity *peer, const char *address, uint32_t mtu, enum GNUNET_NetworkType nt, enum GNUNET_TRANSPORT_ConnectionStatus cs, struct GNUNET_MQ_Handle *mq)
Notify transport service that a MQ became available due to an "inbound" connection or because the com...
unsigned int GNUNET_CONTAINER_multipeermap_size(const struct GNUNET_CONTAINER_MultiPeerMap *map)
Get the number of key-value pairs in the map.
struct GNUNET_TIME_Absolute timeout
Timeout for this queue.
struct GNUNET_TRANSPORT_QueueHandle * qh
handle for this queue with the ch.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ select_read_cb()

static void select_read_cb ( void *  cls)
static

We have been notified that our socket has something to read.

Do the read and reschedule this function to be called again once more is available.

Parameters
clsNULL

Definition at line 709 of file gnunet-communicator-unix.c.

References _, buf, csize, delivering_messages, GNUNET_ALIGN, GNUNET_assert, GNUNET_break_op, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_log, GNUNET_log_strerror, GNUNET_NETWORK_socket_recvfrom(), GNUNET_NO, GNUNET_SCHEDULER_add_read_net(), GNUNET_SCHEDULER_cancel(), GNUNET_SYSERR, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_TRANSPORT_communicator_receive(), GNUNET_TRANSPORT_CS_INBOUND, UNIXMessage::header, lookup_queue(), max_queue_length, msg, queue(), receive_complete_cb(), reschedule_queue_timeout(), ret, UNIXMessage::sender, setup_queue(), and GNUNET_MessageHeader::size.

Referenced by receive_complete_cb(), run(), and setup_queue().

710 {
711  char buf[65536] GNUNET_ALIGN;
712  struct Queue *queue;
713  const struct UNIXMessage *msg;
714  struct sockaddr_un un;
715  socklen_t addrlen;
716  ssize_t ret;
717  uint16_t msize;
718 
719  GNUNET_assert(NULL != unix_sock);
721  unix_sock,
723  NULL);
724  addrlen = sizeof(un);
725  memset(&un, 0, sizeof(un));
727  buf,
728  sizeof(buf),
729  (struct sockaddr *)&un,
730  &addrlen);
731  if ((-1 == ret) && ((EAGAIN == errno) || (ENOBUFS == errno)))
732  return;
733  if (-1 == ret)
734  {
736  return;
737  }
739  "Read %d bytes from socket %s\n",
740  (int)ret,
741  un.sun_path);
742  GNUNET_assert(AF_UNIX == (un.sun_family));
743  msg = (struct UNIXMessage *)buf;
744  msize = ntohs(msg->header.size);
745  if ((msize < sizeof(struct UNIXMessage)) || (msize > ret))
746  {
747  GNUNET_break_op(0);
748  return;
749  }
750  queue = lookup_queue(&msg->sender, &un, addrlen);
751  if (NULL == queue)
752  queue =
753  setup_queue(&msg->sender, GNUNET_TRANSPORT_CS_INBOUND, &un, addrlen);
754  else
756  if (NULL == queue)
757  {
758  GNUNET_log(
760  _(
761  "Maximum number of UNIX connections exceeded, dropping incoming message\n"));
762  return;
763  }
764 
765  {
766  uint16_t offset = 0;
767  uint16_t tsize = msize - sizeof(struct UNIXMessage);
768  const char *msgbuf = (const char *)&msg[1];
769 
770  while (offset + sizeof(struct GNUNET_MessageHeader) <= tsize)
771  {
772  const struct GNUNET_MessageHeader *currhdr;
773  struct GNUNET_MessageHeader al_hdr;
774  uint16_t csize;
775 
776  currhdr = (const struct GNUNET_MessageHeader *)&msgbuf[offset];
777  /* ensure aligned access */
778  memcpy(&al_hdr, currhdr, sizeof(al_hdr));
779  csize = ntohs(al_hdr.size);
780  if ((csize < sizeof(struct GNUNET_MessageHeader)) ||
781  (csize > tsize - offset))
782  {
783  GNUNET_break_op(0);
784  break;
785  }
787  &msg->sender,
788  currhdr,
791  NULL);
792  if (GNUNET_SYSERR == ret)
793  return; /* transport not up */
794  if (GNUNET_NO == ret)
795  break;
797  offset += csize;
798  }
799  }
801  {
802  /* we should try to apply 'back pressure' */
804  read_task = NULL;
805  }
806 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
static struct GNUNET_SCHEDULER_Task * read_task
ID of read task.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static struct GNUNET_TRANSPORT_CommunicatorHandle * ch
Our environment.
struct GNUNET_MessageHeader header
Message header.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_NO
Definition: gnunet_common.h:78
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format...
static int ret
Final status code.
Definition: gnunet-arm.c:89
static void reschedule_queue_timeout(struct Queue *queue)
Increment queue timeout due to activity.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
UNIX Message-Packet header.
static unsigned int csize
Handle for a queue.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
static unsigned long long max_queue_length
Maximum queue length before we stop reading towards the transport service.
static void select_read_cb(void *cls)
We have been notified that our socket has something to read.
static char buf[2048]
this is an inbound connection (communicator initiated)
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
int GNUNET_TRANSPORT_communicator_receive(struct GNUNET_TRANSPORT_CommunicatorHandle *handle, const struct GNUNET_PeerIdentity *sender, const struct GNUNET_MessageHeader *msg, struct GNUNET_TIME_Relative expected_addr_validity, GNUNET_TRANSPORT_MessageCompletedCallback cb, void *cb_cls)
Notify transport service that the communicator has received a message.
static struct Queue * setup_queue(const struct GNUNET_PeerIdentity *target, enum GNUNET_TRANSPORT_ConnectionStatus cs, const struct sockaddr_un *un, socklen_t un_len)
Creates a new outbound queue the transport service will use to send data to another peer...
#define GNUNET_ALIGN
gcc-ism to force alignment; we use this to align char-arrays that may then be cast to &#39;struct&#39;s...
static struct GNUNET_NETWORK_Handle * unix_sock
socket that we transmit all data with
#define GNUNET_log(kind,...)
Header for all communications.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_net(struct GNUNET_TIME_Relative delay, struct GNUNET_NETWORK_Handle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1467
ssize_t GNUNET_NETWORK_socket_recvfrom(const struct GNUNET_NETWORK_Handle *desc, void *buffer, size_t length, struct sockaddr *src_addr, socklen_t *addrlen)
Read data from a socket (always non-blocking).
Definition: network.c:742
struct GNUNET_PeerIdentity sender
What is the identity of the sender (GNUNET_hash of public key)
static void receive_complete_cb(void *cls, int success)
Function called when message was successfully passed to transport service.
static unsigned long long delivering_messages
Number of messages we currently have in our queues towards the transport service. ...
static struct Queue * lookup_queue(const struct GNUNET_PeerIdentity *peer, const struct sockaddr_un *un, socklen_t un_len)
Find an existing queue by address.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ receive_complete_cb()

static void receive_complete_cb ( void *  cls,
int  success 
)
static

Function called when message was successfully passed to transport service.

Continue read activity.

Parameters
clsNULL
successGNUNET_OK on success

Definition at line 683 of file gnunet-communicator-unix.c.

References delivering_messages, GNUNET_assert, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_read_net(), GNUNET_STATISTICS_update(), GNUNET_TIME_UNIT_FOREVER_REL, max_queue_length, and select_read_cb().

Referenced by select_read_cb().

684 {
685  (void)cls;
687  if (GNUNET_OK != success)
689  "# transport transmission failures",
690  1,
691  GNUNET_NO);
692  GNUNET_assert(NULL != unix_sock);
693  if ((NULL == read_task) && (delivering_messages < max_queue_length))
695  unix_sock,
697  NULL);
698 }
static struct GNUNET_SCHEDULER_Task * read_task
ID of read task.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
static struct GNUNET_STATISTICS_Handle * stats
For logging statistics.
static unsigned long long max_queue_length
Maximum queue length before we stop reading towards the transport service.
static void select_read_cb(void *cls)
We have been notified that our socket has something to read.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
static struct GNUNET_NETWORK_Handle * unix_sock
socket that we transmit all data with
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_net(struct GNUNET_TIME_Relative delay, struct GNUNET_NETWORK_Handle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1467
static unsigned long long delivering_messages
Number of messages we currently have in our queues towards the transport service. ...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ mq_init()

static int mq_init ( void *  cls,
const struct GNUNET_PeerIdentity peer,
const char *  address 
)
static

Function called by the transport service to initialize a message queue given address information about another peer.

If and when the communication channel is established, the communicator must call GNUNET_TRANSPORT_communicator_mq_add() to notify the service that the channel is now up. It is the responsibility of the communicator to manage sane retries and timeouts for any peer/address combination provided by the transport service. Timeouts and retries do not need to be signalled to the transport service.

Parameters
clsclosure
peeridentity of the other peer
addresswhere to send the message, human-readable communicator-specific format, 0-terminated, UTF-8
Returns
GNUNET_OK on success, GNUNET_SYSERR if the provided address is invalid

Definition at line 827 of file gnunet-communicator-unix.c.

References COMMUNICATOR_ADDRESS_PREFIX, GNUNET_break_op, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_i2s(), GNUNET_log, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_TRANSPORT_CS_OUTBOUND, lookup_queue(), queue(), setup_queue(), and unix_address_to_sockaddr().

Referenced by run().

828 {
829  struct Queue *queue;
830  const char *path;
831  struct sockaddr_un *un;
832  socklen_t un_len;
833 
834  (void)cls;
835  if (0 != strncmp(address,
837  strlen(COMMUNICATOR_ADDRESS_PREFIX "-")))
838  {
839  GNUNET_break_op(0);
840  return GNUNET_SYSERR;
841  }
842  path = &address[strlen(COMMUNICATOR_ADDRESS_PREFIX "-")];
843  un = unix_address_to_sockaddr(path, &un_len);
844  queue = lookup_queue(peer, un, un_len);
845  if (NULL != queue)
846  {
848  "Address `%s' for %s ignored, queue exists\n",
849  path,
850  GNUNET_i2s(peer));
851  GNUNET_free(un);
852  return GNUNET_OK;
853  }
854  queue = setup_queue(peer, GNUNET_TRANSPORT_CS_OUTBOUND, un, un_len);
855  GNUNET_free(un);
856  if (NULL == queue)
857  {
859  "Failed to setup queue to %s at `%s'\n",
860  GNUNET_i2s(peer),
861  path);
862  return GNUNET_NO;
863  }
864  return GNUNET_OK;
865 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define COMMUNICATOR_ADDRESS_PREFIX
Address prefix used by the communicator.
Handle for a queue.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
static struct sockaddr_un * unix_address_to_sockaddr(const char *unixpath, socklen_t *sock_len)
Convert unix path to a struct sockaddr_un *
static struct Queue * setup_queue(const struct GNUNET_PeerIdentity *target, enum GNUNET_TRANSPORT_ConnectionStatus cs, const struct sockaddr_un *un, socklen_t un_len)
Creates a new outbound queue the transport service will use to send data to another peer...
this is an outbound connection (transport initiated)
#define GNUNET_log(kind,...)
static char * address
GNS address for this phone.
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
static struct Queue * lookup_queue(const struct GNUNET_PeerIdentity *peer, const struct sockaddr_un *un, socklen_t un_len)
Find an existing queue by address.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_queue_delete_it()

static int get_queue_delete_it ( void *  cls,
const struct GNUNET_PeerIdentity target,
void *  value 
)
static

Iterator over all message queues to clean up.

Parameters
clsNULL
targetunused
valuethe queue to destroy
Returns
GNUNET_OK to continue to iterate

Definition at line 877 of file gnunet-communicator-unix.c.

References GNUNET_OK, queue(), queue_destroy(), and value.

Referenced by do_shutdown().

880 {
881  struct Queue *queue = value;
882 
883  (void)cls;
884  (void)target;
885  queue_destroy(queue);
886  return GNUNET_OK;
887 }
static void queue(const char *hostname)
Add hostname to the list of requests to be made.
static void queue_destroy(struct Queue *queue)
Functions with this signature are called whenever we need to close a queue due to a disconnect or fai...
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
static char * value
Value of the record to add/remove.
Handle for a queue.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ do_shutdown()

static void do_shutdown ( void *  cls)
static

Shutdown the UNIX communicator.

Parameters
clsNULL (always)

Definition at line 896 of file gnunet-communicator-unix.c.

References get_queue_delete_it(), GNUNET_break, GNUNET_CONTAINER_multipeermap_destroy(), GNUNET_CONTAINER_multipeermap_iterate(), GNUNET_NETWORK_socket_close(), GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_destroy(), GNUNET_TRANSPORT_communicator_address_remove(), and GNUNET_TRANSPORT_communicator_disconnect().

Referenced by run().

897 {
898  if (NULL != read_task)
899  {
901  read_task = NULL;
902  }
903  if (NULL != write_task)
904  {
906  write_task = NULL;
907  }
908  if (NULL != unix_sock)
909  {
911  unix_sock = NULL;
912  }
915  if (NULL != ai)
916  {
918  ai = NULL;
919  }
920  if (NULL != ch)
921  {
923  ch = NULL;
924  }
925  if (NULL != stats)
926  {
928  stats = NULL;
929  }
930 }
static struct GNUNET_SCHEDULER_Task * read_task
ID of read task.
static struct GNUNET_TRANSPORT_CommunicatorHandle * ch
Our environment.
static int get_queue_delete_it(void *cls, const struct GNUNET_PeerIdentity *target, void *value)
Iterator over all message queues to clean up.
static struct GNUNET_SCHEDULER_Task * write_task
ID of write task.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
void GNUNET_STATISTICS_destroy(struct GNUNET_STATISTICS_Handle *h, int sync_first)
Destroy a handle (free all state associated with it).
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void GNUNET_CONTAINER_multipeermap_destroy(struct GNUNET_CONTAINER_MultiPeerMap *map)
Destroy a hash map.
void GNUNET_TRANSPORT_communicator_disconnect(struct GNUNET_TRANSPORT_CommunicatorHandle *ch)
Disconnect from the transport service.
static struct GNUNET_STATISTICS_Handle * stats
For logging statistics.
void GNUNET_TRANSPORT_communicator_address_remove(struct GNUNET_TRANSPORT_AddressIdentifier *ai)
Notify transport service about an address that this communicator no longer provides for this peer...
static struct GNUNET_TRANSPORT_AddressIdentifier * ai
Handle to the operation that publishes our address.
int GNUNET_CONTAINER_multipeermap_iterate(struct GNUNET_CONTAINER_MultiPeerMap *map, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map.
static struct GNUNET_CONTAINER_MultiPeerMap * queue_map
Queues (map from peer identity to struct Queue)
static struct GNUNET_NETWORK_Handle * unix_sock
socket that we transmit all data with
int GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc)
Close a socket.
Definition: network.c:548
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ enc_notify_cb()

static void enc_notify_cb ( void *  cls,
const struct GNUNET_PeerIdentity sender,
const struct GNUNET_MessageHeader msg 
)
static

Function called when the transport service has received an acknowledgement for this communicator (!) via a different return path.

Not applicable for UNIX.

Parameters
clsclosure
senderwhich peer sent the notification
msgpayload

Definition at line 945 of file gnunet-communicator-unix.c.

References GNUNET_break_op.

Referenced by run().

948 {
949  (void)cls;
950  (void)sender;
951  (void)msg;
952  GNUNET_break_op(0);
953 }
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
Here is the caller graph for this function:

◆ run()

static void run ( void *  cls,
char *const *  args,
const char *  cfgfile,
const struct GNUNET_CONFIGURATION_Handle cfg 
)
static

Setup communicator and launch network interactions.

Parameters
clsNULL (always)
argsremaining command-line arguments
cfgfilename of the configuration file used (for saving, can be NULL!)
cfgconfiguration

Definition at line 965 of file gnunet-communicator-unix.c.

References _, COMMUNICATOR_ADDRESS_PREFIX, COMMUNICATOR_CONFIG_SECTION, DEFAULT_MAX_QUEUE_LENGTH, do_shutdown(), enc_notify_cb(), GNUNET_asprintf(), GNUNET_break, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONTAINER_multipeermap_create(), GNUNET_DISK_directory_create_for_file(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log, GNUNET_log_config_missing(), GNUNET_log_strerror, GNUNET_log_strerror_file, GNUNET_NETWORK_socket_bind(), GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_create(), GNUNET_NO, GNUNET_NT_LOOPBACK, GNUNET_OK, GNUNET_SCHEDULER_add_read_net(), GNUNET_SCHEDULER_add_shutdown(), GNUNET_SCHEDULER_shutdown(), GNUNET_STATISTICS_create(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_TRANSPORT_CC_RELIABLE, GNUNET_TRANSPORT_communicator_address_add(), GNUNET_TRANSPORT_communicator_connect(), max_queue_length, mq_init(), select_read_cb(), and unix_address_to_sockaddr().

Referenced by main().

969 {
970  char *unix_socket_path;
971  struct sockaddr_un *un;
972  socklen_t un_len;
973  char *my_addr;
974 
975  (void)cls;
976 
977  if (GNUNET_OK !=
980  "UNIXPATH",
981  &unix_socket_path))
982  {
985  "UNIXPATH");
986  return;
987  }
988  if (GNUNET_OK !=
991  "MAX_QUEUE_LENGTH",
994 
995  un = unix_address_to_sockaddr(unix_socket_path, &un_len);
996  if (NULL == un)
997  {
999  "Failed to setup UNIX domain socket address with path `%s'\n",
1000  unix_socket_path);
1001  GNUNET_free(unix_socket_path);
1002  return;
1003  }
1004  unix_sock = GNUNET_NETWORK_socket_create(AF_UNIX, SOCK_DGRAM, 0);
1005  if (NULL == unix_sock)
1006  {
1008  GNUNET_free(un);
1009  GNUNET_free(unix_socket_path);
1010  return;
1011  }
1012  if (('\0' != un->sun_path[0]) &&
1014  {
1016  _("Cannot create path to `%s'\n"),
1017  un->sun_path);
1019  unix_sock = NULL;
1020  GNUNET_free(un);
1021  GNUNET_free(unix_socket_path);
1022  return;
1023  }
1025  (const struct sockaddr *)un,
1026  un_len))
1027  {
1028  GNUNET_log_strerror_file(GNUNET_ERROR_TYPE_ERROR, "bind", un->sun_path);
1030  unix_sock = NULL;
1031  GNUNET_free(un);
1032  GNUNET_free(unix_socket_path);
1033  return;
1034  }
1035  GNUNET_free(un);
1036  GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Bound to `%s'\n", unix_socket_path);
1037  stats = GNUNET_STATISTICS_create("C-UNIX", cfg);
1040  unix_sock,
1041  &select_read_cb,
1042  NULL);
1048  &mq_init,
1049  NULL,
1050  &enc_notify_cb,
1051  NULL);
1052  if (NULL == ch)
1053  {
1054  GNUNET_break(0);
1056  GNUNET_free(unix_socket_path);
1057  return;
1058  }
1059  GNUNET_asprintf(&my_addr,
1060  "%s-%s",
1062  unix_socket_path);
1063  GNUNET_free(unix_socket_path);
1065  my_addr,
1068  GNUNET_free(my_addr);
1069 }
Transmission is reliabile (with ACKs), i.e.
static void do_shutdown(void *cls)
Shutdown the UNIX communicator.
static struct GNUNET_SCHEDULER_Task * read_task
ID of read task.
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
static struct GNUNET_TRANSPORT_CommunicatorHandle * ch
Our environment.
struct GNUNET_TRANSPORT_AddressIdentifier * GNUNET_TRANSPORT_communicator_address_add(struct GNUNET_TRANSPORT_CommunicatorHandle *ch, const char *address, enum GNUNET_NetworkType nt, struct GNUNET_TIME_Relative expiration)
Notify transport service about an address that this communicator provides for this peer...
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1284
#define COMMUNICATOR_CONFIG_SECTION
Configuration section used by the communicator.
static int mq_init(void *cls, const struct GNUNET_PeerIdentity *peer, const char *address)
Function called by the transport service to initialize a message queue given address information abou...
struct GNUNET_STATISTICS_Handle * GNUNET_STATISTICS_create(const char *subsystem, const struct GNUNET_CONFIGURATION_Handle *cfg)
Get handle for the statistics service.
int GNUNET_NETWORK_socket_bind(struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, socklen_t address_len)
Bind a socket to a particular address.
Definition: network.c:474
int GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:681
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:517
struct GNUNET_CONTAINER_MultiPeerMap * GNUNET_CONTAINER_multipeermap_create(unsigned int len, int do_not_copy_keys)
Create a multi peer map (hash map for public keys of peers).
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
static void enc_notify_cb(void *cls, const struct GNUNET_PeerIdentity *sender, const struct GNUNET_MessageHeader *msg)
Function called when the transport service has received an acknowledgement for this communicator (!) ...
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
#define COMMUNICATOR_ADDRESS_PREFIX
Address prefix used by the communicator.
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
static struct GNUNET_STATISTICS_Handle * stats
For logging statistics.
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level &#39;level&#39; that indicates a failure of the command &#39;cmd&#39; with the mess...
static unsigned long long max_queue_length
Maximum queue length before we stop reading towards the transport service.
static void select_read_cb(void *cls)
We have been notified that our socket has something to read.
struct GNUNET_TRANSPORT_CommunicatorHandle * GNUNET_TRANSPORT_communicator_connect(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *config_section_name, const char *addr_prefix, enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc, GNUNET_TRANSPORT_CommunicatorMqInit mq_init, void *mq_init_cls, GNUNET_TRANSPORT_CommunicatorNotify notify_cb, void *notify_cb_cls)
Connect to the transport service.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
static struct GNUNET_TRANSPORT_AddressIdentifier * ai
Handle to the operation that publishes our address.
static struct sockaddr_un * unix_address_to_sockaddr(const char *unixpath, socklen_t *sock_len)
Convert unix path to a struct sockaddr_un *
Loopback (same host).
Definition: gnunet_nt_lib.h:44
static struct GNUNET_CONTAINER_MultiPeerMap * queue_map
Queues (map from peer identity to struct Queue)
static struct GNUNET_NETWORK_Handle * unix_sock
socket that we transmit all data with
#define GNUNET_log(kind,...)
int GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_net(struct GNUNET_TIME_Relative delay, struct GNUNET_NETWORK_Handle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when the specified file descriptor is ready f...
Definition: scheduler.c:1467
#define DEFAULT_MAX_QUEUE_LENGTH
How many messages do we keep at most in the queue to the transport service before we start to drop (d...
int GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc)
Close a socket.
Definition: network.c:548
#define GNUNET_free(ptr)
Wrapper around free.
struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_create(int domain, int type, int protocol)
Create a new socket.
Definition: network.c:900
Here is the call graph for this function:
Here is the caller graph for this function:

◆ main()

int main ( int  argc,
char *const *  argv 
)

The main function for the UNIX communicator.

Parameters
argcnumber of arguments from the command line
argvcommand line arguments
Returns
0 ok, 1 on error

Definition at line 1080 of file gnunet-communicator-unix.c.

References _, __attribute__, GNUNET_free, GNUNET_GETOPT_OPTION_END, GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), ret, and run().

1081 {
1082  static const struct GNUNET_GETOPT_CommandLineOption options[] = {
1084  };
1085  int ret;
1086 
1087  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args(argc, argv, &argc, &argv))
1088  return 2;
1089 
1090  ret = (GNUNET_OK ==
1091  GNUNET_PROGRAM_run(argc,
1092  argv,
1093  "gnunet-communicator-unix",
1094  _("GNUnet UNIX domain socket communicator"),
1095  options,
1096  &run,
1097  NULL))
1098  ? 0
1099  : 1;
1100  GNUNET_free((void *)argv);
1101  return ret;
1102 }
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1439
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
Setup communicator and launch network interactions.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
Definition of a command line option.
static int ret
Final status code.
Definition: gnunet-arm.c:89
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:

Variable Documentation

◆ read_task

struct GNUNET_SCHEDULER_Task* read_task
static

ID of read task.

Definition at line 147 of file gnunet-communicator-unix.c.

◆ write_task

struct GNUNET_SCHEDULER_Task* write_task
static

ID of write task.

Definition at line 152 of file gnunet-communicator-unix.c.

◆ delivering_messages

unsigned long long delivering_messages
static

Number of messages we currently have in our queues towards the transport service.

Definition at line 157 of file gnunet-communicator-unix.c.

Referenced by receive_complete_cb(), and select_read_cb().

◆ max_queue_length

unsigned long long max_queue_length
static

Maximum queue length before we stop reading towards the transport service.

Definition at line 162 of file gnunet-communicator-unix.c.

Referenced by receive_complete_cb(), run(), and select_read_cb().

◆ stats

struct GNUNET_STATISTICS_Handle* stats
static

For logging statistics.

Definition at line 167 of file gnunet-communicator-unix.c.

◆ ch

Our environment.

Definition at line 172 of file gnunet-communicator-unix.c.

◆ queue_map

struct GNUNET_CONTAINER_MultiPeerMap* queue_map
static

Queues (map from peer identity to struct Queue)

Definition at line 177 of file gnunet-communicator-unix.c.

◆ queue_head

struct Queue* queue_head
static

Head of queue of messages to transmit.

Definition at line 182 of file gnunet-communicator-unix.c.

◆ queue_tail

struct Queue* queue_tail
static

Tail of queue of messages to transmit.

Definition at line 187 of file gnunet-communicator-unix.c.

Referenced by select_write_cb().

◆ unix_sock

struct GNUNET_NETWORK_Handle* unix_sock
static

socket that we transmit all data with

Definition at line 192 of file gnunet-communicator-unix.c.

◆ ai