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 GAS_solver_address_property_changed s_address_update_property;
344 GAS_solver_address_session_changed s_address_update_session;
346 GAS_solver_address_inuse_changed s_address_update_inuse;
348 GAS_solver_address_network_changed s_address_update_network;
351 * Get address from solver
353 GAS_solver_get_preferred_address s_get;
356 * Get address from solver
358 GAS_solver_stop_get_preferred_address s_get_stop;
361 * Delete address in solver
363 GAS_solver_address_delete s_del;
366 * Change relative preference for quality in solver
368 GAS_solver_address_change_preference s_pref;
371 * Start a bulk operation
373 GAS_solver_bulk_start s_bulk_start;
376 * Bulk operation done
378 GAS_solver_bulk_stop s_bulk_stop;
383 GAS_solver_done s_done;
388 * Disassemble ATS information and update performance information in address
390 * Updates existing information and adds new information
392 * @param dest destination address
393 * @param update source ATS information
394 * @param update_count number of ATS information
395 * @param delta_dest ats performance information which were updated
396 * including previous value
397 * @param delta_count number of ATS information in the delta
398 * @return GNUNET_YES if address was address updated, GNUNET_NO otherwise
401 disassemble_ats_information (struct ATS_Address *dest,
402 const struct GNUNET_ATS_Information *update,
403 uint32_t update_count,
404 struct GNUNET_ATS_Information **delta_dest,
405 uint32_t *delta_count)
413 struct GNUNET_ATS_Information add_atsi[update_count];
414 struct GNUNET_ATS_Information delta_atsi[update_count];
415 struct GNUNET_ATS_Information *tmp_atsi;
416 uint32_t add_atsi_count;
417 uint32_t delta_atsi_count;
421 delta_atsi_count = 0;
423 if (0 == update_count)
426 if (NULL == dest->atsi)
428 /* Create performance information */
429 dest->atsi = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
430 dest->atsi_count = update_count;
431 memcpy (dest->atsi, update, update_count * sizeof (struct GNUNET_ATS_Information));
432 (*delta_dest) = GNUNET_malloc (update_count * sizeof (struct GNUNET_ATS_Information));
433 for (c1 = 0; c1 < update_count; c1 ++)
435 (*delta_dest)[c1].type = update[c1].type;
436 (*delta_dest)[c1].value = htonl(GNUNET_ATS_VALUE_UNDEFINED);
438 (*delta_count) = update_count;
442 for (c1 = 0; c1 < update_count; c1++)
444 /* Update existing performance information */
446 for (c2 = 0; c2 < dest->atsi_count; c2++)
448 if (update[c1].type == dest->atsi[c2].type)
450 if (update[c1].value != dest->atsi[c2].value)
452 /* Save previous value in delta */
453 delta_atsi[delta_atsi_count] = dest->atsi[c2];
456 dest->atsi[c2].value = update[c1].value;
463 if (GNUNET_NO == found)
465 add_atsi[add_atsi_count] = update[c1];
467 delta_atsi[delta_atsi_count].type = update[c1].type;
468 delta_atsi[delta_atsi_count].value = htonl (GNUNET_ATS_VALUE_UNDEFINED);
473 if (add_atsi_count > 0)
475 /* Extend ats performance information */
477 tmp_atsi = GNUNET_malloc ((dest->atsi_count + add_atsi_count) *
478 (sizeof (struct GNUNET_ATS_Information)));
479 memcpy (tmp_atsi, dest->atsi, dest->atsi_count * sizeof (struct GNUNET_ATS_Information));
480 memcpy (&tmp_atsi[dest->atsi_count], add_atsi, add_atsi_count * sizeof (struct GNUNET_ATS_Information));
481 GNUNET_free (dest->atsi);
482 dest->atsi = tmp_atsi;
483 dest->atsi_count = dest->atsi_count + add_atsi_count;
487 if (delta_atsi_count > 0)
490 (*delta_dest) = GNUNET_malloc (delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
491 memcpy ((*delta_dest), delta_atsi, delta_atsi_count * sizeof (struct GNUNET_ATS_Information));
492 (*delta_count) = delta_atsi_count;
499 * Free the given address
501 * @param addr address to destroy
504 free_address (struct ATS_Address *addr)
506 GNUNET_free (addr->plugin);
507 GNUNET_free_non_null (addr->atsi);
512 * Create a ATS_address with the given information
515 * @param plugin_name plugin
516 * @param plugin_addr address
517 * @param plugin_addr_len address length
518 * @param session_id session
519 * @return the ATS_Address
521 static struct ATS_Address *
522 create_address (const struct GNUNET_PeerIdentity *peer,
523 const char *plugin_name,
524 const void *plugin_addr, size_t plugin_addr_len,
527 struct ATS_Address *aa = NULL;
531 aa = GNUNET_malloc (sizeof (struct ATS_Address) + plugin_addr_len);
533 aa->addr_len = plugin_addr_len;
535 memcpy (&aa[1], plugin_addr, plugin_addr_len);
536 aa->plugin = GNUNET_strdup (plugin_name);
537 aa->session_id = session_id;
538 aa->active = GNUNET_NO;
539 aa->used = GNUNET_NO;
540 aa->solver_information = NULL;
543 aa->assigned_bw_in = GNUNET_BANDWIDTH_value_init(0);
544 aa->assigned_bw_out = GNUNET_BANDWIDTH_value_init(0);
546 for (c1 = 0; c1 < GNUNET_ATS_QualityPropertiesCount; c1 ++)
548 aa->atsin[c1].avg_queue_index = 0;
549 for (c2 = 0; c2 < GAS_normalization_queue_length; c2++)
550 aa->atsin[c1].atsi_abs[c2] = GNUNET_ATS_VALUE_UNDEFINED;
557 struct CompareAddressContext
559 const struct ATS_Address *search;
561 /* exact_address != NULL if address and session is equal */
562 struct ATS_Address *exact_address;
563 /* exact_address != NULL if address and session is 0 */
564 struct ATS_Address *base_address;
570 * @param cls a CompareAddressContext containin the source address
572 * @param value the address to compare with
573 * @return GNUNET_YES to continue, GNUNET_NO if address is founce
577 compare_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
579 struct CompareAddressContext *cac = cls;
580 struct ATS_Address *aa = value;
582 /* Find an matching exact address:
585 * aa->addr_len == cac->search->addr_len
586 * aa->plugin == cac->search->plugin
587 * aa->addr == cac->search->addr
588 * aa->session == cac->search->session
590 * return as exact address
592 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
594 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == cac->search->session_id))
595 cac->exact_address = aa;
598 /* Find an matching base address:
602 * aa->session_id == 0
605 * aa->addr_len == cac->search->addr_len
606 * aa->plugin == cac->search->plugin
607 * aa->addr == cac->search->addr
609 * return as base address
611 if ((aa->addr_len == cac->search->addr_len) && (0 == strcmp (aa->plugin, cac->search->plugin)))
613 if ((0 == memcmp (aa->addr, cac->search->addr, aa->addr_len)) && (aa->session_id == 0))
614 cac->base_address = aa;
617 /* Find an matching exact address based on session:
621 * cac->search->addr_len == 0
624 * aa->plugin == cac->search->plugin
625 * aa->session_id == cac->search->session_id
627 * return as exact address
629 if (0 == cac->search->addr_len)
631 if ((0 == strcmp (aa->plugin, cac->search->plugin)) && (aa->session_id == cac->search->session_id))
632 cac->exact_address = aa;
635 if (cac->exact_address == NULL)
636 return GNUNET_YES; /* Continue iteration to find exact address */
638 return GNUNET_NO; /* Stop iteration since we have an exact address */
643 * Find an existing equivalent address record.
644 * Compares by peer identity and network address OR by session ID
645 * (one of the two must match).
647 * @param handle the address handle
648 * @param peer peer to lookup addresses for
649 * @param addr existing address record
650 * @return existing address record, NULL for none
653 find_equivalent_address (struct GAS_Addresses_Handle *handle,
654 const struct GNUNET_PeerIdentity *peer,
655 const struct ATS_Address *addr)
657 struct CompareAddressContext cac;
659 cac.exact_address = NULL;
660 cac.base_address = NULL;
662 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
663 &compare_address_it, &cac);
665 if (cac.exact_address == NULL)
666 return cac.base_address;
667 return cac.exact_address;
672 * Find the exact address
674 * @param handle the address handle to use
676 * @param plugin_name transport plugin name
677 * @param plugin_addr plugin address
678 * @param plugin_addr_len length of the plugin address
679 * @param session_id session id, can be 0
680 * @return an ATS_address or NULL
683 static struct ATS_Address *
684 find_exact_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,
691 struct ATS_Address *aa;
692 struct ATS_Address *ea;
694 aa = create_address (peer,
696 plugin_addr, plugin_addr_len,
699 /* Get existing address or address with session == 0 */
700 ea = find_equivalent_address (handle, peer, aa);
704 else if (ea->session_id != session_id)
711 * Extract an ATS performance info from an address
713 * @param address the address
714 * @param type the type to extract in HBO
715 * @return the value in HBO or GNUNET_ATS_VALUE_UNDEFINED in HBO if value does not exist
718 get_performance_info (struct ATS_Address *address, uint32_t type)
721 GNUNET_assert (NULL != address);
723 if ((NULL == address->atsi) || (0 == address->atsi_count))
724 return GNUNET_ATS_VALUE_UNDEFINED;
726 for (c1 = 0; c1 < address->atsi_count; c1++)
728 if (ntohl(address->atsi[c1].type) == type)
729 return ntohl(address->atsi[c1].value);
731 return GNUNET_ATS_VALUE_UNDEFINED;
736 * Add a new address for a peer.
738 * @param handle the address handle to use
740 * @param plugin_name transport plugin name
741 * @param plugin_addr plugin address
742 * @param plugin_addr_len length of the plugin address
743 * @param session_id session id, can be 0
744 * @param atsi performance information for this address
745 * @param atsi_count number of performance information contained
748 GAS_addresses_add (struct GAS_Addresses_Handle *handle,
749 const struct GNUNET_PeerIdentity *peer,
750 const char *plugin_name,
751 const void *plugin_addr,
752 size_t plugin_addr_len,
754 const struct GNUNET_ATS_Information *atsi,
757 struct ATS_Address *new_address;
758 struct ATS_Address *existing_address;
759 struct GNUNET_ATS_Information *atsi_delta;
760 uint32_t atsi_delta_count;
762 uint32_t previous_session;
765 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
766 "Received `%s' for peer `%s'\n",
770 if (GNUNET_NO == handle->running)
773 GNUNET_assert (NULL != handle->addresses);
775 new_address = create_address (peer, plugin_name, plugin_addr, plugin_addr_len,
778 disassemble_ats_information (new_address, atsi, atsi_count, &atsi_delta, &atsi_delta_count);
779 GNUNET_free_non_null (atsi_delta);
780 addr_net = get_performance_info (new_address, GNUNET_ATS_NETWORK_TYPE);
781 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
782 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
784 /* Get existing address or address with session == 0 */
785 existing_address = find_equivalent_address (handle, peer, new_address);
786 if (existing_address == NULL)
788 /* Add a new address */
789 GNUNET_assert (GNUNET_OK ==
790 GNUNET_CONTAINER_multihashmap_put (handle->addresses,
791 &peer->hashPubKey, new_address,
792 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
794 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding new address %p for peer `%s' session id %u, %s\n",
795 new_address, GNUNET_i2s (peer), session_id, GNUNET_ATS_print_network_type(addr_net));
797 /* Tell solver about new address */
798 handle->s_add (handle->solver, new_address, addr_net);
800 handle->s_bulk_start (handle->solver);
801 GAS_normalization_normalize_property (handle->addresses, new_address, atsi, atsi_count);
802 handle->s_bulk_stop (handle->solver);
804 /* Notify performance clients about new address */
805 GAS_performance_notify_all_clients (&new_address->peer,
807 new_address->addr, new_address->addr_len,
808 new_address->session_id,
809 new_address->atsi, new_address->atsi_count,
810 new_address->assigned_bw_out,
811 new_address->assigned_bw_in);
815 /* We have an existing address we can use, clean up new */
816 GNUNET_free (new_address->plugin);
817 GNUNET_free_non_null (new_address->atsi);
818 GNUNET_free (new_address);
821 if (0 != existing_address->session_id)
823 /* Should not happen */
828 addr_net = get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE);
829 if (GNUNET_ATS_VALUE_UNDEFINED == addr_net)
830 addr_net = GNUNET_ATS_NET_UNSPECIFIED;
832 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
833 "Found existing address for peer `%s' %p with new session %u in network %s\n",
837 GNUNET_ATS_print_network_type (addr_net));
838 /* We have an address without an session, update this address */
840 atsi_delta_count = 0;
841 if (GNUNET_YES == disassemble_ats_information (existing_address, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
843 /* Notify performance clients about properties */
844 GAS_performance_notify_all_clients (&existing_address->peer,
845 existing_address->plugin,
846 existing_address->addr, existing_address->addr_len,
847 existing_address->session_id,
848 existing_address->atsi, existing_address->atsi_count,
849 existing_address->assigned_bw_out,
850 existing_address->assigned_bw_in);
852 for (c1 = 0; c1 < atsi_delta_count; c1++)
854 if ((GNUNET_ATS_NETWORK_TYPE == ntohl (atsi_delta[c1].type)) &&
855 (addr_net != ntohl (atsi_delta[c1].value)))
857 /* Network type changed */
858 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Address for peer `%s' %p changed from network %s to %s\n",
861 GNUNET_ATS_print_network_type (addr_net),
862 GNUNET_ATS_print_network_type (ntohl (atsi_delta[c1].value)));
863 handle->s_address_update_network (handle->solver, existing_address,
864 ntohl (atsi_delta[c1].value),
865 get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE));
866 addr_net = get_performance_info (existing_address, GNUNET_ATS_NETWORK_TYPE);
870 /* Notify solver about update with atsi information and session */
871 handle->s_bulk_start (handle->solver);
872 GAS_normalization_normalize_property (handle->addresses, existing_address, atsi, atsi_count);
873 handle->s_bulk_stop (handle->solver);
875 GNUNET_free_non_null (atsi_delta);
877 /* Notify solver about new session */
878 if (existing_address->session_id == session_id)
879 return; /* possible, can both be 0 since address is revalidated */
881 previous_session = existing_address->session_id;
882 existing_address->session_id = session_id;
883 handle->s_address_update_session (handle->solver, existing_address,
884 previous_session, session_id);
886 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
887 "Updated existing address for peer `%s' %p with new session %u in network %s\n",
891 GNUNET_ATS_print_network_type(addr_net));
896 * Update an address with a session or performance information for a peer.
898 * If an address was added without a session it will be updated with the
901 * @param handle the address handle to use
903 * @param plugin_name transport plugin name
904 * @param plugin_addr plugin address
905 * @param plugin_addr_len length of the plugin address
906 * @param session_id session id, can be 0
907 * @param atsi performance information for this address
908 * @param atsi_count number of performance information contained
911 GAS_addresses_update (struct GAS_Addresses_Handle *handle,
912 const struct GNUNET_PeerIdentity *peer,
913 const char *plugin_name, const void *plugin_addr,
914 size_t plugin_addr_len, uint32_t session_id,
915 const struct GNUNET_ATS_Information *atsi,
918 struct ATS_Address *aa;
919 struct GNUNET_ATS_Information *atsi_delta;
920 uint32_t atsi_delta_count;
921 uint32_t prev_session;
924 if (GNUNET_NO == handle->running)
927 GNUNET_assert (NULL != handle->addresses);
929 /* Get existing address */
930 aa = find_exact_address (handle, peer, plugin_name,
931 plugin_addr, plugin_addr_len, session_id);
934 /* GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n", */
935 /* GNUNET_i2s (peer), plugin_name, session_id); */
936 /* GNUNET_break (0); */
940 if (NULL == aa->solver_information)
942 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Tried to update unknown address for peer `%s' `%s' session id %u\n",
943 GNUNET_i2s (peer), plugin_name, session_id);
947 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
948 "Received `%s' for peer `%s' address \n",
950 GNUNET_i2s (peer), aa);
953 if (session_id != aa->session_id)
955 /* Session changed */
956 prev_session = aa->session_id;
957 aa->session_id = session_id;
958 handle->s_address_update_session (handle->solver, aa, prev_session, aa->session_id);
962 atsi_delta_count = 0;
963 if (GNUNET_YES == disassemble_ats_information (aa, atsi, atsi_count, &atsi_delta, &atsi_delta_count))
965 /* ATS properties changed */
966 for (c1 = 0; c1 < atsi_delta_count; c1++)
968 if (GNUNET_ATS_NETWORK_TYPE == ntohl (atsi_delta[c1].type))
970 /* Network type changed */
971 handle->s_address_update_network (handle->solver, aa,
972 ntohl (atsi_delta[c1].value),
973 get_performance_info (aa, GNUNET_ATS_NETWORK_TYPE));
977 /* Notify performance clients about updated address */
978 GAS_performance_notify_all_clients (&aa->peer,
980 aa->addr, aa->addr_len,
982 aa->atsi, aa->atsi_count,
986 handle->s_bulk_start (handle->solver);
987 GAS_normalization_normalize_property (handle->addresses, aa, atsi, atsi_count);
988 handle->s_bulk_stop (handle->solver);
990 GNUNET_free_non_null (atsi_delta);
994 struct DestroyContext
996 struct ATS_Address *aa;
998 struct GAS_Addresses_Handle *handle;
1001 * GNUNET_NO : full address
1002 * GNUNET_YES : just session
1011 * If session != 0, just the session is deleted, the address itself still exists
1012 * If session == 0, remove full address
1013 * If session == 0 and addrlen == 0, destroy inbound address
1017 * @param value the 'struct ATS_Address'
1018 * @return GNUNET_OK (continue to iterate)
1021 destroy_by_session_id (void *cls, const struct GNUNET_HashCode * key, void *value)
1023 struct DestroyContext *dc = cls;
1024 struct GAS_Addresses_Handle *handle = dc->handle;
1025 const struct ATS_Address *des = dc->aa;
1026 struct ATS_Address *aa = value;
1028 GNUNET_assert (0 == memcmp (&aa->peer, &des->peer,
1029 sizeof (struct GNUNET_PeerIdentity)));
1032 if (des->session_id == 0)
1034 /* Session == 0, remove full address */
1035 if ((0 == strcmp (des->plugin, aa->plugin)) &&
1036 (aa->addr_len == des->addr_len) &&
1037 (0 == memcmp (des->addr, aa->addr, aa->addr_len)))
1040 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1041 "Deleting full address for peer `%s' session %u %p\n",
1042 GNUNET_i2s (&aa->peer), aa->session_id, aa);
1044 /* Notify solver about deletion */
1045 GNUNET_assert (GNUNET_YES ==
1046 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
1047 &aa->peer.hashPubKey, aa));
1048 handle->s_del (handle->solver, aa, GNUNET_NO);
1050 dc->result = GNUNET_NO;
1051 return GNUNET_OK; /* Continue iteration */
1056 /* Session != 0, just remove session */
1057 if (aa->session_id != des->session_id)
1058 return GNUNET_OK; /* irrelevant */
1060 if ((aa->session_id != 0) &&
1061 (0 != strcmp (des->plugin, aa->plugin)))
1063 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1064 "Different plugins during removal: `%s' vs `%s' \n",
1065 des->plugin, aa->plugin);
1070 if (aa->addr_len == 0)
1072 /* Inbound connection died, delete full address */
1073 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1074 "Deleting inbound address for peer `%s': `%s' session %u\n",
1075 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1077 /* Notify solver about deletion */
1078 GNUNET_assert (GNUNET_YES ==
1079 GNUNET_CONTAINER_multihashmap_remove (handle->addresses,
1080 &aa->peer.hashPubKey, aa));
1081 handle->s_del (handle->solver, aa, GNUNET_NO);
1083 dc->result = GNUNET_NO;
1084 return GNUNET_OK; /* Continue iteration */
1089 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1090 "Deleting session for peer `%s': `%s' %u\n",
1091 GNUNET_i2s (&aa->peer), aa->plugin, aa->session_id);
1092 /* Notify solver to delete session */
1093 handle->s_del (handle->solver, aa, GNUNET_YES);
1103 * Remove an address or just a session for a peer.
1105 * @param handle the address handle to use
1107 * @param plugin_name transport plugin name
1108 * @param plugin_addr plugin address
1109 * @param plugin_addr_len length of the plugin address
1110 * @param session_id session id, can be 0
1113 GAS_addresses_destroy (struct GAS_Addresses_Handle *handle,
1114 const struct GNUNET_PeerIdentity *peer,
1115 const char *plugin_name,
1116 const void *plugin_addr,
1117 size_t plugin_addr_len,
1118 uint32_t session_id)
1120 struct ATS_Address *ea;
1121 struct DestroyContext dc;
1122 if (GNUNET_NO == handle->running)
1125 /* Get existing address */
1126 ea = find_exact_address (handle, peer, plugin_name, plugin_addr,
1127 plugin_addr_len, session_id);
1130 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Tried to destroy unknown address for peer `%s' `%s' session id %u\n",
1131 GNUNET_i2s (peer), plugin_name, session_id);
1135 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1136 "Received `%s' for peer `%s' address %p session %u\n",
1138 GNUNET_i2s (peer), ea, session_id);
1140 GNUNET_break (0 < strlen (plugin_name));
1142 dc.aa = create_address (peer, plugin_name, plugin_addr, plugin_addr_len, session_id);
1144 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey,
1145 &destroy_by_session_id, &dc);
1146 free_address (dc.aa);
1151 * Notification about active use of an address.
1152 * in_use == GNUNET_YES:
1153 * This address is used to maintain an active connection with a peer.
1154 * in_use == GNUNET_NO:
1155 * This address is no longer used to maintain an active connection with a peer.
1157 * Note: can only be called with in_use == GNUNET_NO if called with GNUNET_YES
1160 * @param handle the address handle to use
1162 * @param plugin_name transport plugin name
1163 * @param plugin_addr plugin address
1164 * @param plugin_addr_len length of the plugin address
1165 * @param session_id session id, can be 0
1166 * @param in_use GNUNET_YES if GNUNET_NO
1167 * @return GNUNET_SYSERR on failure (address unknown ...)
1170 GAS_addresses_in_use (struct GAS_Addresses_Handle *handle,
1171 const struct GNUNET_PeerIdentity *peer,
1172 const char *plugin_name,
1173 const void *plugin_addr,
1174 size_t plugin_addr_len,
1175 uint32_t session_id,
1178 struct ATS_Address *ea;
1179 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1180 "Received `%s' for peer `%s'\n",
1184 if (GNUNET_NO == handle->running)
1185 return GNUNET_SYSERR;
1187 ea = find_exact_address (handle, peer, plugin_name,
1188 plugin_addr, plugin_addr_len, session_id);
1191 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1192 "Trying to set unknown address `%s', %s %u %s \n",
1194 plugin_name, session_id,
1195 (GNUNET_NO == in_use) ? "NO" : "YES");
1197 return GNUNET_SYSERR;
1199 if (ea->used == in_use)
1202 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1203 "Address in use called multiple times for peer `%s': %s -> %s \n",
1205 (GNUNET_NO == ea->used) ? "NO" : "YES",
1206 (GNUNET_NO == in_use) ? "NO" : "YES");
1207 return GNUNET_SYSERR;
1210 /* Tell solver about update */
1212 handle->s_address_update_inuse (handle->solver, ea, ea->used);
1218 * Cancel address suggestions for a peer
1220 * @param handle the address handle
1221 * @param peer the peer id
1224 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
1225 const struct GNUNET_PeerIdentity *peer)
1227 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1229 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1230 "Received request: `%s' for peer %s\n", "request_address_cancel", GNUNET_i2s (peer));
1234 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1241 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1242 "No address requests pending for peer `%s', cannot remove!\n", GNUNET_i2s (peer));
1245 handle->s_get_stop (handle->solver, peer);
1246 GAS_addresses_handle_backoff_reset (handle, peer);
1247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1248 "Removed request pending for peer `%s\n", GNUNET_i2s (peer));
1249 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1255 * Request address suggestions for a peer
1257 * @param handle the address handle
1258 * @param peer the peer id
1261 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
1262 const struct GNUNET_PeerIdentity *peer)
1264 struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
1265 struct ATS_Address *aa;
1267 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1268 "Received `%s' for peer `%s'\n",
1272 if (GNUNET_NO == handle->running)
1276 if (0 == memcmp (peer, &cur->id, sizeof (cur->id)))
1277 break; /* already suggesting */
1282 cur = GNUNET_malloc (sizeof (struct GAS_Addresses_Suggestion_Requests));
1284 GNUNET_CONTAINER_DLL_insert (handle->r_head, handle->r_tail, cur);
1287 /* Get prefered address from solver */
1288 aa = (struct ATS_Address *) handle->s_get (handle->solver, peer);
1291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1292 "Cannot suggest address for peer `%s'\n", GNUNET_i2s (peer));
1296 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1297 "Suggesting address %p for peer `%s'\n", aa, GNUNET_i2s (peer));
1299 GAS_scheduling_transmit_address_suggestion (peer,
1301 aa->addr, aa->addr_len,
1303 aa->atsi, aa->atsi_count,
1304 aa->assigned_bw_out,
1305 aa->assigned_bw_in);
1307 aa->block_interval = GNUNET_TIME_relative_add (aa->block_interval, ATS_BLOCKING_DELTA);
1308 aa->blocked_until = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), aa->block_interval);
1310 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1311 "Address %p ready for suggestion, block interval now %llu \n",
1312 aa, aa->block_interval);
1317 * Iterator to reset address blocking
1319 * @param cls not used
1320 * @param key the peer
1321 * @param value the address to reset
1322 * @return GNUNET_OK to continue
1325 reset_address_it (void *cls, const struct GNUNET_HashCode *key, void *value)
1327 struct ATS_Address *aa = value;
1329 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1330 "Resetting interval for peer `%s' address %p from %llu to 0\n",
1331 GNUNET_i2s (&aa->peer), aa, aa->block_interval);
1333 aa->blocked_until = GNUNET_TIME_UNIT_ZERO_ABS;
1334 aa->block_interval = GNUNET_TIME_UNIT_ZERO;
1340 * Reset suggestion backoff for a peer
1342 * Suggesting addresses is blocked for ATS_BLOCKING_DELTA. Blocking can be
1343 * reset using this function
1345 * @param handle the address handle
1346 * @param peer the peer id
1349 GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
1350 const struct GNUNET_PeerIdentity *peer)
1352 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1353 "Received `%s' for peer `%s'\n",
1357 GNUNET_break (GNUNET_SYSERR != GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses,
1365 * The preference changed for a peer
1367 * @param cls the address handle
1368 * @param peer the peer
1369 * @param kind the ATS kind
1370 * @param pref_rel the new relative preference value
1373 normalized_preference_changed_cb (void *cls,
1374 const struct GNUNET_PeerIdentity *peer,
1375 enum GNUNET_ATS_PreferenceKind kind,
1378 GNUNET_assert (NULL != cls);
1379 struct GAS_Addresses_Handle *handle = cls;
1380 /* Tell solver about update */
1381 handle->s_pref (handle->solver, peer, kind, pref_rel);
1386 * The relative value for a property changed
1388 * @param cls the address handle
1389 * @param address the peer
1390 * @param type the ATS type
1391 * @param prop_rel the new relative preference value
1394 normalized_property_changed_cb (void *cls,
1395 struct ATS_Address *address,
1399 struct GAS_Addresses_Handle *ah = (struct GAS_Addresses_Handle *) cls;
1400 GNUNET_assert (NULL != ah);
1402 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1403 "Normalized property %s for peer `%s' changed to %.3f \n",
1404 GNUNET_ATS_print_property_type (type),
1405 GNUNET_i2s (&address->peer),
1408 ah->s_address_update_property (ah->solver,
1417 * Function allowing the solver to obtain normalized preference
1418 * values from solver
1421 * @param id the peer to return the normalized properties for
1422 * @return array of double values with |GNUNET_ATS_PreferenceCount| elements
1425 get_preferences_cb (void *cls, const struct GNUNET_PeerIdentity *id)
1427 return GAS_normalization_get_preferences (id);
1431 * Function allowing the solver to obtain normalized property
1432 * values for an address from solver
1435 * @param address the address
1436 * @return array of double values with |GNUNET_ATS_QualityPropertiesCount| elements
1439 get_property_cb (void *cls, const struct ATS_Address *address)
1441 return GAS_normalization_get_properties ((struct ATS_Address *) address);
1445 * Change the preference for a peer
1447 * @param handle the address handle
1448 * @param client the client sending this request
1449 * @param peer the peer id
1450 * @param kind the preference kind to change
1451 * @param score_abs the new preference score
1454 GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
1456 const struct GNUNET_PeerIdentity *peer,
1457 enum GNUNET_ATS_PreferenceKind kind,
1460 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1461 "Received `%s' for peer `%s' for client %p\n",
1462 "CHANGE PREFERENCE",
1463 GNUNET_i2s (peer), client);
1465 if (GNUNET_NO == handle->running)
1468 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains (handle->addresses,
1471 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1472 "Received `%s' for unknown peer `%s' from client %p\n",
1473 "CHANGE PREFERENCE",
1474 GNUNET_i2s (peer), client);
1478 handle->s_bulk_start (handle->solver);
1479 /* Tell normalization about change, normalization will call callback if preference changed */
1480 GAS_normalization_normalize_preference (client, peer, kind, score_abs);
1481 handle->s_bulk_stop (handle->solver);
1486 * Load quotas for networks from configuration
1488 * @param cfg configuration handle
1489 * @param out_dest where to write outbound quotas
1490 * @param in_dest where to write inbound quotas
1491 * @param dest_length length of inbound and outbound arrays
1492 * @return number of networks loaded
1495 load_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg, unsigned long long *out_dest, unsigned long long *in_dest, int dest_length)
1497 char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
1498 char * entry_in = NULL;
1499 char * entry_out = NULL;
1500 char * quota_out_str;
1501 char * quota_in_str;
1505 for (c = 0; (c < GNUNET_ATS_NetworkTypeCount) && (c < dest_length); c++)
1509 GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
1510 GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
1513 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, "a_out_str))
1516 if (0 == strcmp(quota_out_str, GNUNET_ATS_MaxBandwidthString))
1518 out_dest[c] = GNUNET_ATS_MaxBandwidth;
1521 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &out_dest[c])))
1523 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_out, &out_dest[c])))
1526 if (GNUNET_NO == res)
1528 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1529 network_str[c], quota_out_str, GNUNET_ATS_DefaultBandwidth);
1530 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1534 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Outbound quota configure for network `%s' is %llu\n"),
1535 network_str[c], out_dest[c]);
1537 GNUNET_free (quota_out_str);
1541 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configured for network `%s', assigning default bandwidth %llu\n"),
1542 network_str[c], GNUNET_ATS_DefaultBandwidth);
1543 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1547 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, "a_in_str))
1550 if (0 == strcmp(quota_in_str, GNUNET_ATS_MaxBandwidthString))
1552 in_dest[c] = GNUNET_ATS_MaxBandwidth;
1555 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &in_dest[c])))
1557 if ((GNUNET_NO == res) && (GNUNET_OK == GNUNET_CONFIGURATION_get_value_number (cfg, "ats", entry_in, &in_dest[c])))
1560 if (GNUNET_NO == res)
1562 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not load quota for network `%s': `%s', assigning default bandwidth %llu\n"),
1563 network_str[c], quota_in_str, GNUNET_ATS_DefaultBandwidth);
1564 in_dest[c] = GNUNET_ATS_DefaultBandwidth;
1568 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Inbound quota configured for network `%s' is %llu\n"),
1569 network_str[c], in_dest[c]);
1571 GNUNET_free (quota_in_str);
1575 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("No outbound quota configure for network `%s', assigning default bandwidth %llu\n"),
1576 network_str[c], GNUNET_ATS_DefaultBandwidth);
1577 out_dest[c] = GNUNET_ATS_DefaultBandwidth;
1579 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]);
1580 GNUNET_free (entry_out);
1581 GNUNET_free (entry_in);
1583 return GNUNET_ATS_NetworkTypeCount;
1588 * Callback for solver to notify about assignment changes
1590 * @param cls the GAS_Addresses_Handle
1591 * @param address the address with changes
1594 bandwidth_changed_cb (void *cls, struct ATS_Address *address)
1596 struct GAS_Addresses_Handle *handle = cls;
1597 struct GAS_Addresses_Suggestion_Requests *cur;
1599 GNUNET_assert (handle != NULL);
1600 GNUNET_assert (address != NULL);
1602 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bandwidth assignment changed for peer %s \n", GNUNET_i2s(&address->peer));
1604 /* Notify performance clients about changes to address */
1605 GAS_performance_notify_all_clients (&address->peer,
1607 address->addr, address->addr_len,
1608 address->session_id,
1609 address->atsi, address->atsi_count,
1610 address->assigned_bw_out,
1611 address->assigned_bw_in);
1612 cur = handle->r_head;
1615 if (0 == memcmp (&address->peer, &cur->id, sizeof (cur->id)))
1616 break; /* we have an address request pending*/
1621 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1622 "Nobody is interested in peer `%s' :(\n",GNUNET_i2s (&address->peer));
1626 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1627 "Sending bandwidth update for peer `%s'\n",GNUNET_i2s (&address->peer));
1629 /* *Notify scheduling clients about suggestion */
1630 GAS_scheduling_transmit_address_suggestion (&address->peer,
1632 address->addr, address->addr_len,
1633 address->session_id,
1634 address->atsi, address->atsi_count,
1635 address->assigned_bw_out,
1636 address->assigned_bw_in);
1641 * Initialize address subsystem. The addresses subsystem manages the addresses
1642 * known and current performance information. It has a solver component
1643 * responsible for the resource allocation. It tells the solver about changes
1644 * and receives updates when the solver changes the ressource allocation.
1646 * @param cfg configuration to use
1647 * @param stats the statistics handle to use
1648 * @return an address handle
1650 struct GAS_Addresses_Handle *
1651 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
1652 const struct GNUNET_STATISTICS_Handle *stats)
1654 struct GAS_Addresses_Handle *ah;
1655 int quotas[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
1656 unsigned long long quotas_in[GNUNET_ATS_NetworkTypeCount];
1657 unsigned long long quotas_out[GNUNET_ATS_NetworkTypeCount];
1662 ah = GNUNET_malloc (sizeof (struct GAS_Addresses_Handle));
1663 ah->running = GNUNET_NO;
1665 ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
1666 /* Initialize the addresses database */
1667 ah->addresses = GNUNET_CONTAINER_multihashmap_create (128, GNUNET_NO);
1668 GNUNET_assert (NULL != ah->addresses);
1670 /* Figure out configured solution method */
1671 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", "MODE", &mode_str))
1673 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "No ressource assignment method configured, using simplistic approch\n");
1674 ah->ats_mode = MODE_SIMPLISTIC;
1678 for (c = 0; c < strlen (mode_str); c++)
1679 mode_str[c] = toupper (mode_str[c]);
1680 if (0 == strcmp (mode_str, "SIMPLISTIC"))
1682 ah->ats_mode = MODE_SIMPLISTIC;
1684 else if (0 == strcmp (mode_str, "MLP"))
1686 ah->ats_mode = MODE_MLP;
1688 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Assignment method `%s' configured, but GLPK is not availabe, please install \n", mode_str);
1689 ah->ats_mode = MODE_SIMPLISTIC;
1694 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid ressource assignment method `%s' configured, using simplistic approch\n", mode_str);
1695 ah->ats_mode = MODE_SIMPLISTIC;
1697 GNUNET_free (mode_str);
1699 /* Start configured solution method */
1700 switch (ah->ats_mode)
1703 /* Init the MLP solver with default values */
1705 ah->ats_mode = MODE_MLP;
1706 ah->s_init = &GAS_mlp_init;
1707 ah->s_add = &GAS_mlp_address_add;
1708 ah->s_address_update_property = &GAS_mlp_address_property_changed;
1709 ah->s_address_update_session = &GAS_mlp_address_session_changed;
1710 ah->s_address_update_inuse = &GAS_mlp_address_inuse_changed;
1711 ah->s_address_update_network = &GAS_mlp_address_change_network;
1712 ah->s_get = &GAS_mlp_get_preferred_address;
1713 ah->s_get_stop = &GAS_mlp_stop_get_preferred_address;
1714 ah->s_pref = &GAS_mlp_address_change_preference;
1715 ah->s_del = &GAS_mlp_address_delete;
1716 ah->s_bulk_start = &GAS_mlp_bulk_start;
1717 ah->s_bulk_stop = &GAS_mlp_bulk_stop;
1718 ah->s_done = &GAS_mlp_done;
1724 case MODE_SIMPLISTIC:
1725 /* Init the simplistic solver with default values */
1726 ah->ats_mode = MODE_SIMPLISTIC;
1727 ah->s_init = &GAS_proportional_init;
1728 ah->s_add = &GAS_proportional_address_add;
1729 ah->s_address_update_property = &GAS_proportional_address_property_changed;
1730 ah->s_address_update_session = &GAS_proportional_address_session_changed;
1731 ah->s_address_update_inuse = &GAS_proportional_address_inuse_changed;
1732 ah->s_address_update_network = &GAS_proportional_address_change_network;
1733 ah->s_get = &GAS_proportional_get_preferred_address;
1734 ah->s_get_stop = &GAS_proportional_stop_get_preferred_address;
1735 ah->s_pref = &GAS_proportional_address_change_preference;
1736 ah->s_del = &GAS_proportional_address_delete;
1737 ah->s_bulk_start = &GAS_proportional_bulk_start;
1738 ah->s_bulk_stop = &GAS_proportional_bulk_stop;
1739 ah->s_done = &GAS_proportional_done;
1740 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS started in %s mode\n", "SIMPLISTIC");
1747 GNUNET_assert (NULL != ah->s_init);
1748 GNUNET_assert (NULL != ah->s_add);
1749 GNUNET_assert (NULL != ah->s_address_update_inuse);
1750 GNUNET_assert (NULL != ah->s_address_update_property);
1751 GNUNET_assert (NULL != ah->s_address_update_session);
1752 GNUNET_assert (NULL != ah->s_address_update_network);
1753 GNUNET_assert (NULL != ah->s_get);
1754 GNUNET_assert (NULL != ah->s_get_stop);
1755 GNUNET_assert (NULL != ah->s_pref);
1756 GNUNET_assert (NULL != ah->s_del);
1757 GNUNET_assert (NULL != ah->s_done);
1758 GNUNET_assert (NULL != ah->s_bulk_start);
1759 GNUNET_assert (NULL != ah->s_bulk_stop);
1761 GAS_normalization_start (&normalized_preference_changed_cb, ah,
1762 &normalized_property_changed_cb, ah);
1763 quota_count = load_quotas(cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
1765 ah->solver = ah->s_init (cfg, stats, ah->addresses,
1766 quotas, quotas_in, quotas_out, quota_count,
1767 &bandwidth_changed_cb, ah,
1768 &get_preferences_cb, NULL,
1769 &get_property_cb, NULL);
1770 if (NULL == ah->solver)
1772 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Failed to initialize solver!\n"));
1777 /* up and running */
1778 ah->running = GNUNET_YES;
1784 * Destroy all addresses iterator
1787 * @param key peer identity (unused)
1788 * @param value the 'struct ATS_Address' to free
1789 * @return GNUNET_OK (continue to iterate)
1792 destroy_all_address_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1794 struct GAS_Addresses_Handle *handle = cls;
1795 struct ATS_Address *aa = value;
1798 GNUNET_assert (GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove (handle->addresses, key, value));
1800 handle->s_del (handle->solver, aa, GNUNET_NO);
1809 * Remove all addresses
1811 * @param handle the address handle to use
1814 GAS_addresses_destroy_all (struct GAS_Addresses_Handle *handle)
1816 if (GNUNET_NO == handle->running)
1819 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1822 if (handle->addresses != NULL)
1823 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &destroy_all_address_it, handle);
1828 * Shutdown address subsystem.
1830 * @param handle the address handle to shutdown
1833 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
1835 struct GAS_Addresses_Suggestion_Requests *cur;
1837 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1838 "Shutting down addresses\n");
1839 GNUNET_assert (NULL != handle);
1840 GAS_addresses_destroy_all (handle);
1841 handle->running = GNUNET_NO;
1842 GNUNET_CONTAINER_multihashmap_destroy (handle->addresses);
1843 handle->addresses = NULL;
1844 while (NULL != (cur = handle->r_head))
1846 GNUNET_CONTAINER_DLL_remove (handle->r_head, handle->r_tail, cur);
1849 handle->s_done (handle->solver);
1850 GNUNET_free (handle);
1851 /* Stop configured solution method */
1852 GAS_normalization_stop ();
1856 struct PeerIteratorContext
1858 GNUNET_ATS_Peer_Iterator it;
1860 struct GNUNET_CONTAINER_MultiHashMap *peers_returned;
1865 * Iterator to iterate over all peers
1867 * @param cls a PeerIteratorContext
1868 * @param key the peer id
1869 * @param value the ATS_address
1870 * @return GNUNET_OK to continue
1874 const struct GNUNET_HashCode * key,
1877 struct PeerIteratorContext *ip_ctx = cls;
1878 struct GNUNET_PeerIdentity tmp;
1880 if (GNUNET_NO == GNUNET_CONTAINER_multihashmap_contains(ip_ctx->peers_returned, key))
1882 GNUNET_CONTAINER_multihashmap_put(ip_ctx->peers_returned, key, NULL, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1883 tmp.hashPubKey = (*key);
1884 ip_ctx->it (ip_ctx->it_cls, &tmp);
1892 * Return information all peers currently known to ATS
1894 * @param handle the address handle to use
1895 * @param p_it the iterator to call for every peer
1896 * @param p_it_cls the closure for the iterator
1899 GAS_addresses_iterate_peers (struct GAS_Addresses_Handle *handle,
1900 GNUNET_ATS_Peer_Iterator p_it,
1903 struct PeerIteratorContext ip_ctx;
1908 GNUNET_assert (NULL != handle->addresses);
1910 size = GNUNET_CONTAINER_multihashmap_size(handle->addresses);
1914 ip_ctx.it_cls = p_it_cls;
1915 ip_ctx.peers_returned = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_NO);
1916 GNUNET_CONTAINER_multihashmap_iterate (handle->addresses, &peer_it, &ip_ctx);
1917 GNUNET_CONTAINER_multihashmap_destroy (ip_ctx.peers_returned);
1919 p_it (p_it_cls, NULL);
1923 struct PeerInfoIteratorContext
1925 GNUNET_ATS_PeerInfo_Iterator it;
1931 * Iterator to iterate over a peer's addresses
1933 * @param cls a PeerInfoIteratorContext
1934 * @param key the peer id
1935 * @param value the ATS_address
1936 * @return GNUNET_OK to continue
1939 peerinfo_it (void *cls,
1940 const struct GNUNET_HashCode * key,
1943 struct PeerInfoIteratorContext *pi_ctx = cls;
1944 struct ATS_Address *addr = (struct ATS_Address *) value;
1946 if (NULL != pi_ctx->it)
1948 pi_ctx->it (pi_ctx->it_cls,
1951 addr->addr, addr->addr_len,
1953 addr->atsi, addr->atsi_count,
1954 addr->assigned_bw_out,
1955 addr->assigned_bw_in);
1962 * Return information all peers currently known to ATS
1964 * @param handle the address handle to use
1965 * @param peer the respective peer
1966 * @param pi_it the iterator to call for every peer
1967 * @param pi_it_cls the closure for the iterator
1970 GAS_addresses_get_peer_info (struct GAS_Addresses_Handle *handle,
1971 const struct GNUNET_PeerIdentity *peer,
1972 GNUNET_ATS_PeerInfo_Iterator pi_it,
1975 struct PeerInfoIteratorContext pi_ctx;
1976 struct GNUNET_BANDWIDTH_Value32NBO zero_bw;
1977 GNUNET_assert (NULL != peer);
1978 GNUNET_assert (NULL != handle->addresses);
1980 return; /* does not make sense without callback */
1982 zero_bw = GNUNET_BANDWIDTH_value_init (0);
1984 pi_ctx.it_cls = pi_it_cls;
1986 GNUNET_CONTAINER_multihashmap_get_multiple (handle->addresses, &peer->hashPubKey, &peerinfo_it, &pi_ctx);
1989 pi_it (pi_it_cls, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, zero_bw, zero_bw);
1994 /* end of gnunet-service-ats_addresses.c */