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
257 * Pending Address suggestion requests
259 struct GAS_Addresses_Suggestion_Requests
264 struct GAS_Addresses_Suggestion_Requests *next;
269 struct GAS_Addresses_Suggestion_Requests *prev;
274 struct GNUNET_PeerIdentity id;
279 * Handle for ATS address component
281 struct GAS_Addresses_Handle
286 struct GNUNET_STATISTICS_Handle *stat;
289 * A multihashmap to store all addresses
291 struct GNUNET_CONTAINER_MultiHashMap *addresses;
294 * Configure WAN quota in
296 unsigned long long wan_quota_in;
299 * Configure WAN quota out
301 unsigned long long wan_quota_out;
304 * Is ATS addresses running
309 * Configured ATS solver
319 * Address suggestion requests DLL head
321 struct GAS_Addresses_Suggestion_Requests *r_head;
324 * Address suggestion requests DLL tail
326 struct GAS_Addresses_Suggestion_Requests *r_tail;
328 /* Solver functions */
333 GAS_solver_init s_init;
336 * Add an address to the solver
338 GAS_solver_address_add s_add;
341 * Update address in solver
343 GAS_solver_address_update s_update;
346 * Get address from solver
348 GAS_solver_get_preferred_address s_get;
351 * Get address from solver
353 GAS_solver_stop_get_preferred_address s_get_stop;
356 * Delete address in solver
358 GAS_solver_address_delete s_del;
361 * Change preference for quality in solver
363 GAS_solver_address_change_preference s_pref;
368 GAS_solver_done s_done;
373 * Disassemble ATS information and update performance information in address
375 * Updates existing information and adds new information
377 * @param src source ATS information
378 * @param ats_count number of ATS information
379 * @param delta ats performance information which were updated
380 * including previous value
381 * @param delta_count number of ATS information in the delta
382 * @param dest destination address
383 * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
386 disassemble_ats_information (struct ATS_Address *dest,
387 const struct GNUNET_ATS_Information *update,
388 uint32_t update_count,
389 struct GNUNET_ATS_Information **delta_dest,
390 uint32_t *delta_count)
398 struct GNUNET_ATS_Information add_atsi[update_count];
399 struct GNUNET_ATS_Information delta_atsi[update_count];
400 struct GNUNET_ATS_Information *tmp_atsi;
401 uint32_t add_atsi_count;
402 uint32_t delta_atsi_count;
406 delta_atsi_count = 0;
408 if (0 == update_count)
411 if (NULL == dest->atsi)
413 /* Create performance information */
414 dest->atsi = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
415 dest->atsi_count = update_count;
416 memcpy (dest->atsi, update, update_count * sizeof (struct GNUNET_ATS_Information));
417 delta_atsi_count = update_count;
418 (*delta_dest) = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
419 for (c1 = 0; c1 < update_count; c1 ++)
421 (*delta_dest)[c1].type = update[c1].type;
422 (*delta_dest)[c1].value = htonl(GNUNET_ATS_VALUE_UNDEFINED);
424 (*delta_count) = update_count;
428 for (c1 = 0; c1 < update_count; c1++)
430 /* Update existing performance information */
432 for (c2 = 0; c2 < dest->atsi_count; c2++)
434 if (update[c1].type == dest->atsi[c2].type)
436 if (update[c1].value != dest->atsi[c2].value)
438 /* Save previous value in delta */
439 delta_atsi[delta_atsi_count] = dest->atsi[c2];
442 dest->atsi[c2].value = update[c1].value;
449 if (GNUNET_NO == found)
451 add_atsi[add_atsi_count] = update[c1];
453 delta_atsi[delta_atsi_count].type = update[c1].type;
454 delta_atsi[delta_atsi_count].value = htonl (GNUNET_ATS_VALUE_UNDEFINED);
459 if (add_atsi_count > 0)
461 /* Extend ats performance information */
462 tmp_atsi = GNUNET_malloc ((dest->atsi_count + add_atsi_count) *
463 sizeof (sizeof (struct GNUNET_ATS_Information)));
464 memcpy (tmp_atsi, dest->atsi, dest->atsi_count * sizeof (struct GNUNET_ATS_Information));
465 memcpy (&tmp_atsi[dest->atsi_count], add_atsi, add_atsi_count * sizeof (struct GNUNET_ATS_Information));
466 GNUNET_free (dest->atsi);
467 dest->atsi = tmp_atsi;
468 dest->atsi_count = dest->atsi_count + add_atsi_count;
472 if (delta_atsi_count > 0)
475 (*delta_dest) = GNUNET_malloc (delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
476 memcpy ((*delta_dest), delta_atsi, delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
477 (*delta_count) = delta_atsi_count;
484 * Free the given address
486 * @param addr address to destroy
489 free_address (struct ATS_Address *addr)
491 GNUNET_free (addr->plugin);
492 GNUNET_free_non_null (addr->atsi);
497 * Create a ATS_address with the given information
500 * @param plugin_name plugin
501 * @param plugin_addr address
502 * @param plugin_addr_len address length
503 * @param session_id session
504 * @return the ATS_Address
506 static struct ATS_Address *
507 create_address (const struct GNUNET_PeerIdentity *peer,
508 const char *plugin_name,
509 const void *plugin_addr, size_t plugin_addr_len,
512 struct ATS_Address *aa = NULL;
514 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
516 aa->addr_len = plugin_addr_len;
518 memcpy (&aa[1], plugin_addr, plugin_addr_len);
519 aa->plugin = GNUNET_strdup (plugin_name);
520 aa->session_id = session_id;
521 aa->active = GNUNET_NO;
522 aa->used = GNUNET_NO;
523 aa->solver_information = NULL;
526 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
527 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
533 * Destroy the given address.
535 * @param handle the address handle
536 * @param addr address to destroy
537 * @return GNUNET_YES if bandwidth allocations should be recalcualted
540 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
545 GNUNET_assert (GNUNET_YES ==
546 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
547 &addr->peer.hashPubKey,
554 struct CompareAddressContext
556 const struct ATS_Address *search;
558 /* exact_address != NULL if address and session is equal */
559 struct ATS_Address *exact_address;
560 /* exact_address != NULL if address and session is 0 */
561 struct ATS_Address *base_address;
567 * @param cls a CompareAddressContext containin the source address
569 * @param value the address to compare with
570 * @return GNUNET_YES to continue, GNUNET_NO if address is founce
574 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
576 struct CompareAddressContext *cac = cls;
577 struct ATS_Address *aa = value;
579 /* Find an matching exact address:
582 * aa->addr_len == cac->search->addr_len
583 * aa->plugin == cac->search->plugin
584 * aa->addr == cac->search->addr
585 * aa->session == cac->search->session
587 * return as exact address
589 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
591 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
592 cac->exact_address = aa;
595 /* Find an matching base address:
599 * aa->session_id == 0
602 * aa->addr_len == cac->search->addr_len
603 * aa->plugin == cac->search->plugin
604 * aa->addr == cac->search->addr
606 * return as base address
608 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
610 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
611 cac->base_address = aa;
614 /* Find an matching exact address based on session:
618 * cac->search->addr_len == 0
621 * aa->plugin == cac->search->plugin
622 * aa->session_id == cac->search->session_id
624 * return as exact address
626 if (0 == cac->search->addr_len)
628 if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
629 cac->exact_address = aa;
632 if (cac->exact_address == NULL)
633 return GNUNET_YES; /* Continue iteration to find exact address */
635 return GNUNET_NO; /* Stop iteration since we have an exact address */
640 * Find an existing equivalent address record.
641 * Compares by peer identity and network address OR by session ID
642 * (one of the two must match).
644 * @param handle the address handle
645 * @param peer peer to lookup addresses for
646 * @param addr existing address record
647 * @return existing address record, NULL for none
650 find_equivalent_address (struct GAS_Addresses_Handle *handle,
651 const struct GNUNET_PeerIdentity *peer,
652 const struct ATS_Address *addr)
654 struct CompareAddressContext cac;
656 cac.exact_address = NULL;
657 cac.base_address = NULL;
659 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
660 &compare_address_it, &cac);
662 if (cac.exact_address == NULL)
663 return cac.base_address;
664 return cac.exact_address;
669 * Lookup an ATS address by the address properties and session or return an
670 * equivalent address with a session == 0
672 * @param handle the address handle to use
674 * @param plugin_name transport plugin name
675 * @param plugin_addr plugin address
676 * @param plugin_addr_len length of the plugin address
677 * @param session_id session id, can be 0
678 * @param atsi performance information for this address
679 * @param atsi_count number of performance information contained
680 * @return an ATS_address or NULL
683 static struct ATS_Address *
684 lookup_address (struct GAS_Addresses_Handle *handle,
685 const struct GNUNET_PeerIdentity *peer,
686 const char *plugin_name,
687 const void *plugin_addr,
688 size_t plugin_addr_len,
690 const struct GNUNET_ATS_Information *atsi,
693 struct ATS_Address *aa;
694 struct ATS_Address *ea;
696 aa = create_address (peer,
698 plugin_addr, plugin_addr_len,
701 /* Get existing address or address with session == 0 */
702 ea = find_equivalent_address (handle, peer, aa);
708 else if (ea->session_id != session_id)
716 * Extract an ATS performance info from an address
718 * @param address the address
719 * @param type the type to extract in HBO
720 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
723 get_performance_info (struct ATS_Address *address, uint32_t type)
726 GNUNET_assert (NULL != address);
728 if ((NULL == address->atsi) || (0 == address->atsi_count))
729 return GNUNET_ATS_VALUE_UNDEFINED;
731 for (c1 = 0; c1 < address->atsi_count; c1++)
733 if (ntohl(address->atsi[c1].type) == type)
734 return ntohl(address->atsi[c1].value);
736 return GNUNET_ATS_VALUE_UNDEFINED;
741 * Add a new address for a peer.
743 * @param handle the address handle to use
745 * @param plugin_name transport plugin name
746 * @param plugin_addr plugin address
747 * @param plugin_addr_len length of the plugin address
748 * @param session_id session id, can be 0
749 * @param atsi performance information for this address
750 * @param atsi_count number of performance information contained
753 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
754 const struct GNUNET_PeerIdentity *peer,
755 const char *plugin_name, const void *plugin_addr,
756 size_t plugin_addr_len, uint32_t session_id,
757 const struct GNUNET_ATS_Information *atsi,
760 struct ATS_Address *aa;
761 struct ATS_Address *ea;
762 struct GNUNET_ATS_Information *atsi_delta;
763 uint32_t atsi_delta_count;
767 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
768 "Received `%s' for peer `%s'\n",
772 if (GNUNET_NO == handle->running)
775 GNUNET_assert (NULL != handle->addresses);
777 aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
780 disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta, &atsi_delta_count);
781 GNUNET_free_non_null (atsi_delta);
782 addr_net = get_performance_info (aa, GNUNET_ATS_NETWORK_TYPE);
783 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
784 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
786 /* Get existing address or address with session == 0 */
787 ea = find_equivalent_address (handle, peer, aa);
790 /* We have a new address */
791 GNUNET_assert (GNUNET_OK ==
792 GNUNET_CONTAINER_multihashmap_put (handle->addresses,
793 &peer->hashPubKey, aa,
794 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
795 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
796 GNUNET_i2s (peer), session_id, aa);
797 /* Tell solver about new address */
798 handle->s_add (handle->solver, handle->addresses, aa, addr_net);
799 /* Notify performance clients about new address */
800 GAS_performance_notify_all_clients (&aa->peer,
802 aa->addr, aa->addr_len,
804 aa->atsi, aa->atsi_count,
810 GNUNET_free (aa->plugin);
811 GNUNET_free_non_null (aa->atsi);
815 if (ea->session_id != 0)
817 /* This address with the same session is already existing
818 * Should not happen */
819 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
820 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
821 GNUNET_i2s (peer), plugin_name, session_id);
826 /* We have an address without an session, update this address */
828 atsi_delta_count = 0;
829 if (GNUNET_YES == disassemble_ats_information (ea, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
831 GAS_performance_notify_all_clients (&ea->peer,
833 ea->addr, ea->addr_len,
835 ea->atsi, ea->atsi_count,
840 /* Notify solver about update with atsi information and session */
841 handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi_delta, atsi_delta_count);
842 GNUNET_free_non_null (atsi_delta);
845 ea->session_id = session_id;
846 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
847 "Updated existing address for peer `%s' %p with new session %u\n",
848 GNUNET_i2s (peer), ea, session_id);
853 * Update an address with a session or performance information for a peer.
855 * If an address was added without a session it will be updated with the
858 * @param handle the address handle to use
860 * @param plugin_name transport plugin name
861 * @param plugin_addr plugin address
862 * @param plugin_addr_len length of the plugin address
863 * @param session_id session id, can be 0
864 * @param atsi performance information for this address
865 * @param atsi_count number of performance information contained
868 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
869 const struct GNUNET_PeerIdentity *peer,
870 const char *plugin_name, const void *plugin_addr,
871 size_t plugin_addr_len, uint32_t session_id,
872 const struct GNUNET_ATS_Information *atsi,
875 struct ATS_Address *aa;
876 struct GNUNET_ATS_Information *atsi_delta;
877 uint32_t atsi_delta_count;
879 if (GNUNET_NO == handle->running)
882 GNUNET_assert (NULL != handle->addresses);
884 /* Get existing address */
885 aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
886 session_id, atsi, atsi_count);
889 /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
890 /* GNUNET_i2s (peer), plugin_name, session_id); */
891 /* GNUNET_break (0); */
895 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
896 "Received `%s' for peer `%s' address \n",
898 GNUNET_i2s (peer), aa);
902 atsi_delta_count = 0;
903 if (GNUNET_YES == disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
905 /* Notify performance clients about updated address */
906 GAS_performance_notify_all_clients (&aa->peer,
908 aa->addr, aa->addr_len,
910 aa->atsi, aa->atsi_count,
914 /* Tell solver about update */
915 handle->s_update (handle->solver, handle->addresses, aa, session_id, aa->used, atsi_delta, atsi_delta_count);
916 GNUNET_free_non_null (atsi_delta);
920 struct DestroyContext
922 struct ATS_Address *aa;
924 struct GAS_Addresses_Handle *handle;
927 * GNUNET_NO : full address
928 * GNUNET_YES : just session
937 * If session != 0, just the session is deleted, the address itself still exists
938 * If session == 0, remove full address
939 * If session == 0 and addrlen == 0, destroy inbound address
943 * @param value the 'struct ATS_Address'
944 * @return GNUNET_OK (continue to iterate)
947 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
949 struct DestroyContext *dc = cls;
950 struct GAS_Addresses_Handle *handle = dc->handle;
951 const struct ATS_Address *des = dc->aa;
952 struct ATS_Address *aa = value;
954 GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
955 sizeof (struct GNUNET_PeerIdentity)));
958 if (des->session_id == 0)
960 /* Session == 0, remove full address */
961 if ((0 == strcmp (des->plugin, aa->plugin)) &&
962 (aa->addr_len == des->addr_len) &&
963 (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
966 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
967 "Deleting full address for peer `%s' session %u %p\n",
968 GNUNET_i2s (&aa->peer), aa->session_id, aa);
970 /* Notify solver about deletion */
971 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
972 destroy_address (handle, aa);
973 dc->result = GNUNET_NO;
974 return GNUNET_OK; /* Continue iteration */
979 /* Session != 0, just remove session */
980 if (aa->session_id != des->session_id)
981 return GNUNET_OK; /* irrelevant */
983 if ((aa->session_id != 0) &&
984 (0 != strcmp (des->plugin, aa->plugin)))
986 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
987 "Different plugins during removal: `%s' vs `%s' \n",
988 des->plugin, aa->plugin);
993 if (aa->addr_len == 0)
995 /* Inbound connection died, delete full address */
996 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
997 "Deleting inbound address for peer `%s': `%s' session %u\n",
998 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1000 /* Notify solver about deletion */
1001 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1002 destroy_address (handle, aa);
1003 dc->result = GNUNET_NO;
1004 return GNUNET_OK; /* Continue iteration */
1009 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1010 "Deleting session for peer `%s': `%s' %u\n",
1011 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1012 /* Notify solver to delete session */
1013 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
1023 * Remove an address or just a session for a peer.
1025 * @param handle the address handle to use
1027 * @param plugin_name transport plugin name
1028 * @param plugin_addr plugin address
1029 * @param plugin_addr_len length of the plugin address
1030 * @param session_id session id, can be 0
1033 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
1034 const struct GNUNET_PeerIdentity *peer,
1035 const char *plugin_name,
1036 const void *plugin_addr,
1037 size_t plugin_addr_len,
1038 uint32_t session_id)
1040 struct ATS_Address *ea;
1041 struct DestroyContext dc;
1043 if (GNUNET_NO == handle->running)
1046 /* Get existing address */
1047 ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
1048 session_id, NULL, 0);
1050 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1051 "Received `%s' for peer `%s' address %p session %u\n",
1053 GNUNET_i2s (peer), ea, session_id);
1057 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1058 GNUNET_i2s (peer), plugin_name, session_id);
1062 GNUNET_break (0 < strlen (plugin_name));
1064 dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
1066 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
1067 &destroy_by_session_id, &dc);
1068 free_address (dc.aa);
1073 * Notification about active use of an address.
1074 * in_use == GNUNET_YES:
1075 * This address is used to maintain an active connection with a peer.
1076 * in_use == GNUNET_NO:
1077 * This address is no longer used to maintain an active connection with a peer.
1079 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1082 * @param handle the address handle to use
1084 * @param plugin_name transport plugin name
1085 * @param plugin_addr plugin address
1086 * @param plugin_addr_len length of the plugin address
1087 * @param session_id session id, can be 0
1088 * @param in_use GNUNET_YES if GNUNET_NO
1089 * @return GNUNET_SYSERR on failure (address unknown ...)
1092 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1093 const struct GNUNET_PeerIdentity *peer,
1094 const char *plugin_name,
1095 const void *plugin_addr,
1096 size_t plugin_addr_len,
1097 uint32_t session_id,
1100 struct ATS_Address *ea;
1102 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1103 "Received `%s' for peer `%s'\n",
1107 if (GNUNET_NO == handle->running)
1108 return GNUNET_SYSERR;
1110 ea = lookup_address (handle, peer, plugin_name,
1111 plugin_addr, plugin_addr_len,
1112 session_id, NULL, 0);
1115 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1116 "Trying to set unknown address `%s', %s %u %s \n",
1118 plugin_name, session_id,
1119 (GNUNET_NO == in_use) ? "NO" : "YES");
1121 return GNUNET_SYSERR;
1123 if (ea->used == in_use)
1126 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1127 "Address in use called multiple times for peer `%s': %s -> %s \n",
1129 (GNUNET_NO == ea->used) ? "NO" : "YES",
1130 (GNUNET_NO == in_use) ? "NO" : "YES");
1131 return GNUNET_SYSERR;
1134 /* Tell solver about update */
1135 handle->s_update (handle->solver, handle->addresses, ea, session_id, in_use, NULL, 0);
1143 * Cancel address suggestions for a peer
1145 * @param handle the address handle
1146 * @param peer the peer id
1149 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1150 const struct GNUNET_PeerIdentity *peer)
1152 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1154 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1155 "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1159 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1166 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1167 "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1170 handle->s_get_stop (handle->solver, handle->addresses, peer);
1171 GAS_addresses_handle_backoff_reset (handle, peer);
1172 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1173 "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1174 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1180 * Request address suggestions for a peer
1182 * @param handle the address handle
1183 * @param peer the peer id
1186 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1187 const struct GNUNET_PeerIdentity *peer)
1189 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1190 struct ATS_Address *aa;
1192 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1193 "Received `%s' for peer `%s'\n",
1197 if (GNUNET_NO == handle->running)
1201 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1202 break; /* already suggesting */
1207 cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1209 GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1212 /* Get prefered address from solver */
1213 aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1216 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1217 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1221 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1222 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1224 GAS_scheduling_transmit_address_suggestion (peer,
1226 aa->addr, aa->addr_len,
1228 aa->atsi, aa->atsi_count,
1229 aa->assigned_bw_out,
1230 aa->assigned_bw_in);
1232 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1233 aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1235 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1236 "Address %p ready for suggestion, block interval now %llu \n",
1237 aa, aa->block_interval);
1242 * Iterator to reset address blocking
1244 * @param cls not used
1245 * @param key the peer
1246 * @param value the address to reset
1247 * @return GNUNET_OK to continue
1250 reset_address_it (void *cls, const struct GNUNET_HashCode *key, void *value)
1252 struct ATS_Address *aa = value;
1254 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1255 "Resetting interval for peer `%s' address %p from %llu to 0\n",
1256 GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1258 aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1259 aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1265 * Reset suggestion backoff for a peer
1267 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1268 * reset using this function
1270 * @param handle the address handle
1271 * @param peer the peer id
1274 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1275 const struct GNUNET_PeerIdentity *peer)
1277 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1278 "Received `%s' for peer `%s'\n",
1282 GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1290 * Change the preference for a peer
1292 * @param handle the address handle
1293 * @param client the client sending this request
1294 * @param peer the peer id
1295 * @param kind the preference kind to change
1296 * @param score the new preference score
1299 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1301 const struct GNUNET_PeerIdentity *peer,
1302 enum GNUNET_ATS_PreferenceKind kind,
1305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1306 "Received `%s' for peer `%s' for client %p\n",
1307 "CHANGE PREFERENCE",
1308 GNUNET_i2s (peer), client);
1310 if (GNUNET_NO == handle->running)
1313 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1316 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1317 "Received `%s' for unknown peer `%s' from client %p\n",
1318 "CHANGE PREFERENCE",
1319 GNUNET_i2s (peer), client);
1323 /* Tell solver about update */
1324 handle->s_pref (handle->solver, client, peer, kind, score);
1329 * Load quotas for networks from configuration
1331 * @param cfg configuration handle
1332 * @param out_dest where to write outbound quotas
1333 * @param in_dest where to write inbound quotas
1334 * @param dest_length length of inbound and outbound arrays
1335 * @return number of networks loaded
1338 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1340 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1341 char * entry_in = NULL;
1342 char * entry_out = NULL;
1343 char * quota_out_str;
1344 char * quota_in_str;
1348 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1352 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1353 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1356 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, "a_out_str))
1359 if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1361 out_dest[c] = GNUNET_ATS_MaxBandwidth;
1364 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1366 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out, &out_dest[c])))
1369 if (GNUNET_NO == res)
1371 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1372 network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1373 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1377 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1378 network_str[c], out_dest[c]);
1380 GNUNET_free (quota_out_str);
1384 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1385 network_str[c], GNUNET_ATS_DefaultBandwidth);
1386 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1390 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, "a_in_str))
1393 if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1395 in_dest[c] = GNUNET_ATS_MaxBandwidth;
1398 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1400 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in, &in_dest[c])))
1403 if (GNUNET_NO == res)
1405 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1406 network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1407 in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1411 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1412 network_str[c], in_dest[c]);
1414 GNUNET_free (quota_in_str);
1418 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1419 network_str[c], GNUNET_ATS_DefaultBandwidth);
1420 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1422 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]);
1423 GNUNET_free (entry_out);
1424 GNUNET_free (entry_in);
1426 return GNUNET_ATS_NetworkTypeCount;
1431 * Callback for solver to notify about assignment changes
1433 * @param cls the GAS_Addresses_Handle
1434 * @param address the address with changes
1437 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1439 struct GAS_Addresses_Handle *handle = cls;
1440 struct GAS_Addresses_Suggestion_Requests *cur;
1442 GNUNET_assert (handle != NULL);
1443 GNUNET_assert (address != NULL);
1445 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1447 /* Notify performance clients about changes to address */
1448 GAS_performance_notify_all_clients (&address->peer,
1450 address->addr, address->addr_len,
1451 address->session_id,
1452 address->atsi, address->atsi_count,
1453 address->assigned_bw_out,
1454 address->assigned_bw_in);
1455 cur = handle->r_head;
1458 if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1459 break; /* we have an address request pending*/
1464 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1465 "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1469 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1470 "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1472 /* *Notify scheduling clients about suggestion */
1473 GAS_scheduling_transmit_address_suggestion (&address->peer,
1475 address->addr, address->addr_len,
1476 address->session_id,
1477 address->atsi, address->atsi_count,
1478 address->assigned_bw_out,
1479 address->assigned_bw_in);
1484 * Initialize address subsystem. The addresses subsystem manages the addresses
1485 * known and current performance information. It has a solver component
1486 * responsible for the resource allocation. It tells the solver about changes
1487 * and receives updates when the solver changes the ressource allocation.
1489 * @param cfg configuration to use
1490 * @param stats the statistics handle to use
1491 * @return an address handle
1493 struct GAS_Addresses_Handle *
1494 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1495 const struct GNUNET_STATISTICS_Handle *stats)
1497 struct GAS_Addresses_Handle *ah;
1498 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1499 unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
1500 unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
1505 ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1506 ah->running = GNUNET_NO;
1508 ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1509 /* Initialize the addresses database */
1510 ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1511 GNUNET_assert (NULL != ah->addresses);
1513 /* Figure out configured solution method */
1514 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1516 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1517 ah->ats_mode = MODE_SIMPLISTIC;
1521 for (c = 0; c < strlen (mode_str); c++)
1522 mode_str[c] = toupper (mode_str[c]);
1523 if (0 == strcmp (mode_str, "SIMPLISTIC"))
1525 ah->ats_mode = MODE_SIMPLISTIC;
1527 else if (0 == strcmp (mode_str, "MLP"))
1529 ah->ats_mode = MODE_MLP;
1531 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1532 ah->ats_mode = MODE_SIMPLISTIC;
1537 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1538 ah->ats_mode = MODE_SIMPLISTIC;
1540 GNUNET_free (mode_str);
1542 /* Start configured solution method */
1543 switch (ah->ats_mode)
1546 /* Init the MLP solver with default values */
1548 ah->ats_mode = MODE_MLP;
1549 ah->s_init = &GAS_mlp_init;
1550 ah->s_add = &GAS_mlp_address_add;
1551 ah->s_update = &GAS_mlp_address_update;
1552 ah->s_get = &GAS_mlp_get_preferred_address;
1553 ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1554 ah->s_pref = &GAS_mlp_address_change_preference;
1555 ah->s_del = &GAS_mlp_address_delete;
1556 ah->s_done = &GAS_mlp_done;
1562 case MODE_SIMPLISTIC:
1563 /* Init the simplistic solver with default values */
1564 ah->ats_mode = MODE_SIMPLISTIC;
1565 ah->s_init = &GAS_simplistic_init;
1566 ah->s_add = &GAS_simplistic_address_add;
1567 ah->s_update = &GAS_simplistic_address_update;
1568 ah->s_get = &GAS_simplistic_get_preferred_address;
1569 ah->s_get_stop = &GAS_simplistic_stop_get_preferred_address;
1570 ah->s_pref = &GAS_simplistic_address_change_preference;
1571 ah->s_del = &GAS_simplistic_address_delete;
1572 ah->s_done = &GAS_simplistic_done;
1573 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1580 GNUNET_assert (NULL != ah->s_init);
1581 GNUNET_assert (NULL != ah->s_add);
1582 GNUNET_assert (NULL != ah->s_update);
1583 GNUNET_assert (NULL != ah->s_get);
1584 GNUNET_assert (NULL != ah->s_get_stop);
1585 GNUNET_assert (NULL != ah->s_pref);
1586 GNUNET_assert (NULL != ah->s_del);
1587 GNUNET_assert (NULL != ah->s_done);
1589 quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1591 ah->solver = ah->s_init (cfg, stats, quotas, quotas_in, quotas_out, quota_count, &bandwidth_changed_cb, ah);
1592 if (NULL == ah->solver)
1594 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1599 /* up and running */
1600 ah->running = GNUNET_YES;
1606 * Free memory of address.
1609 * @param key peer identity (unused)
1610 * @param value the 'struct ATS_Address' to free
1611 * @return GNUNET_OK (continue to iterate)
1614 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1616 struct GAS_Addresses_Handle *handle = cls;
1617 struct ATS_Address *aa = value;
1618 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1619 destroy_address (handle, aa);
1625 * Remove all addresses
1627 * @param handle the address handle to use
1630 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1632 if (GNUNET_NO == handle->running)
1635 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1639 if (handle->addresses != NULL)
1640 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1645 * Shutdown address subsystem.
1647 * @param handle the address handle to shutdown
1650 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1652 struct GAS_Addresses_Suggestion_Requests *cur;
1654 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1655 "Shutting down addresses\n");
1656 GNUNET_assert (NULL != handle);
1657 GAS_addresses_destroy_all (handle);
1658 handle->running = GNUNET_NO;
1659 GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1660 handle->addresses = NULL;
1661 while (NULL != (cur = handle->r_head))
1663 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1666 handle->s_done (handle->solver);
1667 GNUNET_free (handle);
1668 /* Stop configured solution method */
1673 struct PeerIteratorContext
1675 GNUNET_ATS_Peer_Iterator it;
1677 struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1682 * Iterator to iterate over all peers
1684 * @param cls a PeerIteratorContext
1685 * @param key the peer id
1686 * @param value the ATS_address
1687 * @return GNUNET_OK to continue
1691 const struct GNUNET_HashCode * key,
1694 struct PeerIteratorContext *ip_ctx = cls;
1695 struct GNUNET_PeerIdentity tmp;
1697 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1699 GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1700 tmp.hashPubKey = (*key);
1701 ip_ctx->it (ip_ctx->it_cls, &tmp);
1709 * Return information all peers currently known to ATS
1711 * @param handle the address handle to use
1712 * @param p_it the iterator to call for every peer
1713 * @param p_it_cls the closure for the iterator
1716 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1717 GNUNET_ATS_Peer_Iterator p_it,
1720 struct PeerIteratorContext ip_ctx;
1725 GNUNET_assert (NULL != handle->addresses);
1727 size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1731 ip_ctx.it_cls = p_it_cls;
1732 ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1733 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1734 GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1736 p_it (p_it_cls, NULL);
1740 struct PeerInfoIteratorContext
1742 GNUNET_ATS_PeerInfo_Iterator it;
1748 * Iterator to iterate over a peer's addresses
1750 * @param cls a PeerInfoIteratorContext
1751 * @param key the peer id
1752 * @param value the ATS_address
1753 * @return GNUNET_OK to continue
1756 peerinfo_it (void *cls,
1757 const struct GNUNET_HashCode * key,
1760 struct PeerInfoIteratorContext *pi_ctx = cls;
1761 struct ATS_Address *addr = (struct ATS_Address *) value;
1763 if (NULL != pi_ctx->it)
1765 pi_ctx->it (pi_ctx->it_cls,
1768 addr->addr, addr->addr_len,
1770 addr->atsi, addr->atsi_count,
1771 addr->assigned_bw_out,
1772 addr->assigned_bw_in);
1779 * Return information all peers currently known to ATS
1781 * @param handle the address handle to use
1782 * @param peer the respective peer
1783 * @param pi_it the iterator to call for every peer
1784 * @param pi_it_cls the closure for the iterator
1787 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1788 const struct GNUNET_PeerIdentity *peer,
1789 GNUNET_ATS_PeerInfo_Iterator pi_it,
1792 struct PeerInfoIteratorContext pi_ctx;
1793 struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1794 GNUNET_assert (NULL != peer);
1795 GNUNET_assert (NULL != handle->addresses);
1797 return; /* does not make sense without callback */
1799 zero_bw = GNUNET_BANDWIDTH_value_init (0);
1801 pi_ctx.it_cls = pi_it_cls;
1803 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1806 pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1811 /* end of gnunet-service-ats_addresses.c */