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.c
23 * @brief ats service address management
24 * @author Matthias Wachs
25 * @author Christian Grothoff
28 #include "gnunet_ats_service.h"
29 #include "gnunet-service-ats.h"
30 #include "gnunet-service-ats_addresses.h"
31 #include "gnunet-service-ats_performance.h"
32 #include "gnunet-service-ats_scheduling.h"
33 #include "gnunet-service-ats_reservations.h"
35 #include "gnunet-service-ats_addresses_mlp.h"
37 #include "gnunet-service-ats_addresses_simplistic.h"
40 * NOTE: Do not change this documentation. This documentation is based on
41 * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
42 * use build_txt.sh to generate plaintext output
44 * 1 ATS addresses : ATS address management
46 * This ATS addresses ("addresses") component manages the addresses known to
47 * ATS service and suggests addresses to transport service when it is
48 * interested in address suggestion for a peer. ATS addresses also
49 * instantiates the bandwidth assignment mechanism (solver), notifies it
50 * about changes to addresses and forwards changes to bandwidth assignments
51 * to transport, depending if transport is interested in this change.
57 * Addresses are added by specifying peer ID, plugin, address, address length
58 * and session, if available. ATS information can be specified if available.
62 * ATS specifies a fix set of networks an address can belong to. For each
63 * network an inbound and outbound quota will be specified. The available
64 * networks and addtional helper varaibles are defined in
65 * gnunet_ats_service.h. At the moment 5 networks are defined:
66 * * GNUNET_ATS_NET_UNSPECIFIED
67 * * GNUNET_ATS_NET_LOOPBACK
68 * * GNUNET_ATS_NET_LAN
69 * * GNUNET_ATS_NET_WAN
70 * * GNUNET_ATS_NET_WLAN
72 * The total number of networks defined is stored in
73 * GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
74 * initializer for an int array, while GNUNET_ATS_NetworkType is an
75 * initializer for a char array containing a string description of all
80 * An inbound and outbound quota for each of the networks mentioned in 1.1.2
81 * is loaded from ats configuration during initialization. This quota defines
82 * to total amount of inbound and outbound traffic allowed for a specific
83 * network. The configuration values used are in section ats:
84 * * "NETWORK"_QUOTA_IN = <value>
85 * * "NETWORK"_QUOTA_IN = <value>
87 * You can specify quotas by setting the <value> to a:
88 * * unrestricted: unlimited
89 * * number of bytes: e.g. 10240
90 * * fancy value: e.g. 64 Kib
92 * unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
93 * the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
95 * * GNUNET_ATS_DefaultBandwidth: 65536
96 * * GNUNET_ATS_MaxBandwidth: UINT32_MAX
97 * * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
99 * Details of loading quotas and default values will be described on
101 * 1.1.4 Preference values
103 * 1.2 Data structures used
105 * Addresse uses struct ATS_Address for each address. The structs are stored
106 * in a linked list and provides a pointer void *solver_information for the
107 * solver to store address specific information. It provides the int values
108 * active which is set to GNUNET_YES if the address is select for transport
109 * use and used, representing that transport service is actively using this
110 * address. Address information are stored in peer, addr, addr_len, plugin.
114 * During initialization a hashmap to store addresses is created. The quotas
115 * for all networks defined for ATS are loaded from configuration. For each
116 * network first the logic will check if the string
117 * GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
118 * the configured value as a fancy size and if this fails it will try to use
119 * it as a value_number. If no configuration value is found it will assign
120 * GNUNET_ATS_DefaultBandwidth. The most important step is to load the
121 * configured solver using configuration "[ats]:MODE". Current solvers are
122 * MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
127 * * s_init: init the solver with required information
128 * * s_add: add a new address
129 * * s_update: update ATS values or session for an address
130 * * s_get: get prefered address for a peer
131 * * s_del: delete an address
132 * * s_pref: change preference value for a peer
133 * * s_done: shutdown solver
135 * Callbacks: addresses provides a bandwidth_changed_cb callback to the
136 * solver which is called when bandwidth assigned to peer has changed
140 * During shutdown all addresses are freed and the solver told to shutdown
142 * 1.6 Addresses and sessions
144 * Addresses consist of the address itself and a numerical session. When a
145 * new address without a session is added it has no session, so it gets
146 * session 0 assigned. When an address with a session is added and an address
147 * object with session 0 is found, this object is updated with the session
148 * otherwise a new address object with this session assigned is created.
152 * Addresses a1,a2 with session s1, s2 are "exact" if:
153 * (a1 == a2)&&(s1 == s2)
154 * Addresses a1,a2 with session s1, s2 are "equivalent" if:
155 * (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
157 * 1.7 Address management
159 * Transport service notifies ATS about changes to the addresses known to
162 * 1.7.1 Adding an address
164 * When transport learns a new address it tells ATS and ATS is telling
165 * addresses about it using GAS_address_add. If not known to addresses it
166 * creates a new address object and calls solver's s_add. ATS information are
167 * deserialized and solver is notified about the session and ATS information
170 * 1.7.2 Updating an address
172 * Addresses does an lookup up for the existing address with the given
173 * session. If disassembles included ATS information and notifies the solver
174 * using s_update about the update.
176 * 1.7.3 Deleting an address
178 * Addresses does an lookup for the exact address and session and if removes
179 * this address. If session != 0 the session is set to 0 and the address is
180 * kept. If session == 0, the addresses is removed.
182 * 1.7.4 Requesting an address suggestion
184 * The address client issues a request address message to be notified about
185 * address suggestions for a specific peer. Addresses asks the solver with
186 * s_get. If no address is available, it will not send a response, otherwise
187 * it will respond with the choosen address.
189 * 1.7.5 Address suggestions
191 * Addresses will notify the client automatically on any bandwidth_changed_cb
192 * by the solver if a address suggestion request is pending. If no address is
193 * available it will not respond at all If the client is not interested
194 * anymore, it has to cancel the address suggestion request.
196 * 1.7.6 Suggestions blocks and reset
198 * After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
199 * prevent the client from being thrashed. If the client requires immediately
200 * it can reset this block using GAS_addresses_handle_backoff_reset.
202 * 1.7.7 Marking address in use
204 * The client can notify addresses that it successfully uses an address and
205 * wants this address to be kept by calling GSA_address_in_use. Adresses will
206 * mark the address as used an notify the solver about the use.
208 * 1.7.8 Address lifecycle
211 * * (updated address) || (address in use)
214 * 1.8 Bandwidth assignment
216 * The addresses are used to perform resource allocation operations. ATS
217 * addresses takes care of instantiating the solver configured and notifies
218 * the respective solver about address changes and receives changes to the
219 * bandwidth assignment from the solver. The current bandwidth assignment is
220 * sent to transport. The specific solvers will be described in the specific
223 * 1.9 Changing peer preferences
225 * The bandwidth assigned to a peer can be influenced by setting a preference
226 * for a peer. The prefernce will be given to to the solver with s_pref which
227 * has to take care of the preference value
233 * Available ressource assignment modes
240 * Assign each peer an equal amount of bandwidth (bw)
242 * bw_per_peer = bw_total / #active addresses
249 * Solve ressource assignment as an optimization problem
250 * Uses an mixed integer programming solver
256 * Pending Address suggestion requests
258 struct GAS_Addresses_Suggestion_Requests
263 struct GAS_Addresses_Suggestion_Requests *next;
268 struct GAS_Addresses_Suggestion_Requests *prev;
273 struct GNUNET_PeerIdentity id;
277 * Handle for ATS address component
279 struct GAS_Addresses_Handle
284 struct GNUNET_STATISTICS_Handle *stat;
287 * A multihashmap to store all addresses
289 struct GNUNET_CONTAINER_MultiHashMap *addresses;
292 * Configure WAN quota in
294 unsigned long long wan_quota_in;
297 * Configure WAN quota out
299 unsigned long long wan_quota_out;
302 * Is ATS addresses running
307 * Configured ATS solver
317 * Address suggestion requests DLL head
319 struct GAS_Addresses_Suggestion_Requests *r_head;
322 * Address suggestion requests DLL tail
324 struct GAS_Addresses_Suggestion_Requests *r_tail;
326 /* Solver functions */
331 GAS_solver_init s_init;
334 * Add an address to the solver
336 GAS_solver_address_add s_add;
339 * Update address in solver
341 GAS_solver_address_update s_update;
344 * Get address from solver
346 GAS_solver_get_preferred_address s_get;
349 * Get address from solver
351 GAS_solver_stop_get_preferred_address s_get_stop;
354 * Delete address in solver
356 GAS_solver_address_delete s_del;
359 * Change preference for quality in solver
361 GAS_solver_address_change_preference s_pref;
366 GAS_solver_done s_done;
371 assemble_ats_information (const struct ATS_Address *aa, struct GNUNET_ATS_Information **dest)
373 unsigned int ats_count = GNUNET_ATS_PropertyCount - 1;
374 struct GNUNET_ATS_Information *ats = GNUNET_malloc (ats_count * sizeof (struct GNUNET_ATS_Information));
377 ats[0].type = ntohl(GNUNET_ATS_UTILIZATION_UP);
378 ats[0].value = aa->atsp_utilization_out.value__;
379 ats[1].type = ntohl(GNUNET_ATS_UTILIZATION_DOWN);
380 ats[1].value = aa->atsp_utilization_in.value__;
381 ats[2].type = ntohl(GNUNET_ATS_NETWORK_TYPE);
382 ats[2].value = ntohl(aa->atsp_network_type);
383 ats[3].type = ntohl(GNUNET_ATS_QUALITY_NET_DELAY);
384 ats[3].value = ntohl(aa->atsp_latency.rel_value);
385 ats[4].type = ntohl(GNUNET_ATS_QUALITY_NET_DISTANCE);
386 ats[4].value = ntohl(aa->atsp_distance);
387 ats[5].type = ntohl(GNUNET_ATS_COST_WAN);
388 ats[5].value = ntohl (aa->atsp_cost_wan);
389 ats[6].type = ntohl(GNUNET_ATS_COST_LAN);
390 ats[6].value = ntohl (aa->atsp_cost_lan);
391 ats[7].type = ntohl(GNUNET_ATS_COST_WLAN);
392 ats[7].value = ntohl (aa->atsp_cost_wlan);
397 disassemble_ats_information (const struct GNUNET_ATS_Information *src,
399 struct ATS_Address *dest)
403 for (i = 0; i < ats_count; i++)
404 switch (ntohl (src[i].type))
406 case GNUNET_ATS_UTILIZATION_UP:
407 dest->atsp_utilization_out.value__ = src[i].value;
410 case GNUNET_ATS_UTILIZATION_DOWN:
411 dest->atsp_utilization_in.value__ = src[i].value;
414 case GNUNET_ATS_QUALITY_NET_DELAY:
415 dest->atsp_latency.rel_value = ntohl (src[i].value);
418 case GNUNET_ATS_QUALITY_NET_DISTANCE:
419 dest->atsp_distance = ntohl (src[i].value);
422 case GNUNET_ATS_COST_WAN:
423 dest->atsp_cost_wan = ntohl (src[i].value);
426 case GNUNET_ATS_COST_LAN:
427 dest->atsp_cost_lan = ntohl (src[i].value);
430 case GNUNET_ATS_COST_WLAN:
431 dest->atsp_cost_wlan = ntohl (src[i].value);
434 case GNUNET_ATS_NETWORK_TYPE:
435 dest->atsp_network_type = ntohl (src[i].value);
438 case GNUNET_ATS_ARRAY_TERMINATOR:
441 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
442 "Received unsupported ATS type %u\n", ntohl (src[i].type));
450 * Free the given address
451 * @param addr address to destroy
454 free_address (struct ATS_Address *addr)
456 GNUNET_free (addr->plugin);
461 * Create a ATS_address with the given information
463 * @param plugin_name plugin
464 * @param plugin_addr address
465 * @param plugin_addr_len address length
466 * @param session_id session
467 * @return the ATS_Address
469 static struct ATS_Address *
470 create_address (const struct GNUNET_PeerIdentity *peer,
471 const char *plugin_name,
472 const void *plugin_addr, size_t plugin_addr_len,
475 struct ATS_Address *aa = NULL;
477 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
479 aa->addr_len = plugin_addr_len;
481 memcpy (&aa[1], plugin_addr, plugin_addr_len);
482 aa->plugin = GNUNET_strdup (plugin_name);
483 aa->session_id = session_id;
484 aa->active = GNUNET_NO;
485 aa->used = GNUNET_NO;
486 aa->solver_information = NULL;
487 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
488 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
494 * Destroy the given address.
496 * @param handle the address handle
497 * @param addr address to destroy
498 * @return GNUNET_YES if bandwidth allocations should be recalcualted
501 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
506 GNUNET_assert (GNUNET_YES ==
507 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
508 &addr->peer.hashPubKey,
515 struct CompareAddressContext
517 const struct ATS_Address *search;
519 /* exact_address != NULL if address and session is equal */
520 struct ATS_Address *exact_address;
521 /* exact_address != NULL if address and session is 0 */
522 struct ATS_Address *base_address;
527 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
529 struct CompareAddressContext *cac = cls;
530 struct ATS_Address *aa = value;
532 /* Find an matching exact address:
535 * aa->addr_len == cac->search->addr_len
536 * aa->plugin == cac->search->plugin
537 * aa->addr == cac->search->addr
538 * aa->session == cac->search->session
540 * return as exact address
542 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
544 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
545 cac->exact_address = aa;
548 /* Find an matching base address:
552 * aa->session_id == 0
555 * aa->addr_len == cac->search->addr_len
556 * aa->plugin == cac->search->plugin
557 * aa->addr == cac->search->addr
559 * return as base address
561 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
563 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
564 cac->base_address = aa;
567 /* Find an matching exact address based on session:
571 * cac->search->addr_len == 0
574 * aa->plugin == cac->search->plugin
575 * aa->session_id == cac->search->session_id
577 * return as exact address
579 if (0 == cac->search->addr_len)
581 if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
582 cac->exact_address = aa;
585 if (cac->exact_address == NULL)
586 return GNUNET_YES; /* Continue iteration to find exact address */
588 return GNUNET_NO; /* Stop iteration since we have an exact address */
593 * Find an existing equivalent address record.
594 * Compares by peer identity and network address OR by session ID
595 * (one of the two must match).
597 * @param handle the address handle
598 * @param peer peer to lookup addresses for
599 * @param addr existing address record
600 * @return existing address record, NULL for none
603 find_equivalent_address (struct GAS_Addresses_Handle *handle,
604 const struct GNUNET_PeerIdentity *peer,
605 const struct ATS_Address *addr)
607 struct CompareAddressContext cac;
609 cac.exact_address = NULL;
610 cac.base_address = NULL;
612 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
613 &compare_address_it, &cac);
615 if (cac.exact_address == NULL)
616 return cac.base_address;
617 return cac.exact_address;
621 static struct ATS_Address *
622 lookup_address (struct GAS_Addresses_Handle *handle,
623 const struct GNUNET_PeerIdentity *peer,
624 const char *plugin_name,
625 const void *plugin_addr,
626 size_t plugin_addr_len,
628 const struct GNUNET_ATS_Information *atsi,
631 struct ATS_Address *aa;
632 struct ATS_Address *ea;
634 aa = create_address (peer,
636 plugin_addr, plugin_addr_len,
639 /* Get existing address or address with session == 0 */
640 ea = find_equivalent_address (handle, peer, aa);
646 else if (ea->session_id != session_id)
655 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
656 const struct GNUNET_PeerIdentity *peer,
657 const char *plugin_name, const void *plugin_addr,
658 size_t plugin_addr_len, uint32_t session_id,
659 const struct GNUNET_ATS_Information *atsi,
662 struct ATS_Address *aa;
663 struct ATS_Address *ea;
664 unsigned int ats_res;
666 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
667 "Received `%s' for peer `%s'\n",
671 if (GNUNET_NO == handle->running)
674 GNUNET_assert (NULL != handle->addresses);
676 aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
678 if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, aa)))
680 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
681 "While adding address: had %u ATS elements to add, could only add %u\n",
682 atsi_count, ats_res);
685 /* Get existing address or address with session == 0 */
686 ea = find_equivalent_address (handle, peer, aa);
689 /* We have a new address */
690 GNUNET_assert (GNUNET_OK ==
691 GNUNET_CONTAINER_multihashmap_put (handle->addresses,
692 &peer->hashPubKey, aa,
693 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
694 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
695 GNUNET_i2s (peer), session_id, aa);
696 /* Tell solver about new address */
697 handle->s_add (handle->solver, handle->addresses, aa);
700 GNUNET_free (aa->plugin);
703 if (ea->session_id != 0)
705 /* This address with the same session is already existing
706 * Should not happen */
707 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
708 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
709 GNUNET_i2s (peer), plugin_name, session_id);
714 /* We have an address without an session, update this address */
716 /* Notify solver about update with atsi information and session */
717 handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi, atsi_count);
720 ea->session_id = session_id;
721 if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, ea)))
723 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
724 "While updating address: had %u ATS elements to add, could only add %u\n",
725 atsi_count, ats_res);
727 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
728 "Updated existing address for peer `%s' %p with new session %u\n",
729 GNUNET_i2s (peer), ea, session_id);
734 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
735 const struct GNUNET_PeerIdentity *peer,
736 const char *plugin_name, const void *plugin_addr,
737 size_t plugin_addr_len, uint32_t session_id,
738 const struct GNUNET_ATS_Information *atsi,
741 struct ATS_Address *aa;
744 if (GNUNET_NO == handle->running)
747 GNUNET_assert (NULL != handle->addresses);
749 /* Get existing address */
750 aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
751 session_id, atsi, atsi_count);
754 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n",
755 GNUNET_i2s (peer), plugin_name, session_id);
760 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
761 "Received `%s' for peer `%s' address \n",
763 GNUNET_i2s (peer), aa);
765 /* Tell solver about update */
766 handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi, atsi_count);
769 if (atsi_count != (ats_res = disassemble_ats_information (atsi, atsi_count, aa)))
771 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
772 "While adding address: had %u ATS elements to add, could only add %u\n",
773 atsi_count, ats_res);
775 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
776 "Updated %u ATS elements for address %p\n",
781 struct DestroyContext
783 struct ATS_Address *aa;
785 struct GAS_Addresses_Handle *handle;
788 * GNUNET_NO : full address
789 * GNUNET_YES : just session
798 * If session != 0, just the session is deleted, the address itself still exists
799 * If session == 0, remove full address
800 * If session == 0 and addrlen == 0, destroy inbound address
804 * @param value the 'struct ATS_Address'
805 * @return GNUNET_OK (continue to iterate)
808 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
810 struct DestroyContext *dc = cls;
811 struct GAS_Addresses_Handle *handle = dc->handle;
812 const struct ATS_Address *des = dc->aa;
813 struct ATS_Address *aa = value;
815 GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
816 sizeof (struct GNUNET_PeerIdentity)));
819 if (des->session_id == 0)
821 /* Session == 0, remove full address */
822 if ((0 == strcmp (des->plugin, aa->plugin)) &&
823 (aa->addr_len == des->addr_len) &&
824 (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
827 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
828 "Deleting full address for peer `%s' session %u %p\n",
829 GNUNET_i2s (&aa->peer), aa->session_id, aa);
831 /* Notify solver about deletion */
832 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
833 destroy_address (handle, aa);
834 dc->result = GNUNET_NO;
835 return GNUNET_OK; /* Continue iteration */
840 /* Session != 0, just remove session */
841 if (aa->session_id != des->session_id)
842 return GNUNET_OK; /* irrelevant */
844 if ((aa->session_id != 0) &&
845 (0 != strcmp (des->plugin, aa->plugin)))
847 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
848 "Different plugins during removal: `%s' vs `%s' \n",
849 des->plugin, aa->plugin);
854 if (aa->addr_len == 0)
856 /* Inbound connection died, delete full address */
857 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
858 "Deleting inbound address for peer `%s': `%s' session %u\n",
859 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
861 /* Notify solver about deletion */
862 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
863 destroy_address (handle, aa);
864 dc->result = GNUNET_NO;
865 return GNUNET_OK; /* Continue iteration */
870 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
871 "Deleting session for peer `%s': `%s' %u\n",
872 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
873 /* Notify solver to delete session */
874 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
883 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
884 const struct GNUNET_PeerIdentity *peer,
885 const char *plugin_name, const void *plugin_addr,
886 size_t plugin_addr_len, uint32_t session_id)
888 struct ATS_Address *ea;
889 struct DestroyContext dc;
891 if (GNUNET_NO == handle->running)
894 /* Get existing address */
895 ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
896 session_id, NULL, 0);
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
899 "Received `%s' for peer `%s' address %p session %u\n",
901 GNUNET_i2s (peer), ea, session_id);
905 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
906 GNUNET_i2s (peer), plugin_name, session_id);
910 GNUNET_break (0 < strlen (plugin_name));
912 dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
914 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
915 &destroy_by_session_id, &dc);
916 free_address (dc.aa);
921 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
922 const struct GNUNET_PeerIdentity *peer,
923 const char *plugin_name, const void *plugin_addr,
924 size_t plugin_addr_len, uint32_t session_id, int in_use)
926 struct ATS_Address *ea;
928 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
929 "Received `%s' for peer `%s'\n",
933 if (GNUNET_NO == handle->running)
934 return GNUNET_SYSERR;
936 ea = lookup_address (handle, peer, plugin_name,
937 plugin_addr, plugin_addr_len,
938 session_id, NULL, 0);
941 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
942 "Trying to set unknown address `%s', %s %u %s \n",
944 plugin_name, session_id,
945 (GNUNET_NO == in_use) ? "NO" : "YES");
947 return GNUNET_SYSERR;
949 if (ea->used == in_use)
952 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
953 "Address in use called multiple times for peer `%s': %s -> %s \n",
955 (GNUNET_NO == ea->used) ? "NO" : "YES",
956 (GNUNET_NO == in_use) ? "NO" : "YES");
957 return GNUNET_SYSERR;
960 /* Tell solver about update */
961 handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
969 * Cancel address suggestions for a peer
971 * @param handle the address handle
972 * @param peer the respective peer
975 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
976 const struct GNUNET_PeerIdentity *peer)
978 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
980 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
981 "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
985 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
992 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
993 "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
996 handle->s_get_stop (handle->solver, handle->addresses, peer);
997 GAS_addresses_handle_backoff_reset (handle, peer);
998 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
999 "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1000 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1006 * Add an address suggestions for a peer
1008 * @param handle the address handle
1009 * @param peer the respective peer
1012 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1013 const struct GNUNET_PeerIdentity *peer)
1015 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1016 struct ATS_Address *aa;
1017 struct GNUNET_ATS_Information *ats;
1018 unsigned int ats_count;
1020 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1021 "Received `%s' for peer `%s'\n",
1025 if (GNUNET_NO == handle->running)
1029 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1030 break; /* already suggesting */
1035 cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1037 GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1040 /* Get prefered address from solver */
1041 aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1044 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1045 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1049 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1050 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1052 ats_count = assemble_ats_information (aa, &ats);
1053 GAS_scheduling_transmit_address_suggestion (peer,
1055 aa->addr, aa->addr_len,
1058 aa->assigned_bw_out,
1059 aa->assigned_bw_in);
1061 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1062 aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1064 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1065 "Address %p ready for suggestion, block interval now %llu \n",
1066 aa, aa->block_interval);
1073 reset_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1075 struct ATS_Address *aa = value;
1077 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1078 "Resetting interval for peer `%s' address %p from %llu to 0\n",
1079 GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1081 aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1082 aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1088 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1089 const struct GNUNET_PeerIdentity *peer)
1091 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1092 "Received `%s' for peer `%s'\n",
1096 GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1104 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1106 const struct GNUNET_PeerIdentity *peer,
1107 enum GNUNET_ATS_PreferenceKind kind,
1110 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1111 "Received `%s' for peer `%s' for client %p\n",
1112 "CHANGE PREFERENCE",
1113 GNUNET_i2s (peer), client);
1115 if (GNUNET_NO == handle->running)
1118 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1121 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1122 "Received `%s' for unknown peer `%s' from client %p\n",
1123 "CHANGE PREFERENCE",
1124 GNUNET_i2s (peer), client);
1128 /* Tell solver about update */
1129 handle->s_pref (handle->solver, client, peer, kind, score);
1134 * Load quotas for networks from configuration
1136 * @param cfg configuration handle
1137 * @param out_dest where to write outbound quotas
1138 * @param in_dest where to write inbound quotas
1139 * @param dest_length length of inbound and outbound arrays
1140 * @return number of networks loaded
1143 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1145 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1146 char * entry_in = NULL;
1147 char * entry_out = NULL;
1148 char * quota_out_str;
1149 char * quota_in_str;
1153 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1157 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1158 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1161 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, "a_out_str))
1164 if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1166 out_dest[c] = GNUNET_ATS_MaxBandwidth;
1169 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1171 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out, &out_dest[c])))
1174 if (GNUNET_NO == res)
1176 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1177 network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1178 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1182 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1183 network_str[c], out_dest[c]);
1185 GNUNET_free (quota_out_str);
1189 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1190 network_str[c], GNUNET_ATS_DefaultBandwidth);
1191 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1195 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, "a_in_str))
1198 if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1200 in_dest[c] = GNUNET_ATS_MaxBandwidth;
1203 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1205 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in, &in_dest[c])))
1208 if (GNUNET_NO == res)
1210 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1211 network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1212 in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1216 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1217 network_str[c], in_dest[c]);
1219 GNUNET_free (quota_in_str);
1223 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1224 network_str[c], GNUNET_ATS_DefaultBandwidth);
1225 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1227 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Loaded quota for network `%s' (in/out): %llu %llu\n", network_str[c], in_dest[c], out_dest[c]);
1228 GNUNET_free (entry_out);
1229 GNUNET_free (entry_in);
1231 return GNUNET_ATS_NetworkTypeCount;
1236 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1238 struct GAS_Addresses_Handle *handle = cls;
1239 struct GAS_Addresses_Suggestion_Requests *cur;
1241 GNUNET_assert (handle != NULL);
1242 GNUNET_assert (address != NULL);
1244 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1245 struct GNUNET_ATS_Information *ats;
1246 unsigned int ats_count;
1248 cur = handle->r_head;
1251 if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1252 break; /* we have an address request pending*/
1257 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1258 "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1262 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1263 "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1265 ats_count = assemble_ats_information (address, &ats);
1266 GAS_scheduling_transmit_address_suggestion (&address->peer,
1268 address->addr, address->addr_len,
1269 address->session_id,
1271 address->assigned_bw_out,
1272 address->assigned_bw_in);
1278 * Initialize address subsystem.
1280 * @param cfg configuration to use
1281 * @param stats the statistics handle to use
1283 struct GAS_Addresses_Handle *
1284 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1285 const struct GNUNET_STATISTICS_Handle *stats)
1287 struct GAS_Addresses_Handle *ah;
1288 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1289 unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
1290 unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
1295 ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1296 ah->running = GNUNET_NO;
1298 ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1299 /* Initialize the addresses database */
1300 ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1301 GNUNET_assert (NULL != ah->addresses);
1303 /* Figure out configured solution method */
1304 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1306 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1307 ah->ats_mode = MODE_SIMPLISTIC;
1311 for (c = 0; c < strlen (mode_str); c++)
1312 mode_str[c] = toupper (mode_str[c]);
1313 if (0 == strcmp (mode_str, "SIMPLISTIC"))
1315 ah->ats_mode = MODE_SIMPLISTIC;
1317 else if (0 == strcmp (mode_str, "MLP"))
1319 ah->ats_mode = MODE_MLP;
1321 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1322 ah->ats_mode = MODE_SIMPLISTIC;
1327 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1328 ah->ats_mode = MODE_SIMPLISTIC;
1330 GNUNET_free (mode_str);
1332 /* Start configured solution method */
1333 switch (ah->ats_mode)
1336 /* Init the MLP solver with default values */
1338 ah->ats_mode = MODE_MLP;
1339 ah->s_init = &GAS_mlp_init;
1340 ah->s_add = &GAS_mlp_address_add;
1341 ah->s_update = &GAS_mlp_address_update;
1342 ah->s_get = &GAS_mlp_get_preferred_address;
1343 ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1344 ah->s_pref = &GAS_mlp_address_change_preference;
1345 ah->s_del = &GAS_mlp_address_delete;
1346 ah->s_done = &GAS_mlp_done;
1352 case MODE_SIMPLISTIC:
1353 /* Init the simplistic solver with default values */
1354 ah->ats_mode = MODE_SIMPLISTIC;
1355 ah->s_init = &GAS_simplistic_init;
1356 ah->s_add = &GAS_simplistic_address_add;
1357 ah->s_update = &GAS_simplistic_address_update;
1358 ah->s_get = &GAS_simplistic_get_preferred_address;
1359 ah->s_get_stop = &GAS_simplistic_stop_get_preferred_address;
1360 ah->s_pref = &GAS_simplistic_address_change_preference;
1361 ah->s_del = &GAS_simplistic_address_delete;
1362 ah->s_done = &GAS_simplistic_done;
1363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1370 GNUNET_assert (NULL != ah->s_init);
1371 GNUNET_assert (NULL != ah->s_add);
1372 GNUNET_assert (NULL != ah->s_update);
1373 GNUNET_assert (NULL != ah->s_get);
1374 GNUNET_assert (NULL != ah->s_get_stop);
1375 GNUNET_assert (NULL != ah->s_pref);
1376 GNUNET_assert (NULL != ah->s_del);
1377 GNUNET_assert (NULL != ah->s_done);
1379 quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1381 ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1382 if (NULL == ah->solver)
1384 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1389 /* up and running */
1390 ah->running = GNUNET_YES;
1396 * Free memory of address.
1399 * @param key peer identity (unused)
1400 * @param value the 'struct ATS_Address' to free
1401 * @return GNUNET_OK (continue to iterate)
1404 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1406 struct GAS_Addresses_Handle *handle = cls;
1407 struct ATS_Address *aa = value;
1408 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1409 destroy_address (handle, aa);
1415 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1417 if (GNUNET_NO == handle->running)
1420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1424 if (handle->addresses != NULL)
1425 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1430 * Shutdown address subsystem.
1433 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1435 struct GAS_Addresses_Suggestion_Requests *cur;
1437 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1438 "Shutting down addresses\n");
1439 GNUNET_assert (NULL != handle);
1440 GAS_addresses_destroy_all (handle);
1441 handle->running = GNUNET_NO;
1442 GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1443 handle->addresses = NULL;
1444 while (NULL != (cur = handle->r_head))
1446 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1449 handle->s_done (handle->solver);
1450 GNUNET_free (handle);
1451 /* Stop configured solution method */
1455 struct PeerIteratorContext
1457 GNUNET_ATS_Peer_Iterator it;
1459 struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1464 const struct GNUNET_HashCode * key,
1467 struct PeerIteratorContext *ip_ctx = cls;
1468 struct GNUNET_PeerIdentity tmp;
1470 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1472 GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1473 tmp.hashPubKey = (*key);
1474 ip_ctx->it (ip_ctx->it_cls, &tmp);
1481 * Return all peers currently known to ATS
1483 * @param handle the address handle
1484 * @param p_it the iterator to call for every peer, callbach with id == NULL
1486 * @param p_it_cls the closure for the iterator
1489 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle, GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls)
1491 struct PeerIteratorContext ip_ctx;
1496 GNUNET_assert (NULL != handle->addresses);
1498 size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1502 ip_ctx.it_cls = p_it_cls;
1503 ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1504 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1505 GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1507 p_it (p_it_cls, NULL);
1510 struct PeerInfoIteratorContext
1512 GNUNET_ATS_PeerInfo_Iterator it;
1518 peerinfo_it (void *cls,
1519 const struct GNUNET_HashCode * key,
1522 struct PeerInfoIteratorContext *pi_ctx = cls;
1523 struct ATS_Address *addr = (struct ATS_Address *) value;
1524 struct GNUNET_ATS_Information *ats;
1527 if (NULL != pi_ctx->it)
1529 ats_count = assemble_ats_information (addr, &ats);
1531 pi_ctx->it (pi_ctx->it_cls,
1534 addr->addr, addr->addr_len,
1537 addr->assigned_bw_out,
1538 addr->assigned_bw_in);
1546 * Return all peers currently known to ATS
1548 * @param handle the address handle
1549 * @param peer the respective peer
1550 * @param pi_it the iterator to call for every peer
1551 * @param pi_it_cls the closure for the iterator
1554 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1555 const struct GNUNET_PeerIdentity *peer,
1556 GNUNET_ATS_PeerInfo_Iterator pi_it,
1559 struct PeerInfoIteratorContext pi_ctx;
1560 struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1561 GNUNET_assert (NULL != peer);
1562 GNUNET_assert (NULL != handle->addresses);
1564 return; /* does not make sense without callback */
1566 zero_bw = GNUNET_BANDWIDTH_value_init (0);
1568 pi_ctx.it_cls = pi_it_cls;
1570 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1573 pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1578 /* end of gnunet-service-ats_addresses.c */