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

ATS simple solver. More...

#include "platform.h"
#include "gnunet_ats_plugin_new.h"
#include "gnunet_hello_lib.h"
#include "gnunet_peerstore_service.h"
#include "plugin_ats2_common.c"
Include dependency graph for plugin_ats2_simple.c:

Go to the source code of this file.

Data Structures

struct  Hello
 Entry in list of addresses we could try per peer. More...
 
struct  GNUNET_ATS_SessionHandle
 Internal representation of a session by the plugin. More...
 
struct  Peer
 Information about preferences and sessions we track per peer. More...
 
struct  Network
 Representation of a network (to be expanded...) More...
 
struct  SimpleHandle
 A handle for the proportional solver. More...
 
struct  Counters
 Closure for update_counters and update_allocation. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from(kind, "ats-simple", __VA_ARGS__)
 
#define SUGGEST_FREQ   GNUNET_TIME_UNIT_SECONDS
 Base frequency at which we suggest addresses to transport. More...
 
#define MIN_BANDWIDTH_PER_SESSION   1024
 What is the minimum bandwidth we always try to allocate for any session that is up? (May still be scaled down lower if the number of sessions is so high that the total bandwidth is insufficient to allow for this value to be granted.) More...
 

Functions

struct Peerlookup_peer (struct SimpleHandle *h, const struct GNUNET_PeerIdentity *pid)
 Lookup peer in the peers map. More...
 
static int peer_test_dead (struct Peer *p)
 Check if there is any interesting information left we store about the peer in p. More...
 
static void suggest_hello (struct Hello *hello)
 Contact the transport service and suggest to it to try connecting to the address of hello. More...
 
static void suggest_start_cb (void *cls)
 Consider suggesting a HELLO (without a session) to transport. More...
 
static void watch_cb (void *cls, const struct GNUNET_PEERSTORE_Record *record, const char *emsg)
 Function called by PEERSTORE for each matching record. More...
 
static struct Peerpeer_add (struct SimpleHandle *h, const struct GNUNET_PeerIdentity *pid)
 Find or add peer if necessary. More...
 
static void peer_free (struct Peer *p)
 Free the entry (and associated tasks) of peer p. More...
 
static void consider_notify_transport (struct GNUNET_ATS_SessionHandle *sh)
 Check if the new allocation for sh is significantly different from the last one, and if so, tell transport. More...
 
static int update_counters (void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
 Function used to iterate over all peers and collect counter data. More...
 
static int update_allocation (void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
 Function used to iterate over all peers and collect counter data. More...
 
static void update (struct SimpleHandle *h)
 The world changed, recalculate our allocations. More...
 
static struct GNUNET_ATS_PreferenceHandle * simple_preference_add (void *cls, const struct GNUNET_ATS_Preference *pref)
 The plugin should begin to respect a new preference. More...
 
static void simple_preference_del (void *cls, struct GNUNET_ATS_PreferenceHandle *ph, const struct GNUNET_ATS_Preference *pref)
 The plugin should end respecting a preference. More...
 
static struct GNUNET_ATS_SessionHandlesimple_session_add (void *cls, const struct GNUNET_ATS_SessionData *data, const char *address)
 Transport established a new session with performance characteristics given in data. More...
 
static void simple_session_update (void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
 data changed for a given sh, solver should consider the updated performance characteristics. More...
 
static void simple_session_del (void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
 A session went away. More...
 
void * libgnunet_plugin_ats2_simple_init (void *cls)
 Function invoked when the plugin is loaded. More...
 
void * libgnunet_plugin_ats2_simple_done (void *cls)
 Function used to unload the plugin. More...
 

Detailed Description

ATS simple solver.

Author
Matthias Wachs
Christian Grothoff

TODO:

Definition in file plugin_ats2_simple.c.

Macro Definition Documentation

◆ LOG

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

Definition at line 34 of file plugin_ats2_simple.c.

◆ SUGGEST_FREQ

#define SUGGEST_FREQ   GNUNET_TIME_UNIT_SECONDS

Base frequency at which we suggest addresses to transport.

Multiplied by the square of the number of active connections (and randomized) to calculate the actual frequency at which we will suggest addresses to the transport. Furthermore, each address is also bounded by an exponential back-off.

Definition at line 44 of file plugin_ats2_simple.c.

Referenced by suggest_start_cb().

◆ MIN_BANDWIDTH_PER_SESSION

#define MIN_BANDWIDTH_PER_SESSION   1024

What is the minimum bandwidth we always try to allocate for any session that is up? (May still be scaled down lower if the number of sessions is so high that the total bandwidth is insufficient to allow for this value to be granted.)

Definition at line 52 of file plugin_ats2_simple.c.

Referenced by update_counters().

Function Documentation

◆ lookup_peer()

struct Peer* lookup_peer ( struct SimpleHandle h,
const struct GNUNET_PeerIdentity pid 
)

Lookup peer in the peers map.

Parameters
hhandle to look up in
pidpeer identity to look up by
Returns
NULL for not found

Definition at line 309 of file plugin_ats2_simple.c.

References GNUNET_CONTAINER_multipeermap_get(), and SimpleHandle::peers.

Referenced by peer_add(), and simple_preference_del().

310 {
312 }
struct GNUNET_CONTAINER_MultiPeerMap * peers
Information we track for each peer.
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.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ peer_test_dead()

static int peer_test_dead ( struct Peer p)
static

Check if there is any interesting information left we store about the peer in p.

Parameters
ppeer to test if we can drop the data structure
Returns
GNUNET_YES if no information is left in p

Definition at line 323 of file plugin_ats2_simple.c.

References Peer::bw_by_pk, GNUNET_MQ_PREFERENCE_COUNT, GNUNET_NO, GNUNET_YES, pk, and Peer::sh_head.

Referenced by simple_preference_del(), and simple_session_del().

324 {
326  pk++)
327  if (0 != p->bw_by_pk[pk])
328  return GNUNET_NO;
329  if (NULL != p->sh_head)
330  return GNUNET_NO;
331  return GNUNET_YES;
332 }
uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT]
Array where we sum up the bandwidth requests received indexed by preference kind (see enum GNUNET_MQ_...
static struct GNUNET_CRYPTO_EddsaPrivateKey * pk
Private key of this peer.
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
GNUNET_MQ_PreferenceKind
Enum defining all known preference categories.
#define GNUNET_MQ_PREFERENCE_COUNT
#define GNUNET_YES
Definition: gnunet_common.h:77
Here is the caller graph for this function:

◆ suggest_hello()

static void suggest_hello ( struct Hello hello)
static

Contact the transport service and suggest to it to try connecting to the address of hello.

Updates backoff and timestamp values in the hello.

Parameters
hello[in,out]address suggestion to make

Definition at line 343 of file plugin_ats2_simple.c.

References Hello::address, Hello::backoff, GNUNET_ATS_PluginEnvironment::cls, SimpleHandle::env, Hello::expiration, GNUNET_TIME_absolute_get(), GNUNET_TIME_absolute_get_remaining(), GNUNET_TIME_randomized_backoff(), h, Peer::h, Hello::last_attempt, Peer::last_suggestion, p, Hello::peer, Peer::pid, and GNUNET_ATS_PluginEnvironment::suggest_cb.

Referenced by suggest_start_cb().

344 {
345  struct Peer *p = hello->peer;
346  struct SimpleHandle *h = p->h;
347 
349  hello->backoff =
352  hello->expiration));
353  h->env->suggest_cb(h->env->cls, &p->pid, hello->address);
354 }
struct GNUNET_TIME_Absolute last_suggestion
When did we last suggest an address to connect to for this peer?
struct GNUNET_TIME_Absolute last_attempt
When did we try it last?
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
struct GNUNET_ATS_PluginEnvironment * env
Our execution environment.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
struct GNUNET_TIME_Absolute expiration
When does the HELLO expire?
struct SimpleHandle * h
The handle for the proportional solver.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
struct Peer * peer
Peer this hello belongs to.
struct GNUNET_PeerIdentity pid
Which peer is this for?
void(* suggest_cb)(void *cls, const struct GNUNET_PeerIdentity *pid, const char *address)
Suggest to the transport that it should try establishing a connection using the given address...
struct GNUNET_TIME_Relative backoff
Current exponential backoff value.
Information about preferences and sessions we track per peer.
const char * address
The address we could try.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
void * cls
Closure to pass to all callbacks in this struct.
A handle for the proportional solver.
struct GNUNET_TIME_Relative GNUNET_TIME_randomized_backoff(struct GNUNET_TIME_Relative rt, struct GNUNET_TIME_Relative threshold)
Randomized exponential back-off, starting at 1 ms and going up by a factor of 2+r, where 0 <= r <= 0.5, up to a maximum of the given threshold.
Definition: time.c:758
Here is the call graph for this function:
Here is the caller graph for this function:

◆ suggest_start_cb()

static void suggest_start_cb ( void *  cls)
static

Consider suggesting a HELLO (without a session) to transport.

We look at how many active sessions we have for the peer, and if there are many, reduce the frequency of trying new addresses. Also, for each address we consider when we last tried it, and its exponential backoff if the attempt failed. Note that it is possible that this function is called when no suggestion is to be made.

In this case, we only calculate the time until we make the next suggestion.

Parameters
clsa struct Peer

Definition at line 372 of file plugin_ats2_simple.c.

References GNUNET_TIME_Absolute::abs_value_us, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_absolute_add(), GNUNET_TIME_absolute_get_remaining(), GNUNET_TIME_absolute_max(), GNUNET_TIME_randomized_backoff(), GNUNET_TIME_relative_multiply(), GNUNET_TIME_relative_to_absolute(), GNUNET_TIME_UNIT_FOREVER_ABS, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_TIME_UNIT_ZERO, Peer::h_head, Peer::h_tail, Hello::next, GNUNET_ATS_SessionHandle::next, p, GNUNET_TIME_Relative::rel_value_us, Hello::sh, Peer::sh_head, SUGGEST_FREQ, suggest_hello(), and Peer::task.

Referenced by simple_session_del(), and watch_cb().

373 {
374  struct Peer *p = cls;
376  struct Hello *hello = NULL;
378  struct GNUNET_TIME_Relative xdelay;
379  struct GNUNET_TIME_Absolute xnext;
380  unsigned int num_sessions = 0;
381  uint32_t sq;
382 
383  /* count number of active sessions */
384  for (struct GNUNET_ATS_SessionHandle *sh = p->sh_head; NULL != sh;
385  sh = sh->next)
386  num_sessions++;
387  /* calculate square of number of sessions */
388  num_sessions++; /* start with 1, even if we have zero sessions */
389  if (num_sessions < UINT16_MAX)
390  sq = num_sessions * (uint32_t)num_sessions;
391  else
392  sq = UINT32_MAX;
393  xdelay =
395  sq),
397  xnext = GNUNET_TIME_relative_to_absolute(xdelay);
398 
399  p->task = NULL;
400  while (0 == delay.rel_value_us)
401  {
402  struct Hello *next;
403  struct GNUNET_TIME_Absolute xmax;
404 
405  if (NULL != hello)
406  {
407  /* We went through the loop already once and found
408  a HELLO that is due *now*, so make a suggestion! */
409  GNUNET_break(NULL == hello->sh);
410  suggest_hello(hello);
411  hello = NULL;
413  }
414  for (struct Hello *pos = p->h_head; NULL != pos; pos = next)
415  {
416  struct GNUNET_TIME_Absolute pt;
417 
418  next = pos->next;
419  if (NULL != pos->sh)
420  continue;
421  if (0 ==
423  {
424  /* expired, remove! */
426  GNUNET_free(pos);
427  continue;
428  }
429  pt = GNUNET_TIME_absolute_add(pos->last_attempt, pos->backoff);
430  if ((NULL == hello) || (pt.abs_value_us < hpt.abs_value_us))
431  {
432  hello = pos;
433  hpt = pt;
434  }
435  }
436  if (NULL == hello)
437  return; /* no HELLOs that could still be tried */
438 
439  /* hpt is now the *earliest* possible time for any HELLO
440  but we might not want to go for as early as possible for
441  this peer. So the actual time is the max of the earliest
442  HELLO and the 'xnext' */
443  xmax = GNUNET_TIME_absolute_max(hpt, xnext);
445  }
447 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
uint64_t rel_value_us
The actual value.
static void suggest_hello(struct Hello *hello)
Contact the transport service and suggest to it to try connecting to the address of hello...
Internal representation of a session by the plugin.
struct GNUNET_TIME_Absolute GNUNET_TIME_relative_to_absolute(struct GNUNET_TIME_Relative rel)
Convert relative time to an absolute time in the future.
Definition: time.c:246
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add(struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Relative duration)
Add a given relative duration to the given start time.
Definition: time.c:393
uint64_t abs_value_us
The actual value.
#define SUGGEST_FREQ
Base frequency at which we suggest addresses to transport.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define GNUNET_TIME_UNIT_FOREVER_ABS
Constant used to specify "forever".
struct Hello * h_tail
Kept in a DLL.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
static struct SolverHandle * sh
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_max(struct GNUNET_TIME_Absolute t1, struct GNUNET_TIME_Absolute t2)
Return the maximum of two absolute time values.
Definition: time.c:317
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:440
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
struct Hello * h_head
Kept in a DLL.
Entry in list of addresses we could try per peer.
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
#define GNUNET_TIME_UNIT_ZERO
Relative time zero.
struct GNUNET_SCHEDULER_Task * task
Task used to try again to suggest an address for this peer.
Information about preferences and sessions we track per peer.
static void suggest_start_cb(void *cls)
Consider suggesting a HELLO (without a session) to transport.
struct Hello * next
Kept in a DLL.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
Time for absolute times used by GNUnet, in microseconds.
struct GNUNET_ATS_SessionHandle * sh
Is a session with this address already up? If not, set to NULL.
struct GNUNET_TIME_Relative GNUNET_TIME_randomized_backoff(struct GNUNET_TIME_Relative rt, struct GNUNET_TIME_Relative threshold)
Randomized exponential back-off, starting at 1 ms and going up by a factor of 2+r, where 0 <= r <= 0.5, up to a maximum of the given threshold.
Definition: time.c:758
#define GNUNET_free(ptr)
Wrapper around free.
Time for relative time used by GNUnet, in microseconds.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ watch_cb()

static void watch_cb ( void *  cls,
const struct GNUNET_PEERSTORE_Record record,
const char *  emsg 
)
static

Function called by PEERSTORE for each matching record.

Parameters
clsclosure with a struct Peer
recordpeerstore record information
emsgerror message, or NULL if no errors

Definition at line 458 of file plugin_ats2_simple.c.

References GNUNET_TIME_Absolute::abs_value_us, Hello::address, GNUNET_ATS_SessionHandle::address, Hello::expiration, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_free, GNUNET_HELLO_extract_address(), GNUNET_malloc, GNUNET_memcmp, GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY, GNUNET_SCHEDULER_add_now(), GNUNET_TIME_absolute_get_remaining(), Peer::h_head, Peer::h_tail, GNUNET_ATS_SessionHandle::hello, GNUNET_PEERSTORE_Record::key, Hello::next, GNUNET_ATS_SessionHandle::next, Hello::nt, p, Hello::peer, GNUNET_PEERSTORE_Record::peer, Peer::pid, Hello::sh, Peer::sh_head, suggest_start_cb(), Peer::task, GNUNET_PEERSTORE_Record::value, and GNUNET_PEERSTORE_Record::value_size.

Referenced by peer_add().

461 {
462  struct Peer *p = cls;
463  char *addr;
464  size_t alen;
465  enum GNUNET_NetworkType nt;
467  struct Hello *hello;
468 
469  if (0 != GNUNET_memcmp(&p->pid, &record->peer))
470  {
471  GNUNET_break(0);
472  return;
473  }
474  if (0 != strcmp(record->key, GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY))
475  {
476  GNUNET_break(0);
477  return;
478  }
479  addr = GNUNET_HELLO_extract_address(record->value,
480  record->value_size,
481  &p->pid,
482  &nt,
483  &expiration);
484  if (NULL == addr)
485  return; /* invalid hello, bad signature, other problem */
486  if (0 == GNUNET_TIME_absolute_get_remaining(expiration).rel_value_us)
487  {
488  /* expired, ignore */
489  GNUNET_free(addr);
490  return;
491  }
492  /* check if addr is already known */
493  for (struct Hello *he = p->h_head; NULL != he; he = he->next)
494  {
495  if (0 != strcmp(he->address, addr))
496  continue;
497  if (he->expiration.abs_value_us < expiration.abs_value_us)
498  {
499  he->expiration = expiration;
500  he->nt = nt;
501  }
502  GNUNET_free(addr);
503  return;
504  }
505  /* create new HELLO */
506  alen = strlen(addr) + 1;
507  hello = GNUNET_malloc(sizeof(struct Hello) + alen);
508  hello->address = (const char *)&hello[1];
509  hello->expiration = expiration;
510  hello->nt = nt;
511  hello->peer = p;
512  memcpy(&hello[1], addr, alen);
514  /* check if sh for this HELLO already exists */
515  for (struct GNUNET_ATS_SessionHandle *sh = p->sh_head; NULL != sh;
516  sh = sh->next)
517  {
518  if ((NULL == sh->address) || (0 != strcmp(sh->address, addr)))
519  continue;
520  GNUNET_assert(NULL == sh->hello);
521  sh->hello = hello;
522  hello->sh = sh;
523  break;
524  }
525  GNUNET_free(addr);
526  if (NULL == p->task)
528 }
enum GNUNET_NetworkType nt
Type of the network for this HELLO.
static char * expiration
Credential TTL.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
struct GNUNET_PeerIdentity peer
Peer Identity.
size_t value_size
Size of value BLOB.
Internal representation of a session by the plugin.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
char * key
Record key string.
struct Hello * h_tail
Kept in a DLL.
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
void * value
Record value BLOB.
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:1264
struct GNUNET_TIME_Absolute expiration
When does the HELLO expire?
static struct SolverHandle * sh
struct Hello * h_head
Kept in a DLL.
Entry in list of addresses we could try per peer.
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
struct Peer * peer
Peer this hello belongs to.
struct GNUNET_PeerIdentity pid
Which peer is this for?
#define GNUNET_memcmp(a, b)
Compare memory in a and b, where both must be of the same pointer type.
struct GNUNET_SCHEDULER_Task * task
Task used to try again to suggest an address for this peer.
#define GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY
Key used for storing addresses in URL format in the peerstore.
Information about preferences and sessions we track per peer.
static void suggest_start_cb(void *cls)
Consider suggesting a HELLO (without a session) to transport.
struct Hello * next
Kept in a DLL.
const char * address
The address we could try.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
Time for absolute times used by GNUnet, in microseconds.
struct GNUNET_ATS_SessionHandle * sh
Is a session with this address already up? If not, set to NULL.
char * GNUNET_HELLO_extract_address(const void *raw, size_t raw_size, const struct GNUNET_PeerIdentity *pid, enum GNUNET_NetworkType *nt, struct GNUNET_TIME_Absolute *mono_time)
Check signature and extract address record.
Definition: hello-ng.c:107
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ peer_add()

static struct Peer* peer_add ( struct SimpleHandle h,
const struct GNUNET_PeerIdentity pid 
)
static

Find or add peer if necessary.

Parameters
hour plugin handle
pidthe peer identity to add/look for
Returns
a peer handle

Definition at line 539 of file plugin_ats2_simple.c.

References GNUNET_assert, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_CONTAINER_multipeermap_put(), GNUNET_new, GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY, GNUNET_PEERSTORE_watch(), GNUNET_YES, h, Peer::h, lookup_peer(), p, SimpleHandle::peers, pid, Peer::pid, SimpleHandle::ps, watch_cb(), and Peer::wc.

Referenced by simple_preference_add(), and simple_session_add().

540 {
541  struct Peer *p = lookup_peer(h, pid);
542 
543  if (NULL != p)
544  return p;
545  p = GNUNET_new(struct Peer);
546  p->h = h;
547  p->pid = *pid;
548  p->wc = GNUNET_PEERSTORE_watch(h->ps,
549  "transport",
550  &p->pid,
552  &watch_cb,
553  p);
556  h->peers,
557  &p->pid,
558  p,
560 
561  return p;
562 }
struct GNUNET_PEERSTORE_WatchContext * GNUNET_PEERSTORE_watch(struct GNUNET_PEERSTORE_Handle *h, const char *sub_system, const struct GNUNET_PeerIdentity *peer, const char *key, GNUNET_PEERSTORE_Processor callback, void *callback_cls)
Request watching a given key User will be notified with any new values added to key.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static void watch_cb(void *cls, const struct GNUNET_PEERSTORE_Record *record, const char *emsg)
Function called by PEERSTORE for each matching record.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
struct GNUNET_PEERSTORE_Handle * ps
Handle to the peerstore service.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
struct SimpleHandle * h
The handle for the proportional solver.
struct GNUNET_CONTAINER_MultiPeerMap * peers
Information we track for each peer.
There must only be one value per key; storing a value should fail if a value under the same key alrea...
struct GNUNET_PeerIdentity pid
Which peer is this for?
#define GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY
Key used for storing addresses in URL format in the peerstore.
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.
Information about preferences and sessions we track per peer.
struct Peer * lookup_peer(struct SimpleHandle *h, const struct GNUNET_PeerIdentity *pid)
Lookup peer in the peers map.
#define GNUNET_YES
Definition: gnunet_common.h:77
static struct GNUNET_PeerIdentity pid
Identity of the peer we transmit to / connect to.
struct GNUNET_PEERSTORE_WatchContext * wc
Watch context where we are currently looking for HELLOs for this peer.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ peer_free()

static void peer_free ( struct Peer p)
static

Free the entry (and associated tasks) of peer p.

Note that p must be dead already (see peer_test_dead()).

Parameters
pthe peer to free

Definition at line 572 of file plugin_ats2_simple.c.

References GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multipeermap_remove(), GNUNET_free, GNUNET_PEERSTORE_watch_cancel(), GNUNET_SCHEDULER_cancel(), GNUNET_YES, h, Peer::h, Peer::h_head, Peer::h_tail, SimpleHandle::peers, Peer::pid, Hello::sh, Peer::sh_head, Peer::task, and Peer::wc.

Referenced by simple_preference_del(), and simple_session_del().

573 {
574  struct SimpleHandle *h = p->h;
575  struct Hello *hello;
576 
577  GNUNET_assert(NULL == p->sh_head);
578  while (NULL != (hello = p->h_head))
579  {
581  GNUNET_assert(NULL == hello->sh);
582  GNUNET_free(hello);
583  }
584  if (NULL != p->task)
585  {
587  p->task = NULL;
588  }
589  if (NULL != p->wc)
590  {
592  p->wc = NULL;
593  }
596  GNUNET_free(p);
597 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
void GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc)
Cancel a watch request.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
int GNUNET_CONTAINER_multipeermap_remove(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, const void *value)
Remove the given key-value pair from the map.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
struct Hello * h_tail
Kept in a DLL.
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
struct SimpleHandle * h
The handle for the proportional solver.
struct GNUNET_CONTAINER_MultiPeerMap * peers
Information we track for each peer.
struct Hello * h_head
Kept in a DLL.
Entry in list of addresses we could try per peer.
struct GNUNET_PeerIdentity pid
Which peer is this for?
struct GNUNET_SCHEDULER_Task * task
Task used to try again to suggest an address for this peer.
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_ATS_SessionHandle * sh
Is a session with this address already up? If not, set to NULL.
A handle for the proportional solver.
#define GNUNET_free(ptr)
Wrapper around free.
struct GNUNET_PEERSTORE_WatchContext * wc
Watch context where we are currently looking for HELLOs for this peer.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ consider_notify_transport()

static void consider_notify_transport ( struct GNUNET_ATS_SessionHandle sh)
static

Check if the new allocation for sh is significantly different from the last one, and if so, tell transport.

Parameters
shsession handle to consider updating transport for

Definition at line 607 of file plugin_ats2_simple.c.

References GNUNET_ATS_PluginEnvironment::allocate_cb, GNUNET_ATS_SessionHandle::bw_in, GNUNET_ATS_SessionHandle::bw_out, GNUNET_ATS_PluginEnvironment::cls, GNUNET_ATS_SessionHandle::data, SimpleHandle::env, GNUNET_TIME_absolute_get(), GNUNET_TIME_absolute_get_duration(), h, Peer::h, GNUNET_ATS_SessionHandle::last_allocation, SimpleHandle::networks, GNUNET_ATS_Properties::nt, Hello::nt, Hello::peer, GNUNET_ATS_SessionHandle::peer, Peer::pid, GNUNET_ATS_SessionData::prop, GNUNET_TIME_Relative::rel_value_us, GNUNET_ATS_SessionHandle::session, GNUNET_ATS_SessionHandle::target_in, GNUNET_ATS_SessionHandle::target_out, Network::total_quota_in, Network::total_quota_out, and GNUNET_BANDWIDTH_Value32NBO::value__.

Referenced by update_allocation().

608 {
609  struct Peer *peer = sh->peer;
610  struct SimpleHandle *h = peer->h;
611  enum GNUNET_NetworkType nt = sh->data->prop.nt;
613  uint64_t sig_in;
614  uint64_t sig_out;
615  int64_t delta_in;
616  int64_t delta_out;
617 
619  /* A significant change is more than 10% of the quota,
620  which is given in bytes/second */
621  sig_in = h->networks[nt].total_quota_in * (delay.rel_value_us / 1000LL) /
622  1000LL / 10;
623  sig_out = h->networks[nt].total_quota_out * (delay.rel_value_us / 1000LL) /
624  1000LL / 10;
625  delta_in = ((int64_t)ntohl(sh->bw_in.value__)) - ((int64_t)sh->target_in);
626  delta_out = ((int64_t)ntohl(sh->bw_in.value__)) - ((int64_t)sh->target_in);
627  /* we want the absolute values */
628  if (delta_in < 0)
629  delta_in = -delta_in;
630  if (INT64_MIN == delta_in)
631  delta_in = INT64_MAX; /* Handle corner case: INT_MIN == - INT_MIN */
632  if (delta_out < 0)
633  delta_out = -delta_out;
634  if (INT64_MIN == delta_out)
635  delta_out = INT64_MAX; /* Handle corner case: INT_MIN == - INT_MIN */
636  if ((sig_in > delta_in) && (sig_out > delta_out))
637  return; /* insignificant change */
638  /* change is significant, tell transport! */
639  if (sh->target_in > UINT32_MAX)
640  sh->target_in = UINT32_MAX;
641  sh->bw_in.value__ = htonl((uint32_t)sh->target_in);
642  if (sh->target_out > UINT32_MAX)
643  sh->target_out = UINT32_MAX;
644  sh->bw_out.value__ = htonl((uint32_t)sh->target_out);
646  h->env->allocate_cb(h->env->cls,
647  sh->session,
648  &peer->pid,
649  sh->bw_in,
650  sh->bw_out);
651 }
uint64_t rel_value_us
The actual value.
unsigned long long total_quota_out
Total outbound quota.
const struct GNUNET_ATS_SessionData * data
Current performance data for this session.
uint64_t target_in
New BW-in allocation given to the transport service.
struct GNUNET_BANDWIDTH_Value32NBO bw_in
Last BW-in allocation given to the transport service.
struct Peer * peer
Peer this session is for.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
uint32_t value__
The actual value (bytes per second).
struct GNUNET_ATS_PluginEnvironment * env
Our execution environment.
struct SimpleHandle * h
The handle for the proportional solver.
struct GNUNET_BANDWIDTH_Value32NBO bw_out
Last BW-out allocation given to the transport service.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
uint64_t target_out
New BW-out allocation given to the transport service.
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
unsigned long long total_quota_in
Total inbound quota.
struct GNUNET_PeerIdentity pid
Which peer is this for?
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
enum GNUNET_NetworkType nt
Which network scope does the respective address belong to?
struct GNUNET_TIME_Absolute last_allocation
When did we last update transport about the allocation? Used to dampen the frequency of updates...
void(* allocate_cb)(void *cls, struct GNUNET_ATS_Session *session, const struct GNUNET_PeerIdentity *peer, struct GNUNET_BANDWIDTH_Value32NBO bw_in, struct GNUNET_BANDWIDTH_Value32NBO bw_out)
Tell the transport that it should allocate the given bandwidth to the specified session.
Information about preferences and sessions we track per peer.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:373
struct Network networks[GNUNET_NT_COUNT]
Information we track per network type (quotas).
void * cls
Closure to pass to all callbacks in this struct.
A handle for the proportional solver.
Time for relative time used by GNUnet, in microseconds.
struct GNUNET_ATS_Session * session
The session in the main ATS service.
struct GNUNET_ATS_Properties prop
ATS performance characteristics for a session.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ update_counters()

static int update_counters ( void *  cls,
const struct GNUNET_PeerIdentity pid,
void *  value 
)
static

Function used to iterate over all peers and collect counter data.

Parameters
clsa struct Counters *
pididentity of the peer we process, unused
valuea struct Peer *
Returns
GNUNET_YES (continue to iterate)

Definition at line 701 of file plugin_ats2_simple.c.

References Peer::bw_by_pk, Counters::bw_in_by_nt, Counters::bw_out_by_nt, data, GNUNET_ATS_SessionHandle::data, GNUNET_ATS_Properties::delay, GNUNET_ATS_Properties::distance, GNUNET_assert, GNUNET_MAX, GNUNET_MIN, GNUNET_MQ_PREFERENCE_BANDWIDTH, GNUNET_MQ_PREFERENCE_COUNT, GNUNET_MQ_PREFERENCE_LATENCY, GNUNET_MQ_PREFERENCE_NONE, GNUNET_MQ_PREFERENCE_RELIABILITY, GNUNET_YES, GNUNET_ATS_Properties::goodput_in, GNUNET_ATS_Properties::goodput_out, MIN_BANDWIDTH_PER_SESSION, GNUNET_ATS_SessionHandle::next, Hello::nt, GNUNET_ATS_Properties::nt, Hello::peer, pk, GNUNET_ATS_SessionData::prop, GNUNET_TIME_Relative::rel_value_us, Hello::sh, Peer::sh_head, GNUNET_ATS_SessionHandle::target_out, GNUNET_ATS_Properties::utilization_out, and value.

Referenced by update().

702 {
703  struct Counters *c = cls;
704  struct Peer *peer = value;
706 
707  (void)pid;
708  if (NULL == peer->sh_head)
709  return GNUNET_YES; /* no available session, cannot allocate bandwidth */
710  memset(best, 0, sizeof(best));
711  for (struct GNUNET_ATS_SessionHandle *sh = peer->sh_head; NULL != sh;
712  sh = sh->next)
713  {
714  enum GNUNET_NetworkType nt = sh->data->prop.nt;
715 
716  sh->target_out = MIN_BANDWIDTH_PER_SESSION;
718  c->bw_in_by_nt[nt] +=
719  GNUNET_MAX(MIN_BANDWIDTH_PER_SESSION, sh->data->prop.goodput_in);
721  pk++)
722  {
723  /* General rule: always prefer smaller distance if possible,
724  otherwise decide by pk: */
725  switch (pk)
726  {
728  break;
729 
731  /* For bandwidth, we compare the sum of transmitted bytes and
732  confirmed transmitted bytes, so confirmed data counts twice */
733  if ((NULL == best[pk]) ||
734  (sh->data->prop.distance < best[pk]->data->prop.distance) ||
735  (sh->data->prop.utilization_out + sh->data->prop.goodput_out >
736  best[pk]->data->prop.utilization_out +
737  best[pk]->data->prop.goodput_out))
738  best[pk] = sh;
739  /* If both are equal (i.e. usually this happens if there is a zero), use
740  latency as a yardstick */
741  if ((sh->data->prop.utilization_out + sh->data->prop.goodput_out ==
742  best[pk]->data->prop.utilization_out +
743  best[pk]->data->prop.goodput_out) &&
744  (sh->data->prop.distance == best[pk]->data->prop.distance) &&
745  (sh->data->prop.delay.rel_value_us <
746  best[pk]->data->prop.delay.rel_value_us))
747  best[pk] = sh;
748  break;
749 
751  if ((NULL == best[pk]) ||
752  (sh->data->prop.distance < best[pk]->data->prop.distance) ||
753  ((sh->data->prop.distance == best[pk]->data->prop.distance) &&
754  (sh->data->prop.delay.rel_value_us <
755  best[pk]->data->prop.delay.rel_value_us)))
756  best[pk] = sh;
757  break;
758 
760  /* For reliability, we consider the ratio of goodput to utilization
761  (but use multiplicative formultations to avoid division by zero) */
762  if ((NULL == best[pk]) || (1ULL * sh->data->prop.goodput_out *
763  best[pk]->data->prop.utilization_out >
764  1ULL * sh->data->prop.utilization_out *
765  best[pk]->data->prop.goodput_out))
766  best[pk] = sh;
767  /* If both are equal (i.e. usually this happens if there is a zero), use
768  latency as a yardstick */
769  if ((1ULL * sh->data->prop.goodput_out *
770  best[pk]->data->prop.utilization_out ==
771  1ULL * sh->data->prop.utilization_out *
772  best[pk]->data->prop.goodput_out) &&
773  (sh->data->prop.distance == best[pk]->data->prop.distance) &&
774  (sh->data->prop.delay.rel_value_us <
775  best[pk]->data->prop.delay.rel_value_us))
776  best[pk] = sh;
777  break;
778  }
779  }
780  }
781  /* for first round, assign target bandwidth simply to sum of
782  requested bandwidth */
783  for (enum GNUNET_MQ_PreferenceKind pk =
784  1 /* skip GNUNET_MQ_PREFERENCE_NONE */;
786  pk++)
787  {
788  const struct GNUNET_ATS_SessionData *data = best[pk]->data;
789  enum GNUNET_NetworkType nt;
790 
791  GNUNET_assert(NULL != data);
792  nt = data->prop.nt;
793  best[pk]->target_out =
795  c->bw_out_by_nt[nt] +=
796  (uint64_t)(best[pk]->target_out - MIN_BANDWIDTH_PER_SESSION);
797  }
798  return GNUNET_YES;
799 }
uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT]
Array where we sum up the bandwidth requests received indexed by preference kind (see enum GNUNET_MQ_...
static struct GNUNET_CRYPTO_EddsaPrivateKey * pk
Private key of this peer.
uint64_t rel_value_us
The actual value.
const struct GNUNET_ATS_SessionData * data
Current performance data for this session.
uint32_t goodput_out
Confirmed successful payload on this connection from this peer to the other peer. ...
Internal representation of a session by the plugin.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
No preference was expressed.
uint64_t bw_out_by_nt[GNUNET_NT_COUNT]
Bandwidth that applications would prefer to allocate in this network type.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
GNUNET_MQ_PreferenceKind
Enum defining all known preference categories.
static char * value
Value of the record to add/remove.
#define GNUNET_MQ_PREFERENCE_COUNT
#define GNUNET_MAX(a, b)
Definition: gnunet_common.h:82
static struct SolverHandle * sh
#define GNUNET_MIN(a, b)
Definition: gnunet_common.h:80
uint64_t bw_in_by_nt[GNUNET_NT_COUNT]
Current bandwidth utilization for this network type.
struct GNUNET_TIME_Relative delay
Delay.
The preferred transmission for this envelope focuses on maximizing bandwidth.
uint64_t target_out
New BW-out allocation given to the transport service.
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
#define MIN_BANDWIDTH_PER_SESSION
What is the minimum bandwidth we always try to allocate for any session that is up? (May still be scaled down lower if the number of sessions is so high that the total bandwidth is insufficient to allow for this value to be granted.)
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
Plugin-relevant information about a session.
enum GNUNET_NetworkType nt
Which network scope does the respective address belong to?
Information about preferences and sessions we track per peer.
The preferred transmission for this envelope foces on minimizing latency.
Closure for update_counters and update_allocation.
#define GNUNET_YES
Definition: gnunet_common.h:77
uint32_t data
The data value.
unsigned int distance
Distance on network layer (required for distance-vector routing) in hops.
uint32_t utilization_out
Actual traffic on this connection from this peer to the other peer.
struct GNUNET_ATS_Properties prop
ATS performance characteristics for a session.
The preferred transmission for this envelope foces on reliability.
Here is the caller graph for this function:

◆ update_allocation()

static int update_allocation ( void *  cls,
const struct GNUNET_PeerIdentity pid,
void *  value 
)
static

Function used to iterate over all peers and collect counter data.

Parameters
clsa struct Counters *
pididentity of the peer we process, unused
valuea struct Peer *
Returns
GNUNET_YES (continue to iterate)

Definition at line 812 of file plugin_ats2_simple.c.

References consider_notify_transport(), GNUNET_ATS_SessionHandle::data, GNUNET_YES, GNUNET_ATS_SessionHandle::next, GNUNET_ATS_Properties::nt, Hello::nt, Hello::peer, GNUNET_ATS_SessionData::prop, Counters::scale_in, Counters::scale_out, Hello::sh, Peer::sh_head, GNUNET_ATS_SessionHandle::target_in, GNUNET_ATS_SessionHandle::target_out, and value.

Referenced by update().

815 {
816  struct Counters *c = cls;
817  struct Peer *peer = value;
818 
819  (void)pid;
820  for (struct GNUNET_ATS_SessionHandle *sh = peer->sh_head; NULL != sh;
821  sh = sh->next)
822  {
823  enum GNUNET_NetworkType nt = sh->data->prop.nt;
824 
825  sh->target_out = (uint64_t)(c->scale_out[nt] * sh->target_out);
826  sh->target_in = (uint64_t)(c->scale_in[nt] * sh->target_in);
828  }
829  return GNUNET_YES;
830 }
double scale_in[GNUNET_NT_COUNT]
By how much do we have to scale (up or down) our expectations for inbound bandwidth?
Internal representation of a session by the plugin.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
double scale_out[GNUNET_NT_COUNT]
By how much do we have to scale (up or down) our expectations for outbound bandwidth?
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
static char * value
Value of the record to add/remove.
static struct SolverHandle * sh
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
static void consider_notify_transport(struct GNUNET_ATS_SessionHandle *sh)
Check if the new allocation for sh is significantly different from the last one, and if so...
Information about preferences and sessions we track per peer.
Closure for update_counters and update_allocation.
#define GNUNET_YES
Definition: gnunet_common.h:77
Here is the call graph for this function:
Here is the caller graph for this function:

◆ update()

static void update ( struct SimpleHandle h)
static

The world changed, recalculate our allocations.

Definition at line 837 of file plugin_ats2_simple.c.

References Counters::bw_in_by_nt, Counters::bw_out_by_nt, GNUNET_CONTAINER_multipeermap_iterate(), GNUNET_NT_COUNT, Counters::h, SimpleHandle::networks, Hello::nt, SimpleHandle::peers, Counters::scale_in, Counters::scale_out, Network::total_quota_in, Network::total_quota_out, update_allocation(), and update_counters().

Referenced by simple_preference_add(), simple_preference_del(), simple_session_add(), simple_session_del(), and simple_session_update().

838 {
839  struct Counters cnt = { .h = h };
840 
842  /* calculate how badly the missmatch between requested
843  allocations and available bandwidth is per network type */
844  for (enum GNUNET_NetworkType nt = 0; nt < GNUNET_NT_COUNT; nt++)
845  {
846  cnt.scale_out[nt] =
847  1.0 * cnt.bw_out_by_nt[nt] / h->networks[nt].total_quota_out;
848  cnt.scale_in[nt] =
849  1.0 * cnt.bw_in_by_nt[nt] / h->networks[nt].total_quota_in;
850  }
851  /* recalculate allocations, considering scaling factor, and
852  update transport if the change is significant */
854 }
double scale_in[GNUNET_NT_COUNT]
By how much do we have to scale (up or down) our expectations for inbound bandwidth?
unsigned long long total_quota_out
Total outbound quota.
static int update_counters(void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
Function used to iterate over all peers and collect counter data.
uint64_t bw_out_by_nt[GNUNET_NT_COUNT]
Bandwidth that applications would prefer to allocate in this network type.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
double scale_out[GNUNET_NT_COUNT]
By how much do we have to scale (up or down) our expectations for outbound bandwidth?
uint64_t bw_in_by_nt[GNUNET_NT_COUNT]
Current bandwidth utilization for this network type.
struct GNUNET_CONTAINER_MultiPeerMap * peers
Information we track for each peer.
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
unsigned long long total_quota_in
Total inbound quota.
int GNUNET_CONTAINER_multipeermap_iterate(struct GNUNET_CONTAINER_MultiPeerMap *map, GNUNET_CONTAINER_PeerMapIterator it, void *it_cls)
Iterate over all entries in the map.
static int update_allocation(void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
Function used to iterate over all peers and collect counter data.
struct Network networks[GNUNET_NT_COUNT]
Information we track per network type (quotas).
Closure for update_counters and update_allocation.
struct SimpleHandle * h
Plugin&#39;s state.
#define GNUNET_NT_COUNT
Here is the call graph for this function:
Here is the caller graph for this function:

◆ simple_preference_add()

static struct GNUNET_ATS_PreferenceHandle* simple_preference_add ( void *  cls,
const struct GNUNET_ATS_Preference pref 
)
static

The plugin should begin to respect a new preference.

Parameters
clsthe closure
prefthe preference to add
Returns
plugin's internal representation, or NULL

Definition at line 865 of file plugin_ats2_simple.c.

References GNUNET_ATS_Preference::bw, Peer::bw_by_pk, SimpleHandle::bw_by_pk, GNUNET_assert, GNUNET_MQ_PREFERENCE_COUNT, h, p, GNUNET_ATS_Preference::peer, peer_add(), GNUNET_ATS_Preference::pk, update(), and GNUNET_BANDWIDTH_Value32NBO::value__.

Referenced by libgnunet_plugin_ats2_simple_init().

866 {
867  struct SimpleHandle *h = cls;
868  struct Peer *p = peer_add(h, &pref->peer);
869 
871  p->bw_by_pk[pref->pk] += ntohl(pref->bw.value__);
872  h->bw_by_pk[pref->pk] += ntohl(pref->bw.value__);
873  update(h);
874  return NULL;
875 }
uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT]
Array where we sum up the bandwidth requests received indexed by preference kind (see enum GNUNET_MQ_...
static void update(struct SimpleHandle *h)
The world changed, recalculate our allocations.
static struct Peer * peer_add(struct SimpleHandle *h, const struct GNUNET_PeerIdentity *pid)
Find or add peer if necessary.
enum GNUNET_MQ_PreferenceKind pk
What type of performance preference does the client have?
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT]
Array where we sum up the bandwidth requests received indexed by preference kind (see enum GNUNET_MQ_...
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
uint32_t value__
The actual value (bytes per second).
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
#define GNUNET_MQ_PREFERENCE_COUNT
struct GNUNET_BANDWIDTH_Value32NBO bw
How much bandwidth in bytes/second does the application expect?
Information about preferences and sessions we track per peer.
A handle for the proportional solver.
struct GNUNET_PeerIdentity peer
Peer to get address suggestions for.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ simple_preference_del()

static void simple_preference_del ( void *  cls,
struct GNUNET_ATS_PreferenceHandle *  ph,
const struct GNUNET_ATS_Preference pref 
)
static

The plugin should end respecting a preference.

Parameters
clsthe closure
phwhatever preference_add returned
prefthe preference to delete
Returns
plugin's internal representation, or NULL

Definition at line 887 of file plugin_ats2_simple.c.

References GNUNET_ATS_Preference::bw, Peer::bw_by_pk, SimpleHandle::bw_by_pk, GNUNET_assert, GNUNET_MQ_PREFERENCE_COUNT, GNUNET_YES, h, lookup_peer(), p, GNUNET_ATS_Preference::peer, peer_free(), peer_test_dead(), GNUNET_ATS_Preference::pk, update(), and GNUNET_BANDWIDTH_Value32NBO::value__.

Referenced by libgnunet_plugin_ats2_simple_init().

890 {
891  struct SimpleHandle *h = cls;
892  struct Peer *p = lookup_peer(h, &pref->peer);
893 
894  GNUNET_assert(NULL != p);
896  p->bw_by_pk[pref->pk] -= ntohl(pref->bw.value__);
897  h->bw_by_pk[pref->pk] -= ntohl(pref->bw.value__);
898  if ((0 == p->bw_by_pk[pref->pk]) && (GNUNET_YES == peer_test_dead(p)))
899  peer_free(p);
900  update(h);
901 }
uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT]
Array where we sum up the bandwidth requests received indexed by preference kind (see enum GNUNET_MQ_...
static void update(struct SimpleHandle *h)
The world changed, recalculate our allocations.
enum GNUNET_MQ_PreferenceKind pk
What type of performance preference does the client have?
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT]
Array where we sum up the bandwidth requests received indexed by preference kind (see enum GNUNET_MQ_...
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
uint32_t value__
The actual value (bytes per second).
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
#define GNUNET_MQ_PREFERENCE_COUNT
static int peer_test_dead(struct Peer *p)
Check if there is any interesting information left we store about the peer in p.
static void peer_free(struct Peer *p)
Free the entry (and associated tasks) of peer p.
struct GNUNET_BANDWIDTH_Value32NBO bw
How much bandwidth in bytes/second does the application expect?
Information about preferences and sessions we track per peer.
struct Peer * lookup_peer(struct SimpleHandle *h, const struct GNUNET_PeerIdentity *pid)
Lookup peer in the peers map.
#define GNUNET_YES
Definition: gnunet_common.h:77
A handle for the proportional solver.
struct GNUNET_PeerIdentity peer
Peer to get address suggestions for.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ simple_session_add()

static struct GNUNET_ATS_SessionHandle* simple_session_add ( void *  cls,
const struct GNUNET_ATS_SessionData data,
const char *  address 
)
static

Transport established a new session with performance characteristics given in data.

Parameters
clsclosure
dataperformance characteristics of sh
addressaddress information (for debugging)
Returns
handle by which the plugin will identify this session

Definition at line 914 of file plugin_ats2_simple.c.

References Hello::address, GNUNET_ATS_SessionHandle::address, Hello::backoff, data, GNUNET_ATS_SessionHandle::data, GNUNET_assert, GNUNET_CONTAINER_DLL_insert, GNUNET_malloc, GNUNET_TIME_UNIT_ZERO, h, Peer::h_head, GNUNET_ATS_SessionHandle::hello, Hello::next, p, GNUNET_ATS_SessionHandle::peer, GNUNET_ATS_SessionData::peer, peer_add(), GNUNET_ATS_SessionData::session, GNUNET_ATS_SessionHandle::session, Hello::sh, Peer::sh_head, Peer::sh_tail, and update().

Referenced by libgnunet_plugin_ats2_simple_init().

917 {
918  struct SimpleHandle *h = cls;
919  struct Peer *p = peer_add(h, &data->peer);
920  struct Hello *hello;
921  size_t alen;
923 
924  /* setup session handle */
925  GNUNET_assert(NULL != data);
926  if (NULL == address)
927  alen = 0;
928  else
929  alen = strlen(address) + 1;
930  sh = GNUNET_malloc(sizeof(struct GNUNET_ATS_SessionHandle) + alen);
931  sh->peer = p;
932  sh->session = data->session;
933  sh->data = data;
934  if (NULL == address)
935  {
936  sh->address = NULL;
937  }
938  else
939  {
940  memcpy(&sh[1], address, alen);
941  sh->address = (const char *)&sh[1];
942  }
944  if (NULL != address)
945  {
946  /* match HELLO */
947  hello = p->h_head;
948  while ((NULL != hello) && (0 != strcmp(address, hello->address)))
949  hello = hello->next;
950  if (NULL != hello)
951  {
952  hello->sh = sh;
954  sh->hello = hello;
955  }
956  }
957  update(h);
958  return sh;
959 }
struct GNUNET_ATS_Session * session
Handle to the session that has the given properties.
const struct GNUNET_ATS_SessionData * data
Current performance data for this session.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
static void update(struct SimpleHandle *h)
The world changed, recalculate our allocations.
static struct Peer * peer_add(struct SimpleHandle *h, const struct GNUNET_PeerIdentity *pid)
Find or add peer if necessary.
Internal representation of a session by the plugin.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_PeerIdentity peer
Peer the session is with.
struct Peer * peer
Peer this session is for.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
static struct SolverHandle * sh
struct GNUNET_ATS_SessionHandle * sh_tail
Kept in DLL per peer.
struct Hello * h_head
Kept in a DLL.
Entry in list of addresses we could try per peer.
struct Hello * hello
Hello matching this session, or NULL for none.
#define GNUNET_TIME_UNIT_ZERO
Relative time zero.
struct GNUNET_TIME_Relative backoff
Current exponential backoff value.
Information about preferences and sessions we track per peer.
struct Hello * next
Kept in a DLL.
const char * address
The address we could try.
struct GNUNET_ATS_SessionHandle * sh
Is a session with this address already up? If not, set to NULL.
A handle for the proportional solver.
uint32_t data
The data value.
const char * address
Address used by this session (largely for debugging).
static char * address
GNS address for this phone.
#define GNUNET_malloc(size)
Wrapper around malloc.
struct GNUNET_ATS_Session * session
The session in the main ATS service.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ simple_session_update()

static void simple_session_update ( void *  cls,
struct GNUNET_ATS_SessionHandle sh,
const struct GNUNET_ATS_SessionData data 
)
static

data changed for a given sh, solver should consider the updated performance characteristics.

Parameters
clsclosure
shsession this is about
dataperformance characteristics of sh

Definition at line 971 of file plugin_ats2_simple.c.

References data, GNUNET_ATS_SessionHandle::data, GNUNET_assert, h, and update().

Referenced by libgnunet_plugin_ats2_simple_init().

974 {
975  struct SimpleHandle *h = cls;
976 
977  GNUNET_assert(NULL != data);
978  sh->data = data; /* this statement should not really do anything... */
979  update(h);
980 }
const struct GNUNET_ATS_SessionData * data
Current performance data for this session.
static void update(struct SimpleHandle *h)
The world changed, recalculate our allocations.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
A handle for the proportional solver.
uint32_t data
The data value.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ simple_session_del()

static void simple_session_del ( void *  cls,
struct GNUNET_ATS_SessionHandle sh,
const struct GNUNET_ATS_SessionData data 
)
static

A session went away.

Solver should update accordingly.

Parameters
clsclosure
shsession this is about
data(last) performance characteristics of sh

Definition at line 991 of file plugin_ats2_simple.c.

References GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_SCHEDULER_add_now(), GNUNET_YES, h, GNUNET_ATS_SessionHandle::hello, p, GNUNET_ATS_SessionHandle::peer, peer_free(), peer_test_dead(), Hello::sh, Peer::sh_head, Peer::sh_tail, suggest_start_cb(), Peer::task, and update().

Referenced by libgnunet_plugin_ats2_simple_init().

994 {
995  struct SimpleHandle *h = cls;
996  struct Peer *p = sh->peer;
997  struct Hello *hello = sh->hello;
998 
999  /* clean up sh */
1001  if (NULL != hello)
1002  {
1003  GNUNET_assert(sh == hello->sh);
1004  hello->sh = NULL;
1005  /* session went down, if necessary restart suggesting
1006  addresses */
1007  if (NULL == p->task)
1009  }
1010  GNUNET_free(sh);
1011  /* del peer if otherwise dead */
1012  if ((NULL == p->sh_head) && (GNUNET_YES == peer_test_dead(p)))
1013  peer_free(p);
1014  update(h);
1015 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
static void update(struct SimpleHandle *h)
The world changed, recalculate our allocations.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct Peer * peer
Peer this session is for.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
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:1264
struct GNUNET_ATS_SessionHandle * sh_tail
Kept in DLL per peer.
static int peer_test_dead(struct Peer *p)
Check if there is any interesting information left we store about the peer in p.
Entry in list of addresses we could try per peer.
static void peer_free(struct Peer *p)
Free the entry (and associated tasks) of peer p.
struct Hello * hello
Hello matching this session, or NULL for none.
struct GNUNET_SCHEDULER_Task * task
Task used to try again to suggest an address for this peer.
Information about preferences and sessions we track per peer.
static void suggest_start_cb(void *cls)
Consider suggesting a HELLO (without a session) to transport.
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_ATS_SessionHandle * sh
Is a session with this address already up? If not, set to NULL.
A handle for the proportional solver.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ libgnunet_plugin_ats2_simple_init()

void* libgnunet_plugin_ats2_simple_init ( void *  cls)

Function invoked when the plugin is loaded.

Parameters
[in,out]clsthe struct GNUNET_ATS_PluginEnvironment * to use; modified to return the API functions (ugh).
Returns
the struct SimpleHandle to pass as a closure

Definition at line 1029 of file plugin_ats2_simple.c.

References GNUNET_ATS_PluginEnvironment::cfg, GNUNET_ATS_SolverFunctions::cls, GNUNET_ATS_PluginEnvironment::cls, env, SimpleHandle::env, get_quota(), GNUNET_break, GNUNET_CONTAINER_multipeermap_create(), GNUNET_new, GNUNET_NT_COUNT, GNUNET_NT_to_string(), GNUNET_PEERSTORE_connect(), GNUNET_YES, name, SimpleHandle::networks, Hello::nt, SimpleHandle::peers, GNUNET_ATS_SolverFunctions::preference_add, GNUNET_ATS_SolverFunctions::preference_del, SimpleHandle::ps, GNUNET_ATS_SolverFunctions::session_add, GNUNET_ATS_SolverFunctions::session_del, GNUNET_ATS_SolverFunctions::session_update, sf, simple_preference_add(), simple_preference_del(), simple_session_add(), simple_session_del(), simple_session_update(), Network::total_quota_in, Network::total_quota_out, and Network::type.

1030 {
1031  static struct GNUNET_ATS_SolverFunctions sf;
1033  struct SimpleHandle *s;
1034 
1035  s = GNUNET_new(struct SimpleHandle);
1036  s->env = env;
1038  s->ps = GNUNET_PEERSTORE_connect(env->cfg);
1039  sf.cls = s;
1045  for (enum GNUNET_NetworkType nt = 0; nt < GNUNET_NT_COUNT; nt++)
1046  {
1047  const char *name = GNUNET_NT_to_string(nt);
1048 
1049  if (NULL == name)
1050  {
1051  GNUNET_break(0);
1052  break;
1053  }
1054  get_quota(env->cfg, name, "IN", &s->networks[nt].total_quota_in);
1055  get_quota(env->cfg, name, "OUT", &s->networks[nt].total_quota_out);
1056  s->networks[nt].type = nt;
1057  }
1058  return &sf;
1059 }
const char * GNUNET_NT_to_string(enum GNUNET_NetworkType net)
Convert a enum GNUNET_NetworkType to a string.
Definition: nt.c:43
unsigned long long total_quota_out
Total outbound quota.
void(* session_update)(void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
data changed for a given sh, solver should consider the updated performance characteristics.
static struct GNUNET_ATS_SessionHandle * simple_session_add(void *cls, const struct GNUNET_ATS_SessionData *data, const char *address)
Transport established a new session with performance characteristics given in data.
static struct GNUNET_ATS_PreferenceHandle * simple_preference_add(void *cls, const struct GNUNET_ATS_Preference *pref)
The plugin should begin to respect a new preference.
static void simple_preference_del(void *cls, struct GNUNET_ATS_PreferenceHandle *ph, const struct GNUNET_ATS_Preference *pref)
The plugin should end respecting a preference.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_CONTAINER_MultiPeerMap * GNUNET_CONTAINER_multipeermap_create(unsigned int len, int do_not_copy_keys)
Create a multi peer map (hash map for public keys of peers).
static void simple_session_update(void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
data changed for a given sh, solver should consider the updated performance characteristics.
GNUNET_NetworkType
Types of networks (with separate quotas) we support.
Definition: gnunet_nt_lib.h:35
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void(* session_del)(void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
A session went away.
struct GNUNET_ATS_PluginEnvironment * env
Our execution environment.
struct GNUNET_PEERSTORE_Handle * ps
Handle to the peerstore service.
struct GNUNET_ATS_PreferenceHandle *(* preference_add)(void *cls, const struct GNUNET_ATS_Preference *pref)
The plugin should begin to respect a new preference.
struct GNUNET_CONTAINER_MultiPeerMap * peers
Information we track for each peer.
struct GNUNET_ATS_SessionHandle *(* session_add)(void *cls, const struct GNUNET_ATS_SessionData *data, const char *address)
Transport established a new session with performance characteristics given in data.
static struct GNUNET_NAT_AUTO_Test * nt
Handle to a NAT test operation.
enum GNUNET_NetworkType type
ATS network type.
static void get_quota(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *nts, const char *direction, unsigned long long *quota)
Parse cfg for quota as specified for direction of network type nts.
unsigned long long total_quota_in
Total inbound quota.
struct GNUNET_PEERSTORE_Handle * GNUNET_PEERSTORE_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Connect to the PEERSTORE service.
const char * name
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
void * cls
Closure to pass to all solver functions in this struct.
static void simple_session_del(void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
A session went away.
void(* preference_del)(void *cls, struct GNUNET_ATS_PreferenceHandle *ph, const struct GNUNET_ATS_Preference *pref)
The plugin should end respecting a preference.
struct Network networks[GNUNET_NT_COUNT]
Information we track per network type (quotas).
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration handle to be used by the solver.
void * cls
Closure to pass to all callbacks in this struct.
#define GNUNET_YES
Definition: gnunet_common.h:77
A handle for the proportional solver.
static struct GNUNET_ATS_SolverFunctions * sf
Solver handle.
The ATS plugin will pass a pointer to a struct of this type as to the initialization function of the ...
#define GNUNET_NT_COUNT
Here is the call graph for this function:

◆ libgnunet_plugin_ats2_simple_done()

void* libgnunet_plugin_ats2_simple_done ( void *  cls)

Function used to unload the plugin.

Parameters
clsreturn value from libgnunet_plugin_ats_proportional_init()

Definition at line 1068 of file plugin_ats2_simple.c.

References GNUNET_ATS_SolverFunctions::cls, GNUNET_break, GNUNET_CONTAINER_multipeermap_destroy(), GNUNET_CONTAINER_multipeermap_size(), GNUNET_free, GNUNET_NO, GNUNET_PEERSTORE_disconnect(), SimpleHandle::peers, SimpleHandle::ps, and sf.

1069 {
1070  struct GNUNET_ATS_SolverFunctions *sf = cls;
1071  struct SimpleHandle *s = sf->cls;
1072 
1076  GNUNET_free(s);
1077  return NULL;
1078 }
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
void GNUNET_CONTAINER_multipeermap_destroy(struct GNUNET_CONTAINER_MultiPeerMap *map)
Destroy a hash map.
struct GNUNET_PEERSTORE_Handle * ps
Handle to the peerstore service.
void GNUNET_PEERSTORE_disconnect(struct GNUNET_PEERSTORE_Handle *h, int sync_first)
Disconnect from the PEERSTORE service.
struct GNUNET_CONTAINER_MultiPeerMap * peers
Information we track for each peer.
void * cls
Closure to pass to all solver functions in this struct.
A handle for the proportional solver.
unsigned int GNUNET_CONTAINER_multipeermap_size(const struct GNUNET_CONTAINER_MultiPeerMap *map)
Get the number of key-value pairs in the map.
static struct GNUNET_ATS_SolverFunctions * sf
Solver handle.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function: