GNUnet  0.10.x
Data Structures | Macros | Functions
ats_api_scheduling.c File Reference

automatic transport selection and outbound bandwidth determination More...

#include "platform.h"
#include "gnunet_ats_service.h"
#include "ats.h"
Include dependency graph for ats_api_scheduling.c:

Go to the source code of this file.

Data Structures

struct  GNUNET_ATS_AddressRecord
 Information we track per address, incoming or outgoing. More...
 
struct  GNUNET_ATS_SchedulingHandle
 Handle to the ATS subsystem for bandwidth/transport scheduling information. More...
 

Macros

#define INTERFACE_PROCESSING_INTERVAL   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
 How frequently do we scan the interfaces for changes to the addresses? More...
 
#define LOG(kind, ...)   GNUNET_log_from(kind, "ats-scheduling-api", __VA_ARGS__)
 
#define NOT_FOUND   0
 Session ID we use if there is no session / slot. More...
 

Functions

static void reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
 Re-establish the connection to the ATS service. More...
 
static void reconnect_task (void *cls)
 Re-establish the connection to the ATS service. More...
 
static void force_reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
 Disconnect from ATS and then reconnect. More...
 
static struct GNUNET_ATS_AddressRecordfind_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id, const struct GNUNET_PeerIdentity *peer)
 Find the session object corresponding to the given session ID. More...
 
static uint32_t find_empty_session_slot (struct GNUNET_ATS_SchedulingHandle *sh)
 Get an available session ID. More...
 
static uint32_t find_session_id (struct GNUNET_ATS_SchedulingHandle *sh, struct GNUNET_ATS_Session *session, const struct GNUNET_HELLO_Address *address)
 Get the ID for the given session object. More...
 
static void release_session (struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id)
 Release the session slot from the session table (ATS service is also done using it). More...
 
static void handle_ats_session_release (void *cls, const struct GNUNET_ATS_SessionReleaseMessage *srm)
 Type of a function to call when we receive a session release message from the service. More...
 
static void handle_ats_address_suggestion (void *cls, const struct AddressSuggestionMessage *m)
 Type of a function to call when we receive a address suggestion message from the service. More...
 
static void error_handler (void *cls, enum GNUNET_MQ_Error error)
 We encountered an error handling the MQ to the ATS service. More...
 
static void send_add_address_message (struct GNUNET_ATS_SchedulingHandle *sh, const struct GNUNET_ATS_AddressRecord *ar)
 Generate and transmit the struct AddressAddMessage for the given address record. More...
 
struct GNUNET_ATS_SchedulingHandleGNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_ATS_AddressSuggestionCallback suggest_cb, void *suggest_cb_cls)
 Initialize the ATS subsystem. More...
 
void GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
 Client is done with ATS scheduling, release resources. More...
 
struct GNUNET_ATS_AddressRecordGNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh, const struct GNUNET_HELLO_Address *address, struct GNUNET_ATS_Session *session, const struct GNUNET_ATS_Properties *prop)
 We have a new address ATS should know. More...
 
void GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar, struct GNUNET_ATS_Session *session)
 An address was used to initiate a session. More...
 
int GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar, struct GNUNET_ATS_Session *session)
 A session was destroyed, disassociate it from the given address record. More...
 
void GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar, const struct GNUNET_ATS_Properties *prop)
 We have updated performance statistics for a given address. More...
 
void GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar)
 An address got destroyed, stop using it as a valid address. More...
 

Detailed Description

automatic transport selection and outbound bandwidth determination

Author
Christian Grothoff
Matthias Wachs

TODO:

Definition in file ats_api_scheduling.c.

Macro Definition Documentation

◆ INTERFACE_PROCESSING_INTERVAL

#define INTERFACE_PROCESSING_INTERVAL   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)

How frequently do we scan the interfaces for changes to the addresses?

Definition at line 41 of file ats_api_scheduling.c.

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from(kind, "ats-scheduling-api", __VA_ARGS__)

◆ NOT_FOUND

#define NOT_FOUND   0

Session ID we use if there is no session / slot.

Definition at line 48 of file ats_api_scheduling.c.

Referenced by find_empty_session_slot(), find_session_id(), GNUNET_ATS_address_add(), and release_session().

Function Documentation

◆ reconnect()

static void reconnect ( struct GNUNET_ATS_SchedulingHandle sh)
static

Re-establish the connection to the ATS service.

Parameters
shhandle to use to re-connect.

Definition at line 514 of file ats_api_scheduling.c.

References GNUNET_ATS_SchedulingHandle::cfg, error_handler(), force_reconnect(), GNUNET_assert, GNUNET_break, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION, GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE, GNUNET_MESSAGE_TYPE_ATS_START, GNUNET_MQ_handler_end, GNUNET_MQ_hd_fixed_size, GNUNET_MQ_msg, GNUNET_MQ_send(), init, GNUNET_ATS_SchedulingHandle::mq, send_add_address_message(), GNUNET_ATS_SchedulingHandle::session_array, GNUNET_ATS_SchedulingHandle::session_array_size, ClientStartMessage::start_flag, and START_FLAG_SCHEDULING.

Referenced by GNUNET_ATS_scheduling_init(), and reconnect_task().

515 {
517  GNUNET_MQ_hd_fixed_size (ats_session_release,
520  sh),
521  GNUNET_MQ_hd_fixed_size (ats_address_suggestion,
524  sh),
526  };
527  struct GNUNET_MQ_Envelope *ev;
528  struct ClientStartMessage *init;
529  unsigned int i;
530  struct GNUNET_ATS_AddressRecord *ar;
531 
532  GNUNET_assert (NULL == sh->mq);
533  sh->mq = GNUNET_CLIENT_connect (sh->cfg,
534  "ats",
535  handlers,
536  &error_handler,
537  sh);
538  if (NULL == sh->mq)
539  {
540  GNUNET_break (0);
541  force_reconnect (sh);
542  return;
543  }
544  ev = GNUNET_MQ_msg (init,
546  init->start_flag = htonl (START_FLAG_SCHEDULING);
547  GNUNET_MQ_send (sh->mq, ev);
548  if (NULL == sh->mq)
549  return;
550  for (i=0;i<sh->session_array_size;i++)
551  {
552  ar = sh->session_array[i];
553  if (NULL == ar)
554  continue;
555  send_add_address_message (sh, ar);
556  if (NULL == sh->mq)
557  return;
558  }
559 }
#define GNUNET_MESSAGE_TYPE_ATS_START
Type of the &#39;struct ClientStartMessage&#39; sent by clients to ATS to identify the type of the client...
static void send_add_address_message(struct GNUNET_ATS_SchedulingHandle *sh, const struct GNUNET_ATS_AddressRecord *ar)
Generate and transmit the struct AddressAddMessage for the given address record.
struct GNUNET_ATS_AddressRecord ** session_array
Array of session objects (we need to translate them to numbers and back for the protocol; the offset ...
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:901
const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
uint32_t start_flag
NBO value of an enum StartFlag.
Definition: ats.h:80
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION
Type of the &#39;struct AddressSuggestionMessage&#39; sent by ATS to clients to suggest switching to a differ...
#define GNUNET_MQ_hd_fixed_size(name, code, str, ctx)
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:67
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE
Type of the &#39;struct SessionReleaseMessage&#39; sent by ATS to client to confirm that a session ID was des...
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
This is a scheduling client (aka transport service)
Definition: ats.h:43
unsigned int session_array_size
Size of the session_array.
Information we track per address, incoming or outgoing.
static void error_handler(void *cls, enum GNUNET_MQ_Error error)
We encountered an error handling the MQ to the ATS service.
Message handler for a specific message type.
static char * init
Set to the name of a service to start.
Definition: gnunet-arm.c:69
ATS Service suggests to the transport service to use the address identified by the given session_id f...
Definition: ats.h:248
struct GNUNET_MQ_Handle * mq
Message queue for sending requests to the ATS service.
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:353
Message sent by ATS service to client to confirm that it is done using the given session ID...
Definition: ats.h:221
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
First message any client sends to ATS, used to self-identify (what type of client this is)...
Definition: ats.h:70
static void force_reconnect(struct GNUNET_ATS_SchedulingHandle *sh)
Disconnect from ATS and then reconnect.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ reconnect_task()

static void reconnect_task ( void *  cls)
static

Re-establish the connection to the ATS service.

Parameters
clshandle to use to re-connect.

Definition at line 166 of file ats_api_scheduling.c.

References reconnect(), GNUNET_ATS_AddressRecord::sh, and GNUNET_ATS_SchedulingHandle::task.

Referenced by force_reconnect().

167 {
168  struct GNUNET_ATS_SchedulingHandle *sh = cls;
169 
170  sh->task = NULL;
171  reconnect (sh);
172 }
struct GNUNET_SCHEDULER_Task * task
Task to trigger reconnect.
Handle to the ATS subsystem for bandwidth/transport scheduling information.
static struct SolverHandle * sh
static void reconnect(struct GNUNET_ATS_SchedulingHandle *sh)
Re-establish the connection to the ATS service.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ force_reconnect()

static void force_reconnect ( struct GNUNET_ATS_SchedulingHandle sh)
static

Disconnect from ATS and then reconnect.

Parameters
shour handle

Definition at line 181 of file ats_api_scheduling.c.

References GNUNET_ATS_SchedulingHandle::backoff, GNUNET_BANDWIDTH_ZERO, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, GNUNET_ATS_SchedulingHandle::mq, reconnect_task(), GNUNET_ATS_SchedulingHandle::suggest_cb, GNUNET_ATS_SchedulingHandle::suggest_cb_cls, and GNUNET_ATS_SchedulingHandle::task.

Referenced by error_handler(), handle_ats_address_suggestion(), reconnect(), and release_session().

182 {
183  if (NULL != sh->mq)
184  {
185  GNUNET_MQ_destroy (sh->mq);
186  sh->mq = NULL;
187  }
188  sh->suggest_cb (sh->suggest_cb_cls,
189  NULL, NULL, NULL,
195  sh);
196 }
struct GNUNET_SCHEDULER_Task * task
Task to trigger reconnect.
GNUNET_ATS_AddressSuggestionCallback suggest_cb
Callback to invoke on suggestions.
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:1246
void * suggest_cb_cls
Closure for suggest_cb.
#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 backoff
Reconnect backoff delay.
#define GNUNET_BANDWIDTH_ZERO
Convenience definition to use for 0-bandwidth.
struct GNUNET_MQ_Handle * mq
Message queue for sending requests to the ATS service.
static void reconnect_task(void *cls)
Re-establish the connection to the ATS service.
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:824
Here is the call graph for this function:
Here is the caller graph for this function:

◆ find_session()

static struct GNUNET_ATS_AddressRecord* find_session ( struct GNUNET_ATS_SchedulingHandle sh,
uint32_t  session_id,
const struct GNUNET_PeerIdentity peer 
)
static

Find the session object corresponding to the given session ID.

Parameters
shour handle
session_idcurrent session ID
peerpeer the session belongs to
Returns
the session object (or NULL)

Definition at line 208 of file ats_api_scheduling.c.

References GNUNET_ATS_AddressRecord::address, GNUNET_break, GNUNET_memcmp, GNUNET_HELLO_Address::peer, GNUNET_ATS_SchedulingHandle::session_array, GNUNET_ATS_SchedulingHandle::session_array_size, and session_id.

Referenced by handle_ats_address_suggestion().

211 {
212  struct GNUNET_ATS_AddressRecord *ar;
213 
214  if (session_id >= sh->session_array_size)
215  {
216  GNUNET_break (0);
217  return NULL;
218  }
219  if (0 == session_id)
220  return NULL;
221  ar = sh->session_array[session_id];
222  if (NULL == ar)
223  {
224  GNUNET_break (0);
225  return NULL;
226  }
227  if (NULL == ar->address)
228  {
229  /* address was destroyed in the meantime, this can happen
230  as we communicate asynchronously with the ATS service. */
231  return NULL;
232  }
233  if (0 != GNUNET_memcmp (peer,
234  &ar->address->peer))
235  {
236  GNUNET_break (0);
237  return NULL;
238  }
239  return ar;
240 }
struct GNUNET_ATS_AddressRecord ** session_array
Array of session objects (we need to translate them to numbers and back for the protocol; the offset ...
static struct GNUNET_HashCode session_id
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
unsigned int session_array_size
Size of the session_array.
Information we track per address, incoming or outgoing.
struct GNUNET_PeerIdentity peer
For which peer is this an address?
#define GNUNET_memcmp(a, b)
Compare memory in a and b, where both must be of the same pointer type.
struct GNUNET_HELLO_Address * address
Address data.
Here is the caller graph for this function:

◆ find_empty_session_slot()

static uint32_t find_empty_session_slot ( struct GNUNET_ATS_SchedulingHandle sh)
static

Get an available session ID.

Parameters
shour handle
Returns
an unused slot, but never NOT_FOUND (0)

Definition at line 250 of file ats_api_scheduling.c.

References GNUNET_array_grow, GNUNET_assert, NOT_FOUND, GNUNET_ATS_SchedulingHandle::session_array, and GNUNET_ATS_SchedulingHandle::session_array_size.

Referenced by GNUNET_ATS_address_add().

251 {
252  static uint32_t off;
253  uint32_t i;
254 
256  i = 0;
257  while ( ( (NOT_FOUND == off) ||
258  (NULL != sh->session_array[off % sh->session_array_size]) ) &&
259  (i < sh->session_array_size) )
260  {
261  off++;
262  i++;
263  }
264  if ( (NOT_FOUND != off % sh->session_array_size) &&
265  (NULL == sh->session_array[off % sh->session_array_size]) )
266  return off;
267  i = sh->session_array_size;
269  sh->session_array_size,
270  sh->session_array_size * 2);
271  return i;
272 }
struct GNUNET_ATS_AddressRecord ** session_array
Array of session objects (we need to translate them to numbers and back for the protocol; the offset ...
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define NOT_FOUND
Session ID we use if there is no session / slot.
#define GNUNET_array_grow(arr, size, tsize)
Grow a well-typed (!) array.
unsigned int session_array_size
Size of the session_array.
Here is the caller graph for this function:

◆ find_session_id()

static uint32_t find_session_id ( struct GNUNET_ATS_SchedulingHandle sh,
struct GNUNET_ATS_Session session,
const struct GNUNET_HELLO_Address address 
)
static

Get the ID for the given session object.

Parameters
shour handle
sessionsession object
addressthe address we are looking for
Returns
the session id or NOT_FOUND for error

Definition at line 284 of file ats_api_scheduling.c.

References GNUNET_ATS_AddressRecord::address, GNUNET_break, GNUNET_HELLO_address_cmp(), GNUNET_memcmp, GNUNET_NO, GNUNET_ATS_AddressRecord::in_destroy, NOT_FOUND, GNUNET_HELLO_Address::peer, GNUNET_ATS_AddressRecord::session, GNUNET_ATS_SchedulingHandle::session_array, and GNUNET_ATS_SchedulingHandle::session_array_size.

Referenced by GNUNET_ATS_address_add().

287 {
288  uint32_t i;
289 
290  if (NULL == address)
291  {
292  GNUNET_break (0);
293  return NOT_FOUND;
294  }
295  for (i = 1; i < sh->session_array_size; i++)
296  if ( (NULL != sh->session_array[i]) &&
297  (GNUNET_NO == sh->session_array[i]->in_destroy) &&
298  ( (session == sh->session_array[i]->session) ||
299  (NULL == sh->session_array[i]->session) ) &&
300  (0 == GNUNET_memcmp (&address->peer,
301  &sh->session_array[i]->address->peer)) &&
302  (0 == GNUNET_HELLO_address_cmp (address,
303  sh->session_array[i]->address)) )
304  return i;
305  return NOT_FOUND;
306 }
struct GNUNET_ATS_AddressRecord ** session_array
Array of session objects (we need to translate them to numbers and back for the protocol; the offset ...
#define GNUNET_NO
Definition: gnunet_common.h:81
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_ATS_Session * session
Session handle.
int GNUNET_HELLO_address_cmp(const struct GNUNET_HELLO_Address *a1, const struct GNUNET_HELLO_Address *a2)
Compare two addresses.
Definition: address.c:130
#define NOT_FOUND
Session ID we use if there is no session / slot.
unsigned int session_array_size
Size of the session_array.
struct GNUNET_PeerIdentity peer
For which peer is this an address?
#define GNUNET_memcmp(a, b)
Compare memory in a and b, where both must be of the same pointer type.
struct GNUNET_HELLO_Address * address
Address data.
int in_destroy
We&#39;re about to destroy this address record, just ATS does not know this yet.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ release_session()

static void release_session ( struct GNUNET_ATS_SchedulingHandle sh,
uint32_t  session_id 
)
static

Release the session slot from the session table (ATS service is also done using it).

Parameters
shour handle
session_ididentifies session that is no longer valid

Definition at line 317 of file ats_api_scheduling.c.

References GNUNET_ATS_AddressRecord::address, force_reconnect(), GNUNET_break, GNUNET_free, GNUNET_HELLO_address_free, NOT_FOUND, GNUNET_ATS_AddressRecord::session, GNUNET_ATS_SchedulingHandle::session_array, GNUNET_ATS_SchedulingHandle::session_array_size, and session_id.

Referenced by handle_ats_session_release().

319 {
320  struct GNUNET_ATS_AddressRecord *ar;
321 
322  if (NOT_FOUND == session_id)
323  return;
324  if (session_id >= sh->session_array_size)
325  {
326  GNUNET_break (0);
327  force_reconnect (sh);
328  return;
329  }
330  /* this slot should have been removed from remove_session before */
331  ar = sh->session_array[session_id];
332  if (NULL != ar->session)
333  {
334  GNUNET_break (0);
335  force_reconnect (sh);
336  return;
337  }
339  GNUNET_free (ar);
340  sh->session_array[session_id] = NULL;
341 }
struct GNUNET_ATS_AddressRecord ** session_array
Array of session objects (we need to translate them to numbers and back for the protocol; the offset ...
static struct GNUNET_HashCode session_id
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_ATS_Session * session
Session handle.
#define NOT_FOUND
Session ID we use if there is no session / slot.
unsigned int session_array_size
Size of the session_array.
Information we track per address, incoming or outgoing.
struct GNUNET_HELLO_Address * address
Address data.
#define GNUNET_HELLO_address_free(addr)
Free an address.
#define GNUNET_free(ptr)
Wrapper around free.
static void force_reconnect(struct GNUNET_ATS_SchedulingHandle *sh)
Disconnect from ATS and then reconnect.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ handle_ats_session_release()

static void handle_ats_session_release ( void *  cls,
const struct GNUNET_ATS_SessionReleaseMessage srm 
)
static

Type of a function to call when we receive a session release message from the service.

Parameters
clsthe struct GNUNET_ATS_SchedulingHandle
srmmessage received

Definition at line 352 of file ats_api_scheduling.c.

References release_session(), GNUNET_ATS_SessionReleaseMessage::session_id, and GNUNET_ATS_AddressRecord::sh.

354 {
355  struct GNUNET_ATS_SchedulingHandle *sh = cls;
356 
357  /* Note: peer field in srm not necessary right now,
358  but might be good to have in the future */
359  release_session (sh,
360  ntohl (srm->session_id));
361 }
Handle to the ATS subsystem for bandwidth/transport scheduling information.
uint32_t session_id
Number the client used to identify the session.
Definition: ats.h:231
static struct SolverHandle * sh
static void release_session(struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id)
Release the session slot from the session table (ATS service is also done using it).
Here is the call graph for this function:

◆ handle_ats_address_suggestion()

static void handle_ats_address_suggestion ( void *  cls,
const struct AddressSuggestionMessage m 
)
static

Type of a function to call when we receive a address suggestion message from the service.

Parameters
clsthe struct GNUNET_ATS_SchedulingHandle
mmessage received

Definition at line 372 of file ats_api_scheduling.c.

References GNUNET_ATS_AddressRecord::address, GNUNET_ATS_SchedulingHandle::backoff, AddressSuggestionMessage::bandwidth_in, AddressSuggestionMessage::bandwidth_out, find_session(), force_reconnect(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_HELLO_address_check_option(), GNUNET_HELLO_ADDRESS_INFO_INBOUND, GNUNET_i2s(), GNUNET_TIME_UNIT_ZERO, GNUNET_YES, GNUNET_ATS_AddressRecord::in_destroy, LOG, AddressSuggestionMessage::peer, GNUNET_HELLO_Address::peer, GNUNET_ATS_AddressRecord::session, session_id, AddressSuggestionMessage::session_id, GNUNET_ATS_AddressRecord::sh, GNUNET_ATS_AddressRecord::slot, GNUNET_ATS_SchedulingHandle::suggest_cb, GNUNET_ATS_SchedulingHandle::suggest_cb_cls, GNUNET_HELLO_Address::transport_name, and GNUNET_BANDWIDTH_Value32NBO::value__.

374 {
375  struct GNUNET_ATS_SchedulingHandle *sh = cls;
376  struct GNUNET_ATS_AddressRecord *ar;
377  uint32_t session_id;
378 
379  session_id = ntohl (m->session_id);
380  if (0 == session_id)
381  {
382  GNUNET_break (0);
383  force_reconnect (sh);
384  return;
385  }
386  ar = find_session (sh,
387  session_id,
388  &m->peer);
389  if (NULL == ar)
390  {
391  GNUNET_break (0);
392  force_reconnect (sh);
393  return;
394  }
395  if (NULL == sh->suggest_cb)
396  return;
397  if (GNUNET_YES == ar->in_destroy)
398  {
399  /* ignore suggestion, as this address is dying, unless BW is 0,
400  in that case signal 'disconnect' via BW 0 */
401  if ( (0 == ntohl (m->bandwidth_out.value__)) &&
402  (0 == ntohl (m->bandwidth_in.value__)) )
403  {
405  "ATS suggests disconnect from peer `%s' with BW %u/%u\n",
406  GNUNET_i2s (&ar->address->peer),
407  (unsigned int) ntohl (m->bandwidth_out.value__),
408  (unsigned int) ntohl (m->bandwidth_in.value__));
409  sh->suggest_cb (sh->suggest_cb_cls,
410  &m->peer,
411  NULL,
412  NULL,
413  m->bandwidth_out,
414  m->bandwidth_in);
415  }
416  return;
417  }
418  if ( (NULL == ar->session) &&
421  {
422  GNUNET_break (0);
423  return;
424  }
427  "ATS suggests address slot %u for peer `%s' using plugin %s\n",
428  ar->slot,
429  GNUNET_i2s (&ar->address->peer),
430  ar->address->transport_name);
431  sh->suggest_cb (sh->suggest_cb_cls,
432  &m->peer,
433  ar->address,
434  ar->session,
435  m->bandwidth_out,
436  m->bandwidth_in);
437 }
static struct GNUNET_ATS_AddressRecord * find_session(struct GNUNET_ATS_SchedulingHandle *sh, uint32_t session_id, const struct GNUNET_PeerIdentity *peer)
Find the session object corresponding to the given session ID.
Handle to the ATS subsystem for bandwidth/transport scheduling information.
GNUNET_ATS_AddressSuggestionCallback suggest_cb
Callback to invoke on suggestions.
static struct GNUNET_HashCode session_id
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in
How much bandwidth we are allowed for receiving.
Definition: ats.h:276
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out
How much bandwidth we are allowed for sending.
Definition: ats.h:271
#define LOG(kind,...)
uint32_t session_id
Internal number this client uses to refer to the address this suggestion is about.
Definition: ats.h:259
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
uint32_t value__
The actual value (bytes per second).
struct GNUNET_ATS_Session * session
Session handle.
int GNUNET_HELLO_address_check_option(const struct GNUNET_HELLO_Address *address, enum GNUNET_HELLO_AddressInfo option)
Check if an address has a local option set.
Definition: address.c:39
void * suggest_cb_cls
Closure for suggest_cb.
This is an inbound address and cannot be used to initiate an outbound connection to another peer...
static struct SolverHandle * sh
const char * transport_name
Name of the transport plugin enabling the communication using this address.
Information we track per address, incoming or outgoing.
struct GNUNET_PeerIdentity peer
For which peer is this an address?
#define GNUNET_TIME_UNIT_ZERO
Relative time zero.
struct GNUNET_TIME_Relative backoff
Reconnect backoff delay.
struct GNUNET_HELLO_Address * address
Address data.
#define GNUNET_YES
Definition: gnunet_common.h:80
struct GNUNET_PeerIdentity peer
Which peer is this about? (Technically redundant, as the session_id should be sufficient, but may enable client to find the session faster and/or check consistency).
Definition: ats.h:266
int in_destroy
We&#39;re about to destroy this address record, just ATS does not know this yet.
uint32_t slot
Which slot (index) in the session array does this record correspond to? FIXME: a linear search on thi...
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
static void force_reconnect(struct GNUNET_ATS_SchedulingHandle *sh)
Disconnect from ATS and then reconnect.
Here is the call graph for this function:

◆ error_handler()

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

We encountered an error handling the MQ to the ATS service.

Reconnect.

Parameters
clsthe struct GNUNET_ATS_SchedulingHandle
errordetails about the error

Definition at line 448 of file ats_api_scheduling.c.

References force_reconnect(), GNUNET_ERROR_TYPE_DEBUG, LOG, and GNUNET_ATS_AddressRecord::sh.

Referenced by reconnect().

450 {
451  struct GNUNET_ATS_SchedulingHandle *sh = cls;
452 
454  "ATS connection died (code %d), reconnecting\n",
455  (int) error);
456  force_reconnect (sh);
457 }
Handle to the ATS subsystem for bandwidth/transport scheduling information.
#define LOG(kind,...)
static struct SolverHandle * sh
static void force_reconnect(struct GNUNET_ATS_SchedulingHandle *sh)
Disconnect from ATS and then reconnect.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ send_add_address_message()

static void send_add_address_message ( struct GNUNET_ATS_SchedulingHandle sh,
const struct GNUNET_ATS_AddressRecord ar 
)
static

Generate and transmit the struct AddressAddMessage for the given address record.

Parameters
shthe scheduling handle to use for transmission
arthe address to inform the ATS service about

Definition at line 468 of file ats_api_scheduling.c.

References GNUNET_ATS_AddressRecord::address, GNUNET_HELLO_Address::address, GNUNET_HELLO_Address::address_length, AddressAddMessage::address_length, AddressAddMessage::address_local_info, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_memcpy, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_NT_UNSPECIFIED, GNUNET_HELLO_Address::local_info, LOG, m, GNUNET_ATS_SchedulingHandle::mq, AddressAddMessage::peer, GNUNET_HELLO_Address::peer, AddressAddMessage::plugin_name_length, pm, GNUNET_ATS_AddressRecord::properties, AddressAddMessage::properties, GNUNET_ATS_PropertiesNBO::scope, GNUNET_ATS_AddressRecord::session, AddressAddMessage::session_id, GNUNET_ATS_AddressRecord::slot, and GNUNET_HELLO_Address::transport_name.

Referenced by GNUNET_ATS_address_add(), and reconnect().

470 {
471  struct GNUNET_MQ_Envelope *ev;
472  struct AddressAddMessage *m;
473  char *pm;
474  size_t namelen;
475  size_t msize;
476 
477  if (NULL == sh->mq)
478  return; /* disconnected, skip for now */
480  namelen = strlen (ar->address->transport_name) + 1;
481  msize = ar->address->address_length + namelen;
483  m->peer = ar->address->peer;
484  m->address_length = htons (ar->address->address_length);
485  m->address_local_info = htonl ((uint32_t) ar->address->local_info);
486  m->plugin_name_length = htons (namelen);
487  m->session_id = htonl (ar->slot);
488  m->properties = ar->properties;
489 
491  "Adding address for peer `%s', plugin `%s', session %p slot %u\n",
492  GNUNET_i2s (&ar->address->peer),
493  ar->address->transport_name,
494  ar->session,
495  ar->slot);
496  pm = (char *) &m[1];
497  GNUNET_memcpy (pm,
498  ar->address->address,
499  ar->address->address_length);
500  if (NULL != ar->address->transport_name)
502  ar->address->transport_name,
503  namelen);
504  GNUNET_MQ_send (sh->mq, ev);
505 }
size_t address_length
Number of bytes in address.
uint16_t address_length
Number of bytes in the address that follows this struct.
Definition: ats.h:122
enum GNUNET_HELLO_AddressInfo local_info
Extended information about address.
const void * address
Binary representation of the address (plugin-specific).
struct GNUNET_PeerIdentity peer
Identity of the peer that this address is for.
Definition: ats.h:132
struct GNUNET_ATS_PropertiesNBO properties
Performance properties of the address.
Definition: ats.h:149
uint32_t scope
Which network scope does the respective address belong to? This property does not change...
#define LOG(kind,...)
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_ATS_Session * session
Session handle.
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:99
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct...
Definition: gnunet_mq_lib.h:52
#define GNUNET_memcpy(dst, src, n)
const char * transport_name
Name of the transport plugin enabling the communication using this address.
uint16_t plugin_name_length
Number of bytes in the plugin name that follows this struct.
Definition: ats.h:127
struct GNUNET_ATS_PropertiesNBO properties
Performance data about the address.
struct GNUNET_PeerIdentity peer
For which peer is this an address?
uint32_t address_local_info
Local-only information of the address, see enum GNUNET_HELLO_AddressInfo.
Definition: ats.h:144
struct GNUNET_MQ_Handle * mq
Message queue for sending requests to the ATS service.
struct GNUNET_HELLO_Address * address
Address data.
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:353
#define GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD
Type of the &#39;struct AddressUpdateMessage&#39; sent by client to ATS to add a new address.
uint32_t session_id
Internal number this client will henceforth use to refer to this address.
Definition: ats.h:138
uint32_t slot
Which slot (index) in the session array does this record correspond to? FIXME: a linear search on thi...
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
static struct GNUNET_TRANSPORT_PluginMonitor * pm
Handle if we are monitoring plugin session activity.
Category of last resort.
Definition: gnunet_nt_lib.h:40
Scheduling client to ATS service: here is another address you can use.
Definition: ats.h:112
Here is the call graph for this function:
Here is the caller graph for this function: