GNUnet  0.19.4
client.c File Reference

code for access to services More...

#include "platform.h"
#include "gnunet_protocols.h"
#include "gnunet_util_lib.h"
#include "gnunet_resolver_service.h"
#include "gnunet_socks.h"
Include dependency graph for client.c:

Go to the source code of this file.

Data Structures

struct  AddressProbe
 During connect, we try multiple possible IP addresses to find out which one might work. More...
 
struct  ClientState
 State we keep per client. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "util-client", __VA_ARGS__)
 
#define CONNECT_RETRY_TIMEOUT
 Timeout we use on TCP connect before trying another result from the DNS resolver. More...
 

Functions

static void start_connect (void *cls)
 Try to connect to the service. More...
 
static void connect_fail_continuation (struct ClientState *cstate)
 We've failed for good to establish a connection (timeout or no more addresses to try). More...
 
static void transmit_ready (void *cls)
 We are ready to send a message to the service. More...
 
static enum GNUNET_GenericReturnValue recv_message (void *cls, const struct GNUNET_MessageHeader *msg)
 We have received a full message, pass to the MQ dispatcher. More...
 
static void cancel_aps (struct ClientState *cstate)
 Cancel all remaining connect attempts. More...
 
static void connection_client_destroy_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Implement the destruction of a message queue. More...
 
static void receive_ready (void *cls)
 This function is called once we have data ready to read. More...
 
static void connect_success_continuation (struct ClientState *cstate)
 We've succeeded in establishing a connection. More...
 
static struct GNUNET_NETWORK_Handletry_unixpath (const char *service_name, const struct GNUNET_CONFIGURATION_Handle *cfg)
 Try connecting to the server using UNIX domain sockets. More...
 
static void connect_probe_continuation (void *cls)
 Scheduler let us know that we're either ready to write on the socket OR connect timed out. More...
 
static void try_connect_using_address (void *cls, const struct sockaddr *addr, socklen_t addrlen)
 Try to establish a connection given the specified address. More...
 
static int test_service_configuration (const char *service_name, const struct GNUNET_CONFIGURATION_Handle *cfg)
 Test whether the configuration has proper values for connection (UNIXPATH || (PORT && HOSTNAME)). More...
 
static void connection_client_send_impl (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)
 Implements the transmission functionality of a message queue. More...
 
static void connection_client_cancel_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Cancel the currently sent message. More...
 
int GNUNET_CLIENT_test (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *service_name)
 Test if the port or UNIXPATH of the given service_name is in use and thus (most likely) the respective service is up. More...
 
struct GNUNET_MQ_HandleGNUNET_CLIENT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *service_name, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *error_handler_cls)
 Create a message queue to connect to a GNUnet service. More...
 

Detailed Description

code for access to services

Author
Christian Grothoff

Generic TCP code for reliable, record-oriented TCP connections between clients and service providers.

Definition in file client.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from (kind, "util-client", __VA_ARGS__)

Definition at line 37 of file client.c.

◆ CONNECT_RETRY_TIMEOUT

#define CONNECT_RETRY_TIMEOUT
Value:
#define GNUNET_TIME_UNIT_SECONDS
One second.
struct GNUNET_TIME_Relative GNUNET_TIME_relative_multiply(struct GNUNET_TIME_Relative rel, unsigned long long factor)
Multiply relative time by a given factor.
Definition: time.c:484

Timeout we use on TCP connect before trying another result from the DNS resolver.

Actual value used is this value divided by the number of address families. Default is 5s.

Definition at line 45 of file client.c.

Function Documentation

◆ start_connect()

static void start_connect ( void *  cls)
static

Try to connect to the service.

Parameters
clsthe struct ClientState to try to connect to the service

Definition at line 787 of file client.c.

788 {
789  struct ClientState *cstate = cls;
790 
791  cstate->retry_task = NULL;
792 #if 0
793  /* Never use a local source if a proxy is configured */
794  if (GNUNET_YES ==
796  cstate->cfg))
797  {
798  socks_connect (cstate);
799  return;
800  }
801 #endif
802 
803  if ((0 == (cstate->attempts++ % 2)) ||
804  (0 == cstate->port) ||
805  (NULL == cstate->hostname))
806  {
807  /* on even rounds, try UNIX first, or always
808  if we do not have a DNS name and TCP port. */
809  cstate->sock = try_unixpath (cstate->service_name,
810  cstate->cfg);
811  if (NULL != cstate->sock)
812  {
814  return;
815  }
816  }
817  if ((NULL == cstate->hostname) ||
818  (0 == cstate->port))
819  {
820  /* All options failed. Boo! */
821  connect_fail_continuation (cstate);
822  return;
823  }
824  cstate->dns_active
825  = GNUNET_RESOLVER_ip_get (cstate->hostname,
826  AF_UNSPEC,
829  cstate);
830 }
static void try_connect_using_address(void *cls, const struct sockaddr *addr, socklen_t addrlen)
Try to establish a connection given the specified address.
Definition: client.c:638
static void connect_success_continuation(struct ClientState *cstate)
We've succeeded in establishing a connection.
Definition: client.c:483
static struct GNUNET_NETWORK_Handle * try_unixpath(const char *service_name, const struct GNUNET_CONFIGURATION_Handle *cfg)
Try connecting to the server using UNIX domain sockets.
Definition: client.c:511
static void connect_fail_continuation(struct ClientState *cstate)
We've failed for good to establish a connection (timeout or no more addresses to try).
Definition: client.c:221
#define CONNECT_RETRY_TIMEOUT
Timeout we use on TCP connect before trying another result from the DNS resolver.
Definition: client.c:45
@ GNUNET_YES
struct GNUNET_RESOLVER_RequestHandle * GNUNET_RESOLVER_ip_get(const char *hostname, int af, struct GNUNET_TIME_Relative timeout, GNUNET_RESOLVER_AddressCallback callback, void *callback_cls)
Convert a string to one or more IP addresses.
Definition: resolver_api.c:940
int GNUNET_SOCKS_check_service(const char *service_name, const struct GNUNET_CONFIGURATION_Handle *cfg)
Check if a SOCKS proxy is required by a service.
Definition: socks.c:594
State we keep per client.
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: client.c:116
unsigned int attempts
How often have we tried to connect?
Definition: client.c:194
struct GNUNET_SCHEDULER_Task * retry_task
Task for trying to connect to the service.
Definition: client.c:148
char * hostname
Hostname, if any.
Definition: client.c:138
struct GNUNET_RESOLVER_RequestHandle * dns_active
Handle to a pending DNS lookup request, NULL if DNS is finished.
Definition: client.c:111
unsigned long long port
TCP port (0 for disabled).
Definition: client.c:184
struct GNUNET_NETWORK_Handle * sock
The connection handle, NULL if not live.
Definition: client.c:106
char * service_name
Name of the service we interact with.
Definition: client.c:133

References ClientState::attempts, ClientState::cfg, connect_fail_continuation(), CONNECT_RETRY_TIMEOUT, connect_success_continuation(), ClientState::dns_active, GNUNET_RESOLVER_ip_get(), GNUNET_SOCKS_check_service(), GNUNET_YES, ClientState::hostname, ClientState::port, ClientState::retry_task, ClientState::service_name, ClientState::sock, try_connect_using_address(), and try_unixpath().

Referenced by connect_fail_continuation(), and GNUNET_CLIENT_connect().

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

◆ connect_fail_continuation()

static void connect_fail_continuation ( struct ClientState cstate)
static

We've failed for good to establish a connection (timeout or no more addresses to try).

Parameters
cstatethe connection we tried to establish

Definition at line 221 of file client.c.

222 {
223  GNUNET_break (NULL == cstate->ap_head);
224  GNUNET_break (NULL == cstate->ap_tail);
225  GNUNET_break (NULL == cstate->dns_active);
226  GNUNET_break (NULL == cstate->sock);
227  GNUNET_assert (NULL == cstate->send_task);
228  GNUNET_assert (NULL == cstate->recv_task);
229  // GNUNET_assert (NULL == cstate->proxy_handshake);
230 
231  cstate->back_off = GNUNET_TIME_STD_BACKOFF (cstate->back_off);
233  "Failed to establish connection to `%s', no further addresses to try, will try again in %s.\n",
234  cstate->service_name,
236  GNUNET_YES));
237  cstate->retry_task
239  &start_connect,
240  cstate);
241 }
static void start_connect(void *cls)
Try to connect to the service.
Definition: client.c:787
#define LOG(kind,...)
Definition: client.c:37
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
@ GNUNET_ERROR_TYPE_DEBUG
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:1272
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:569
#define GNUNET_TIME_STD_BACKOFF(r)
Perform our standard exponential back-off calculation, starting at 1 ms and then going by a factor of...
struct GNUNET_TIME_Relative back_off
Current value for our incremental back-off (for connect re-tries).
Definition: client.c:179
struct GNUNET_SCHEDULER_Task * send_task
Task for sending messages to the service.
Definition: client.c:153
struct GNUNET_SCHEDULER_Task * recv_task
Task for sending messages to the service.
Definition: client.c:158
struct AddressProbe * ap_tail
Linked list of sockets we are currently trying out (during connect).
Definition: client.c:128
struct AddressProbe * ap_head
Linked list of sockets we are currently trying out (during connect).
Definition: client.c:122

References ClientState::ap_head, ClientState::ap_tail, ClientState::back_off, ClientState::dns_active, GNUNET_assert, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_SCHEDULER_add_delayed(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_STD_BACKOFF, GNUNET_YES, LOG, ClientState::recv_task, ClientState::retry_task, ClientState::send_task, ClientState::service_name, ClientState::sock, and start_connect().

Referenced by connect_probe_continuation(), start_connect(), and try_connect_using_address().

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

◆ transmit_ready()

static void transmit_ready ( void *  cls)
static

We are ready to send a message to the service.

Parameters
clsthe struct ClientState with the msg to transmit

Definition at line 250 of file client.c.

251 {
252  struct ClientState *cstate = cls;
253  ssize_t ret;
254  size_t len;
255  const char *pos;
256  int notify_in_flight;
257 
258  cstate->send_task = NULL;
259  if (GNUNET_YES == cstate->in_destroy)
260  return;
261  pos = (const char *) cstate->msg;
262  len = ntohs (cstate->msg->size);
263  GNUNET_assert (cstate->msg_off < len);
265  "message of type %u and size %u trying to send with socket %p (MQ: %p\n",
266  ntohs (cstate->msg->type),
267  ntohs (cstate->msg->size),
268  cstate->sock,
269  cstate->mq);
270 
271 RETRY:
273  &pos[cstate->msg_off],
274  len - cstate->msg_off);
275  if ( (-1 == ret) &&
276  ( (EAGAIN == errno) ||
277  (EINTR == errno) ) )
278  {
279  /* ignore */
280  ret = 0;
281  }
282  if (-1 == ret)
283  {
285  "Error during sending message of type %u: %s\n",
286  ntohs (cstate->msg->type),
287  strerror (errno));
288  if (EINTR == errno)
289  {
291  "Retrying message of type %u\n",
292  ntohs (cstate->msg->type));
293  goto RETRY;
294  }
295  GNUNET_MQ_inject_error (cstate->mq,
297  return;
298  }
299  notify_in_flight = (0 == cstate->msg_off);
300  cstate->msg_off += ret;
301  if (cstate->msg_off < len)
302  {
304  "rescheduling message of type %u\n",
305  ntohs (cstate->msg->type));
306  cstate->send_task
308  cstate->sock,
310  cstate);
311  if (notify_in_flight)
313  return;
314  }
316  "sending message of type %u and size %u successful\n",
317  ntohs (cstate->msg->type),
318  ntohs (cstate->msg->size));
319  cstate->msg = NULL;
321 }
static void transmit_ready(void *cls)
We are ready to send a message to the service.
Definition: client.c:250
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
uint16_t len
length of data (which is always a uint32_t, but presumably this can be used to specify that fewer byt...
@ GNUNET_ERROR_TYPE_WARNING
void GNUNET_MQ_inject_error(struct GNUNET_MQ_Handle *mq, enum GNUNET_MQ_Error error)
Call the error handler of a message queue with the given error code.
Definition: mq.c:269
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:421
void GNUNET_MQ_impl_send_in_flight(struct GNUNET_MQ_Handle *mq)
Call the send notification for the current message, but do not try to send the next message until #gn...
Definition: mq.c:444
@ GNUNET_MQ_ERROR_WRITE
FIXME: document!
ssize_t GNUNET_NETWORK_socket_send(const struct GNUNET_NETWORK_Handle *desc, const void *buffer, size_t length)
Send data (always non-blocking).
Definition: network.c:737
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:1577
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
#define RETRY
Return code we give on 'send' if we failed to send right now but it makes sense to retry later.
struct GNUNET_MQ_Handle * mq
MQ to talk to client.
int in_destroy
Are we supposed to die? GNUNET_SYSERR if destruction must be deferred, GNUNET_NO by default,...
Definition: client.c:201
const struct GNUNET_MessageHeader * msg
Next message to transmit to the service.
Definition: client.c:143
size_t msg_off
Offset in the message where we are for transmission.
Definition: client.c:189
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.

Referenced by connect_success_continuation(), connection_client_send_impl(), and recv_message().

Here is the caller graph for this function:

◆ recv_message()

static enum GNUNET_GenericReturnValue recv_message ( void *  cls,
const struct GNUNET_MessageHeader msg 
)
static

We have received a full message, pass to the MQ dispatcher.

Called by the tokenizer via receive_ready().

Parameters
clsthe struct ClientState
msgmessage we received.
Returns
GNUNET_OK on success, GNUNET_NO to stop further processing due to disconnect (no error) GNUNET_SYSERR to stop further processing due to error

Definition at line 250 of file client.c.

337 {
338  struct ClientState *cstate = cls;
339 
340  if (GNUNET_YES == cstate->in_destroy)
341  return GNUNET_NO;
343  "Received message of type %u and size %u from %s\n",
344  ntohs (msg->type),
345  ntohs (msg->size),
346  cstate->service_name);
347  GNUNET_MQ_inject_message (cstate->mq,
348  msg);
349  if (GNUNET_YES == cstate->in_destroy)
350  return GNUNET_NO;
351  return GNUNET_OK;
352 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
@ GNUNET_OK
@ GNUNET_NO
void GNUNET_MQ_inject_message(struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *mh)
Call the message message handler that was registered for the type of the given message in the given m...
Definition: mq.c:187

References GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_MQ_ERROR_WRITE, GNUNET_MQ_impl_send_continue(), GNUNET_MQ_impl_send_in_flight(), GNUNET_MQ_inject_error(), GNUNET_NETWORK_socket_send(), GNUNET_SCHEDULER_add_write_net(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, ClientState::in_destroy, len, LOG, ClientState::mq, ClientState::msg, ClientState::msg_off, ret, RETRY, ClientState::send_task, GNUNET_MessageHeader::size, ClientState::sock, transmit_ready(), and GNUNET_MessageHeader::type.

Referenced by GNUNET_CLIENT_connect(), and reconnect().

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

◆ cancel_aps()

static void cancel_aps ( struct ClientState cstate)
static

Cancel all remaining connect attempts.

Parameters
cstatehandle of the client state to process

Definition at line 361 of file client.c.

362 {
363  struct AddressProbe *pos;
364 
365  while (NULL != (pos = cstate->ap_head))
366  {
371  cstate->ap_tail,
372  pos);
373  GNUNET_free (pos);
374  }
375 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
#define GNUNET_free(ptr)
Wrapper around free.
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc)
Close a socket.
Definition: network.c:508
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:975
During connect, we try multiple possible IP addresses to find out which one might work.
struct GNUNET_SCHEDULER_Task * task
Task waiting for the connection to finish connecting.
struct GNUNET_NETWORK_Handle * sock
Underlying OS's socket.
struct ClientState * cstate
Connection for which we are probing.
Definition: client.c:84

References ClientState::ap_head, ClientState::ap_tail, AddressProbe::cstate, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_NETWORK_socket_close(), GNUNET_OK, GNUNET_SCHEDULER_cancel(), AddressProbe::sock, and AddressProbe::task.

Referenced by connect_probe_continuation(), and connection_client_destroy_impl().

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

◆ connection_client_destroy_impl()

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

Implement 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 ClientState

Definition at line 386 of file client.c.

388 {
389  struct ClientState *cstate = impl_state;
390 
391  (void) mq;
392  if (NULL != cstate->dns_active)
393  {
395  cstate->dns_active = NULL;
396  }
397  if (NULL != cstate->send_task)
398  {
400  cstate->send_task = NULL;
401  }
402  if (NULL != cstate->retry_task)
403  {
405  cstate->retry_task = NULL;
406  }
407  if (GNUNET_SYSERR == cstate->in_destroy)
408  {
409  /* defer destruction */
410  cstate->in_destroy = GNUNET_YES;
411  cstate->mq = NULL;
412  return;
413  }
414  if (NULL != cstate->recv_task)
415  {
417  cstate->recv_task = NULL;
418  }
419  if (NULL != cstate->sock)
420  {
422  "destroying socket: %p\n",
423  cstate->sock);
425  }
426  cancel_aps (cstate);
427  GNUNET_free (cstate->service_name);
428  GNUNET_free (cstate->hostname);
429  GNUNET_MST_destroy (cstate->mst);
430  GNUNET_free (cstate);
431 }
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
static void cancel_aps(struct ClientState *cstate)
Cancel all remaining connect attempts.
Definition: client.c:361
@ GNUNET_SYSERR
void GNUNET_RESOLVER_request_cancel(struct GNUNET_RESOLVER_RequestHandle *rh)
Cancel a request that is still pending with the resolver.
void GNUNET_MST_destroy(struct GNUNET_MessageStreamTokenizer *mst)
Destroys a tokenizer.
Definition: mst.c:404
struct GNUNET_MessageStreamTokenizer * mst
Tokenizer for inbound messages.
Definition: client.c:163

References cancel_aps(), ClientState::dns_active, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_MST_destroy(), GNUNET_NETWORK_socket_close(), GNUNET_RESOLVER_request_cancel(), GNUNET_SCHEDULER_cancel(), GNUNET_SYSERR, GNUNET_YES, ClientState::hostname, ClientState::in_destroy, LOG, mq, ClientState::mq, ClientState::mst, ClientState::recv_task, ClientState::retry_task, ClientState::send_task, ClientState::service_name, and ClientState::sock.

Referenced by GNUNET_CLIENT_connect(), and receive_ready().

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

◆ receive_ready()

static void receive_ready ( void *  cls)
static

This function is called once we have data ready to read.

Parameters
clsstruct ClientState with connection to read from

Definition at line 440 of file client.c.

441 {
442  struct ClientState *cstate = cls;
444 
445  cstate->recv_task = NULL;
446  cstate->in_destroy = GNUNET_SYSERR;
447  ret = GNUNET_MST_read (cstate->mst,
448  cstate->sock,
449  GNUNET_NO,
450  GNUNET_NO);
451  if (GNUNET_SYSERR == ret)
452  {
453  if (NULL != cstate->mq)
454  GNUNET_MQ_inject_error (cstate->mq,
456  if (GNUNET_YES == cstate->in_destroy)
458  cstate);
459  return;
460  }
461  if (GNUNET_YES == cstate->in_destroy)
462  {
464  cstate);
465  return;
466  }
467  cstate->in_destroy = GNUNET_NO;
468  GNUNET_assert (NULL == cstate->recv_task);
469  cstate->recv_task
471  cstate->sock,
472  &receive_ready,
473  cstate);
474 }
static void receive_ready(void *cls)
This function is called once we have data ready to read.
Definition: client.c:440
static void connection_client_destroy_impl(struct GNUNET_MQ_Handle *mq, void *impl_state)
Implement the destruction of a message queue.
Definition: client.c:386
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_MQ_ERROR_READ
Failed to read message from the network.
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:1506
int GNUNET_MST_read(struct GNUNET_MessageStreamTokenizer *mst, struct GNUNET_NETWORK_Handle *sock, int purge, int one_shot)
Add incoming data to the receive buffer and call the callback for all complete messages.
Definition: mst.c:338

References connection_client_destroy_impl(), GNUNET_assert, GNUNET_MQ_ERROR_READ, GNUNET_MQ_inject_error(), GNUNET_MST_read(), GNUNET_NO, GNUNET_SCHEDULER_add_read_net(), GNUNET_SYSERR, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, ClientState::in_destroy, ClientState::mq, ClientState::mst, ClientState::recv_task, ret, and ClientState::sock.

Referenced by connect_success_continuation().

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

◆ connect_success_continuation()

static void connect_success_continuation ( struct ClientState cstate)
static

We've succeeded in establishing a connection.

Parameters
cstatethe connection we tried to establish

Definition at line 483 of file client.c.

484 {
485  GNUNET_assert (NULL == cstate->recv_task);
486  cstate->recv_task
488  cstate->sock,
489  &receive_ready,
490  cstate);
491  if (NULL != cstate->msg)
492  {
493  GNUNET_assert (NULL == cstate->send_task);
494  cstate->send_task
496  cstate->sock,
498  cstate);
499  }
500 }

References GNUNET_assert, GNUNET_SCHEDULER_add_read_net(), GNUNET_SCHEDULER_add_write_net(), GNUNET_TIME_UNIT_FOREVER_REL, ClientState::msg, receive_ready(), ClientState::recv_task, ClientState::send_task, ClientState::sock, and transmit_ready().

Referenced by connect_probe_continuation(), and start_connect().

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

◆ try_unixpath()

static struct GNUNET_NETWORK_Handle* try_unixpath ( const char *  service_name,
const struct GNUNET_CONFIGURATION_Handle cfg 
)
static

Try connecting to the server using UNIX domain sockets.

Parameters
service_namename of service to connect to
cfgconfiguration to use
Returns
NULL on error, socket connected to UNIX otherwise

Definition at line 511 of file client.c.

513 {
514 #if AF_UNIX
515  struct GNUNET_NETWORK_Handle *sock;
516  char *unixpath;
517  struct sockaddr_un s_un;
518 
519  unixpath = NULL;
520  if ((GNUNET_OK ==
522  service_name,
523  "UNIXPATH",
524  &unixpath)) &&
525  (0 < strlen (unixpath)))
526  {
527  /* We have a non-NULL unixpath, need to validate it */
528  if (strlen (unixpath) >= sizeof(s_un.sun_path))
529  {
531  _ ("UNIXPATH `%s' too long, maximum length is %llu\n"),
532  unixpath,
533  (unsigned long long) sizeof(s_un.sun_path));
534  unixpath = GNUNET_NETWORK_shorten_unixpath (unixpath);
536  _ ("Using `%s' instead\n"),
537  unixpath);
538  if (NULL == unixpath)
539  return NULL;
540  }
541  memset (&s_un,
542  0,
543  sizeof(s_un));
544  s_un.sun_family = AF_UNIX;
545  GNUNET_strlcpy (s_un.sun_path,
546  unixpath,
547  sizeof(s_un.sun_path));
548 #if HAVE_SOCKADDR_UN_SUN_LEN
549  s_un.sun_len = (u_char) sizeof(struct sockaddr_un);
550 #endif
551  sock = GNUNET_NETWORK_socket_create (AF_UNIX,
552  SOCK_STREAM,
553  0);
554  if ((NULL != sock) &&
555  ((GNUNET_OK ==
557  (struct sockaddr *) &s_un,
558  sizeof(s_un))) ||
559  (EINPROGRESS == errno)))
560  {
562  "Successfully connected to unixpath `%s'!\n",
563  unixpath);
564  GNUNET_free (unixpath);
565  return sock;
566  }
567  if (NULL != sock)
569  }
570  GNUNET_free (unixpath);
571 #endif
572  return NULL;
573 }
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
static char * service_name
Option -s: service name (hash to get service descriptor)
Definition: gnunet-vpn.c:50
enum GNUNET_GenericReturnValue 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.
@ GNUNET_ERROR_TYPE_INFO
enum GNUNET_GenericReturnValue GNUNET_NETWORK_socket_connect(const struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, socklen_t address_len)
Connect a socket to some remote address.
Definition: network.c:601
struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_create(int domain, int type, int protocol)
Create a new socket.
Definition: network.c:832
char * GNUNET_NETWORK_shorten_unixpath(char *unixpath)
Given a unixpath that is too long (larger than UNIX_PATH_MAX), shorten it to an acceptable length whi...
Definition: network.c:143
size_t GNUNET_strlcpy(char *dst, const char *src, size_t n)
Like strlcpy but portable.
Definition: strings.c:138
#define _(String)
GNU gettext support macro.
Definition: platform.h:178
handle to a socket
Definition: network.c:53

References _, cfg, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_NETWORK_shorten_unixpath(), GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_connect(), GNUNET_NETWORK_socket_create(), GNUNET_OK, GNUNET_strlcpy(), LOG, and service_name.

Referenced by start_connect().

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

◆ connect_probe_continuation()

static void connect_probe_continuation ( void *  cls)
static

Scheduler let us know that we're either ready to write on the socket OR connect timed out.

Do the right thing.

Parameters
clsthe struct AddressProbe * with the address that we are probing

Definition at line 583 of file client.c.

584 {
585  struct AddressProbe *ap = cls;
586  struct ClientState *cstate = ap->cstate;
587  const struct GNUNET_SCHEDULER_TaskContext *tc;
588  int error;
589  socklen_t len;
590 
591  ap->task = NULL;
592  GNUNET_assert (NULL != ap->sock);
594  cstate->ap_tail,
595  ap);
596  len = sizeof(error);
597  error = 0;
600  (GNUNET_OK !=
602  SOL_SOCKET,
603  SO_ERROR,
604  &error,
605  &len)) ||
606  (0 != error))
607  {
610  GNUNET_free (ap);
611  if ((NULL == cstate->ap_head) &&
612  // (NULL == cstate->proxy_handshake) &&
613  (NULL == cstate->dns_active))
614  connect_fail_continuation (cstate);
615  return;
616  }
618  "Connection to `%s' succeeded!\n",
619  cstate->service_name);
620  /* trigger jobs that waited for the connection */
621  GNUNET_assert (NULL == cstate->sock);
622  cstate->sock = ap->sock;
623  GNUNET_free (ap);
624  cancel_aps (cstate);
626 }
enum GNUNET_GenericReturnValue 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:626
const struct GNUNET_SCHEDULER_TaskContext * GNUNET_SCHEDULER_get_task_context(void)
Obtain the reasoning why the current task was started.
Definition: scheduler.c:752
@ GNUNET_SCHEDULER_REASON_WRITE_READY
The writing socket is ready.
static struct GNUNET_SCHEDULER_TaskContext tc
Task context of the current task.
Definition: scheduler.c:431
Context information passed to each scheduler task.
enum GNUNET_SCHEDULER_Reason reason
Reason why the task is run now.

References ClientState::ap_head, ClientState::ap_tail, cancel_aps(), connect_fail_continuation(), connect_success_continuation(), AddressProbe::cstate, ClientState::dns_active, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_getsockopt(), GNUNET_OK, GNUNET_SCHEDULER_get_task_context(), GNUNET_SCHEDULER_REASON_WRITE_READY, len, LOG, GNUNET_SCHEDULER_TaskContext::reason, ClientState::service_name, AddressProbe::sock, ClientState::sock, AddressProbe::task, and tc.

Referenced by try_connect_using_address().

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

◆ try_connect_using_address()

static void try_connect_using_address ( void *  cls,
const struct sockaddr *  addr,
socklen_t  addrlen 
)
static

Try to establish a connection given the specified address.

This function is called by the resolver once we have a DNS reply.

Parameters
clsour struct ClientState *
addraddress to try, NULL for "last call"
addrlenlength of addr

Definition at line 638 of file client.c.

641 {
642  struct ClientState *cstate = cls;
643  struct AddressProbe *ap;
644 
645  if (NULL == addr)
646  {
647  cstate->dns_active = NULL;
648  if ((NULL == cstate->ap_head) &&
649  // (NULL == cstate->proxy_handshake) &&
650  (NULL == cstate->sock))
652  return;
653  }
654  if (NULL != cstate->sock)
655  return; /* already connected */
656  /* try to connect */
658  "Trying to connect using address `%s:%u'\n",
659  GNUNET_a2s (addr,
660  addrlen),
661  (unsigned int) cstate->port);
662  ap = GNUNET_malloc (sizeof(struct AddressProbe) + addrlen);
663  ap->addr = (const struct sockaddr *) &ap[1];
664  GNUNET_memcpy (&ap[1],
665  addr,
666  addrlen);
667  ap->addrlen = addrlen;
668  ap->cstate = cstate;
669 
670  switch (ap->addr->sa_family)
671  {
672  case AF_INET:
673  ((struct sockaddr_in *) ap->addr)->sin_port = htons (cstate->port);
674  break;
675 
676  case AF_INET6:
677  ((struct sockaddr_in6 *) ap->addr)->sin6_port = htons (cstate->port);
678  break;
679 
680  default:
681  GNUNET_break (0);
682  GNUNET_free (ap);
683  return; /* not supported by us */
684  }
685  ap->sock = GNUNET_NETWORK_socket_create (ap->addr->sa_family,
686  SOCK_STREAM,
687  0);
688  if (NULL == ap->sock)
689  {
690  GNUNET_free (ap);
691  return; /* not supported by OS */
692  }
693  if ((GNUNET_OK !=
695  ap->addr,
696  ap->addrlen)) &&
697  (EINPROGRESS != errno))
698  {
699  /* maybe refused / unsupported address, try next */
701  "connect");
704  GNUNET_free (ap);
705  return;
706  }
708  cstate->ap_tail,
709  ap);
711  ap->sock,
713  ap);
714 }
static void connect_probe_continuation(void *cls)
Scheduler let us know that we're either ready to write on the socket OR connect timed out.
Definition: client.c:583
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
const char * GNUNET_a2s(const struct sockaddr *addr, socklen_t addrlen)
Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string (for printing debug messages).
#define GNUNET_malloc(size)
Wrapper around malloc.
socklen_t addrlen
Length of addr.
const struct sockaddr * addr
The address; do not free (allocated at the end of this struct).

References AddressProbe::addr, AddressProbe::addrlen, ClientState::ap_head, ClientState::ap_tail, connect_fail_continuation(), connect_probe_continuation(), CONNECT_RETRY_TIMEOUT, AddressProbe::cstate, ClientState::dns_active, GNUNET_a2s(), GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_free, GNUNET_log_strerror, GNUNET_malloc, GNUNET_memcpy, GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_connect(), GNUNET_NETWORK_socket_create(), GNUNET_OK, GNUNET_SCHEDULER_add_write_net(), LOG, ClientState::port, AddressProbe::sock, ClientState::sock, and AddressProbe::task.

Referenced by start_connect().

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

◆ test_service_configuration()

static int test_service_configuration ( const char *  service_name,
const struct GNUNET_CONFIGURATION_Handle cfg 
)
static

Test whether the configuration has proper values for connection (UNIXPATH || (PORT && HOSTNAME)).

Parameters
service_namename of service to connect to
cfgconfiguration to use
Returns
GNUNET_OK if the configuration is valid, GNUNET_SYSERR if not

Definition at line 726 of file client.c.

728 {
729  int ret = GNUNET_SYSERR;
730  char *hostname = NULL;
731  unsigned long long port;
732 
733 #if AF_UNIX
734  char *unixpath = NULL;
735 
736  if ((GNUNET_OK ==
738  service_name,
739  "UNIXPATH",
740  &unixpath)) &&
741  (0 < strlen (unixpath)))
742  ret = GNUNET_OK;
743  else if ((GNUNET_OK ==
745  service_name,
746  "UNIXPATH")))
747  {
749  service_name,
750  "UNIXPATH",
751  _ ("not a valid filename"));
752  GNUNET_free (unixpath);
753  return GNUNET_SYSERR; /* UNIXPATH specified but invalid! */
754  }
755  GNUNET_free (unixpath);
756 #endif
757 
758  if ((GNUNET_YES ==
760  service_name,
761  "PORT")) &&
762  (GNUNET_OK ==
764  service_name,
765  "PORT",
766  &port)) &&
767  (port <= 65535) &&
768  (0 != port) &&
769  (GNUNET_OK ==
771  service_name,
772  "HOSTNAME",
773  &hostname)) &&
774  (0 != strlen (hostname)))
775  ret = GNUNET_OK;
777  return ret;
778 }
static uint16_t port
Port number.
Definition: gnunet-bcd.c:147
static char * hostname
Our hostname; we give this to all the peers we start.
enum GNUNET_GenericReturnValue 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.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_have_value(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Test if we have a value for a particular option.
void GNUNET_log_config_invalid(enum GNUNET_ErrorType kind, const char *section, const char *option, const char *required)
Log error message about invalid configuration option value.
@ GNUNET_ERROR_TYPE_ERROR

References _, cfg, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_have_value(), GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log_config_invalid(), GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, hostname, port, ret, and service_name.

Referenced by GNUNET_CLIENT_connect().

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

◆ connection_client_send_impl()

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

Implements the transmission functionality of a message queue.

Parameters
mqthe message queue
msgthe message to send
impl_stateour struct ClientState

Definition at line 841 of file client.c.

844 {
845  struct ClientState *cstate = impl_state;
846 
847  (void) mq;
848  /* only one message at a time allowed */
849  GNUNET_assert (NULL == cstate->msg);
850  GNUNET_assert (NULL == cstate->send_task);
851  cstate->msg = msg;
852  cstate->msg_off = 0;
853  if (NULL == cstate->sock)
854  {
856  "message of type %u waiting for socket\n",
857  ntohs (msg->type));
858  return; /* still waiting for connection */
859  }
860  cstate->send_task
862  cstate);
863 }
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:1299

References GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_SCHEDULER_add_now(), LOG, mq, msg, ClientState::msg, ClientState::msg_off, ClientState::send_task, ClientState::sock, transmit_ready(), and GNUNET_MessageHeader::type.

Referenced by GNUNET_CLIENT_connect().

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

◆ connection_client_cancel_impl()

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

Cancel the currently sent message.

Parameters
mqmessage queue
impl_stateour struct ClientState

Definition at line 873 of file client.c.

875 {
876  struct ClientState *cstate = impl_state;
877 
878  (void) mq;
879  GNUNET_assert (NULL != cstate->msg);
880  GNUNET_assert (0 == cstate->msg_off);
881  cstate->msg = NULL;
882  if (NULL != cstate->send_task)
883  {
885  cstate->send_task = NULL;
886  }
887 }

References GNUNET_assert, GNUNET_SCHEDULER_cancel(), mq, ClientState::msg, ClientState::msg_off, and ClientState::send_task.

Referenced by GNUNET_CLIENT_connect().

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