GNUnet  0.10.x
plugin_ats2_simple.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2011-2015, 2018 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
29 #include "platform.h"
30 #include "gnunet_ats_plugin_new.h"
31 #include "gnunet_hello_lib.h"
33 
34 #define LOG(kind, ...) GNUNET_log_from (kind, "ats-simple", __VA_ARGS__)
35 
36 
44 #define SUGGEST_FREQ GNUNET_TIME_UNIT_SECONDS
45 
52 #define MIN_BANDWIDTH_PER_SESSION 1024
53 
54 
58 struct SimpleHandle;
59 
60 
65 struct Peer;
66 
67 
71 struct Hello
72 {
76  struct Hello *next;
77 
81  struct Hello *prev;
82 
86  struct Peer *peer;
87 
91  const char *address;
92 
98 
103 
108 
113 
118 };
119 
120 
126 {
131 
136 
141 
146 
150  struct Hello *hello;
151 
155  struct Peer *peer;
156 
160  const char *address;
161 
166  struct GNUNET_TIME_Absolute last_allocation;
167 
172 
177 
181  uint64_t target_in;
182 
186  uint64_t target_out;
187 };
188 
189 
194 struct Peer
195 {
200 
205 
209  struct Hello *h_head;
210 
214  struct Hello *h_tail;
215 
219  struct SimpleHandle *h;
220 
226 
231 
236 
240  struct GNUNET_TIME_Absolute last_suggestion;
241 
246  uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT];
247 };
248 
249 
253 struct Network
254 {
258  unsigned long long total_quota_in;
259 
263  unsigned long long total_quota_out;
264 
269 };
270 
271 
276 {
281 
286 
291 
297  uint64_t bw_by_pk[GNUNET_MQ_PREFERENCE_COUNT];
298 
302  struct Network networks[GNUNET_NT_COUNT];
303 };
304 
305 
313 struct Peer *
315 {
316  return GNUNET_CONTAINER_multipeermap_get (h->peers, pid);
317 }
318 
319 
327 static int
329 {
331  pk++)
332  if (0 != p->bw_by_pk[pk])
333  return GNUNET_NO;
334  if (NULL != p->sh_head)
335  return GNUNET_NO;
336  return GNUNET_YES;
337 }
338 
339 
347 static void
349 {
350  struct Peer *p = hello->peer;
351  struct SimpleHandle *h = p->h;
352 
354  hello->backoff =
357  hello->expiration));
358  h->env->suggest_cb (h->env->cls, &p->pid, hello->address);
359 }
360 
361 
376 static void
377 suggest_start_cb (void *cls)
378 {
379  struct Peer *p = cls;
381  struct Hello *hello = NULL;
383  struct GNUNET_TIME_Relative xdelay;
384  struct GNUNET_TIME_Absolute xnext;
385  unsigned int num_sessions = 0;
386  uint32_t sq;
387 
388  /* count number of active sessions */
389  for (struct GNUNET_ATS_SessionHandle *sh = p->sh_head; NULL != sh;
390  sh = sh->next)
391  num_sessions++;
392  /* calculate square of number of sessions */
393  num_sessions++; /* start with 1, even if we have zero sessions */
394  if (num_sessions < UINT16_MAX)
395  sq = num_sessions * (uint32_t) num_sessions;
396  else
397  sq = UINT32_MAX;
398  xdelay =
400  sq),
402  xnext = GNUNET_TIME_relative_to_absolute (xdelay);
403 
404  p->task = NULL;
405  while (0 == delay.rel_value_us)
406  {
407  struct Hello *next;
408  struct GNUNET_TIME_Absolute xmax;
409 
410  if (NULL != hello)
411  {
412  /* We went through the loop already once and found
413  a HELLO that is due *now*, so make a suggestion! */
414  GNUNET_break (NULL == hello->sh);
415  suggest_hello (hello);
416  hello = NULL;
418  }
419  for (struct Hello *pos = p->h_head; NULL != pos; pos = next)
420  {
421  struct GNUNET_TIME_Absolute pt;
422 
423  next = pos->next;
424  if (NULL != pos->sh)
425  continue;
426  if (0 ==
428  {
429  /* expired, remove! */
431  GNUNET_free (pos);
432  continue;
433  }
434  pt = GNUNET_TIME_absolute_add (pos->last_attempt, pos->backoff);
435  if ((NULL == hello) || (pt.abs_value_us < hpt.abs_value_us))
436  {
437  hello = pos;
438  hpt = pt;
439  }
440  }
441  if (NULL == hello)
442  return; /* no HELLOs that could still be tried */
443 
444  /* hpt is now the *earliest* possible time for any HELLO
445  but we might not want to go for as early as possible for
446  this peer. So the actual time is the max of the earliest
447  HELLO and the 'xnext' */
448  xmax = GNUNET_TIME_absolute_max (hpt, xnext);
449  delay = GNUNET_TIME_absolute_get_remaining (xmax);
450  }
452 }
453 
454 
462 static void
463 watch_cb (void *cls,
464  const struct GNUNET_PEERSTORE_Record *record,
465  const char *emsg)
466 {
467  struct Peer *p = cls;
468  char *addr;
469  size_t alen;
470  enum GNUNET_NetworkType nt;
471  struct GNUNET_TIME_Absolute expiration;
472  struct Hello *hello;
473 
474  if (0 != GNUNET_memcmp (&p->pid, &record->peer))
475  {
476  GNUNET_break (0);
477  return;
478  }
479  if (0 != strcmp (record->key, GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY))
480  {
481  GNUNET_break (0);
482  return;
483  }
484  addr = GNUNET_HELLO_extract_address (record->value,
485  record->value_size,
486  &p->pid,
487  &nt,
488  &expiration);
489  if (NULL == addr)
490  return; /* invalid hello, bad signature, other problem */
491  if (0 == GNUNET_TIME_absolute_get_remaining (expiration).rel_value_us)
492  {
493  /* expired, ignore */
494  GNUNET_free (addr);
495  return;
496  }
497  /* check if addr is already known */
498  for (struct Hello *he = p->h_head; NULL != he; he = he->next)
499  {
500  if (0 != strcmp (he->address, addr))
501  continue;
502  if (he->expiration.abs_value_us < expiration.abs_value_us)
503  {
504  he->expiration = expiration;
505  he->nt = nt;
506  }
507  GNUNET_free (addr);
508  return;
509  }
510  /* create new HELLO */
511  alen = strlen (addr) + 1;
512  hello = GNUNET_malloc (sizeof(struct Hello) + alen);
513  hello->address = (const char *) &hello[1];
514  hello->expiration = expiration;
515  hello->nt = nt;
516  hello->peer = p;
517  memcpy (&hello[1], addr, alen);
518  GNUNET_CONTAINER_DLL_insert (p->h_head, p->h_tail, hello);
519  /* check if sh for this HELLO already exists */
520  for (struct GNUNET_ATS_SessionHandle *sh = p->sh_head; NULL != sh;
521  sh = sh->next)
522  {
523  if ((NULL == sh->address) || (0 != strcmp (sh->address, addr)))
524  continue;
525  GNUNET_assert (NULL == sh->hello);
526  sh->hello = hello;
527  hello->sh = sh;
528  break;
529  }
530  GNUNET_free (addr);
531  if (NULL == p->task)
533 }
534 
535 
543 static struct Peer *
545 {
546  struct Peer *p = lookup_peer (h, pid);
547 
548  if (NULL != p)
549  return p;
550  p = GNUNET_new (struct Peer);
551  p->h = h;
552  p->pid = *pid;
553  p->wc = GNUNET_PEERSTORE_watch (h->ps,
554  "transport",
555  &p->pid,
557  &watch_cb,
558  p);
561  h->peers,
562  &p->pid,
563  p,
565 
566  return p;
567 }
568 
569 
576 static void
577 peer_free (struct Peer *p)
578 {
579  struct SimpleHandle *h = p->h;
580  struct Hello *hello;
581 
582  GNUNET_assert (NULL == p->sh_head);
583  while (NULL != (hello = p->h_head))
584  {
585  GNUNET_CONTAINER_DLL_remove (p->h_head, p->h_tail, hello);
586  GNUNET_assert (NULL == hello->sh);
587  GNUNET_free (hello);
588  }
589  if (NULL != p->task)
590  {
592  p->task = NULL;
593  }
594  if (NULL != p->wc)
595  {
597  p->wc = NULL;
598  }
601  GNUNET_free (p);
602 }
603 
604 
611 static void
613 {
614  struct Peer *peer = sh->peer;
615  struct SimpleHandle *h = peer->h;
616  enum GNUNET_NetworkType nt = sh->data->prop.nt;
617  struct GNUNET_TIME_Relative delay;
618  uint64_t sig_in;
619  uint64_t sig_out;
620  int64_t delta_in;
621  int64_t delta_out;
622 
624  /* A significant change is more than 10% of the quota,
625  which is given in bytes/second */
626  sig_in = h->networks[nt].total_quota_in * (delay.rel_value_us / 1000LL)
627  / 1000LL / 10;
628  sig_out = h->networks[nt].total_quota_out * (delay.rel_value_us / 1000LL)
629  / 1000LL / 10;
630  delta_in = ((int64_t) ntohl (sh->bw_in.value__)) - ((int64_t) sh->target_in);
631  delta_out = ((int64_t) ntohl (sh->bw_in.value__)) - ((int64_t) sh->target_in);
632  /* we want the absolute values */
633  if (delta_in < 0)
634  delta_in = -delta_in;
635  if (INT64_MIN == delta_in)
636  delta_in = INT64_MAX; /* Handle corner case: INT_MIN == - INT_MIN */
637  if (delta_out < 0)
638  delta_out = -delta_out;
639  if (INT64_MIN == delta_out)
640  delta_out = INT64_MAX; /* Handle corner case: INT_MIN == - INT_MIN */
641  if ((sig_in > delta_in) && (sig_out > delta_out))
642  return; /* insignificant change */
643  /* change is significant, tell transport! */
644  if (sh->target_in > UINT32_MAX)
645  sh->target_in = UINT32_MAX;
646  sh->bw_in.value__ = htonl ((uint32_t) sh->target_in);
647  if (sh->target_out > UINT32_MAX)
648  sh->target_out = UINT32_MAX;
649  sh->bw_out.value__ = htonl ((uint32_t) sh->target_out);
651  h->env->allocate_cb (h->env->cls,
652  sh->session,
653  &peer->pid,
654  sh->bw_in,
655  sh->bw_out);
656 }
657 
658 
662 struct Counters
663 {
667  struct SimpleHandle *h;
668 
675  uint64_t bw_out_by_nt[GNUNET_NT_COUNT];
676 
681  uint64_t bw_in_by_nt[GNUNET_NT_COUNT];
682 
687  double scale_out[GNUNET_NT_COUNT];
688 
693  double scale_in[GNUNET_NT_COUNT];
694 };
695 
696 
706 static int
707 update_counters (void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
708 {
709  struct Counters *c = cls;
710  struct Peer *peer = value;
712 
713  (void) pid;
714  if (NULL == peer->sh_head)
715  return GNUNET_YES; /* no available session, cannot allocate bandwidth */
716  memset (best, 0, sizeof(best));
717  for (struct GNUNET_ATS_SessionHandle *sh = peer->sh_head; NULL != sh;
718  sh = sh->next)
719  {
720  enum GNUNET_NetworkType nt = sh->data->prop.nt;
721 
724  c->bw_in_by_nt[nt] +=
727  pk++)
728  {
729  /* General rule: always prefer smaller distance if possible,
730  otherwise decide by pk: */
731  switch (pk)
732  {
734  break;
735 
737  /* For bandwidth, we compare the sum of transmitted bytes and
738  confirmed transmitted bytes, so confirmed data counts twice */
739  if ((NULL == best[pk]) ||
740  (sh->data->prop.distance < best[pk]->data->prop.distance) ||
742  best[pk]->data->prop.utilization_out
743  + best[pk]->data->prop.goodput_out))
744  best[pk] = sh;
745  /* If both are equal (i.e. usually this happens if there is a zero), use
746  latency as a yardstick */
748  best[pk]->data->prop.utilization_out
749  + best[pk]->data->prop.goodput_out) &&
750  (sh->data->prop.distance == best[pk]->data->prop.distance) &&
752  best[pk]->data->prop.delay.rel_value_us))
753  best[pk] = sh;
754  break;
755 
757  if ((NULL == best[pk]) ||
758  (sh->data->prop.distance < best[pk]->data->prop.distance) ||
759  ((sh->data->prop.distance == best[pk]->data->prop.distance) &&
761  best[pk]->data->prop.delay.rel_value_us)))
762  best[pk] = sh;
763  break;
764 
766  /* For reliability, we consider the ratio of goodput to utilization
767  (but use multiplicative formultations to avoid division by zero) */
768  if ((NULL == best[pk]) || (1ULL * sh->data->prop.goodput_out
769  * best[pk]->data->prop.utilization_out >
770  1ULL * sh->data->prop.utilization_out
771  * best[pk]->data->prop.goodput_out))
772  best[pk] = sh;
773  /* If both are equal (i.e. usually this happens if there is a zero), use
774  latency as a yardstick */
775  if ((1ULL * sh->data->prop.goodput_out
776  * best[pk]->data->prop.utilization_out ==
777  1ULL * sh->data->prop.utilization_out
778  * best[pk]->data->prop.goodput_out) &&
779  (sh->data->prop.distance == best[pk]->data->prop.distance) &&
781  best[pk]->data->prop.delay.rel_value_us))
782  best[pk] = sh;
783  break;
784  }
785  }
786  }
787  /* for first round, assign target bandwidth simply to sum of
788  requested bandwidth */
789  for (enum GNUNET_MQ_PreferenceKind pk =
790  1 /* skip GNUNET_MQ_PREFERENCE_NONE */;
792  pk++)
793  {
794  const struct GNUNET_ATS_SessionData *data = best[pk]->data;
795  enum GNUNET_NetworkType nt;
796 
797  GNUNET_assert (NULL != data);
798  nt = data->prop.nt;
799  best[pk]->target_out =
801  c->bw_out_by_nt[nt] +=
802  (uint64_t) (best[pk]->target_out - MIN_BANDWIDTH_PER_SESSION);
803  }
804  return GNUNET_YES;
805 }
806 
807 
817 static int
818 update_allocation (void *cls,
819  const struct GNUNET_PeerIdentity *pid,
820  void *value)
821 {
822  struct Counters *c = cls;
823  struct Peer *peer = value;
824 
825  (void) pid;
826  for (struct GNUNET_ATS_SessionHandle *sh = peer->sh_head; NULL != sh;
827  sh = sh->next)
828  {
829  enum GNUNET_NetworkType nt = sh->data->prop.nt;
830 
831  sh->target_out = (uint64_t) (c->scale_out[nt] * sh->target_out);
832  sh->target_in = (uint64_t) (c->scale_in[nt] * sh->target_in);
834  }
835  return GNUNET_YES;
836 }
837 
838 
842 static void
844 {
845  struct Counters cnt = { .h = h };
846 
848  /* calculate how badly the missmatch between requested
849  allocations and available bandwidth is per network type */
850  for (enum GNUNET_NetworkType nt = 0; nt < GNUNET_NT_COUNT; nt++)
851  {
852  cnt.scale_out[nt] =
853  1.0 * cnt.bw_out_by_nt[nt] / h->networks[nt].total_quota_out;
854  cnt.scale_in[nt] =
855  1.0 * cnt.bw_in_by_nt[nt] / h->networks[nt].total_quota_in;
856  }
857  /* recalculate allocations, considering scaling factor, and
858  update transport if the change is significant */
860 }
861 
862 
870 static struct GNUNET_ATS_PreferenceHandle *
871 simple_preference_add (void *cls, const struct GNUNET_ATS_Preference *pref)
872 {
873  struct SimpleHandle *h = cls;
874  struct Peer *p = peer_add (h, &pref->peer);
875 
877  p->bw_by_pk[pref->pk] += ntohl (pref->bw.value__);
878  h->bw_by_pk[pref->pk] += ntohl (pref->bw.value__);
879  update (h);
880  return NULL;
881 }
882 
883 
892 static void
894  struct GNUNET_ATS_PreferenceHandle *ph,
895  const struct GNUNET_ATS_Preference *pref)
896 {
897  struct SimpleHandle *h = cls;
898  struct Peer *p = lookup_peer (h, &pref->peer);
899 
900  GNUNET_assert (NULL != p);
902  p->bw_by_pk[pref->pk] -= ntohl (pref->bw.value__);
903  h->bw_by_pk[pref->pk] -= ntohl (pref->bw.value__);
904  if ((0 == p->bw_by_pk[pref->pk]) && (GNUNET_YES == peer_test_dead (p)))
905  peer_free (p);
906  update (h);
907 }
908 
909 
919 static struct GNUNET_ATS_SessionHandle *
921  const struct GNUNET_ATS_SessionData *data,
922  const char *address)
923 {
924  struct SimpleHandle *h = cls;
925  struct Peer *p = peer_add (h, &data->peer);
926  struct Hello *hello;
927  size_t alen;
929 
930  /* setup session handle */
931  GNUNET_assert (NULL != data);
932  if (NULL == address)
933  alen = 0;
934  else
935  alen = strlen (address) + 1;
936  sh = GNUNET_malloc (sizeof(struct GNUNET_ATS_SessionHandle) + alen);
937  sh->peer = p;
938  sh->session = data->session;
939  sh->data = data;
940  if (NULL == address)
941  {
942  sh->address = NULL;
943  }
944  else
945  {
946  memcpy (&sh[1], address, alen);
947  sh->address = (const char *) &sh[1];
948  }
950  if (NULL != address)
951  {
952  /* match HELLO */
953  hello = p->h_head;
954  while ((NULL != hello) && (0 != strcmp (address, hello->address)))
955  hello = hello->next;
956  if (NULL != hello)
957  {
958  hello->sh = sh;
960  sh->hello = hello;
961  }
962  }
963  update (h);
964  return sh;
965 }
966 
967 
976 static void
979  const struct GNUNET_ATS_SessionData *data)
980 {
981  struct SimpleHandle *h = cls;
982 
983  GNUNET_assert (NULL != data);
984  sh->data = data; /* this statement should not really do anything... */
985  update (h);
986 }
987 
988 
996 static void
999  const struct GNUNET_ATS_SessionData *data)
1000 {
1001  struct SimpleHandle *h = cls;
1002  struct Peer *p = sh->peer;
1003  struct Hello *hello = sh->hello;
1004 
1005  /* clean up sh */
1007  if (NULL != hello)
1008  {
1009  GNUNET_assert (sh == hello->sh);
1010  hello->sh = NULL;
1011  /* session went down, if necessary restart suggesting
1012  addresses */
1013  if (NULL == p->task)
1015  }
1016  GNUNET_free (sh);
1017  /* del peer if otherwise dead */
1018  if ((NULL == p->sh_head) && (GNUNET_YES == peer_test_dead (p)))
1019  peer_free (p);
1020  update (h);
1021 }
1022 
1023 
1024 #include "plugin_ats2_common.c"
1025 
1026 
1034 void *
1036 {
1037  static struct GNUNET_ATS_SolverFunctions sf;
1039  struct SimpleHandle *s;
1040 
1041  s = GNUNET_new (struct SimpleHandle);
1042  s->env = env;
1044  s->ps = GNUNET_PEERSTORE_connect (env->cfg);
1045  sf.cls = s;
1051  for (enum GNUNET_NetworkType nt = 0; nt < GNUNET_NT_COUNT; nt++)
1052  {
1053  const char *name = GNUNET_NT_to_string (nt);
1054 
1055  if (NULL == name)
1056  {
1057  GNUNET_break (0);
1058  break;
1059  }
1060  get_quota (env->cfg, name, "IN", &s->networks[nt].total_quota_in);
1061  get_quota (env->cfg, name, "OUT", &s->networks[nt].total_quota_out);
1062  s->networks[nt].type = nt;
1063  }
1064  return &sf;
1065 }
1066 
1067 
1073 void *
1075 {
1076  struct GNUNET_ATS_SolverFunctions *sf = cls;
1077  struct SimpleHandle *s = sf->cls;
1078 
1082  GNUNET_free (s);
1083  return NULL;
1084 }
1085 
1086 
1087 /* end of plugin_ats2_simple.c */
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
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_...
void GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc)
Cancel a watch request.
enum GNUNET_NetworkType nt
Type of the network for this HELLO.
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.
static struct GNUNET_CRYPTO_EddsaPrivateKey * pk
Private key of this peer.
uint64_t rel_value_us
The actual value.
const char * GNUNET_NT_to_string(enum GNUNET_NetworkType net)
Convert a enum GNUNET_NetworkType to a string.
Definition: nt.c:44
struct GNUNET_ATS_Session * session
Handle to the session that has the given properties.
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.
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.
struct GNUNET_PeerIdentity peer
Peer Identity.
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.
uint32_t goodput_out
Confirmed successful payload on this connection from this peer to the other peer. ...
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 suggest_hello(struct Hello *hello)
Contact the transport service and suggest to it to try connecting to the address of hello...
static void update(struct SimpleHandle *h)
The world changed, recalculate our allocations.
uint64_t target_in
New BW-in allocation given to the transport service.
void * libgnunet_plugin_ats2_simple_done(void *cls)
Function used to unload the plugin.
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?
size_t value_size
Size of value BLOB.
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
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static struct GNUNET_ATS_PerformanceHandle * ph
ATS performance handle used.
Definition: gnunet-ats.c:116
struct Hello * prev
Kept in a DLL.
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 void simple_preference_del(void *cls, struct GNUNET_ATS_PreferenceHandle *ph, const struct GNUNET_ATS_Preference *pref)
The plugin should end respecting a preference.
static int update_counters(void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
Function used to iterate over all peers and collect counter data.
No preference was expressed.
struct GNUNET_PeerIdentity peer
Peer the session is with.
static void watch_cb(void *cls, const struct GNUNET_PEERSTORE_Record *record, const char *emsg)
Function called by PEERSTORE for each matching record.
int GNUNET_CONTAINER_multipeermap_remove(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, const void *value)
Remove the given key-value pair from the map.
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_BANDWIDTH_Value32NBO bw_in
Last BW-in allocation given to the transport service.
void * libgnunet_plugin_ats2_simple_init(void *cls)
Function invoked when the plugin is loaded.
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
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct Peer * peer
Peer this session is for.
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_...
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).
uint64_t abs_value_us
The actual value.
#define SUGGEST_FREQ
Base frequency at which we suggest addresses to transport.
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.
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
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:99
void GNUNET_CONTAINER_multipeermap_destroy(struct GNUNET_CONTAINER_MultiPeerMap *map)
Destroy a hash map.
#define GNUNET_TIME_UNIT_FOREVER_ABS
Constant used to specify "forever".
uint32_t value__
The actual value (bytes per second).
void(* session_del)(void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
A session went away.
char * key
Record key string.
struct Hello * h_tail
Kept in a DLL.
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_PluginEnvironment * env
Our execution environment.
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:1253
struct GNUNET_PEERSTORE_Handle * ps
Handle to the peerstore service.
struct GNUNET_ATS_SessionHandle * sh_head
Kept in DLL per peer.
GNUNET_MQ_PreferenceKind
Enum defining all known preference categories.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
void * value
Record value BLOB.
static char * value
Value of the record to add/remove.
Information about ongoing sessions of the transport client.
void GNUNET_PEERSTORE_disconnect(struct GNUNET_PEERSTORE_Handle *h, int sync_first)
Disconnect from 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.
#define GNUNET_MQ_PREFERENCE_COUNT
#define GNUNET_MAX(a, b)
Definition: gnunet_common.h:82
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:1280
struct GNUNET_TIME_Absolute expiration
When does the HELLO expire?
#define GNUNET_MIN(a, b)
Definition: gnunet_common.h:80
struct SimpleHandle * h
The handle for the proportional solver.
uint64_t bw_in_by_nt[GNUNET_NT_COUNT]
Current bandwidth utilization for this network type.
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
Representation of a network (to be expanded...)
struct GNUNET_TIME_Relative delay
Delay.
The preferred transmission for this envelope focuses on maximizing bandwidth.
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
Preference being expressed by an application client.
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
struct GNUNET_CONTAINER_MultiPeerMap * peers
Information we track for each peer.
Context for a watch request.
Internal representation of the hash map.
struct GNUNET_ATS_SessionHandle * sh_tail
Kept in DLL per peer.
Handle to the PEERSTORE service.
Definition: peerstore_api.c:40
struct Hello * h_head
Kept in a DLL.
static int peer_test_dead(struct Peer *p)
Check if there is any interesting information left we store about the peer in p.
struct GNUNET_BANDWIDTH_Value32NBO bw_out
Last BW-out allocation given to the transport service.
uint32_t goodput_in
Confirmed useful payload on this connection to this peer from the other 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.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
Entry in list of addresses we could try per peer.
uint64_t target_out
New BW-out allocation given to the transport service.
#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 Peer * peer
Peer this hello belongs to.
enum GNUNET_NetworkType type
ATS network type.
ATS solver helper functions to be inlined.
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.
There must only be one value per key; storing a value should fail if a value under the same key alrea...
unsigned long long total_quota_in
Total inbound quota.
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_BANDWIDTH_Value32NBO bw
How much bandwidth in bytes/second does the application expect?
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.
Plugin-relevant information about a session.
struct GNUNET_PeerIdentity pid
Which peer is this for?
32-bit bandwidth used for network exchange by GNUnet, in bytes per second.
enum GNUNET_NetworkType nt
Which network scope does the respective address belong to?
#define GNUNET_TIME_UNIT_ZERO
Relative time zero.
#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.
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...
struct GNUNET_TIME_Absolute last_allocation
When did we last update transport about the allocation? Used to dampen the frequency of updates...
#define GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY
Key used for storing addresses in URL format in the peerstore.
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...
int GNUNET_CONTAINER_multipeermap_put(struct GNUNET_CONTAINER_MultiPeerMap *map, const struct GNUNET_PeerIdentity *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
struct GNUNET_ATS_SessionHandle * prev
Kept in DLL per peer.
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 void simple_session_del(void *cls, struct GNUNET_ATS_SessionHandle *sh, const struct GNUNET_ATS_SessionData *data)
A session went away.
The identity of the host (wraps the signing key of the peer).
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.
struct GNUNET_TIME_Relative backoff
Current exponential backoff value.
static int update_allocation(void *cls, const struct GNUNET_PeerIdentity *pid, void *value)
Function used to iterate over all peers and collect counter data.
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
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).
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.
static void suggest_start_cb(void *cls)
Consider suggesting a HELLO (without a session) to transport.
struct Hello * next
Kept in a DLL.
The preferred transmission for this envelope foces on minimizing latency.
Single PEERSTORE record.
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration handle to be used by the solver.
Entry in list of pending tasks.
Definition: scheduler.c:134
Closure for update_counters and update_allocation.
struct Peer * lookup_peer(struct SimpleHandle *h, const struct GNUNET_PeerIdentity *pid)
Lookup peer in the peers map.
struct GNUNET_HELLO_Message * hello
Pointer to the HELLO message of this peer; can be NULL.
static void record(void *cls, size_t data_size, const void *data)
Process recorded audio data.
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
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
void * cls
Closure to pass to all callbacks in this struct.
Time for absolute times used by GNUnet, in microseconds.
#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.
unsigned int GNUNET_CONTAINER_multipeermap_size(const struct GNUNET_CONTAINER_MultiPeerMap *map)
Get the number of key-value pairs in the map.
struct GNUNET_PeerIdentity peer
Peer to get address suggestions for.
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 ...
static struct GNUNET_PeerIdentity pid
Identity of the peer we transmit to / connect to.
struct SimpleHandle * h
Plugin&#39;s state.
uint32_t data
The data value.
const char * address
Address used by this session (largely for debugging).
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:108
unsigned int distance
Distance on network layer (required for distance-vector routing) in hops.
#define GNUNET_NT_COUNT
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_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
Time for relative time used by GNUnet, in microseconds.
uint32_t utilization_out
Actual traffic on this connection from this peer to the other peer.
struct GNUNET_PEERSTORE_WatchContext * wc
Watch context where we are currently looking for HELLOs for this peer.
struct GNUNET_ATS_Session * session
The session in the main ATS service.
struct GNUNET_ATS_Properties prop
ATS performance characteristics for a session.
struct GNUNET_ATS_SessionHandle * next
Kept in DLL per peer.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:966
The preferred transmission for this envelope foces on reliability.