GNUnet  0.11.x
Data Structures | Macros | Functions
transport_api_core.c File Reference

library to access the transport service for message exchange More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_constants.h"
#include "gnunet_arm_service.h"
#include "gnunet_hello_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_transport_service.h"
#include "transport.h"
Include dependency graph for transport_api_core.c:

Go to the source code of this file.

Data Structures

struct  Neighbour
 A connected controller which is not our child. More...
 
struct  GNUNET_TRANSPORT_CoreHandle
 Handle for the transport service (includes all of the state for the transport service). More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "transport-api-core", __VA_ARGS__)
 
#define UNREADY_WARN_TIME   GNUNET_TIME_UNIT_MINUTES
 If we could not send any payload to a peer for this amount of time, we print a warning. More...
 
#define STARTING_NEIGHBOURS_SIZE   16
 How large to start with for the hashmap of neighbours. More...
 

Functions

static void disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_CoreHandle *h)
 Function that will schedule the job that will try to connect us again to the client. More...
 
static struct Neighbourneighbour_find (struct GNUNET_TRANSPORT_CoreHandle *h, const struct GNUNET_PeerIdentity *peer)
 Get the neighbour list entry for the given peer. More...
 
static void notify_excess_cb (void *cls)
 Function called by the bandwidth tracker if we have excess bandwidth. More...
 
static int neighbour_delete (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
 Iterator over hash map entries, for deleting state of a neighbour. More...
 
static void mq_error_handler (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 int check_hello (void *cls, const struct GNUNET_MessageHeader *msg)
 Function we use for checking incoming HELLO messages. More...
 
static void handle_hello (void *cls, const struct GNUNET_MessageHeader *msg)
 Function we use for handling incoming HELLO messages. More...
 
static void notify_send_done_fin (void *cls)
 A message from the handler's message queue to a neighbour was transmitted. More...
 
static void notify_send_done (void *cls)
 A message from the handler's message queue to a neighbour was transmitted. More...
 
static void mq_send_impl (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)
 Implement sending functionality of a message queue. More...
 
static void mq_destroy_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Handle destruction of a message queue. More...
 
static void mq_cancel_impl (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Implementation function that cancels the currently sent message. More...
 
static void peer_mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
 We had an error processing a message we forwarded from a peer to the CORE service. More...
 
static void outbound_bw_tracker_update (void *cls)
 The outbound quota has changed in a way that may require us to reset the timeout. More...
 
static void handle_connect (void *cls, const struct ConnectInfoMessage *cim)
 Function we use for handling incoming connect messages. More...
 
static void handle_disconnect (void *cls, const struct DisconnectInfoMessage *dim)
 Function we use for handling incoming disconnect messages. More...
 
static void handle_send_ok (void *cls, const struct SendOkMessage *okm)
 Function we use for handling incoming send-ok messages. More...
 
static int check_recv (void *cls, const struct InboundMessage *im)
 Function we use for checking incoming "inbound" messages. More...
 
static void handle_recv (void *cls, const struct InboundMessage *im)
 Function we use for handling incoming messages. More...
 
static void handle_set_quota (void *cls, const struct QuotaSetMessage *qm)
 Function we use for handling incoming set quota messages. More...
 
static void reconnect (void *cls)
 Try again to connect to transport service. More...
 
struct GNUNET_MQ_HandleGNUNET_TRANSPORT_core_get_mq (struct GNUNET_TRANSPORT_CoreHandle *handle, const struct GNUNET_PeerIdentity *peer)
 Checks if a given peer is connected to us and get the message queue. More...
 
struct GNUNET_TRANSPORT_CoreHandleGNUNET_TRANSPORT_core_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_PeerIdentity *self, const struct GNUNET_MQ_MessageHandler *handlers, void *cls, GNUNET_TRANSPORT_NotifyConnect nc, GNUNET_TRANSPORT_NotifyDisconnect nd, GNUNET_TRANSPORT_NotifyExcessBandwidth neb)
 Connect to the transport service. More...
 
void GNUNET_TRANSPORT_core_disconnect (struct GNUNET_TRANSPORT_CoreHandle *handle)
 Disconnect from the transport service. More...
 

Detailed Description

library to access the transport service for message exchange

Author
Christian Grothoff

Definition in file transport_api_core.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from (kind, "transport-api-core", __VA_ARGS__)

Definition at line 35 of file transport_api_core.c.

◆ UNREADY_WARN_TIME

#define UNREADY_WARN_TIME   GNUNET_TIME_UNIT_MINUTES

If we could not send any payload to a peer for this amount of time, we print a warning.

Definition at line 41 of file transport_api_core.c.

◆ STARTING_NEIGHBOURS_SIZE

#define STARTING_NEIGHBOURS_SIZE   16

How large to start with for the hashmap of neighbours.

Definition at line 46 of file transport_api_core.c.

Function Documentation

◆ disconnect_and_schedule_reconnect()

static void disconnect_and_schedule_reconnect ( struct GNUNET_TRANSPORT_CoreHandle h)
static

Function that will schedule the job that will try to connect us again to the client.

Parameters
htransport service to reconnect

Definition at line 805 of file transport_api_core.c.

806 {
807  GNUNET_assert (NULL == h->reconnect_task);
808  /* Forget about all neighbours that we used to be connected to */
810  if (NULL != h->mq)
811  {
813  h->mq = NULL;
814  }
816  "Scheduling task to reconnect to transport service in %s.\n",
818  h->reconnect_task =
819  GNUNET_SCHEDULER_add_delayed (h->reconnect_delay, &reconnect, h);
820  h->reconnect_delay = GNUNET_TIME_STD_BACKOFF (h->reconnect_delay);
821 }
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
@ GNUNET_YES
Definition: gnunet_common.h:97
int GNUNET_CONTAINER_multipeermap_iterate(struct GNUNET_CONTAINER_MultiPeerMap *map, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
@ GNUNET_ERROR_TYPE_DEBUG
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:837
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1269
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:557
#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_MQ_Handle * mq
Our connection to the ARM service.
Definition: arm_api.c:107
struct GNUNET_SCHEDULER_Task * reconnect_task
ID of the reconnect task (if any).
Definition: arm_api.c:147
static int neighbour_delete(void *cls, const struct GNUNET_PeerIdentity *key, void *value)
Iterator over hash map entries, for deleting state of a neighbour.
static void reconnect(void *cls)
Try again to connect to transport service.
#define LOG(kind,...)

References GNUNET_assert, GNUNET_CONTAINER_multipeermap_iterate(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_STD_BACKOFF, GNUNET_YES, h, LOG, GNUNET_ARM_Handle::mq, neighbour_delete(), reconnect(), and GNUNET_ARM_Handle::reconnect_task.

Referenced by GNUNET_TRANSPORT_core_disconnect(), handle_connect(), handle_disconnect(), handle_recv(), handle_send_ok(), handle_set_quota(), and mq_error_handler().

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

◆ neighbour_find()

static struct Neighbour* neighbour_find ( struct GNUNET_TRANSPORT_CoreHandle h,
const struct GNUNET_PeerIdentity peer 
)
static

Get the neighbour list entry for the given peer.

Parameters
hour context
peerpeer to look up
Returns
NULL if no such peer entry exists

Definition at line 216 of file transport_api_core.c.

218 {
219  return GNUNET_CONTAINER_multipeermap_get (h->neighbours, peer);
220 }
void * GNUNET_CONTAINER_multipeermap_get(const struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key)
Given a key find a value in the map matching the key.
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.

References GNUNET_CONTAINER_multipeermap_get(), h, and peer.

Referenced by GNUNET_TRANSPORT_core_get_mq(), handle_connect(), handle_disconnect(), handle_recv(), handle_send_ok(), and handle_set_quota().

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

◆ notify_excess_cb()

static void notify_excess_cb ( void *  cls)
static

Function called by the bandwidth tracker if we have excess bandwidth.

Parameters
clsthe struct Neighbour that has excess bandwidth

Definition at line 230 of file transport_api_core.c.

231 {
232  struct Neighbour *n = cls;
233  struct GNUNET_TRANSPORT_CoreHandle *h = n->h;
234 
236  "Notifying CORE that more bandwidth is available for %s\n",
237  GNUNET_i2s (&n->id));
238 
239  if (NULL != h->neb_cb)
240  h->neb_cb (h->cls, &n->id, n->handlers_cls);
241 }
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
Handle for the transport service (includes all of the state for the transport service).
A connected controller which is not our child.
void * handlers_cls
Closure for mq handlers.
struct GNUNET_TRANSPORT_CoreHandle * h
Overall transport handle.
struct GNUNET_PeerIdentity id
Identity of this neighbour.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), h, Neighbour::h, Neighbour::handlers_cls, Neighbour::id, and LOG.

Referenced by handle_connect().

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

◆ neighbour_delete()

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

Iterator over hash map entries, for deleting state of a neighbour.

Parameters
clsthe struct GNUNET_TRANSPORT_CoreHandle *
keypeer identity
valuevalue in the hash map, the neighbour entry to delete
Returns
GNUNET_YES if we should continue to iterate, GNUNET_NO if not.

Definition at line 255 of file transport_api_core.c.

256 {
258  struct Neighbour *n = value;
259 
261  "Dropping entry for neighbour `%s'.\n",
262  GNUNET_i2s (key));
264  if (NULL != handle->nd_cb)
265  handle->nd_cb (handle->cls, &n->id, n->handlers_cls);
266  if (NULL != n->timeout_task)
267  {
269  n->timeout_task = NULL;
270  }
271  if (NULL != n->env)
272  {
274  n->env = NULL;
275  }
276  GNUNET_MQ_destroy (n->mq);
277  GNUNET_assert (NULL == n->mq);
278  GNUNET_assert (
279  GNUNET_YES ==
281  GNUNET_free (n);
282  return GNUNET_YES;
283 }
struct GNUNET_HashCode key
The key used in the DHT.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
static char * value
Value of the record to add/remove.
void GNUNET_BANDWIDTH_tracker_notification_stop(struct GNUNET_BANDWIDTH_Tracker *av)
Stop notifying about tracker updates and excess notifications.
Definition: bandwidth.c:325
int GNUNET_CONTAINER_multipeermap_remove(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, const void *value)
Remove the given key-value pair from the map.
#define GNUNET_free(ptr)
Wrapper around free.
void GNUNET_MQ_send_cancel(struct GNUNET_MQ_Envelope *ev)
Cancel sending the message.
Definition: mq.c:929
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:972
void * cls
Closure for the callbacks.
struct GNUNET_MQ_Envelope * env
Envelope with the message we are currently transmitting (or NULL).
struct GNUNET_MQ_Handle * mq
Active message queue for the peer.
struct GNUNET_BANDWIDTH_Tracker out_tracker
Outbound bandwidh tracker.
struct GNUNET_SCHEDULER_Task * timeout_task
Task to trigger MQ when we have enough bandwidth for the next transmission.

References GNUNET_TRANSPORT_CoreHandle::cls, Neighbour::env, GNUNET_assert, GNUNET_BANDWIDTH_tracker_notification_stop(), GNUNET_CONTAINER_multipeermap_remove(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_i2s(), GNUNET_MQ_destroy(), GNUNET_MQ_send_cancel(), GNUNET_SCHEDULER_cancel(), GNUNET_YES, handle, Neighbour::handlers_cls, Neighbour::id, key, LOG, Neighbour::mq, Neighbour::out_tracker, Neighbour::timeout_task, and value.

Referenced by disconnect_and_schedule_reconnect(), and handle_disconnect().

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

◆ mq_error_handler()

static void mq_error_handler ( 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
clsclosure with the struct GNUNET_TRANSPORT_CoreHandle *
errorerror code

Definition at line 296 of file transport_api_core.c.

297 {
299 
301  "Error receiving from transport service (%d), disconnecting temporarily.\n",
302  error);
304 }
@ GNUNET_ERROR_TYPE_ERROR
static void disconnect_and_schedule_reconnect(struct GNUNET_TRANSPORT_CoreHandle *h)
Function that will schedule the job that will try to connect us again to the client.

References GNUNET_TRANSPORT_CoreHandle::cls, disconnect_and_schedule_reconnect(), GNUNET_ERROR_TYPE_ERROR, h, and LOG.

Referenced by reconnect().

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

◆ check_hello()

static int check_hello ( void *  cls,
const struct GNUNET_MessageHeader msg 
)
static

Function we use for checking incoming HELLO messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_CoreHandle *
msgmessage received
Returns
GNUNET_OK if message is well-formed

Definition at line 315 of file transport_api_core.c.

316 {
317  struct GNUNET_PeerIdentity me;
318 
319  if (GNUNET_OK !=
320  GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) msg, &me))
321  {
322  GNUNET_break (0);
323  return GNUNET_SYSERR;
324  }
325  return GNUNET_OK;
326 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static GNUNET_NETWORK_STRUCT_END struct GNUNET_PeerIdentity me
Our own peer identity.
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
int GNUNET_HELLO_get_id(const struct GNUNET_HELLO_Message *hello, struct GNUNET_PeerIdentity *peer)
Get the peer identity from a HELLO message.
Definition: hello.c:671
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
A HELLO message is used to exchange information about transports with other peers.
The identity of the host (wraps the signing key of the peer).

References GNUNET_break, GNUNET_HELLO_get_id(), GNUNET_OK, GNUNET_SYSERR, me, and msg.

Here is the call graph for this function:

◆ handle_hello()

static void handle_hello ( void *  cls,
const struct GNUNET_MessageHeader msg 
)
static

Function we use for handling incoming HELLO messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_CoreHandle *
msgmessage received

Definition at line 336 of file transport_api_core.c.

337 {
338  /* we do not care => FIXME: signal in options to NEVER send HELLOs! */
339 }

◆ notify_send_done_fin()

static void notify_send_done_fin ( void *  cls)
static

A message from the handler's message queue to a neighbour was transmitted.

Now trigger (possibly delayed) notification of the neighbour's message queue that we are done and thus ready for the next message.

Parameters
clsthe struct Neighbour where the message was sent

Definition at line 351 of file transport_api_core.c.

352 {
353  struct Neighbour *n = cls;
354 
355  n->timeout_task = NULL;
356  n->is_ready = GNUNET_YES;
358 }
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:499
int is_ready
Is this peer currently ready to receive a message?

References GNUNET_MQ_impl_send_continue(), GNUNET_YES, Neighbour::is_ready, Neighbour::mq, and Neighbour::timeout_task.

Referenced by notify_send_done().

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

◆ notify_send_done()

static void notify_send_done ( void *  cls)
static

A message from the handler's message queue to a neighbour was transmitted.

Now trigger (possibly delayed) notification of the neighbour's message queue that we are done and thus ready for the next message.

Parameters
clsthe struct Neighbour where the message was sent

Definition at line 370 of file transport_api_core.c.

371 {
372  struct Neighbour *n = cls;
374 
375  n->timeout_task = NULL;
376  if (NULL != n->env)
377  {
379  n->env_size + n->traffic_overhead);
380  n->env = NULL;
381  n->traffic_overhead = 0;
382  }
384  if (0 == delay.rel_value_us)
385  {
386  n->is_ready = GNUNET_YES;
388  return;
389  }
391  /* cannot send even a small message without violating
392  quota, wait a before allowing MQ to send next message */
393  n->timeout_task =
395 }
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
int GNUNET_BANDWIDTH_tracker_consume(struct GNUNET_BANDWIDTH_Tracker *av, ssize_t size)
Notify the tracker that a certain number of bytes of bandwidth have been consumed.
Definition: bandwidth.c:402
struct GNUNET_TIME_Relative GNUNET_BANDWIDTH_tracker_get_delay(struct GNUNET_BANDWIDTH_Tracker *av, size_t size)
Compute how long we should wait until consuming size bytes of bandwidth in order to stay within the g...
Definition: bandwidth.c:458
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:532
Time for relative time used by GNUnet, in microseconds.
uint64_t rel_value_us
The actual value.
uint16_t env_size
Size of the message in env.
unsigned long long traffic_overhead
Sending consumed more bytes on wire than payload was announced This overhead is added to the delay of...
static void notify_send_done_fin(void *cls)
A message from the handler's message queue to a neighbour was transmitted.

References delay, Neighbour::env, Neighbour::env_size, GNUNET_BANDWIDTH_tracker_consume(), GNUNET_BANDWIDTH_tracker_get_delay(), GNUNET_MQ_impl_send_continue(), GNUNET_MQ_impl_send_in_flight(), GNUNET_SCHEDULER_add_delayed(), GNUNET_YES, Neighbour::is_ready, Neighbour::mq, notify_send_done_fin(), Neighbour::out_tracker, GNUNET_TIME_Relative::rel_value_us, Neighbour::timeout_task, and Neighbour::traffic_overhead.

Referenced by mq_send_impl(), and outbound_bw_tracker_update().

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

◆ mq_send_impl()

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

Implement sending functionality of a message queue.

Called one message at a time. Should send the msg to the transport service and then notify the queue once we are ready for the next one.

Parameters
mqthe message queue
msgthe message to send
impl_statestate of the implementation

Definition at line 409 of file transport_api_core.c.

412 {
413  struct Neighbour *n = impl_state;
414  struct GNUNET_TRANSPORT_CoreHandle *h = n->h;
415  struct OutboundMessage *obm;
416  uint16_t msize;
417 
419  msize = ntohs (msg->size);
420  if (msize >= GNUNET_MAX_MESSAGE_SIZE - sizeof(*obm))
421  {
422  GNUNET_break (0);
424  return;
425  }
426  GNUNET_assert (NULL == n->env);
427  n->env =
429  {
430  struct GNUNET_MQ_Envelope *env;
431 
433  obm->priority = htonl ((uint32_t) GNUNET_MQ_env_get_options (env));
434  }
436  GNUNET_TIME_UNIT_MINUTES); /* FIXME: to be removed */
437  obm->peer = n->id;
438  GNUNET_assert (NULL == n->timeout_task);
439  n->is_ready = GNUNET_NO;
440  n->env_size = ntohs (msg->size);
442  GNUNET_MQ_send (h->mq, n->env);
444  "Queued message of type %u for neighbour `%s'.\n",
445  ntohs (msg->type),
446  GNUNET_i2s (&n->id));
447 }
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
@ GNUNET_NO
Definition: gnunet_common.h:94
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message,...
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:355
#define GNUNET_MQ_msg_nested_mh(mvar, type, mh)
Allocate a GNUNET_MQ_Envelope, and append a payload message after the given message struct.
void GNUNET_MQ_notify_sent(struct GNUNET_MQ_Envelope *ev, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
Call a callback once the envelope has been sent, that is, sending it can not be canceled anymore.
Definition: mq.c:787
enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_get_options(struct GNUNET_MQ_Envelope *env)
Get performance preferences set for this envelope.
Definition: mq.c:1037
struct GNUNET_MQ_Envelope * GNUNET_MQ_get_current_envelope(struct GNUNET_MQ_Handle *mq)
Function to obtain the current envelope from within GNUNET_MQ_SendImpl implementations.
Definition: mq.c:991
#define GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
Request to TRANSPORT to transmit a message.
#define GNUNET_TIME_UNIT_MINUTES
One minute.
struct GNUNET_TIME_RelativeNBO GNUNET_TIME_relative_hton(struct GNUNET_TIME_Relative a)
Convert relative time to network byte order.
Definition: time.c:444
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.
Message used to notify the transport service about a message to be transmitted to another peer.
Definition: transport.h:285
uint32_t priority
An enum GNUNET_MQ_PriorityPreferences in NBO.
Definition: transport.h:294
struct GNUNET_PeerIdentity peer
Which peer should receive the message?
Definition: transport.h:308
struct GNUNET_TIME_RelativeNBO timeout
Allowed delay.
Definition: transport.h:302
static void notify_send_done(void *cls)
A message from the handler's message queue to a neighbour was transmitted.

References env, Neighbour::env, Neighbour::env_size, GNUNET_assert, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_MAX_MESSAGE_SIZE, GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, GNUNET_MQ_env_get_options(), GNUNET_MQ_get_current_envelope(), GNUNET_MQ_impl_send_continue(), GNUNET_MQ_msg_nested_mh, GNUNET_MQ_notify_sent(), GNUNET_MQ_send(), GNUNET_NO, GNUNET_TIME_relative_hton(), GNUNET_TIME_UNIT_MINUTES, GNUNET_YES, h, Neighbour::h, Neighbour::id, Neighbour::is_ready, LOG, mq, GNUNET_ARM_Handle::mq, msg, notify_send_done(), OutboundMessage::peer, OutboundMessage::priority, GNUNET_MessageHeader::size, OutboundMessage::timeout, Neighbour::timeout_task, and GNUNET_MessageHeader::type.

Referenced by handle_connect().

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

◆ mq_destroy_impl()

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

Handle destruction of a message queue.

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

Parameters
mqthe message queue to destroy
impl_statestate of the implementation

Definition at line 458 of file transport_api_core.c.

459 {
460  struct Neighbour *n = impl_state;
461 
462  GNUNET_assert (mq == n->mq);
463  n->mq = NULL;
464 }

References GNUNET_assert, mq, and Neighbour::mq.

Referenced by handle_connect().

Here is the caller graph for this function:

◆ mq_cancel_impl()

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

Implementation function that cancels the currently sent message.

Should basically undo whatever mq_send_impl() did.

Parameters
mqmessage queue
impl_statestate specific to the implementation

Definition at line 475 of file transport_api_core.c.

476 {
477  struct Neighbour *n = impl_state;
478 
480  if (NULL != n->env)
481  {
483  n->env = NULL;
484  }
485 
486  n->is_ready = GNUNET_YES;
487 }

References Neighbour::env, GNUNET_assert, GNUNET_MQ_send_cancel(), GNUNET_NO, GNUNET_YES, and Neighbour::is_ready.

Referenced by handle_connect().

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

◆ peer_mq_error_handler()

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

We had an error processing a message we forwarded from a peer to the CORE service.

We should just complain about it but otherwise continue processing.

Parameters
clsclosure
errorerror code

Definition at line 499 of file transport_api_core.c.

500 {
501  /* struct Neighbour *n = cls; */
502 
503  GNUNET_break_op (0);
504 }
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.

References GNUNET_break_op.

Referenced by handle_connect().

Here is the caller graph for this function:

◆ outbound_bw_tracker_update()

static void outbound_bw_tracker_update ( void *  cls)
static

The outbound quota has changed in a way that may require us to reset the timeout.

Update the timeout.

Parameters
clsthe struct Neighbour for which the timeout changed

Definition at line 514 of file transport_api_core.c.

515 {
516  struct Neighbour *n = cls;
518 
519  if (NULL == n->timeout_task)
520  return;
524 }

References delay, GNUNET_BANDWIDTH_tracker_get_delay(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_cancel(), notify_send_done(), Neighbour::out_tracker, and Neighbour::timeout_task.

Referenced by handle_connect().

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

◆ handle_connect()

static void handle_connect ( void *  cls,
const struct ConnectInfoMessage cim 
)
static

Function we use for handling incoming connect messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_Handle *
cimmessage received

Definition at line 534 of file transport_api_core.c.

535 {
537  struct Neighbour *n;
538 
540  "Receiving CONNECT message for `%s' with quota %u\n",
541  GNUNET_i2s (&cim->id),
542  ntohl (cim->quota_out.value__));
543  n = neighbour_find (h, &cim->id);
544  if (NULL != n)
545  {
546  GNUNET_break (0); /* FIXME: this assertion seems to fail sometimes!? */
548  return;
549  }
550  n = GNUNET_new (struct Neighbour);
551  n->id = cim->id;
552  n->h = h;
553  n->is_ready = GNUNET_YES;
554  n->traffic_overhead = 0;
557  n,
561  n);
564  h->neighbours,
565  &n->id,
566  n,
568 
573  n,
574  h->handlers,
576  n);
577  if (NULL != h->nc_cb)
578  {
579  n->handlers_cls = h->nc_cb (h->cls, &n->id, n->mq);
581  }
582 }
#define MAX_BANDWIDTH_CARRY_S
Number of seconds that available bandwidth carries over (can accumulate).
void GNUNET_BANDWIDTH_tracker_update_quota(struct GNUNET_BANDWIDTH_Tracker *av, struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit)
Update quota of bandwidth tracker.
Definition: bandwidth.c:526
void GNUNET_BANDWIDTH_tracker_init2(struct GNUNET_BANDWIDTH_Tracker *av, GNUNET_BANDWIDTH_TrackerUpdateCallback update_cb, void *update_cb_cls, struct GNUNET_BANDWIDTH_Value32NBO bytes_per_second_limit, uint32_t max_carry_s, GNUNET_BANDWIDTH_ExcessNotificationCallback excess_cb, void *excess_cb_cls)
Initialize bandwidth tracker.
Definition: bandwidth.c:259
#define GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT
Bandwidth (in/out) to assume initially (before either peer has communicated any particular preference...
int GNUNET_CONTAINER_multipeermap_put(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY
There must only be one value per key; storing a value should fail if a value under the same key alrea...
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_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:565
void GNUNET_MQ_set_handlers_closure(struct GNUNET_MQ_Handle *mq, void *handlers_cls)
Change the closure argument in all of the handlers of the mq.
Definition: mq.c:596
struct GNUNET_PeerIdentity id
Identity of the new neighbour.
Definition: transport.h:141
struct GNUNET_BANDWIDTH_Value32NBO quota_out
Current outbound quota for this peer.
Definition: transport.h:135
uint32_t value__
The actual value (bytes per second).
static void peer_mq_error_handler(void *cls, enum GNUNET_MQ_Error error)
We had an error processing a message we forwarded from a peer to the CORE service.
static void outbound_bw_tracker_update(void *cls)
The outbound quota has changed in a way that may require us to reset the timeout.
static struct Neighbour * neighbour_find(struct GNUNET_TRANSPORT_CoreHandle *h, const struct GNUNET_PeerIdentity *peer)
Get the neighbour list entry for the given peer.
static void mq_destroy_impl(struct GNUNET_MQ_Handle *mq, void *impl_state)
Handle destruction of a message queue.
static void mq_cancel_impl(struct GNUNET_MQ_Handle *mq, void *impl_state)
Implementation function that cancels the currently sent message.
static void notify_excess_cb(void *cls)
Function called by the bandwidth tracker if we have excess bandwidth.
static void mq_send_impl(struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)
Implement sending functionality of a message queue.

References GNUNET_TRANSPORT_CoreHandle::cls, disconnect_and_schedule_reconnect(), GNUNET_assert, GNUNET_BANDWIDTH_tracker_init2(), GNUNET_BANDWIDTH_tracker_update_quota(), GNUNET_break, GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_CONTAINER_multipeermap_put(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_MQ_queue_for_callbacks(), GNUNET_MQ_set_handlers_closure(), GNUNET_new, GNUNET_OK, GNUNET_YES, h, Neighbour::h, Neighbour::handlers_cls, ConnectInfoMessage::id, Neighbour::id, Neighbour::is_ready, LOG, MAX_BANDWIDTH_CARRY_S, Neighbour::mq, mq_cancel_impl(), mq_destroy_impl(), mq_send_impl(), neighbour_find(), notify_excess_cb(), Neighbour::out_tracker, outbound_bw_tracker_update(), peer_mq_error_handler(), ConnectInfoMessage::quota_out, Neighbour::traffic_overhead, and GNUNET_BANDWIDTH_Value32NBO::value__.

Here is the call graph for this function:

◆ handle_disconnect()

static void handle_disconnect ( void *  cls,
const struct DisconnectInfoMessage dim 
)
static

Function we use for handling incoming disconnect messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_CoreHandle *
dimmessage received

Definition at line 592 of file transport_api_core.c.

593 {
595  struct Neighbour *n;
596 
597  GNUNET_break (ntohl (dim->reserved) == 0);
599  "Receiving DISCONNECT message for `%s'.\n",
600  GNUNET_i2s (&dim->peer));
601  n = neighbour_find (h, &dim->peer);
602  if (NULL == n)
603  {
604  GNUNET_break (0);
606  return;
607  }
609 }
uint32_t reserved
Reserved, always zero.
Definition: transport.h:159
struct GNUNET_PeerIdentity peer
Who got disconnected?
Definition: transport.h:164

References GNUNET_TRANSPORT_CoreHandle::cls, disconnect_and_schedule_reconnect(), GNUNET_assert, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_YES, h, LOG, neighbour_delete(), neighbour_find(), DisconnectInfoMessage::peer, and DisconnectInfoMessage::reserved.

Here is the call graph for this function:

◆ handle_send_ok()

static void handle_send_ok ( void *  cls,
const struct SendOkMessage okm 
)
static

Function we use for handling incoming send-ok messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_CoreHandle *
okmmessage received

Definition at line 619 of file transport_api_core.c.

620 {
622  struct Neighbour *n;
623  uint32_t bytes_msg;
624  uint32_t bytes_physical;
625  uint16_t success = ntohs (okm->success);
626 
627  bytes_msg = ntohs (okm->bytes_msg);
628  bytes_physical = ntohl (okm->bytes_physical);
630  "Receiving SEND_OK message, transmission to %s %s.\n",
631  GNUNET_i2s (&okm->peer),
632  success == GNUNET_OK ? "succeeded" : "failed");
633  n = neighbour_find (h, &okm->peer);
634  if (NULL == n)
635  {
636  /* We should never get a 'SEND_OK' for a peer that we are not
637  connected to */
638  GNUNET_break (0);
640  return;
641  }
642  if (bytes_physical > bytes_msg)
643  {
645  "Overhead for %u byte message was %u\n",
646  bytes_msg,
647  bytes_physical - bytes_msg);
648  n->traffic_overhead += bytes_physical - bytes_msg;
649  }
650 }
uint16_t success
GNUNET_OK if the transmission succeeded, GNUNET_SYSERR if it failed (i.e.
Definition: transport.h:234
uint16_t bytes_msg
Size of message sent.
Definition: transport.h:239
uint32_t bytes_physical
Size of message sent over wire.
Definition: transport.h:245
struct GNUNET_PeerIdentity peer
Which peer can send more now?
Definition: transport.h:251

References SendOkMessage::bytes_msg, SendOkMessage::bytes_physical, GNUNET_TRANSPORT_CoreHandle::cls, disconnect_and_schedule_reconnect(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_OK, h, LOG, neighbour_find(), SendOkMessage::peer, SendOkMessage::success, and Neighbour::traffic_overhead.

Here is the call graph for this function:

◆ check_recv()

static int check_recv ( void *  cls,
const struct InboundMessage im 
)
static

Function we use for checking incoming "inbound" messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_CoreHandle *
immessage received

Definition at line 660 of file transport_api_core.c.

661 {
662  const struct GNUNET_MessageHeader *imm;
663  uint16_t size;
664 
665  size = ntohs (im->header.size) - sizeof(*im);
666  if (size < sizeof(struct GNUNET_MessageHeader))
667  {
668  GNUNET_break (0);
669  return GNUNET_SYSERR;
670  }
671  imm = (const struct GNUNET_MessageHeader *) &im[1];
672  if (ntohs (imm->size) != size)
673  {
674  GNUNET_break (0);
675  return GNUNET_SYSERR;
676  }
677  return GNUNET_OK;
678 }
static unsigned int size
Size of the "table".
Definition: peer.c:67
Header for all communications.
struct GNUNET_MessageHeader header
Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV.
Definition: transport.h:203

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, InboundMessage::header, GNUNET_MessageHeader::size, and size.

◆ handle_recv()

static void handle_recv ( void *  cls,
const struct InboundMessage im 
)
static

Function we use for handling incoming messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_CoreHandle *
immessage received

Definition at line 688 of file transport_api_core.c.

689 {
691  const struct GNUNET_MessageHeader *imm =
692  (const struct GNUNET_MessageHeader *) &im[1];
693  struct Neighbour *n;
694 
696  "Received message of type %u with %u bytes from `%s'.\n",
697  (unsigned int) ntohs (imm->type),
698  (unsigned int) ntohs (imm->size),
699  GNUNET_i2s (&im->peer));
700  n = neighbour_find (h, &im->peer);
701  if (NULL == n)
702  {
703  GNUNET_break (0);
705  return;
706  }
707  h->rom_pending++;
708  GNUNET_MQ_inject_message (n->mq, imm);
709 }
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:202
struct GNUNET_PeerIdentity peer
Which peer sent the message?
Definition: transport.h:208

References GNUNET_TRANSPORT_CoreHandle::cls, disconnect_and_schedule_reconnect(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_MQ_inject_message(), h, LOG, Neighbour::mq, neighbour_find(), InboundMessage::peer, GNUNET_MessageHeader::size, and GNUNET_MessageHeader::type.

Here is the call graph for this function:

◆ handle_set_quota()

static void handle_set_quota ( void *  cls,
const struct QuotaSetMessage qm 
)
static

Function we use for handling incoming set quota messages.

Parameters
clsclosure, a struct GNUNET_TRANSPORT_CoreHandle *
msgmessage received

Definition at line 719 of file transport_api_core.c.

720 {
722  struct Neighbour *n;
723 
725  "Receiving SET_QUOTA message for `%s' with quota %u\n",
726  GNUNET_i2s (&qm->peer),
727  ntohl (qm->quota.value__));
728  n = neighbour_find (h, &qm->peer);
729  if (NULL == n)
730  {
731  GNUNET_break (
732  0); /* FIXME: julius reports this assertion fails sometimes? */
734  return;
735  }
737 }
struct GNUNET_BANDWIDTH_Value32NBO quota
Quota.
Definition: transport.h:185
struct GNUNET_PeerIdentity peer
About which peer are we talking here?
Definition: transport.h:190

References GNUNET_TRANSPORT_CoreHandle::cls, disconnect_and_schedule_reconnect(), GNUNET_BANDWIDTH_tracker_update_quota(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), h, LOG, neighbour_find(), Neighbour::out_tracker, QuotaSetMessage::peer, QuotaSetMessage::quota, and GNUNET_BANDWIDTH_Value32NBO::value__.

Here is the call graph for this function:

◆ reconnect()

static void reconnect ( void *  cls)
static

Try again to connect to transport service.

Parameters
clsthe handle to the transport service

Definition at line 746 of file transport_api_core.c.

747 {
750  { GNUNET_MQ_hd_var_size (hello,
752  struct GNUNET_MessageHeader,
753  h),
754  GNUNET_MQ_hd_fixed_size (connect,
756  struct ConnectInfoMessage,
757  h),
760  struct DisconnectInfoMessage,
761  h),
762  GNUNET_MQ_hd_fixed_size (send_ok,
764  struct SendOkMessage,
765  h),
766  GNUNET_MQ_hd_var_size (recv,
768  struct InboundMessage,
769  h),
770  GNUNET_MQ_hd_fixed_size (set_quota,
772  struct QuotaSetMessage,
773  h),
775  struct GNUNET_MQ_Envelope *env;
776  struct StartMessage *s;
777  uint32_t options;
778 
779  h->reconnect_task = NULL;
780  LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to transport service.\n");
781  GNUNET_assert (NULL == h->mq);
782  h->mq =
784  if (NULL == h->mq)
785  return;
787  options = 0;
788  if (h->check_self)
789  options |= 1;
790  if (NULL != h->handlers)
791  options |= 2;
792  s->options = htonl (options);
793  s->self = h->self;
794  GNUNET_MQ_send (h->mq, env);
795 }
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
struct GNUNET_MQ_Handle * GNUNET_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.
Definition: client.c:1064
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:67
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
#define GNUNET_MQ_hd_fixed_size(name, code, str, ctx)
#define GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
Message from TRANSPORT notifying about a client that connected to us.
#define GNUNET_MESSAGE_TYPE_TRANSPORT_START
Message from the core saying that the transport server should start giving it messages.
#define GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
Message from TRANSPORT notifying about a message that was received.
#define GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
Message from TRANSPORT notifying about a client that disconnected from us.
#define GNUNET_MESSAGE_TYPE_HELLO
HELLO message with friend only flag used for communicating peer addresses.
#define GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
Confirmation from TRANSPORT that message for transmission has been queued (and that the next message ...
#define GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
Message telling transport to limit its receive rate.
static void disconnect(struct GNUNET_PEERSTORE_Handle *h)
Disconnect from the peerstore service.
Message from the transport service to the library informing about neighbors.
Definition: transport.h:118
Message from the transport service to the library informing about disconnects.
Definition: transport.h:150
const struct GNUNET_CONFIGURATION_Handle * cfg
The configuration that we are using.
Definition: arm_api.c:112
Message handler for a specific message type.
Message used to notify the transport API about a message received from the network.
Definition: transport.h:199
Message used to set a particular bandwidth quota.
Definition: transport.h:176
Message used to notify the transport API that it can send another message to the transport service.
Definition: transport.h:217
Message from the transport service to the library asking to check if both processes agree about this ...
Definition: transport.h:92
uint32_t options
0: no options 1: The self field should be checked 2: this client is interested in payload traffic
Definition: transport.h:103
struct GNUNET_PeerIdentity self
Identity we think we have.
Definition: transport.h:109
static void mq_error_handler(void *cls, enum GNUNET_MQ_Error error)
Generic error handler, called with the appropriate error code and the same closure specified at the c...

References GNUNET_ARM_Handle::cfg, GNUNET_TRANSPORT_CoreHandle::cls, disconnect(), env, GNUNET_assert, GNUNET_CLIENT_connect(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_MESSAGE_TYPE_HELLO, GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT, GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT, GNUNET_MESSAGE_TYPE_TRANSPORT_RECV, GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK, GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA, GNUNET_MESSAGE_TYPE_TRANSPORT_START, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg, GNUNET_MQ_send(), h, handlers, LOG, GNUNET_ARM_Handle::mq, mq_error_handler(), options, StartMessage::options, GNUNET_ARM_Handle::reconnect_task, and StartMessage::self.

Referenced by disconnect_and_schedule_reconnect(), and GNUNET_TRANSPORT_core_connect().

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