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_normalization.h"
32 #include "gnunet-service-ats_performance.h"
33 #include "gnunet-service-ats_scheduling.h"
34 #include "gnunet-service-ats_reservations.h"
36 #include "gnunet-service-ats-solver_mlp.h"
38 #include "gnunet-service-ats-solver_proportional.h"
41 * NOTE: Do not change this documentation. This documentation is based on
42 * gnunet.org:/vcs/fsnsg/ats-paper.git/tech-doku/ats-tech-guide.tex
43 * use build_txt.sh to generate plaintext output
45 * 1 ATS addresses : ATS address management
47 * This ATS addresses ("addresses") component manages the addresses known to
48 * ATS service and suggests addresses to transport service when it is
49 * interested in address suggestion for a peer. ATS addresses also
50 * instantiates the bandwidth assignment mechanism (solver), notifies it
51 * about changes to addresses and forwards changes to bandwidth assignments
52 * to transport, depending if transport is interested in this change.
58 * Addresses are added by specifying peer ID, plugin, address, address length
59 * and session, if available. ATS information can be specified if available.
63 * ATS specifies a fix set of networks an address can belong to. For each
64 * network an inbound and outbound quota will be specified. The available
65 * networks and addtional helper varaibles are defined in
66 * gnunet_ats_service.h. At the moment 5 networks are defined:
67 * * GNUNET_ATS_NET_UNSPECIFIED
68 * * GNUNET_ATS_NET_LOOPBACK
69 * * GNUNET_ATS_NET_LAN
70 * * GNUNET_ATS_NET_WAN
71 * * GNUNET_ATS_NET_WLAN
73 * The total number of networks defined is stored in
74 * GNUNET_ATS_NetworkTypeCount GNUNET_ATS_NetworkType can be used array
75 * initializer for an int array, while GNUNET_ATS_NetworkType is an
76 * initializer for a char array containing a string description of all
81 * An inbound and outbound quota for each of the networks mentioned in 1.1.2
82 * is loaded from ats configuration during initialization. This quota defines
83 * to total amount of inbound and outbound traffic allowed for a specific
84 * network. The configuration values used are in section ats:
85 * * "NETWORK"_QUOTA_IN = <value>
86 * * "NETWORK"_QUOTA_IN = <value>
88 * You can specify quotas by setting the <value> to a:
89 * * unrestricted: unlimited
90 * * number of bytes: e.g. 10240
91 * * fancy value: e.g. 64 Kib
93 * unlimited is defined as GNUNET_ATS_MaxBandwidthString and equivalent to
94 * the value GNUNET_ATS_MaxBandwidth Important predefined values for quotas
96 * * GNUNET_ATS_DefaultBandwidth: 65536
97 * * GNUNET_ATS_MaxBandwidth: UINT32_MAX
98 * * GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT: 1024
100 * Details of loading quotas and default values will be described on
102 * 1.1.4 Preference values
104 * 1.2 Data structures used
106 * Addresse uses struct ATS_Address for each address. The structs are stored
107 * in a linked list and provides a pointer void *solver_information for the
108 * solver to store address specific information. It provides the int values
109 * active which is set to GNUNET_YES if the address is select for transport
110 * use and used, representing that transport service is actively using this
111 * address. Address information are stored in peer, addr, addr_len, plugin.
115 * During initialization a hashmap to store addresses is created. The quotas
116 * for all networks defined for ATS are loaded from configuration. For each
117 * network first the logic will check if the string
118 * GNUNET_ATS_MaxBandwidthString is configured, if not it will try to convert
119 * the configured value as a fancy size and if this fails it will try to use
120 * it as a value_number. If no configuration value is found it will assign
121 * GNUNET_ATS_DefaultBandwidth. The most important step is to load the
122 * configured solver using configuration "[ats]:MODE". Current solvers are
123 * MODE_SIMPLISTIC, MODE_MLP. Interaction is done using a solver API
128 * * s_init: init the solver with required information
129 * * s_add: add a new address
130 * * s_update: update ATS values or session for an address
131 * * s_get: get prefered address for a peer
132 * * s_del: delete an address
133 * * s_pref: change preference value for a peer
134 * * s_done: shutdown solver
136 * Callbacks: addresses provides a bandwidth_changed_cb callback to the
137 * solver which is called when bandwidth assigned to peer has changed
141 * During shutdown all addresses are freed and the solver told to shutdown
143 * 1.6 Addresses and sessions
145 * Addresses consist of the address itself and a numerical session. When a
146 * new address without a session is added it has no session, so it gets
147 * session 0 assigned. When an address with a session is added and an address
148 * object with session 0 is found, this object is updated with the session
149 * otherwise a new address object with this session assigned is created.
153 * Addresses a1,a2 with session s1, s2 are "exact" if:
154 * (a1 == a2)&&(s1 == s2)
155 * Addresses a1,a2 with session s1, s2 are "equivalent" if:
156 * (a1 == a2)&&((s1 == s2)||(s1 == 0)||(s2 == 0)
158 * 1.7 Address management
160 * Transport service notifies ATS about changes to the addresses known to
163 * 1.7.1 Adding an address
165 * When transport learns a new address it tells ATS and ATS is telling
166 * addresses about it using GAS_address_add. If not known to addresses it
167 * creates a new address object and calls solver's s_add. ATS information are
168 * deserialized and solver is notified about the session and ATS information
171 * 1.7.2 Updating an address
173 * Addresses does an lookup up for the existing address with the given
174 * session. If disassembles included ATS information and notifies the solver
175 * using s_update about the update.
177 * 1.7.3 Deleting an address
179 * Addresses does an lookup for the exact address and session and if removes
180 * this address. If session != 0 the session is set to 0 and the address is
181 * kept. If session == 0, the addresses is removed.
183 * 1.7.4 Requesting an address suggestion
185 * The address client issues a request address message to be notified about
186 * address suggestions for a specific peer. Addresses asks the solver with
187 * s_get. If no address is available, it will not send a response, otherwise
188 * it will respond with the choosen address.
190 * 1.7.5 Address suggestions
192 * Addresses will notify the client automatically on any bandwidth_changed_cb
193 * by the solver if a address suggestion request is pending. If no address is
194 * available it will not respond at all If the client is not interested
195 * anymore, it has to cancel the address suggestion request.
197 * 1.7.6 Suggestions blocks and reset
199 * After suggesting an address it is blocked for ATS_BLOCKING_DELTA sec. to
200 * prevent the client from being thrashed. If the client requires immediately
201 * it can reset this block using GAS_addresses_handle_backoff_reset.
203 * 1.7.7 Marking address in use
205 * The client can notify addresses that it successfully uses an address and
206 * wants this address to be kept by calling GSA_address_in_use. Adresses will
207 * mark the address as used an notify the solver about the use.
209 * 1.7.8 Address lifecycle
212 * * (updated address) || (address in use)
215 * 1.8 Bandwidth assignment
217 * The addresses are used to perform resource allocation operations. ATS
218 * addresses takes care of instantiating the solver configured and notifies
219 * the respective solver about address changes and receives changes to the
220 * bandwidth assignment from the solver. The current bandwidth assignment is
221 * sent to transport. The specific solvers will be described in the specific
224 * 1.9 Changing peer preferences
226 * The bandwidth assigned to a peer can be influenced by setting a preference
227 * for a peer. The prefernce will be given to to the solver with s_pref which
228 * has to take care of the preference value
234 * Available ressource assignment modes
241 * Assign each peer an equal amount of bandwidth (bw)
243 * bw_per_peer = bw_total / #active addresses
250 * Solve ressource assignment as an optimization problem
251 * Uses an mixed integer programming solver
258 * Pending Address suggestion requests
260 struct GAS_Addresses_Suggestion_Requests
265 struct GAS_Addresses_Suggestion_Requests *next;
270 struct GAS_Addresses_Suggestion_Requests *prev;
275 struct GNUNET_PeerIdentity id;
280 * Handle for ATS address component
282 struct GAS_Addresses_Handle
287 struct GNUNET_STATISTICS_Handle *stat;
290 * A multihashmap to store all addresses
292 struct GNUNET_CONTAINER_MultiHashMap *addresses;
295 * Configure WAN quota in
297 unsigned long long wan_quota_in;
300 * Configure WAN quota out
302 unsigned long long wan_quota_out;
305 * Is ATS addresses running
310 * Configured ATS solver
320 * Address suggestion requests DLL head
322 struct GAS_Addresses_Suggestion_Requests *r_head;
325 * Address suggestion requests DLL tail
327 struct GAS_Addresses_Suggestion_Requests *r_tail;
329 /* Solver functions */
334 GAS_solver_init s_init;
337 * Add an address to the solver
339 GAS_solver_address_add s_add;
342 * Update address in solver
344 GAS_solver_address_update s_update;
347 * Get address from solver
349 GAS_solver_get_preferred_address s_get;
352 * Get address from solver
354 GAS_solver_stop_get_preferred_address s_get_stop;
357 * Delete address in solver
359 GAS_solver_address_delete s_del;
362 * Change relative preference for quality in solver
364 GAS_solver_address_change_preference s_pref;
369 GAS_solver_done s_done;
374 * Disassemble ATS information and update performance information in address
376 * Updates existing information and adds new information
378 * @param dest destination address
379 * @param update source ATS information
380 * @param update_count number of ATS information
381 * @param delta_dest ats performance information which were updated
382 * including previous value
383 * @param delta_count number of ATS information in the delta
384 * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
387 disassemble_ats_information (struct ATS_Address *dest,
388 const struct GNUNET_ATS_Information *update,
389 uint32_t update_count,
390 struct GNUNET_ATS_Information **delta_dest,
391 uint32_t *delta_count)
399 struct GNUNET_ATS_Information add_atsi[update_count];
400 struct GNUNET_ATS_Information delta_atsi[update_count];
401 struct GNUNET_ATS_Information *tmp_atsi;
402 uint32_t add_atsi_count;
403 uint32_t delta_atsi_count;
407 delta_atsi_count = 0;
409 if (0 == update_count)
412 if (NULL == dest->atsi)
414 /* Create performance information */
415 dest->atsi = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
416 dest->atsi_count = update_count;
417 memcpy (dest->atsi, update, update_count * sizeof (struct GNUNET_ATS_Information));
418 delta_atsi_count = update_count;
419 (*delta_dest) = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
420 for (c1 = 0; c1 < update_count; c1 ++)
422 (*delta_dest)[c1].type = update[c1].type;
423 (*delta_dest)[c1].value = htonl(GNUNET_ATS_VALUE_UNDEFINED);
425 (*delta_count) = update_count;
429 for (c1 = 0; c1 < update_count; c1++)
431 /* Update existing performance information */
433 for (c2 = 0; c2 < dest->atsi_count; c2++)
435 if (update[c1].type == dest->atsi[c2].type)
437 if (update[c1].value != dest->atsi[c2].value)
439 /* Save previous value in delta */
440 delta_atsi[delta_atsi_count] = dest->atsi[c2];
443 dest->atsi[c2].value = update[c1].value;
450 if (GNUNET_NO == found)
452 add_atsi[add_atsi_count] = update[c1];
454 delta_atsi[delta_atsi_count].type = update[c1].type;
455 delta_atsi[delta_atsi_count].value = htonl (GNUNET_ATS_VALUE_UNDEFINED);
460 if (add_atsi_count > 0)
462 /* Extend ats performance information */
464 tmp_atsi = GNUNET_malloc ((dest->atsi_count + add_atsi_count) *
465 (sizeof (struct GNUNET_ATS_Information)));
466 memcpy (tmp_atsi, dest->atsi, dest->atsi_count * sizeof (struct GNUNET_ATS_Information));
467 memcpy (&tmp_atsi[dest->atsi_count], add_atsi, add_atsi_count * sizeof (struct GNUNET_ATS_Information));
468 GNUNET_free (dest->atsi);
469 dest->atsi = tmp_atsi;
470 dest->atsi_count = dest->atsi_count + add_atsi_count;
474 if (delta_atsi_count > 0)
477 (*delta_dest) = GNUNET_malloc (delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
478 memcpy ((*delta_dest), delta_atsi, delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
479 (*delta_count) = delta_atsi_count;
486 * Free the given address
488 * @param addr address to destroy
491 free_address (struct ATS_Address *addr)
493 GNUNET_free (addr->plugin);
494 GNUNET_free_non_null (addr->atsi);
499 * Create a ATS_address with the given information
502 * @param plugin_name plugin
503 * @param plugin_addr address
504 * @param plugin_addr_len address length
505 * @param session_id session
506 * @return the ATS_Address
508 static struct ATS_Address *
509 create_address (const struct GNUNET_PeerIdentity *peer,
510 const char *plugin_name,
511 const void *plugin_addr, size_t plugin_addr_len,
514 struct ATS_Address *aa = NULL;
518 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
520 aa->addr_len = plugin_addr_len;
522 memcpy (&aa[1], plugin_addr, plugin_addr_len);
523 aa->plugin = GNUNET_strdup (plugin_name);
524 aa->session_id = session_id;
525 aa->active = GNUNET_NO;
526 aa->used = GNUNET_NO;
527 aa->solver_information = NULL;
530 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
531 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
533 for (c1 = 0; c1 < GNUNET_ATS_QualityPropertiesCount; c1 ++)
535 aa->atsin[c1].avg_queue_index = 0;
536 for (c2 = 0; c2 < GAS_normalization_queue_length; c2++)
537 aa->atsin[c1].atsi_abs[c2] = GNUNET_ATS_VALUE_UNDEFINED;
545 * Destroy the given address.
547 * @param handle the address handle
548 * @param addr address to destroy
549 * @return GNUNET_YES if bandwidth allocations should be recalcualted
552 destroy_address (struct GAS_Addresses_Handle *handle, struct ATS_Address *addr)
557 GNUNET_assert (GNUNET_YES ==
558 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
559 &addr->peer.hashPubKey,
566 struct CompareAddressContext
568 const struct ATS_Address *search;
570 /* exact_address != NULL if address and session is equal */
571 struct ATS_Address *exact_address;
572 /* exact_address != NULL if address and session is 0 */
573 struct ATS_Address *base_address;
579 * @param cls a CompareAddressContext containin the source address
581 * @param value the address to compare with
582 * @return GNUNET_YES to continue, GNUNET_NO if address is founce
586 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
588 struct CompareAddressContext *cac = cls;
589 struct ATS_Address *aa = value;
591 /* Find an matching exact address:
594 * aa->addr_len == cac->search->addr_len
595 * aa->plugin == cac->search->plugin
596 * aa->addr == cac->search->addr
597 * aa->session == cac->search->session
599 * return as exact address
601 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
603 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
604 cac->exact_address = aa;
607 /* Find an matching base address:
611 * aa->session_id == 0
614 * aa->addr_len == cac->search->addr_len
615 * aa->plugin == cac->search->plugin
616 * aa->addr == cac->search->addr
618 * return as base address
620 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
622 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
623 cac->base_address = aa;
626 /* Find an matching exact address based on session:
630 * cac->search->addr_len == 0
633 * aa->plugin == cac->search->plugin
634 * aa->session_id == cac->search->session_id
636 * return as exact address
638 if (0 == cac->search->addr_len)
640 if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
641 cac->exact_address = aa;
644 if (cac->exact_address == NULL)
645 return GNUNET_YES; /* Continue iteration to find exact address */
647 return GNUNET_NO; /* Stop iteration since we have an exact address */
652 * Find an existing equivalent address record.
653 * Compares by peer identity and network address OR by session ID
654 * (one of the two must match).
656 * @param handle the address handle
657 * @param peer peer to lookup addresses for
658 * @param addr existing address record
659 * @return existing address record, NULL for none
662 find_equivalent_address (struct GAS_Addresses_Handle *handle,
663 const struct GNUNET_PeerIdentity *peer,
664 const struct ATS_Address *addr)
666 struct CompareAddressContext cac;
668 cac.exact_address = NULL;
669 cac.base_address = NULL;
671 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
672 &compare_address_it, &cac);
674 if (cac.exact_address == NULL)
675 return cac.base_address;
676 return cac.exact_address;
681 * Lookup an ATS address by the address properties and session or return an
682 * equivalent address with a session == 0
684 * @param handle the address handle to use
686 * @param plugin_name transport plugin name
687 * @param plugin_addr plugin address
688 * @param plugin_addr_len length of the plugin address
689 * @param session_id session id, can be 0
690 * @param atsi performance information for this address
691 * @param atsi_count number of performance information contained
692 * @return an ATS_address or NULL
695 static struct ATS_Address *
696 lookup_address (struct GAS_Addresses_Handle *handle,
697 const struct GNUNET_PeerIdentity *peer,
698 const char *plugin_name,
699 const void *plugin_addr,
700 size_t plugin_addr_len,
702 const struct GNUNET_ATS_Information *atsi,
705 struct ATS_Address *aa;
706 struct ATS_Address *ea;
708 aa = create_address (peer,
710 plugin_addr, plugin_addr_len,
713 /* Get existing address or address with session == 0 */
714 ea = find_equivalent_address (handle, peer, aa);
720 else if (ea->session_id != session_id)
728 * Extract an ATS performance info from an address
730 * @param address the address
731 * @param type the type to extract in HBO
732 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
735 get_performance_info (struct ATS_Address *address, uint32_t type)
738 GNUNET_assert (NULL != address);
740 if ((NULL == address->atsi) || (0 == address->atsi_count))
741 return GNUNET_ATS_VALUE_UNDEFINED;
743 for (c1 = 0; c1 < address->atsi_count; c1++)
745 if (ntohl(address->atsi[c1].type) == type)
746 return ntohl(address->atsi[c1].value);
748 return GNUNET_ATS_VALUE_UNDEFINED;
755 * Add a new address for a peer.
757 * @param handle the address handle to use
759 * @param plugin_name transport plugin name
760 * @param plugin_addr plugin address
761 * @param plugin_addr_len length of the plugin address
762 * @param session_id session id, can be 0
763 * @param atsi performance information for this address
764 * @param atsi_count number of performance information contained
767 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
768 const struct GNUNET_PeerIdentity *peer,
769 const char *plugin_name, const void *plugin_addr,
770 size_t plugin_addr_len, uint32_t session_id,
771 const struct GNUNET_ATS_Information *atsi,
774 struct ATS_Address *aa;
775 struct ATS_Address *ea;
776 struct GNUNET_ATS_Information *atsi_delta;
777 uint32_t atsi_delta_count;
781 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
782 "Received `%s' for peer `%s'\n",
786 if (GNUNET_NO == handle->running)
789 GNUNET_assert (NULL != handle->addresses);
791 aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
794 disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta, &atsi_delta_count);
795 GNUNET_free_non_null (atsi_delta);
796 addr_net = get_performance_info (aa, GNUNET_ATS_NETWORK_TYPE);
797 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
798 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
800 /* Get existing address or address with session == 0 */
801 ea = find_equivalent_address (handle, peer, aa);
804 /* We have a new address */
805 GNUNET_assert (GNUNET_OK ==
806 GNUNET_CONTAINER_multihashmap_put (handle->addresses,
807 &peer->hashPubKey, aa,
808 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
809 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added new address for peer `%s' session id %u, %p\n",
810 GNUNET_i2s (peer), session_id, aa);
811 /* Tell solver about new address */
812 GAS_normalization_normalize_property (handle->addresses, aa, atsi, atsi_count);
813 handle->s_add (handle->solver, handle->addresses, aa, addr_net);
814 /* Notify performance clients about new address */
815 GAS_performance_notify_all_clients (&aa->peer,
817 aa->addr, aa->addr_len,
819 aa->atsi, aa->atsi_count,
825 GNUNET_free (aa->plugin);
826 GNUNET_free_non_null (aa->atsi);
830 if (ea->session_id != 0)
832 /* This address with the same session is already existing
833 * Should not happen */
834 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
835 "Added already existing address for peer `%s' `%s' %p with new session %u\n",
836 GNUNET_i2s (peer), plugin_name, session_id);
841 /* We have an address without an session, update this address */
843 atsi_delta_count = 0;
844 if (GNUNET_YES == disassemble_ats_information (ea, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
846 GAS_performance_notify_all_clients (&ea->peer,
848 ea->addr, ea->addr_len,
850 ea->atsi, ea->atsi_count,
855 /* Notify solver about update with atsi information and session */
856 GAS_normalization_normalize_property (handle->addresses, ea, atsi, atsi_count);
857 handle->s_update (handle->solver, handle->addresses, ea, session_id, ea->used, atsi_delta, atsi_delta_count);
858 GNUNET_free_non_null (atsi_delta);
861 ea->session_id = session_id;
862 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
863 "Updated existing address for peer `%s' %p with new session %u\n",
864 GNUNET_i2s (peer), ea, session_id);
869 * Update an address with a session or performance information for a peer.
871 * If an address was added without a session it will be updated with the
874 * @param handle the address handle to use
876 * @param plugin_name transport plugin name
877 * @param plugin_addr plugin address
878 * @param plugin_addr_len length of the plugin address
879 * @param session_id session id, can be 0
880 * @param atsi performance information for this address
881 * @param atsi_count number of performance information contained
884 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
885 const struct GNUNET_PeerIdentity *peer,
886 const char *plugin_name, const void *plugin_addr,
887 size_t plugin_addr_len, uint32_t session_id,
888 const struct GNUNET_ATS_Information *atsi,
891 struct ATS_Address *aa;
892 struct GNUNET_ATS_Information *atsi_delta;
893 uint32_t atsi_delta_count;
894 uint32_t prev_session;
896 if (GNUNET_NO == handle->running)
899 GNUNET_assert (NULL != handle->addresses);
901 /* Get existing address */
902 aa = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
903 session_id, atsi, atsi_count);
906 /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
907 /* GNUNET_i2s (peer), plugin_name, session_id); */
908 /* GNUNET_break (0); */
912 if (NULL == aa->solver_information)
914 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n",
915 GNUNET_i2s (peer), plugin_name, session_id);
919 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
920 "Received `%s' for peer `%s' address \n",
922 GNUNET_i2s (peer), aa);
926 atsi_delta_count = 0;
927 if (GNUNET_YES == disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
929 /* Notify performance clients about updated address */
930 GAS_performance_notify_all_clients (&aa->peer,
932 aa->addr, aa->addr_len,
934 aa->atsi, aa->atsi_count,
938 prev_session = aa->session_id;
939 aa->session_id = session_id;
941 GAS_normalization_normalize_property (handle->addresses, aa, atsi, atsi_count);
943 /* Tell solver about update */
944 handle->s_update (handle->solver, handle->addresses, aa, prev_session, aa->used, atsi_delta, atsi_delta_count);
945 GNUNET_free_non_null (atsi_delta);
949 struct DestroyContext
951 struct ATS_Address *aa;
953 struct GAS_Addresses_Handle *handle;
956 * GNUNET_NO : full address
957 * GNUNET_YES : just session
966 * If session != 0, just the session is deleted, the address itself still exists
967 * If session == 0, remove full address
968 * If session == 0 and addrlen == 0, destroy inbound address
972 * @param value the 'struct ATS_Address'
973 * @return GNUNET_OK (continue to iterate)
976 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
978 struct DestroyContext *dc = cls;
979 struct GAS_Addresses_Handle *handle = dc->handle;
980 const struct ATS_Address *des = dc->aa;
981 struct ATS_Address *aa = value;
983 GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
984 sizeof (struct GNUNET_PeerIdentity)));
987 if (des->session_id == 0)
989 /* Session == 0, remove full address */
990 if ((0 == strcmp (des->plugin, aa->plugin)) &&
991 (aa->addr_len == des->addr_len) &&
992 (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
995 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
996 "Deleting full address for peer `%s' session %u %p\n",
997 GNUNET_i2s (&aa->peer), aa->session_id, aa);
999 /* Notify solver about deletion */
1000 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1001 destroy_address (handle, aa);
1002 dc->result = GNUNET_NO;
1003 return GNUNET_OK; /* Continue iteration */
1008 /* Session != 0, just remove session */
1009 if (aa->session_id != des->session_id)
1010 return GNUNET_OK; /* irrelevant */
1012 if ((aa->session_id != 0) &&
1013 (0 != strcmp (des->plugin, aa->plugin)))
1015 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1016 "Different plugins during removal: `%s' vs `%s' \n",
1017 des->plugin, aa->plugin);
1022 if (aa->addr_len == 0)
1024 /* Inbound connection died, delete full address */
1025 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1026 "Deleting inbound address for peer `%s': `%s' session %u\n",
1027 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1029 /* Notify solver about deletion */
1030 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1031 destroy_address (handle, aa);
1032 dc->result = GNUNET_NO;
1033 return GNUNET_OK; /* Continue iteration */
1038 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1039 "Deleting session for peer `%s': `%s' %u\n",
1040 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1041 /* Notify solver to delete session */
1042 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_YES);
1052 * Remove an address or just a session for a peer.
1054 * @param handle the address handle to use
1056 * @param plugin_name transport plugin name
1057 * @param plugin_addr plugin address
1058 * @param plugin_addr_len length of the plugin address
1059 * @param session_id session id, can be 0
1062 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
1063 const struct GNUNET_PeerIdentity *peer,
1064 const char *plugin_name,
1065 const void *plugin_addr,
1066 size_t plugin_addr_len,
1067 uint32_t session_id)
1069 struct ATS_Address *ea;
1070 struct DestroyContext dc;
1072 if (GNUNET_NO == handle->running)
1075 /* Get existing address */
1076 ea = lookup_address (handle, peer, plugin_name, plugin_addr, plugin_addr_len,
1077 session_id, NULL, 0);
1079 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1080 "Received `%s' for peer `%s' address %p session %u\n",
1082 GNUNET_i2s (peer), ea, session_id);
1086 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1087 GNUNET_i2s (peer), plugin_name, session_id);
1091 GNUNET_break (0 < strlen (plugin_name));
1093 dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
1095 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
1096 &destroy_by_session_id, &dc);
1097 free_address (dc.aa);
1102 * Notification about active use of an address.
1103 * in_use == GNUNET_YES:
1104 * This address is used to maintain an active connection with a peer.
1105 * in_use == GNUNET_NO:
1106 * This address is no longer used to maintain an active connection with a peer.
1108 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1111 * @param handle the address handle to use
1113 * @param plugin_name transport plugin name
1114 * @param plugin_addr plugin address
1115 * @param plugin_addr_len length of the plugin address
1116 * @param session_id session id, can be 0
1117 * @param in_use GNUNET_YES if GNUNET_NO
1118 * @return GNUNET_SYSERR on failure (address unknown ...)
1121 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1122 const struct GNUNET_PeerIdentity *peer,
1123 const char *plugin_name,
1124 const void *plugin_addr,
1125 size_t plugin_addr_len,
1126 uint32_t session_id,
1129 struct ATS_Address *ea;
1132 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1133 "Received `%s' for peer `%s'\n",
1137 if (GNUNET_NO == handle->running)
1138 return GNUNET_SYSERR;
1140 ea = lookup_address (handle, peer, plugin_name,
1141 plugin_addr, plugin_addr_len,
1142 session_id, NULL, 0);
1145 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1146 "Trying to set unknown address `%s', %s %u %s \n",
1148 plugin_name, session_id,
1149 (GNUNET_NO == in_use) ? "NO" : "YES");
1151 return GNUNET_SYSERR;
1153 if (ea->used == in_use)
1156 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1157 "Address in use called multiple times for peer `%s': %s -> %s \n",
1159 (GNUNET_NO == ea->used) ? "NO" : "YES",
1160 (GNUNET_NO == in_use) ? "NO" : "YES");
1161 return GNUNET_SYSERR;
1164 /* Tell solver about update */
1165 prev_inuse = ea->used;
1167 handle->s_update (handle->solver, handle->addresses, ea, session_id, prev_inuse, NULL, 0);
1175 * Cancel address suggestions for a peer
1177 * @param handle the address handle
1178 * @param peer the peer id
1181 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1182 const struct GNUNET_PeerIdentity *peer)
1184 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1186 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1187 "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1191 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1198 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1199 "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1202 handle->s_get_stop (handle->solver, handle->addresses, peer);
1203 GAS_addresses_handle_backoff_reset (handle, peer);
1204 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1205 "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1206 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1212 * Request address suggestions for a peer
1214 * @param handle the address handle
1215 * @param peer the peer id
1218 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1219 const struct GNUNET_PeerIdentity *peer)
1221 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1222 struct ATS_Address *aa;
1224 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1225 "Received `%s' for peer `%s'\n",
1229 if (GNUNET_NO == handle->running)
1233 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1234 break; /* already suggesting */
1239 cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1241 GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1244 /* Get prefered address from solver */
1245 aa = (struct ATS_Address *) handle->s_get (handle->solver, handle->addresses, peer);
1248 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1249 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1253 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1254 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1256 GAS_scheduling_transmit_address_suggestion (peer,
1258 aa->addr, aa->addr_len,
1260 aa->atsi, aa->atsi_count,
1261 aa->assigned_bw_out,
1262 aa->assigned_bw_in);
1264 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1265 aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1267 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1268 "Address %p ready for suggestion, block interval now %llu \n",
1269 aa, aa->block_interval);
1274 * Iterator to reset address blocking
1276 * @param cls not used
1277 * @param key the peer
1278 * @param value the address to reset
1279 * @return GNUNET_OK to continue
1282 reset_address_it (void *cls, const struct GNUNET_HashCode *key, void *value)
1284 struct ATS_Address *aa = value;
1286 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1287 "Resetting interval for peer `%s' address %p from %llu to 0\n",
1288 GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1290 aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1291 aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1297 * Reset suggestion backoff for a peer
1299 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1300 * reset using this function
1302 * @param handle the address handle
1303 * @param peer the peer id
1306 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1307 const struct GNUNET_PeerIdentity *peer)
1309 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1310 "Received `%s' for peer `%s'\n",
1314 GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1322 * The preference changed for a peer
1324 * @param cls the address handle
1325 * @param peer the peer
1326 * @param kind the ATS kind
1327 * @param pref_rel the new relative preference value
1330 normalized_preference_changed_cb (void *cls,
1331 const struct GNUNET_PeerIdentity *peer,
1332 enum GNUNET_ATS_PreferenceKind kind,
1335 GNUNET_assert (NULL != cls);
1336 struct GAS_Addresses_Handle *handle = cls;
1337 /* Tell solver about update */
1338 handle->s_pref (handle->solver, handle->addresses, peer, kind, pref_rel);
1343 * The relative value for a property changed
1345 * @param cls the address handle
1346 * @param peer the peer
1347 * @param type the ATS type
1348 * @param prop_rel the new relative preference value
1351 normalized_property_changed_cb (void *cls,
1352 const struct ATS_Address *peer,
1356 GNUNET_assert (NULL != cls);
1357 //struct GAS_Addresses_Handle *handle = cls;
1358 /* Tell solver about update */
1359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1360 "Normalized property %s for peer `%s' changed to %.3f \n",
1361 GNUNET_ATS_print_property_type (type),
1362 GNUNET_i2s (&peer->peer),
1367 get_preferences_cb (void *cls, const struct GNUNET_PeerIdentity *id)
1369 return GAS_normalization_get_preferences (id);
1374 * Change the preference for a peer
1376 * @param handle the address handle
1377 * @param client the client sending this request
1378 * @param peer the peer id
1379 * @param kind the preference kind to change
1380 * @param score_abs the new preference score
1383 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1385 const struct GNUNET_PeerIdentity *peer,
1386 enum GNUNET_ATS_PreferenceKind kind,
1389 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1390 "Received `%s' for peer `%s' for client %p\n",
1391 "CHANGE PREFERENCE",
1392 GNUNET_i2s (peer), client);
1394 if (GNUNET_NO == handle->running)
1397 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1400 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1401 "Received `%s' for unknown peer `%s' from client %p\n",
1402 "CHANGE PREFERENCE",
1403 GNUNET_i2s (peer), client);
1406 /* Tell normalization about change, normalization will call callback if preference changed */
1407 GAS_normalization_normalize_preference (client, peer, kind, score_abs);
1412 * Load quotas for networks from configuration
1414 * @param cfg configuration handle
1415 * @param out_dest where to write outbound quotas
1416 * @param in_dest where to write inbound quotas
1417 * @param dest_length length of inbound and outbound arrays
1418 * @return number of networks loaded
1421 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1423 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1424 char * entry_in = NULL;
1425 char * entry_out = NULL;
1426 char * quota_out_str;
1427 char * quota_in_str;
1431 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1435 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1436 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1439 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, "a_out_str))
1442 if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1444 out_dest[c] = GNUNET_ATS_MaxBandwidth;
1447 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1449 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out, &out_dest[c])))
1452 if (GNUNET_NO == res)
1454 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1455 network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1456 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1460 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1461 network_str[c], out_dest[c]);
1463 GNUNET_free (quota_out_str);
1467 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1468 network_str[c], GNUNET_ATS_DefaultBandwidth);
1469 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1473 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, "a_in_str))
1476 if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1478 in_dest[c] = GNUNET_ATS_MaxBandwidth;
1481 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1483 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in, &in_dest[c])))
1486 if (GNUNET_NO == res)
1488 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1489 network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1490 in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1494 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1495 network_str[c], in_dest[c]);
1497 GNUNET_free (quota_in_str);
1501 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1502 network_str[c], GNUNET_ATS_DefaultBandwidth);
1503 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1505 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]);
1506 GNUNET_free (entry_out);
1507 GNUNET_free (entry_in);
1509 return GNUNET_ATS_NetworkTypeCount;
1514 * Callback for solver to notify about assignment changes
1516 * @param cls the GAS_Addresses_Handle
1517 * @param address the address with changes
1520 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1522 struct GAS_Addresses_Handle *handle = cls;
1523 struct GAS_Addresses_Suggestion_Requests *cur;
1525 GNUNET_assert (handle != NULL);
1526 GNUNET_assert (address != NULL);
1528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1530 /* Notify performance clients about changes to address */
1531 GAS_performance_notify_all_clients (&address->peer,
1533 address->addr, address->addr_len,
1534 address->session_id,
1535 address->atsi, address->atsi_count,
1536 address->assigned_bw_out,
1537 address->assigned_bw_in);
1538 cur = handle->r_head;
1541 if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1542 break; /* we have an address request pending*/
1547 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1548 "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1552 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1553 "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1555 /* *Notify scheduling clients about suggestion */
1556 GAS_scheduling_transmit_address_suggestion (&address->peer,
1558 address->addr, address->addr_len,
1559 address->session_id,
1560 address->atsi, address->atsi_count,
1561 address->assigned_bw_out,
1562 address->assigned_bw_in);
1567 * Initialize address subsystem. The addresses subsystem manages the addresses
1568 * known and current performance information. It has a solver component
1569 * responsible for the resource allocation. It tells the solver about changes
1570 * and receives updates when the solver changes the ressource allocation.
1572 * @param cfg configuration to use
1573 * @param stats the statistics handle to use
1574 * @return an address handle
1576 struct GAS_Addresses_Handle *
1577 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1578 const struct GNUNET_STATISTICS_Handle *stats)
1580 struct GAS_Addresses_Handle *ah;
1581 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1582 unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
1583 unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
1588 ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1589 ah->running = GNUNET_NO;
1591 ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1592 /* Initialize the addresses database */
1593 ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1594 GNUNET_assert (NULL != ah->addresses);
1596 /* Figure out configured solution method */
1597 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1599 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1600 ah->ats_mode = MODE_SIMPLISTIC;
1604 for (c = 0; c < strlen (mode_str); c++)
1605 mode_str[c] = toupper (mode_str[c]);
1606 if (0 == strcmp (mode_str, "SIMPLISTIC"))
1608 ah->ats_mode = MODE_SIMPLISTIC;
1610 else if (0 == strcmp (mode_str, "MLP"))
1612 ah->ats_mode = MODE_MLP;
1614 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1615 ah->ats_mode = MODE_SIMPLISTIC;
1620 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1621 ah->ats_mode = MODE_SIMPLISTIC;
1623 GNUNET_free (mode_str);
1625 /* Start configured solution method */
1626 switch (ah->ats_mode)
1629 /* Init the MLP solver with default values */
1631 ah->ats_mode = MODE_MLP;
1632 ah->s_init = &GAS_mlp_init;
1633 ah->s_add = &GAS_mlp_address_add;
1634 ah->s_update = &GAS_mlp_address_update;
1635 ah->s_get = &GAS_mlp_get_preferred_address;
1636 ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1637 ah->s_pref = &GAS_mlp_address_change_preference;
1638 ah->s_del = &GAS_mlp_address_delete;
1639 ah->s_done = &GAS_mlp_done;
1645 case MODE_SIMPLISTIC:
1646 /* Init the simplistic solver with default values */
1647 ah->ats_mode = MODE_SIMPLISTIC;
1648 ah->s_init = &GAS_proportional_init;
1649 ah->s_add = &GAS_proportional_address_add;
1650 ah->s_update = &GAS_proportional_address_update;
1651 ah->s_get = &GAS_proportional_get_preferred_address;
1652 ah->s_get_stop = &GAS_proportional_stop_get_preferred_address;
1653 ah->s_pref = &GAS_proportional_address_change_preference;
1654 ah->s_del = &GAS_proportional_address_delete;
1655 ah->s_done = &GAS_proportional_done;
1656 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1663 GNUNET_assert (NULL != ah->s_init);
1664 GNUNET_assert (NULL != ah->s_add);
1665 GNUNET_assert (NULL != ah->s_update);
1666 GNUNET_assert (NULL != ah->s_get);
1667 GNUNET_assert (NULL != ah->s_get_stop);
1668 GNUNET_assert (NULL != ah->s_pref);
1669 GNUNET_assert (NULL != ah->s_del);
1670 GNUNET_assert (NULL != ah->s_done);
1672 GAS_normalization_start (&normalized_preference_changed_cb, ah,
1673 &normalized_property_changed_cb, ah);
1674 quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1676 ah->solver = ah->s_init (cfg, stats,
1677 quotas, quotas_in, quotas_out, quota_count,
1678 &bandwidth_changed_cb, ah,
1679 &get_preferences_cb, NULL);
1680 if (NULL == ah->solver)
1682 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to initialize solver!\n");
1687 /* up and running */
1688 ah->running = GNUNET_YES;
1694 * Free memory of address.
1697 * @param key peer identity (unused)
1698 * @param value the 'struct ATS_Address' to free
1699 * @return GNUNET_OK (continue to iterate)
1702 free_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1704 struct GAS_Addresses_Handle *handle = cls;
1705 struct ATS_Address *aa = value;
1706 handle->s_del (handle->solver, handle->addresses, aa, GNUNET_NO);
1707 destroy_address (handle, aa);
1713 * Remove all addresses
1715 * @param handle the address handle to use
1718 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1720 if (GNUNET_NO == handle->running)
1723 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1727 if (handle->addresses != NULL)
1728 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &free_address_it, handle);
1733 * Shutdown address subsystem.
1735 * @param handle the address handle to shutdown
1738 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1740 struct GAS_Addresses_Suggestion_Requests *cur;
1742 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1743 "Shutting down addresses\n");
1744 GNUNET_assert (NULL != handle);
1745 GAS_addresses_destroy_all (handle);
1746 handle->running = GNUNET_NO;
1747 GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1748 handle->addresses = NULL;
1749 while (NULL != (cur = handle->r_head))
1751 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1754 handle->s_done (handle->solver);
1755 GNUNET_free (handle);
1756 /* Stop configured solution method */
1757 GAS_normalization_stop ();
1761 struct PeerIteratorContext
1763 GNUNET_ATS_Peer_Iterator it;
1765 struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1770 * Iterator to iterate over all peers
1772 * @param cls a PeerIteratorContext
1773 * @param key the peer id
1774 * @param value the ATS_address
1775 * @return GNUNET_OK to continue
1779 const struct GNUNET_HashCode * key,
1782 struct PeerIteratorContext *ip_ctx = cls;
1783 struct GNUNET_PeerIdentity tmp;
1785 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1787 GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1788 tmp.hashPubKey = (*key);
1789 ip_ctx->it (ip_ctx->it_cls, &tmp);
1797 * Return information all peers currently known to ATS
1799 * @param handle the address handle to use
1800 * @param p_it the iterator to call for every peer
1801 * @param p_it_cls the closure for the iterator
1804 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1805 GNUNET_ATS_Peer_Iterator p_it,
1808 struct PeerIteratorContext ip_ctx;
1813 GNUNET_assert (NULL != handle->addresses);
1815 size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1819 ip_ctx.it_cls = p_it_cls;
1820 ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1821 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1822 GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1824 p_it (p_it_cls, NULL);
1828 struct PeerInfoIteratorContext
1830 GNUNET_ATS_PeerInfo_Iterator it;
1836 * Iterator to iterate over a peer's addresses
1838 * @param cls a PeerInfoIteratorContext
1839 * @param key the peer id
1840 * @param value the ATS_address
1841 * @return GNUNET_OK to continue
1844 peerinfo_it (void *cls,
1845 const struct GNUNET_HashCode * key,
1848 struct PeerInfoIteratorContext *pi_ctx = cls;
1849 struct ATS_Address *addr = (struct ATS_Address *) value;
1851 if (NULL != pi_ctx->it)
1853 pi_ctx->it (pi_ctx->it_cls,
1856 addr->addr, addr->addr_len,
1858 addr->atsi, addr->atsi_count,
1859 addr->assigned_bw_out,
1860 addr->assigned_bw_in);
1867 * Return information all peers currently known to ATS
1869 * @param handle the address handle to use
1870 * @param peer the respective peer
1871 * @param pi_it the iterator to call for every peer
1872 * @param pi_it_cls the closure for the iterator
1875 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1876 const struct GNUNET_PeerIdentity *peer,
1877 GNUNET_ATS_PeerInfo_Iterator pi_it,
1880 struct PeerInfoIteratorContext pi_ctx;
1881 struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1882 GNUNET_assert (NULL != peer);
1883 GNUNET_assert (NULL != handle->addresses);
1885 return; /* does not make sense without callback */
1887 zero_bw = GNUNET_BANDWIDTH_value_init (0);
1889 pi_ctx.it_cls = pi_it_cls;
1891 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1894 pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1899 /* end of gnunet-service-ats_addresses.c */