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 * Delete address in solver
351 GAS_solver_address_delete s_del;
354 * Change preference for quality in solver
356 GAS_solver_address_change_preference s_pref;
361 GAS_solver_done s_done;
366 assemble_ats_information (const struct ATS_Address *aa, struct GNUNET_ATS_Information **dest)
368 unsigned int ats_count = GNUNET_ATS_PropertyCount - 1;
369 struct GNUNET_ATS_Information *ats = GNUNET_malloc (ats_count * sizeof (struct GNUNET_ATS_Information));
372 ats[0].type = ntohl(GNUNET_ATS_UTILIZATION_UP);
373 ats[0].value = aa->atsp_utilization_out.value__;
374 ats[1].type = ntohl(GNUNET_ATS_UTILIZATION_DOWN);
375 ats[1].value = aa->atsp_utilization_in.value__;
376 ats[2].type = ntohl(GNUNET_ATS_NETWORK_TYPE);
377 ats[2].value = ntohl(aa->atsp_network_type);
378 ats[3].type = ntohl(GNUNET_ATS_QUALITY_NET_DELAY);
379 ats[3].value = ntohl(aa->atsp_latency.rel_value);
380 ats[4].type = ntohl(GNUNET_ATS_QUALITY_NET_DISTANCE);
381 ats[4].value = ntohl(aa->atsp_distance);
382 ats[5].type = ntohl(GNUNET_ATS_COST_WAN);
383 ats[5].value = ntohl (aa->atsp_cost_wan);
384 ats[6].type = ntohl(GNUNET_ATS_COST_LAN);
385 ats[6].value = ntohl (aa->atsp_cost_lan);
386 ats[7].type = ntohl(GNUNET_ATS_COST_WLAN);
387 ats[7].value = ntohl (aa->atsp_cost_wlan);
392 disassemble_ats_information (const struct GNUNET_ATS_Information *src,
394 struct ATS_Address *dest)
398 for (i = 0; i < ats_count; i++)
399 switch (ntohl (src[i].type))
401 case GNUNET_ATS_UTILIZATION_UP:
402 dest->atsp_utilization_out.value__ = src[i].value;
405 case GNUNET_ATS_UTILIZATION_DOWN:
406 dest->atsp_utilization_in.value__ = src[i].value;
409 case GNUNET_ATS_QUALITY_NET_DELAY:
410 dest->atsp_latency.rel_value = ntohl (src[i].value);
413 case GNUNET_ATS_QUALITY_NET_DISTANCE:
414 dest->atsp_distance = ntohl (src[i].value);
417 case GNUNET_ATS_COST_WAN:
418 dest->atsp_cost_wan = ntohl (src[i].value);
421 case GNUNET_ATS_COST_LAN:
422 dest->atsp_cost_lan = ntohl (src[i].value);
425 case GNUNET_ATS_COST_WLAN:
426 dest->atsp_cost_wlan = ntohl (src[i].value);
429 case GNUNET_ATS_NETWORK_TYPE:
430 dest->atsp_network_type = ntohl (src[i].value);
433 case GNUNET_ATS_ARRAY_TERMINATOR:
436 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
437 "Received unsupported ATS type %u\n", ntohl (src[i].type));
445 * Free the given address
446 * @param addr address to destroy
449 free_address (struct ATS_Address *addr)
451 GNUNET_free (addr->plugin);
456 * Create a ATS_address with the given information
458 * @param plugin_name plugin
459 * @param plugin_addr address
460 * @param plugin_addr_len address length
461 * @param session_id session
462 * @return the ATS_Address
464 static struct ATS_Address *
465 create_address (const struct GNUNET_PeerIdentity *peer,
466 const char *plugin_name,
467 const void *plugin_addr, size_t plugin_addr_len,
470 struct ATS_Address *aa = NULL;
472 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
474 aa->addr_len = plugin_addr_len;
476 memcpy (&aa[1], plugin_addr, plugin_addr_len);
477 aa->plugin = GNUNET_strdup (plugin_name);
478 aa->session_id = session_id;
479 aa->active = GNUNET_NO;
480 aa->used = GNUNET_NO;
481 aa->solver_information = NULL;
482 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
483 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
489 * Destroy the given address.
491 * @param handle the address handle
492 * @param addr address to destroy
493 * @return GNUNET_YES if bandwidth allocations should be recalcualted
496 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
501 GNUNET_assert (GNUNET_YES ==
502 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
503 &addr->peer.hashPubKey,
510 struct CompareAddressContext
512 const struct ATS_Address *search;
514 /* exact_address != NULL if address and session is equal */
515 struct ATS_Address *exact_address;
516 /* exact_address != NULL if address and session is 0 */
517 struct ATS_Address *base_address;
522 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
524 struct CompareAddressContext *cac = cls;
525 struct ATS_Address *aa = value;
527 /* Find an matching exact address:
530 * aa->addr_len == cac->search->addr_len
531 * aa->plugin == cac->search->plugin
532 * aa->addr == cac->search->addr
533 * aa->session == cac->search->session
535 * return as exact address
537 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
539 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
540 cac->exact_address = aa;
543 /* Find an matching base address:
547 * aa->session_id == 0
550 * aa->addr_len == cac->search->addr_len
551 * aa->plugin == cac->search->plugin
552 * aa->addr == cac->search->addr
554 * return as base address
556 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
558 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
559 cac->base_address = aa;
562 /* Find an matching exact address based on session:
566 * cac->search->addr_len == 0
569 * aa->plugin == cac->search->plugin
570 * aa->session_id == cac->search->session_id
572 * return as exact address
574 if (0 == cac->search->addr_len)
576 if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
577 cac->exact_address = aa;
580 if (cac->exact_address == NULL)
581 return GNUNET_YES; /* Continue iteration to find exact address */
583 return GNUNET_NO; /* Stop iteration since we have an exact address */
588 * Find an existing equivalent address record.
589 * Compares by peer identity and network address OR by session ID
590 * (one of the two must match).
592 * @param handle the address handle
593 * @param peer peer to lookup addresses for
594 * @param addr existing address record
595 * @return existing address record, NULL for none
598 find_equivalent_address (struct GAS_Addresses_Handle *handle,
599 const struct GNUNET_PeerIdentity *peer,
600 const struct ATS_Address *addr)
602 struct CompareAddressContext cac;
604 cac.exact_address = NULL;
605 cac.base_address = NULL;
607 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
608 &compare_address_it, &cac);
610 if (cac.exact_address == NULL)
611 return cac.base_address;
612 return cac.exact_address;
616 static struct ATS_Address *
617 lookup_address (struct GAS_Addresses_Handle *handle,
618 const struct GNUNET_PeerIdentity *peer,
619 const char *plugin_name,
620 const void *plugin_addr,
621 size_t plugin_addr_len,
623 const struct GNUNET_ATS_Information *atsi,
626 struct ATS_Address *aa;
627 struct ATS_Address *ea;
629 aa = create_address (peer,
631 plugin_addr, plugin_addr_len,
634 /* Get existing address or address with session == 0 */
635 ea = find_equivalent_address (handle, peer, aa);
641 else if (ea->session_id != session_id)
650 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
651 const struct GNUNET_PeerIdentity *peer,
652 const char *plugin_name, const void *plugin_addr,
653 size_t plugin_addr_len, uint32_t session_id,
654 const struct GNUNET_ATS_Information *atsi,
657 struct ATS_Address *aa;
658 struct ATS_Address *ea;
659 unsigned int ats_res;
661 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
662 "Received `%s' for peer `%s'\n",
666 if (GNUNET_NO == handle->running)
669 GNUNET_assert (NULL != handle->addresses);
671 aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
673 if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, aa)))
675 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
676 "While adding address: had %u ATS elements to add, could only add %u\n",
677 atsi_count, ats_res);
680 /* Get existing address or address with session == 0 */
681 ea = find_equivalent_address (handle, peer, aa);
684 /* We have a new address */
685 GNUNET_assert (GNUNET_OK ==
686 GNUNET_CONTAINER_multihashmap_put (handle->addresses,
687 &peer->hashPubKey, aa,
688 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
689 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
690 GNUNET_i2s (peer), session_id, aa);
691 /* Tell solver about new address */
692 handle->s_add (handle->solver, handle->addresses, aa);
695 GNUNET_free (aa->plugin);
698 if (ea->session_id != 0)
700 /* This address with the same session is already existing
701 * Should not happen */
702 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
703 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
704 GNUNET_i2s (peer), plugin_name, session_id);
709 /* We have an address without an session, update this address */
711 /* Notify solver about update with atsi information and session */
712 handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi, atsi_count);
715 ea->session_id = session_id;
716 if (atsi_count != (ats_res = disassemble_ats_information(atsi, atsi_count, ea)))
718 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
719 "While updating address: had %u ATS elements to add, could only add %u\n",
720 atsi_count, ats_res);
722 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
723 "Updated existing address for peer `%s' %p with new session %u\n",
724 GNUNET_i2s (peer), ea, session_id);
729 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
730 const struct GNUNET_PeerIdentity *peer,
731 const char *plugin_name, const void *plugin_addr,
732 size_t plugin_addr_len, uint32_t session_id,
733 const struct GNUNET_ATS_Information *atsi,
736 struct ATS_Address *aa;
739 if (GNUNET_NO == handle->running)
742 GNUNET_assert (NULL != handle->addresses);
744 /* Get existing address */
745 aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
746 session_id, atsi, atsi_count);
749 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n",
750 GNUNET_i2s (peer), plugin_name, session_id);
755 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
756 "Received `%s' for peer `%s' address \n",
758 GNUNET_i2s (peer), aa);
760 /* Tell solver about update */
761 handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi, atsi_count);
764 if (atsi_count != (ats_res = disassemble_ats_information (atsi, atsi_count, aa)))
766 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
767 "While adding address: had %u ATS elements to add, could only add %u\n",
768 atsi_count, ats_res);
770 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
771 "Updated %u ATS elements for address %p\n",
776 struct DestroyContext
778 struct ATS_Address *aa;
780 struct GAS_Addresses_Handle *handle;
783 * GNUNET_NO : full address
784 * GNUNET_YES : just session
793 * If session != 0, just the session is deleted, the address itself still exists
794 * If session == 0, remove full address
795 * If session == 0 and addrlen == 0, destroy inbound address
799 * @param value the 'struct ATS_Address'
800 * @return GNUNET_OK (continue to iterate)
803 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
805 struct DestroyContext *dc = cls;
806 struct GAS_Addresses_Handle *handle = dc->handle;
807 const struct ATS_Address *des = dc->aa;
808 struct ATS_Address *aa = value;
810 GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
811 sizeof (struct GNUNET_PeerIdentity)));
814 if (des->session_id == 0)
816 /* Session == 0, remove full address */
817 if ((0 == strcmp (des->plugin, aa->plugin)) &&
818 (aa->addr_len == des->addr_len) &&
819 (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
822 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
823 "Deleting full address for peer `%s' session %u %p\n",
824 GNUNET_i2s (&aa->peer), aa->session_id, aa);
826 /* Notify solver about deletion */
827 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
828 destroy_address (handle, aa);
829 dc->result = GNUNET_NO;
830 return GNUNET_OK; /* Continue iteration */
835 /* Session != 0, just remove session */
836 if (aa->session_id != des->session_id)
837 return GNUNET_OK; /* irrelevant */
839 if ((aa->session_id != 0) &&
840 (0 != strcmp (des->plugin, aa->plugin)))
842 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
843 "Different plugins during removal: `%s' vs `%s' \n",
844 des->plugin, aa->plugin);
849 if (aa->addr_len == 0)
851 /* Inbound connection died, delete full address */
852 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
853 "Deleting inbound address for peer `%s': `%s' session %u\n",
854 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
856 /* Notify solver about deletion */
857 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
858 destroy_address (handle, aa);
859 dc->result = GNUNET_NO;
860 return GNUNET_OK; /* Continue iteration */
865 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
866 "Deleting session for peer `%s': `%s' %u\n",
867 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
868 /* Notify solver to delete session */
869 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
878 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
879 const struct GNUNET_PeerIdentity *peer,
880 const char *plugin_name, const void *plugin_addr,
881 size_t plugin_addr_len, uint32_t session_id)
883 struct ATS_Address *ea;
884 struct DestroyContext dc;
886 if (GNUNET_NO == handle->running)
889 /* Get existing address */
890 ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
891 session_id, NULL, 0);
893 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
894 "Received `%s' for peer `%s' address %p session %u\n",
896 GNUNET_i2s (peer), ea, session_id);
900 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
901 GNUNET_i2s (peer), plugin_name, session_id);
905 GNUNET_break (0 < strlen (plugin_name));
907 dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
909 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
910 &destroy_by_session_id, &dc);
911 free_address (dc.aa);
916 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
917 const struct GNUNET_PeerIdentity *peer,
918 const char *plugin_name, const void *plugin_addr,
919 size_t plugin_addr_len, uint32_t session_id, int in_use)
921 struct ATS_Address *ea;
923 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
924 "Received `%s' for peer `%s'\n",
928 if (GNUNET_NO == handle->running)
929 return GNUNET_SYSERR;
931 ea = lookup_address (handle, peer, plugin_name,
932 plugin_addr, plugin_addr_len,
933 session_id, NULL, 0);
936 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
937 "Trying to set unknown address `%s', %s %u %s \n",
939 plugin_name, session_id,
940 (GNUNET_NO == in_use) ? "NO" : "YES");
942 return GNUNET_SYSERR;
944 if (ea->used == in_use)
947 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
948 "Address in use called multiple times for peer `%s': %s -> %s \n",
950 (GNUNET_NO == ea->used) ? "NO" : "YES",
951 (GNUNET_NO == in_use) ? "NO" : "YES");
952 return GNUNET_SYSERR;
955 /* Tell solver about update */
956 handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
964 * Cancel address suggestions for a peer
966 * @param handle the address handle
967 * @param peer the respective peer
970 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
971 const struct GNUNET_PeerIdentity *peer)
973 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
975 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
976 "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
980 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
987 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
988 "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
991 GAS_addresses_handle_backoff_reset (handle, peer);
992 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
993 "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
994 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1000 * Add an address suggestions for a peer
1002 * @param handle the address handle
1003 * @param peer the respective peer
1006 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1007 const struct GNUNET_PeerIdentity *peer)
1009 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1010 struct ATS_Address *aa;
1011 struct GNUNET_ATS_Information *ats;
1012 unsigned int ats_count;
1014 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1015 "Received `%s' for peer `%s'\n",
1019 if (GNUNET_NO == handle->running)
1023 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1024 break; /* already suggesting */
1029 cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1031 GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1034 /* Get prefered address from solver */
1035 aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1038 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1039 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1043 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1044 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1046 ats_count = assemble_ats_information (aa, &ats);
1047 GAS_scheduling_transmit_address_suggestion (peer,
1049 aa->addr, aa->addr_len,
1052 aa->assigned_bw_out,
1053 aa->assigned_bw_in);
1055 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1056 aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1058 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1059 "Address %p ready for suggestion, block interval now %llu \n",
1060 aa, aa->block_interval);
1067 reset_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1069 struct ATS_Address *aa = value;
1071 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1072 "Resetting interval for peer `%s' address %p from %llu to 0\n",
1073 GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1075 aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1076 aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1082 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1083 const struct GNUNET_PeerIdentity *peer)
1085 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1086 "Received `%s' for peer `%s'\n",
1090 GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1098 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1100 const struct GNUNET_PeerIdentity *peer,
1101 enum GNUNET_ATS_PreferenceKind kind,
1104 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1105 "Received `%s' for peer `%s' for client %p\n",
1106 "CHANGE PREFERENCE",
1107 GNUNET_i2s (peer), client);
1109 if (GNUNET_NO == handle->running)
1112 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1115 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1116 "Received `%s' for unknown peer `%s' from client %p\n",
1117 "CHANGE PREFERENCE",
1118 GNUNET_i2s (peer), client);
1122 /* Tell solver about update */
1123 handle->s_pref (handle->solver, client, peer, kind, score);
1128 * Load quotas for networks from configuration
1130 * @param cfg configuration handle
1131 * @param out_dest where to write outbound quotas
1132 * @param in_dest where to write inbound quotas
1133 * @param dest_length length of inbound and outbound arrays
1134 * @return number of networks loaded
1137 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1139 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1140 char * entry_in = NULL;
1141 char * entry_out = NULL;
1142 char * quota_out_str;
1143 char * quota_in_str;
1147 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1151 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1152 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1155 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, "a_out_str))
1158 if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1160 out_dest[c] = GNUNET_ATS_MaxBandwidth;
1163 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1165 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out, &out_dest[c])))
1168 if (GNUNET_NO == res)
1170 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1171 network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1172 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1176 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1177 network_str[c], out_dest[c]);
1179 GNUNET_free (quota_out_str);
1183 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1184 network_str[c], GNUNET_ATS_DefaultBandwidth);
1185 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1189 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, "a_in_str))
1192 if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1194 in_dest[c] = GNUNET_ATS_MaxBandwidth;
1197 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1199 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in, &in_dest[c])))
1202 if (GNUNET_NO == res)
1204 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1205 network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1206 in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1210 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1211 network_str[c], in_dest[c]);
1213 GNUNET_free (quota_in_str);
1217 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1218 network_str[c], GNUNET_ATS_DefaultBandwidth);
1219 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1221 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]);
1222 GNUNET_free (entry_out);
1223 GNUNET_free (entry_in);
1225 return GNUNET_ATS_NetworkTypeCount;
1230 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1232 struct GAS_Addresses_Handle *handle = cls;
1233 struct GAS_Addresses_Suggestion_Requests *cur;
1235 GNUNET_assert (handle != NULL);
1236 GNUNET_assert (address != NULL);
1238 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1239 struct GNUNET_ATS_Information *ats;
1240 unsigned int ats_count;
1242 cur = handle->r_head;
1245 if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1246 break; /* we have an address request pending*/
1251 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1252 "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1256 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1257 "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1259 ats_count = assemble_ats_information (address, &ats);
1260 GAS_scheduling_transmit_address_suggestion (&address->peer,
1262 address->addr, address->addr_len,
1263 address->session_id,
1265 address->assigned_bw_out,
1266 address->assigned_bw_in);
1272 * Initialize address subsystem.
1274 * @param cfg configuration to use
1275 * @param stats the statistics handle to use
1277 struct GAS_Addresses_Handle *
1278 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1279 const struct GNUNET_STATISTICS_Handle *stats)
1281 struct GAS_Addresses_Handle *ah;
1282 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1283 unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
1284 unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
1289 ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1290 ah->running = GNUNET_NO;
1292 ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1293 /* Initialize the addresses database */
1294 ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1295 GNUNET_assert (NULL != ah->addresses);
1297 /* Figure out configured solution method */
1298 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1300 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1301 ah->ats_mode = MODE_SIMPLISTIC;
1305 for (c = 0; c < strlen (mode_str); c++)
1306 mode_str[c] = toupper (mode_str[c]);
1307 if (0 == strcmp (mode_str, "SIMPLISTIC"))
1309 ah->ats_mode = MODE_SIMPLISTIC;
1311 else if (0 == strcmp (mode_str, "MLP"))
1313 ah->ats_mode = MODE_MLP;
1315 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1316 ah->ats_mode = MODE_SIMPLISTIC;
1321 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1322 ah->ats_mode = MODE_SIMPLISTIC;
1324 GNUNET_free (mode_str);
1326 /* Start configured solution method */
1327 switch (ah->ats_mode)
1330 /* Init the MLP solver with default values */
1332 ah->ats_mode = MODE_MLP;
1333 ah->s_init = &GAS_mlp_init;
1334 ah->s_add = &GAS_mlp_address_add;
1335 ah->s_update = &GAS_mlp_address_update;
1336 ah->s_get = &GAS_mlp_get_preferred_address;
1337 ah->s_pref = &GAS_mlp_address_change_preference;
1338 ah->s_del = &GAS_mlp_address_delete;
1339 ah->s_done = &GAS_mlp_done;
1345 case MODE_SIMPLISTIC:
1346 /* Init the simplistic solver with default values */
1347 ah->ats_mode = MODE_SIMPLISTIC;
1348 ah->s_init = &GAS_simplistic_init;
1349 ah->s_add = &GAS_simplistic_address_add;
1350 ah->s_update = &GAS_simplistic_address_update;
1351 ah->s_get = &GAS_simplistic_get_preferred_address;
1352 ah->s_pref = &GAS_simplistic_address_change_preference;
1353 ah->s_del = &GAS_simplistic_address_delete;
1354 ah->s_done = &GAS_simplistic_done;
1355 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1362 GNUNET_assert (NULL != ah->s_init);
1363 GNUNET_assert (NULL != ah->s_add);
1364 GNUNET_assert (NULL != ah->s_update);
1365 GNUNET_assert (NULL != ah->s_get);
1366 GNUNET_assert (NULL != ah->s_pref);
1367 GNUNET_assert (NULL != ah->s_del);
1368 GNUNET_assert (NULL != ah->s_done);
1370 quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1372 ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1373 if (NULL == ah->solver)
1375 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1380 /* up and running */
1381 ah->running = GNUNET_YES;
1387 * Free memory of address.
1390 * @param key peer identity (unused)
1391 * @param value the 'struct ATS_Address' to free
1392 * @return GNUNET_OK (continue to iterate)
1395 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1397 struct GAS_Addresses_Handle *handle = cls;
1398 struct ATS_Address *aa = value;
1399 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1400 destroy_address (handle, aa);
1406 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1408 if (GNUNET_NO == handle->running)
1411 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1415 if (handle->addresses != NULL)
1416 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1421 * Shutdown address subsystem.
1424 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1426 struct GAS_Addresses_Suggestion_Requests *cur;
1428 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1429 "Shutting down addresses\n");
1430 GNUNET_assert (NULL != handle);
1431 GAS_addresses_destroy_all (handle);
1432 handle->running = GNUNET_NO;
1433 GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1434 handle->addresses = NULL;
1435 while (NULL != (cur = handle->r_head))
1437 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1440 handle->s_done (handle->solver);
1441 GNUNET_free (handle);
1442 /* Stop configured solution method */
1446 struct PeerIteratorContext
1448 GNUNET_ATS_Peer_Iterator it;
1450 struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1455 const struct GNUNET_HashCode * key,
1458 struct PeerIteratorContext *ip_ctx = cls;
1459 struct GNUNET_PeerIdentity tmp;
1461 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1463 GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1464 tmp.hashPubKey = (*key);
1465 ip_ctx->it (ip_ctx->it_cls, &tmp);
1472 * Return all peers currently known to ATS
1474 * @param handle the address handle
1475 * @param p_it the iterator to call for every peer, callbach with id == NULL
1477 * @param p_it_cls the closure for the iterator
1480 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle, GNUNET_ATS_Peer_Iterator p_it, void *p_it_cls)
1482 struct PeerIteratorContext ip_ctx;
1487 GNUNET_assert (NULL != handle->addresses);
1489 size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1493 ip_ctx.it_cls = p_it_cls;
1494 ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1495 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1496 GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1498 p_it (p_it_cls, NULL);
1501 struct PeerInfoIteratorContext
1503 GNUNET_ATS_PeerInfo_Iterator it;
1509 peerinfo_it (void *cls,
1510 const struct GNUNET_HashCode * key,
1513 struct PeerInfoIteratorContext *pi_ctx = cls;
1514 struct ATS_Address *addr = (struct ATS_Address *) value;
1515 struct GNUNET_ATS_Information *ats;
1518 if (NULL != pi_ctx->it)
1520 ats_count = assemble_ats_information (addr, &ats);
1522 pi_ctx->it (pi_ctx->it_cls,
1525 addr->addr, addr->addr_len,
1528 addr->assigned_bw_out,
1529 addr->assigned_bw_in);
1537 * Return all peers currently known to ATS
1539 * @param handle the address handle
1540 * @param peer the respective peer
1541 * @param pi_it the iterator to call for every peer
1542 * @param pi_it_cls the closure for the iterator
1545 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1546 const struct GNUNET_PeerIdentity *peer,
1547 GNUNET_ATS_PeerInfo_Iterator pi_it,
1550 struct PeerInfoIteratorContext pi_ctx;
1551 struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1552 GNUNET_assert (NULL != peer);
1553 GNUNET_assert (NULL != handle->addresses);
1555 return; /* does not make sense without callback */
1557 zero_bw = GNUNET_BANDWIDTH_value_init (0);
1559 pi_ctx.it_cls = pi_it_cls;
1561 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1564 pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1569 /* end of gnunet-service-ats_addresses.c */