2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file ats/gnunet-service-ats_addresses_simplistic.h
23 * @brief ats simplistic ressource assignment
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet-service-ats_addresses.h"
30 #include "gnunet_statistics_service.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "ats-simplistic",__VA_ARGS__)
36 * NOTE: Do not change this documentation. This documentation is based on
37 * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
38 * use build_txt.sh to generate plaintext output
40 * ATS addresses : simplistic solver
42 * The simplistic solver ("simplistic") distributes the available bandwidth
43 * fair over all the addresses influenced by the preference values. For each
44 * available network type an in- and outbound quota is configured and the
45 * bandwidth available in these networks is distributed over the addresses.
46 * The solver first assigns every addresses the minimum amount of bandwidth
47 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT and then distributes the remaining
48 * bandwidth available according to the preference values. For each peer only
49 * a single address gets bandwidth assigned and only one address marked as
51 * The most important functionality for the solver is implemented in:
53 * is an hashmap iterator returning the prefered address for an peer
54 * * update_quota_per_network
55 * distributes available bandwidth for a network over active addresses
57 * Changes to addresses automatically have an impact on the the bandwidth
58 * assigned to other addresses in the same network since the solver
59 * distributes the remaining bandwidth over the addresses in the network.
60 * When changes to the addresses occur, the solver first performs the
61 * changes, like adding or deleting addresses, and then updates bandwidth
62 * assignment for the affected network. Bandwidth assignment is only
63 * recalculated on demand when an address is requested by a client for a peer
64 * or when the addresses available have changed or an address changed the
65 * network it is located in. When the bandwidth assignment has changed the
66 * callback is called with the new bandwidth assignments. The bandwidth
67 * distribution for a network is recalculated due to:
68 * * address suggestion requests
70 * * address switching networks during address update
71 * * preference changes
73 * 3.1 Data structures used
75 * For each ATS network (e.g. WAN, LAN, loopback) a struct Network is used to
76 * specify network related information as total adresses and active addresses
77 * in this network and the configured in- and outbound quota. Each network
78 * also contains a list of addresses added to the solver located in this
79 * network. The simplistic solver uses the addresses' solver_information
80 * field to store the simplistic network it belongs to for each address.
84 * When the simplistic solver is initialized the solver creates a new solver
85 * handle and initializes the network structures with the quotas passed from
86 * addresses and returns the handle solver.
88 * 3.3 Adding an address
90 * When a new address is added to the solver using s_add, a lookup for the
91 * network for this address is done and the address is enqueued in in the
92 * linked list of the network.
94 * 3.4 Updating an address
96 * The main purpose of address updates is to update the ATS information for
97 * addresse selection. Important for the simplistic solver is when an address
98 * switches network it is located in. This is common because addresses added
99 * by transport's validation mechanism are commonly located in
100 * GNUNET_ATS_NET_UNSPECIFIED. Addresses in validation are located in this
101 * network type and only if a connection is successful on return of payload
102 * data transport switches to the real network the address is located in.
103 * When an address changes networks it is first of all removed from the old
104 * network using the solver API function GAS_simplistic_address_delete and
105 * the network in the address struct is updated. A lookup for the respective
106 * new simplistic network is done and stored in the addresse's
107 * solver_information field. Next the address is re-added to the solver using
108 * the solver API function GAS_simplistic_address_add. If the address was
109 * marked as in active, the solver checks if bandwidth is available in the
110 * network and if yes sets the address to active and updates the bandwidth
111 * distribution in this network. If no bandwidth is available it sets the
112 * bandwidth for this address to 0 and tries to suggest an alternative
113 * address. If an alternative address was found, addresses' callback is
114 * called for this address.
116 * 3.5 Deleting an address
118 * When an address is removed from the solver, it removes the respective
119 * address from the network and if the address was marked as active, it
120 * updates the bandwidth distribution for this network.
122 * 3.6 Requesting addresses
124 * When an address is requested for a peer the solver performs a lookup for
125 * the peer entry in addresses address hashmap and selects the best address.
126 * The selection of the most suitable address is done in the find_address_it
127 * hashmap iterator described in detail in section 3.7. If no address is
128 * returned, no address can be suggested at the moment. If the address
129 * returned is marked as active, the solver can return this address. If the
130 * address is not marked as active, the solver checks if another address
131 * belongign to this peer is marked as active and marks the address as
132 * inactive, updates the bandwidth for this address to 0, call the bandwidth
133 * changed callback for this address due to the change and updates quota
134 * assignment for the addresse's network. the now in-active address is
135 * belonging to. The solver marks the new address as active and updates the
136 * bandwidth assignment for this network.
138 * 3.7 Choosing addresses
140 * Choosing the best possible address for suggestion is done by iterating
141 * over all addresses of a peer stored in addresses' hashmap and using the
142 * hashmap iterator find_address_it to select the best available address.
143 * Several checks are done when an address is selected. First if this address
144 * is currently blocked by addresses from being suggested. An address is
145 * blocked for the duration of ATS_BLOCKING_DELTA when it is suggested to
146 * transport. Next it is checked if at least
147 * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT bytes bandwidth is available in the
148 * addresse's network, because suggesting an address without bandwidth does
149 * not make sense. This also ensures that all active addresses in this
150 * network get at least the minimum amount of bandwidth assigned. In the next
151 * step the solver ensures that for tcp connections inbound connections are
152 * prefered over outbound connections. In the next stet the solver ensures
153 * that connections are prefered in the following order:
154 * * connections are already established and have bandwidth assigned
155 * * connections with a shorter distance
156 * * connectes have a shorter latency
158 * 3.8 Changing preferences
162 * During shutdown all network entries and aging processes are destroyed and
168 * This solver ssigns in and outbound bandwidth equally for all addresses in
169 * specific network type (WAN, LAN) based on configured in and outbound quota
172 * The solver is notified by addresses about changes to the addresses and
173 * recalculates the bandwith assigned if required. The solver notifies addresses
174 * by calling the GAS_bandwidth_changed_cb callback.
181 * For each peer only a single is selected and marked as "active" in the address
186 * You have the networks WAN and LAN and quotas
187 * WAN_TOTAL_IN, WAN_TOTAL_OUT
188 * LAN_TOTAL_IN, LAN_TOTAL_OUT
190 * If you have x addresses in the network segment LAN, the quotas are
191 * QUOTA_PER_ADDRESS = LAN_TOTAL_OUT / x
193 * Quotas are automatically recalculated and reported back when addresses are
198 #define PREF_AGING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
199 #define PREF_AGING_FACTOR 0.95
201 #define DEFAULT_PREFERENCE 1.0
202 #define MIN_UPDATE_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
205 * A handle for the simplistic solver
207 struct GAS_SIMPLISTIC_Handle
213 struct GNUNET_STATISTICS_Handle *stats;
216 * Total number of addresses for solver
218 unsigned int total_addresses;
221 * Number of active addresses for solver
223 unsigned int active_addresses;
228 struct Network *network_entries;
233 unsigned int networks;
238 GAS_bandwidth_changed_cb bw_changed;
243 void *bw_changed_cls;
245 struct GNUNET_CONTAINER_MultiHashMap *prefs;
247 struct PreferenceClient *pc_head;
248 struct PreferenceClient *pc_tail;
259 * Network description
264 * Total inbound quota
267 unsigned long long total_quota_in;
270 * Total outbound quota
273 unsigned long long total_quota_out;
276 * Number of active addresses for this network
278 unsigned int active_addresses;
281 * Number of total addresses for this network
283 unsigned int total_addresses;
286 * String for statistics total addresses
291 * String for statistics active addresses
295 struct AddressWrapper *head;
296 struct AddressWrapper *tail;
299 struct AddressWrapper
301 struct AddressWrapper *next;
302 struct AddressWrapper *prev;
304 struct ATS_Address *addr;
308 struct PreferenceClient
310 struct PreferenceClient *prev;
311 struct PreferenceClient *next;
314 double f_total[GNUNET_ATS_PreferenceCount];
316 struct PreferencePeer *p_head;
317 struct PreferencePeer *p_tail;
321 struct PreferencePeer
323 struct PreferencePeer *next;
324 struct PreferencePeer *prev;
325 struct PreferenceClient *client;
326 struct GAS_SIMPLISTIC_Handle *s;
327 struct GNUNET_PeerIdentity id;
329 double f[GNUNET_ATS_PreferenceCount];
330 double f_rel[GNUNET_ATS_PreferenceCount];
333 GNUNET_SCHEDULER_TaskIdentifier aging_task;
337 * Get the prefered address for a specific peer
339 * @param solver the solver handle
340 * @param addresses the address hashmap containing all addresses
341 * @param peer the identity of the peer
343 const struct ATS_Address *
344 GAS_simplistic_get_preferred_address (void *solver,
345 struct GNUNET_CONTAINER_MultiHashMap * addresses,
346 const struct GNUNET_PeerIdentity *peer);
349 * Init the simplistic problem solving component
352 * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
353 * out_quota[i] contains outbound quota for network type i
354 * in_quota[i] contains inbound quota for network type i
357 * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
358 * network[2] == GNUNET_ATS_NET_LAN
359 * out_quota[2] == 65353
360 * in_quota[2] == 65353
362 * @param cfg configuration handle
363 * @param stats the GNUNET_STATISTICS handle
364 * @param network array of GNUNET_ATS_NetworkType with length dest_length
365 * @param out_quota array of outbound quotas
366 * @param in_quota array of outbound quota
367 * @param dest_length array length for quota arrays
368 * @param bw_changed_cb callback for changed bandwidth amounts
369 * @param bw_changed_cb_cls cls for callback
370 * @return handle for the solver on success, NULL on fail
373 GAS_simplistic_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
374 const struct GNUNET_STATISTICS_Handle *stats,
376 unsigned long long *out_quota,
377 unsigned long long *in_quota,
379 GAS_bandwidth_changed_cb bw_changed_cb,
380 void *bw_changed_cb_cls)
383 struct GAS_SIMPLISTIC_Handle *s = GNUNET_malloc (sizeof (struct GAS_SIMPLISTIC_Handle));
384 struct Network * cur;
385 char * net_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
388 s->stats = (struct GNUNET_STATISTICS_Handle *) stats;
389 s->bw_changed = bw_changed_cb;
390 s->bw_changed_cls = bw_changed_cb_cls;
391 s->networks = dest_length;
392 s->network_entries = GNUNET_malloc (dest_length * sizeof (struct Network));
393 s->active_addresses = 0;
394 s->total_addresses = 0;
395 s->prefs = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
397 for (c = 0; c < dest_length; c++)
399 cur = &s->network_entries[c];
400 cur->total_addresses = 0;
401 cur->active_addresses = 0;
402 cur->type = network[c];
403 cur->total_quota_in = in_quota[c];
404 cur->total_quota_out = out_quota[c];
405 cur->desc = net_str[c];
406 GNUNET_asprintf (&cur->stat_total, "# ATS addresses %s total", cur->desc);
407 GNUNET_asprintf (&cur->stat_active, "# ATS active addresses %s total", cur->desc);
413 free_pref (void *cls,
414 const struct GNUNET_HashCode * key,
423 * Shutdown the simplistic problem solving component
425 * @param solver the respective handle to shutdown
428 GAS_simplistic_done (void *solver)
430 struct GAS_SIMPLISTIC_Handle *s = solver;
431 struct PreferenceClient *pc;
432 struct PreferenceClient *next_pc;
433 struct PreferencePeer *p;
434 struct PreferencePeer *next_p;
435 struct AddressWrapper *cur;
436 struct AddressWrapper *next;
438 GNUNET_assert (s != NULL);
440 for (c = 0; c < s->networks; c++)
442 if (s->network_entries[c].total_addresses > 0)
444 LOG (GNUNET_ERROR_TYPE_ERROR,
445 "Had %u addresses for network `%s' not deleted during shutdown\n",
446 s->network_entries[c].total_addresses,
447 s->network_entries[c].desc);
451 if (s->network_entries[c].active_addresses > 0)
453 LOG (GNUNET_ERROR_TYPE_ERROR,
454 "Had %u active addresses for network `%s' not deleted during shutdown\n",
455 s->network_entries[c].active_addresses,
456 s->network_entries[c].desc);
460 next = s->network_entries[c].head;
461 while (NULL != (cur = next))
464 GNUNET_CONTAINER_DLL_remove (s->network_entries[c].head,
465 s->network_entries[c].tail,
469 GNUNET_free (s->network_entries[c].stat_total);
470 GNUNET_free (s->network_entries[c].stat_active);
472 if (s->total_addresses > 0)
474 LOG (GNUNET_ERROR_TYPE_ERROR,
475 "Had %u addresses not deleted during shutdown\n",
479 if (s->active_addresses > 0)
481 LOG (GNUNET_ERROR_TYPE_ERROR,
482 "Had %u active addresses not deleted during shutdown\n",
483 s->active_addresses);
486 GNUNET_free (s->network_entries);
488 next_pc = s->pc_head;
489 while (NULL != (pc = next_pc))
492 GNUNET_CONTAINER_DLL_remove (s->pc_head, s->pc_tail, pc);
494 while (NULL != (p = next_p))
497 if (GNUNET_SCHEDULER_NO_TASK != p->aging_task)
499 GNUNET_SCHEDULER_cancel(p->aging_task);
500 p->aging_task = GNUNET_SCHEDULER_NO_TASK;
502 GNUNET_CONTAINER_DLL_remove (pc->p_head, pc->p_tail, p);
508 GNUNET_CONTAINER_multihashmap_iterate (s->prefs, &free_pref, NULL);
509 GNUNET_CONTAINER_multihashmap_destroy (s->prefs);
515 * Test if bandwidth is available in this network
517 * @param net the network type to update
518 * @return GNUNET_YES or GNUNET_NO
522 bw_available_in_network (struct Network *net)
524 unsigned int na = net->active_addresses + 1;
525 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
526 if (((net->total_quota_in / na) > min_bw) &&
527 ((net->total_quota_out / na) > min_bw))
529 LOG (GNUNET_ERROR_TYPE_DEBUG,
530 "Enough bandwidth available for %u active addresses in network `%s'\n",
536 LOG (GNUNET_ERROR_TYPE_DEBUG,
537 "Not enough bandwidth available for %u active addresses in network `%s'\n",
545 * Update the quotas for a network type
547 * @param s the solver handle
548 * @param net the network type to update
549 * @param address_except address excluded from notifcation, since we suggest
553 update_quota_per_network (struct GAS_SIMPLISTIC_Handle *s,
555 struct ATS_Address *address_except)
557 unsigned long long remaining_quota_in = 0;
558 unsigned long long quota_out_used = 0;
560 unsigned long long remaining_quota_out = 0;
561 unsigned long long quota_in_used = 0;
562 uint32_t min_bw = ntohl (GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT.value__);
563 double total_prefs; /* Important: has to be double not float due to precision */
564 double cur_pref; /* Important: has to be double not float due to precision */
565 double *t = NULL; /* Important: has to be double not float due to precision */
567 unsigned long long assigned_quota_in = 0;
568 unsigned long long assigned_quota_out = 0;
569 struct AddressWrapper *cur;
571 LOG (GNUNET_ERROR_TYPE_DEBUG,
572 "Recalculate quota for network type `%s' for %u addresses (in/out): %llu/%llu \n",
573 net->desc, net->active_addresses, net->total_quota_in, net->total_quota_in);
575 if (net->active_addresses == 0)
576 return; /* no addresses to update */
579 * Assign every peer in network minimum Bandwidth
580 * Distribute bandwidth left according to preference
583 if ((net->active_addresses * min_bw) > net->total_quota_in)
588 if ((net->active_addresses * min_bw) > net->total_quota_out)
594 remaining_quota_in = net->total_quota_in - (net->active_addresses * min_bw);
595 remaining_quota_out = net->total_quota_out - (net->active_addresses * min_bw);
596 LOG (GNUNET_ERROR_TYPE_DEBUG, "Remaining bandwidth : (in/out): %llu/%llu \n",
597 remaining_quota_in, remaining_quota_out);
599 for (cur = net->head; NULL != cur; cur = cur->next)
601 if (GNUNET_YES == cur->addr->active)
603 t = GNUNET_CONTAINER_multihashmap_get (s->prefs, &cur->addr->peer.hashPubKey);
605 total_prefs += DEFAULT_PREFERENCE;
612 for (cur = net->head; NULL != cur; cur = cur->next)
614 if (GNUNET_YES == cur->addr->active)
617 t = GNUNET_CONTAINER_multihashmap_get (s->prefs, &cur->addr->peer.hashPubKey);
619 cur_pref = DEFAULT_PREFERENCE;
622 assigned_quota_in = min_bw + ((cur_pref / total_prefs) * remaining_quota_in);
623 assigned_quota_out = min_bw + ((cur_pref / total_prefs) * remaining_quota_out);
625 LOG (GNUNET_ERROR_TYPE_DEBUG,
626 "New quota for peer `%s' with preference (cur/total) %.3f/%.3f (in/out): %llu / %llu\n",
627 GNUNET_i2s (&cur->addr->peer),
628 cur_pref, total_prefs,
629 assigned_quota_in, assigned_quota_out);
633 assigned_quota_in = 0;
634 assigned_quota_out = 0;
637 quota_in_used += assigned_quota_in;
638 quota_out_used += assigned_quota_out;
639 /* Prevent overflow due to rounding errors */
640 if (assigned_quota_in > UINT32_MAX)
641 assigned_quota_in = UINT32_MAX;
642 if (assigned_quota_out > UINT32_MAX)
643 assigned_quota_out = UINT32_MAX;
645 /* Compare to current bandwidth assigned */
646 if ((assigned_quota_in != ntohl(cur->addr->assigned_bw_in.value__)) ||
647 (assigned_quota_out != ntohl(cur->addr->assigned_bw_out.value__)))
649 cur->addr->assigned_bw_in.value__ = htonl (assigned_quota_in);
650 cur->addr->assigned_bw_out.value__ = htonl (assigned_quota_out);
651 /* Notify on change */
652 if ((GNUNET_YES == cur->addr->active) && (cur->addr != address_except))
653 s->bw_changed (s->bw_changed_cls, cur->addr);
657 LOG (GNUNET_ERROR_TYPE_DEBUG,
658 "Total bandwidth assigned is (in/out): %llu /%llu\n",
661 if (quota_out_used > net->total_quota_out + 1) /* +1 is required due to rounding errors */
663 LOG (GNUNET_ERROR_TYPE_ERROR,
664 "Total outbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
665 net->active_addresses,
667 net->total_quota_out);
669 if (quota_in_used > net->total_quota_in + 1) /* +1 is required due to rounding errors */
671 LOG (GNUNET_ERROR_TYPE_ERROR,
672 "Total inbound bandwidth assigned is larger than allowed (used/allowed) for %u active addresses: %llu / %llu\n",
673 net->active_addresses,
675 net->total_quota_in);
680 update_all_networks (struct GAS_SIMPLISTIC_Handle *s)
683 for (i = 0; i < s->networks; i++)
684 update_quota_per_network (s, &s->network_entries[i], NULL);
689 addresse_increment (struct GAS_SIMPLISTIC_Handle *s,
694 if (GNUNET_YES == total)
696 s->total_addresses ++;
697 net->total_addresses ++;
698 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", 1, GNUNET_NO);
699 GNUNET_STATISTICS_update (s->stats, net->stat_total, 1, GNUNET_NO);
701 if (GNUNET_YES == active)
703 net->active_addresses ++;
704 s->active_addresses ++;
705 GNUNET_STATISTICS_update (s->stats, "# ATS active addresses total", 1, GNUNET_NO);
706 GNUNET_STATISTICS_update (s->stats, net->stat_active, 1, GNUNET_NO);
712 addresse_decrement (struct GAS_SIMPLISTIC_Handle *s,
718 if (GNUNET_YES == total)
720 if (s->total_addresses < 1)
727 s->total_addresses --;
728 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
730 if (net->total_addresses < 1)
737 net->total_addresses --;
738 GNUNET_STATISTICS_update (s->stats, net->stat_total, -1, GNUNET_NO);
742 if (GNUNET_YES == active)
744 if (net->active_addresses < 1)
751 net->active_addresses --;
752 GNUNET_STATISTICS_update (s->stats, net->stat_active, -1, GNUNET_NO);
754 if (s->active_addresses < 1)
761 s->active_addresses --;
762 GNUNET_STATISTICS_update (s->stats, "# ATS addresses total", -1, GNUNET_NO);
769 * Extract an ATS performance info from an address
771 * @param address the address
772 * @param type the type to extract in HBO
773 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
776 get_performance_info (struct ATS_Address *address, uint32_t type)
779 GNUNET_assert (NULL != address);
781 if ((NULL == address->atsi) || (0 == address->atsi_count))
782 return GNUNET_ATS_VALUE_UNDEFINED;
784 for (c1 = 0; c1 < address->atsi_count; c1++)
786 if (ntohl(address->atsi[c1].type) == type)
787 return ntohl(address->atsi[c1].value);
789 return GNUNET_ATS_VALUE_UNDEFINED;
794 * Add a single address within a network to the solver
796 * @param solver the solver Handle
797 * @param addresses the address hashmap containing all addresses
798 * @param address the address to add
799 * @param network network type of this address
802 GAS_simplistic_address_add (void *solver,
803 struct GNUNET_CONTAINER_MultiHashMap *addresses,
804 struct ATS_Address *address,
807 struct GAS_SIMPLISTIC_Handle *s = solver;
808 struct Network *net = NULL;
809 struct AddressWrapper *aw = NULL;
812 GNUNET_assert (NULL != s);
813 for (c = 0; c < s->networks; c++)
815 net = &s->network_entries[c];
816 if (network == net->type)
825 aw = GNUNET_malloc (sizeof (struct AddressWrapper));
827 GNUNET_CONTAINER_DLL_insert (net->head, net->tail, aw);
828 addresse_increment (s, net, GNUNET_YES, GNUNET_NO);
829 aw->addr->solver_information = net;
832 LOG (GNUNET_ERROR_TYPE_DEBUG, "After adding address now total %u and active %u addresses in network `%s'\n",
833 net->total_addresses,
834 net->active_addresses,
839 * Remove an address from the solver
841 * @param solver the solver handle
842 * @param addresses the address hashmap containing all addresses
843 * @param address the address to remove
844 * @param session_only delete only session not whole address
847 GAS_simplistic_address_delete (void *solver,
848 struct GNUNET_CONTAINER_MultiHashMap * addresses,
849 struct ATS_Address *address, int session_only)
851 struct GAS_SIMPLISTIC_Handle *s = solver;
853 struct AddressWrapper *aw;
855 /* Remove an adress completely, we have to:
856 * - Remove from specific network
857 * - Decrease number of total addresses
859 * - decrease number of active addreses
863 net = (struct Network *) address->solver_information;
865 if (GNUNET_NO == session_only)
867 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s address %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
868 (GNUNET_NO == address->active) ? "inactive" : "active",
869 address, GNUNET_i2s (&address->peer),
870 net->desc, net->total_addresses, net->active_addresses);
873 addresse_decrement (s, net, GNUNET_YES, GNUNET_NO);
874 for (aw = net->head; NULL != aw; aw = aw->next)
876 if (aw->addr == address)
884 GNUNET_CONTAINER_DLL_remove (net->head, net->tail, aw);
889 /* Remove session only: remove if active and update */
890 LOG (GNUNET_ERROR_TYPE_DEBUG, "Deleting %s session %p for peer `%s' from network `%s' (total: %u/ active: %u)\n",
891 (GNUNET_NO == address->active) ? "inactive" : "active",
892 address, GNUNET_i2s (&address->peer),
893 net->desc, net->total_addresses, net->active_addresses);
896 if (GNUNET_YES == address->active)
898 /* Address was active, remove from network and update quotas*/
899 address->active = GNUNET_NO;
900 if (GNUNET_SYSERR == addresse_decrement (s, net, GNUNET_NO, GNUNET_YES))
902 update_quota_per_network (s, net, NULL);
904 LOG (GNUNET_ERROR_TYPE_DEBUG, "After deleting address now total %u and active %u addresses in network `%s'\n",
905 net->total_addresses,
906 net->active_addresses,
911 static struct Network *
912 find_network (struct GAS_SIMPLISTIC_Handle *s, uint32_t type)
915 for (c = 0 ; c < s->networks; c++)
917 if (s->network_entries[c].type == type)
918 return &s->network_entries[c];
924 * Updates a single address in the solve
926 * @param solver the solver Handle
927 * @param addresses the address hashmap containing all addresses
928 * @param address the update address
929 * @param session the new session (if changed otherwise current)
930 * @param in_use the new address in use state (if changed otherwise current)
931 * @param prev_ats the latest ATS information
932 * @param prev_atsi_count the atsi count
935 GAS_simplistic_address_update (void *solver,
936 struct GNUNET_CONTAINER_MultiHashMap *addresses,
937 struct ATS_Address *address,
940 const struct GNUNET_ATS_Information *prev_ats,
941 uint32_t prev_atsi_count)
943 struct ATS_Address *new;
944 struct GAS_SIMPLISTIC_Handle *s = (struct GAS_SIMPLISTIC_Handle *) solver;
949 int save_active = GNUNET_NO;
950 struct Network *new_net = NULL;
951 for (i = 0; i < prev_atsi_count; i++)
953 prev_type = ntohl (prev_ats[i].type);
954 prev_value = ntohl (prev_ats[i].value);
957 case GNUNET_ATS_UTILIZATION_UP:
958 //if (address->atsp_utilization_out.value__ != atsi[i].value)
961 case GNUNET_ATS_UTILIZATION_DOWN:
962 //if (address->atsp_utilization_in.value__ != atsi[i].value)
965 case GNUNET_ATS_QUALITY_NET_DELAY:
966 //if (address->atsp_latency.rel_value != value)
969 case GNUNET_ATS_QUALITY_NET_DISTANCE:
970 //if (address->atsp_distance != value)
973 case GNUNET_ATS_COST_WAN:
974 //if (address->atsp_cost_wan != value)
977 case GNUNET_ATS_COST_LAN:
978 //if (address->atsp_cost_lan != value)
981 case GNUNET_ATS_COST_WLAN:
982 //if (address->atsp_cost_wlan != value)
985 case GNUNET_ATS_NETWORK_TYPE:
986 addr_net = get_performance_info (address, GNUNET_ATS_NETWORK_TYPE);
987 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
990 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
992 if (addr_net != prev_value)
995 LOG (GNUNET_ERROR_TYPE_DEBUG, "Network type changed, moving %s address from `%s' to `%s'\n",
996 (GNUNET_YES == address->active) ? "active" : "inactive",
997 GNUNET_ATS_print_network_type(prev_value),
998 GNUNET_ATS_print_network_type(addr_net));
1000 save_active = address->active;
1001 /* remove from old network */
1002 GAS_simplistic_address_delete (solver, addresses, address, GNUNET_NO);
1004 /* set new network type */
1005 new_net = find_network (solver, addr_net);
1006 address->solver_information = new_net;
1008 /* Add to new network and update*/
1009 GAS_simplistic_address_add (solver, addresses, address, addr_net);
1010 if (GNUNET_YES == save_active)
1012 /* check if bandwidth available in new network */
1013 if (GNUNET_YES == (bw_available_in_network (new_net)))
1015 /* Suggest updated address */
1016 address->active = GNUNET_YES;
1017 addresse_increment (s, new_net, GNUNET_NO, GNUNET_YES);
1018 update_quota_per_network (solver, new_net, NULL);
1022 LOG (GNUNET_ERROR_TYPE_DEBUG, "Not enough bandwidth in new network, suggesting alternative address ..\n");
1024 /* Set old address to zero bw */
1025 address->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0);
1026 address->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0);
1027 s->bw_changed (s->bw_changed_cls, address);
1029 /* Find new address to suggest since no bandwidth in network*/
1030 new = (struct ATS_Address *) GAS_simplistic_get_preferred_address (s, addresses, &address->peer);
1033 /* Have an alternative address to suggest */
1034 s->bw_changed (s->bw_changed_cls, new);
1042 case GNUNET_ATS_ARRAY_TERMINATOR:
1045 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1046 "Received unsupported ATS type %u\n", prev_type);
1053 if (address->session_id != session)
1055 LOG (GNUNET_ERROR_TYPE_DEBUG,
1056 "Session changed from %u to %u\n", address->session_id, session);
1057 address->session_id = session;
1059 if (address->used != in_use)
1061 LOG (GNUNET_ERROR_TYPE_DEBUG,
1062 "Usage changed from %u to %u\n", address->used, in_use);
1063 address->used = in_use;
1071 * Find a "good" address to use for a peer. If we already have an existing
1072 * address, we stick to it. Otherwise, we pick by lowest distance and then
1073 * by lowest latency.
1075 * @param cls the 'struct ATS_Address**' where we store the result
1077 * @param value another 'struct ATS_Address*' to consider using
1078 * @return GNUNET_OK (continue to iterate)
1081 find_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1083 struct ATS_Address **previous_p = cls;
1084 struct ATS_Address *current = (struct ATS_Address *) value;
1085 struct ATS_Address *previous = *previous_p;
1086 struct GNUNET_TIME_Absolute now;
1087 struct Network *net = (struct Network *) current->solver_information;
1088 uint32_t p_distance_cur;
1089 uint32_t p_distance_prev;
1090 uint32_t p_delay_cur;
1091 uint32_t p_delay_prev;
1093 now = GNUNET_TIME_absolute_get();
1095 if (current->blocked_until.abs_value == GNUNET_TIME_absolute_max (now, current->blocked_until).abs_value)
1097 /* This address is blocked for suggestion */
1098 LOG (GNUNET_ERROR_TYPE_DEBUG,
1099 "Address %p blocked for suggestion for %llu ms \n",
1101 GNUNET_TIME_absolute_get_difference(now, current->blocked_until).rel_value);
1105 if (GNUNET_NO == bw_available_in_network (net))
1106 return GNUNET_OK; /* There's no bandwidth available in this network */
1108 if (NULL != previous)
1110 if ((0 == strcmp (previous->plugin, "tcp")) &&
1111 (0 == strcmp (current->plugin, "tcp")))
1113 if ((0 != previous->addr_len) &&
1114 (0 == current->addr_len))
1116 /* saved address was an outbound address, but we have an inbound address */
1117 *previous_p = current;
1120 if (0 == previous->addr_len)
1122 /* saved address was an inbound address, so do not overwrite */
1128 if (NULL == previous)
1130 *previous_p = current;
1133 if ((ntohl (previous->assigned_bw_in.value__) == 0) &&
1134 (ntohl (current->assigned_bw_in.value__) > 0))
1136 /* stick to existing connection */
1137 *previous_p = current;
1141 p_distance_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DISTANCE);
1142 p_distance_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DISTANCE);
1143 if ((p_distance_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_distance_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
1144 (p_distance_prev > p_distance_cur))
1146 /* user shorter distance */
1147 *previous_p = current;
1151 p_delay_prev = get_performance_info (previous, GNUNET_ATS_QUALITY_NET_DELAY);
1152 p_delay_cur = get_performance_info (current, GNUNET_ATS_QUALITY_NET_DELAY);
1153 if ((p_delay_prev != GNUNET_ATS_VALUE_UNDEFINED) && (p_delay_cur != GNUNET_ATS_VALUE_UNDEFINED) &&
1154 (p_delay_prev > p_delay_cur))
1156 /* user lower latency */
1157 *previous_p = current;
1166 find_active_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1168 struct ATS_Address * dest = (struct ATS_Address *) (*(struct ATS_Address **)cls);
1169 struct ATS_Address * aa = (struct ATS_Address *) value;
1171 if (GNUNET_YES == aa->active)
1175 /* should never happen */
1176 LOG (GNUNET_ERROR_TYPE_ERROR, "Multiple active addresses for peer `%s'\n", GNUNET_i2s (&aa->peer));
1185 static struct ATS_Address *
1186 find_active_address (void *solver,
1187 struct GNUNET_CONTAINER_MultiHashMap * addresses,
1188 const struct GNUNET_PeerIdentity *peer)
1190 struct ATS_Address * dest = NULL;
1192 GNUNET_CONTAINER_multihashmap_get_multiple(addresses,
1194 &find_active_address_it, &dest);
1199 * Get the prefered address for a specific peer
1201 * @param solver the solver handle
1202 * @param addresses the address hashmap containing all addresses
1203 * @param peer the identity of the peer
1205 const struct ATS_Address *
1206 GAS_simplistic_get_preferred_address (void *solver,
1207 struct GNUNET_CONTAINER_MultiHashMap * addresses,
1208 const struct GNUNET_PeerIdentity *peer)
1210 struct GAS_SIMPLISTIC_Handle *s = solver;
1211 struct Network *net_prev;
1212 struct Network *net_cur;
1213 struct ATS_Address *cur;
1214 struct ATS_Address *prev;
1216 GNUNET_assert (s != NULL);
1218 /* Get address with: stick to current address, lower distance, lower latency */
1219 GNUNET_CONTAINER_multihashmap_get_multiple (addresses, &peer->hashPubKey,
1220 &find_address_it, &cur);
1223 LOG (GNUNET_ERROR_TYPE_DEBUG, "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1227 LOG (GNUNET_ERROR_TYPE_DEBUG, "Suggesting %s address %p for peer `%s'\n",
1228 (GNUNET_NO == cur->active) ? "inactive" : "active",
1229 cur, GNUNET_i2s (peer));
1230 net_cur = (struct Network *) cur->solver_information;
1231 if (GNUNET_YES == cur->active)
1233 /* This address was selected previously, so no need to update quotas */
1237 /* This address was not active, so we have to:
1239 * - mark previous active address as not active
1240 * - update quota for previous address network
1241 * - update quota for this address network
1244 prev = find_active_address (s, addresses, peer);
1247 net_prev = (struct Network *) prev->solver_information;
1248 prev->active = GNUNET_NO; /* No active any longer */
1249 prev->assigned_bw_in = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
1250 prev->assigned_bw_out = GNUNET_BANDWIDTH_value_init (0); /* no bw assigned */
1251 s->bw_changed (s->bw_changed_cls, prev); /* notify about bw change, REQUIRED? */
1252 if (GNUNET_SYSERR == addresse_decrement (s, net_prev, GNUNET_NO, GNUNET_YES))
1254 update_quota_per_network (s, net_prev, NULL);
1257 if (GNUNET_NO == (bw_available_in_network (cur->solver_information)))
1259 GNUNET_break (0); /* This should never happen*/
1263 cur->active = GNUNET_YES;
1264 addresse_increment(s, net_cur, GNUNET_NO, GNUNET_YES);
1265 update_quota_per_network (s, net_cur, cur);
1272 * Stop notifying about address and bandwidth changes for this peer
1274 * @param solver the MLP handle
1275 * @param addresses address hashmap
1276 * @param peer the peer
1279 GAS_simplistic_stop_get_preferred_address (void *solver,
1280 struct GNUNET_CONTAINER_MultiHashMap *addresses,
1281 const struct GNUNET_PeerIdentity *peer)
1287 recalculate_preferences (struct PreferencePeer *p)
1289 struct GAS_SIMPLISTIC_Handle *s = p->s;
1290 struct PreferencePeer *p_cur;
1291 struct PreferenceClient *c_cur = p->client;
1292 double p_rel_global;
1303 * Set of peers p_i in P
1304 * Set of preference kinds k
1305 * A preference value f_k_p_i with an unknown range
1308 * A client specific relative preference f_p_i_rel [1..2] for all peers
1310 * For every client c
1312 * For every preference kind k:
1314 * We remember for the preference f_p_i for each peer p_i.
1315 * We have a default preference value f_p_i = 0
1316 * We have a sum of all preferences f_t = sum (f_p_i)
1317 * So we can calculate a relative preference value fr_p_i:
1320 * f_k_p_i_rel = [1..2], default 1.0
1322 * f_p_i_rel = sum (f_k_p_i_rel) / count(k)
1327 /* For this client: for all preferences, except TERMINATOR */
1328 for (kind = GNUNET_ATS_PREFERENCE_END + 1 ; kind < GNUNET_ATS_PreferenceCount; kind ++)
1330 /* Recalcalculate total preference for this quality kind over all peers*/
1331 c_cur->f_total[kind] = 0;
1332 for (p_cur = c_cur->p_head; NULL != p_cur; p_cur = p_cur->next)
1333 c_cur->f_total[kind] += p_cur->f[kind];
1335 LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p has total preference for %s of %.3f\n",
1337 GNUNET_ATS_print_preference_type (kind),
1338 c_cur->f_total[kind]);
1340 /* Recalcalculate relative preference for all peers */
1341 for (p_cur = c_cur->p_head; NULL != p_cur; p_cur = p_cur->next)
1343 /* Calculate relative preference for specific kind */
1344 if (0.0 == c_cur->f_total[kind])
1346 /* No one has preference, so set default preference */
1347 p_cur->f_rel[kind] = DEFAULT_PREFERENCE;
1351 p_cur->f_rel[kind] = (c_cur->f_total[kind] + p_cur->f[kind]) / c_cur->f_total[kind];
1353 LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p: peer `%s' has relative preference for %s of %.3f\n",
1355 GNUNET_i2s (&p_cur->id),
1356 GNUNET_ATS_print_preference_type (kind),
1357 p_cur->f_rel[kind]);
1359 /* Calculate peer relative preference */
1360 /* Start with kind = 1 to exclude terminator */
1361 p_cur->f_rel_total = 0;
1362 for (rkind = GNUNET_ATS_PREFERENCE_END + 1; rkind < GNUNET_ATS_PreferenceCount; rkind ++)
1364 p_cur->f_rel_total += p_cur->f_rel[rkind];
1366 p_cur->f_rel_total /= (GNUNET_ATS_PreferenceCount - 1.0); /* -1 due to terminator */
1367 LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p: peer `%s' has total relative preference of %.3f\n",
1369 GNUNET_i2s (&p_cur->id),
1370 p_cur->f_rel_total);
1374 /* Calculcate global total relative peer preference over all clients */
1377 for (c_cur = s->pc_head; NULL != c_cur; c_cur = c_cur->next)
1379 for (p_cur = c_cur->p_head; NULL != p_cur; p_cur = p_cur->next)
1380 if (0 == memcmp (&p_cur->id, &p->id, sizeof (p_cur->id)))
1385 p_rel_global += p_cur->f_rel_total;
1388 p_rel_global /= clients;
1389 LOG (GNUNET_ERROR_TYPE_DEBUG, "Global preference value for peer `%s': %.3f\n",
1390 GNUNET_i2s (&p->id), p_rel_global);
1392 /* Update global map */
1393 if (NULL != (dest = GNUNET_CONTAINER_multihashmap_get(s->prefs, &p->id.hashPubKey)))
1394 (*dest) = p_rel_global;
1397 dest = GNUNET_malloc (sizeof (double));
1398 (*dest) = p_rel_global;
1399 GNUNET_CONTAINER_multihashmap_put(s->prefs,
1402 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1407 update_preference (struct PreferencePeer *p,
1408 enum GNUNET_ATS_PreferenceKind kind,
1411 double score = score_f;
1413 /* Update preference value according to type */
1415 case GNUNET_ATS_PREFERENCE_BANDWIDTH:
1416 case GNUNET_ATS_PREFERENCE_LATENCY:
1417 p->f[kind] = (p->f[kind] + score) / 2;
1419 case GNUNET_ATS_PREFERENCE_END:
1424 recalculate_preferences(p);
1425 update_all_networks (p->s);
1430 preference_aging (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1435 struct PreferencePeer *p = cls;
1436 GNUNET_assert (NULL != p);
1439 p->aging_task = GNUNET_SCHEDULER_NO_TASK;
1441 LOG (GNUNET_ERROR_TYPE_DEBUG, "Aging preferences for peer `%s'\n",
1442 GNUNET_i2s (&p->id));
1444 /* Issue for aging :
1446 * Not for every peer preference values are set by default, so reducing the
1447 * absolute preference value does not help for aging because it does not have
1448 * influence on the relative values.
1450 * So we have to reduce the relative value to have an immediate impact on
1451 * quota calculation. In addition we cannot call recalculate_preferences here
1452 * but instead reduce the absolute value to have an aging impact on future
1453 * calls to change_preference where recalculate_preferences is called
1456 /* Aging absolute values: */
1457 for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
1462 p->f[i] *= PREF_AGING_FACTOR;
1463 LOG (GNUNET_ERROR_TYPE_DEBUG, "Aged preference for peer `%s' from %.3f to %.3f\n",
1464 GNUNET_i2s (&p->id), backup, p->f[i]);
1467 /* Updating relative value */
1468 t = GNUNET_CONTAINER_multihashmap_get (p->s->prefs, &p->id.hashPubKey);
1476 (*t) = (*t) * PREF_AGING_FACTOR;
1479 update_all_networks (p->s);
1481 p->aging_task = GNUNET_SCHEDULER_add_delayed (PREF_AGING_INTERVAL,
1482 &preference_aging, p);
1487 * Changes the preferences for a peer in the problem
1489 * @param solver the solver handle
1490 * @param client the client with this preference
1491 * @param peer the peer to change the preference for
1492 * @param kind the kind to change the preference
1493 * @param score the score
1496 GAS_simplistic_address_change_preference (void *solver,
1498 const struct GNUNET_PeerIdentity *peer,
1499 enum GNUNET_ATS_PreferenceKind kind,
1502 static struct GNUNET_TIME_Absolute next_update;
1503 struct GAS_SIMPLISTIC_Handle *s = solver;
1504 struct PreferenceClient *c_cur;
1505 struct PreferencePeer *p_cur;
1508 GNUNET_assert (NULL != solver);
1509 GNUNET_assert (NULL != client);
1510 GNUNET_assert (NULL != peer);
1512 LOG (GNUNET_ERROR_TYPE_DEBUG, "Client %p changes preference for peer `%s' %s %f\n",
1515 GNUNET_ATS_print_preference_type (kind),
1518 if (kind >= GNUNET_ATS_PreferenceCount)
1524 /* Find preference client */
1525 for (c_cur = s->pc_head; NULL != c_cur; c_cur = c_cur->next)
1527 if (client == c_cur->client)
1530 /* Not found: create new preference client */
1533 c_cur = GNUNET_malloc (sizeof (struct PreferenceClient));
1534 c_cur->client = client;
1535 GNUNET_CONTAINER_DLL_insert (s->pc_head, s->pc_tail, c_cur);
1538 /* Find entry for peer */
1539 for (p_cur = c_cur->p_head; NULL != p_cur; p_cur = p_cur->next)
1540 if (0 == memcmp (&p_cur->id, peer, sizeof (p_cur->id)))
1543 /* Not found: create new peer entry */
1546 p_cur = GNUNET_malloc (sizeof (struct PreferencePeer));
1548 p_cur->client = c_cur;
1549 p_cur->id = (*peer);
1550 for (i = 0; i < GNUNET_ATS_PreferenceCount; i++)
1552 /* Default value per peer absolut preference for a quality:
1553 * No value set, so absolute preference 0 */
1555 /* Default value per peer relative preference for a quality: 1.0 */
1556 p_cur->f_rel[i] = DEFAULT_PREFERENCE;
1558 p_cur->aging_task = GNUNET_SCHEDULER_add_delayed (PREF_AGING_INTERVAL, &preference_aging, p_cur);
1559 GNUNET_CONTAINER_DLL_insert (c_cur->p_head, c_cur->p_tail, p_cur);
1562 update_preference (p_cur, kind, score);
1564 /* FIXME: We should update quotas if UPDATE_INTERVAL is reached */
1565 if (GNUNET_TIME_absolute_get().abs_value > next_update.abs_value)
1568 next_update = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(),
1569 MIN_UPDATE_INTERVAL);
1573 /* end of gnunet-service-ats_addresses_simplistic.c */