src/ats/gnunet-service-ats-solver_proportional.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file ats/gnunet-service-ats-solver_proportional.h
  23  * @brief ATS proportional solver
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_statistics_service.h"
  29 #include "gnunet-service-ats_addresses.h"
  30
  31 /**
  32  * ATS proportional solver
  33  *
  34  * General description
  35  */
  36
  37 /**
  38  * Changes the preferences for a peer in the problem
  39  *
  40  * @param solver the solver handle
  41  * @param addresses the address hashmap
  42  * @param peer the peer to change the preference for
  43  * @param kind the kind to change the preference
  44  * @param pref_rel the normalized preference value for this kind over all clients
  45  */
  46 void
  47 GAS_proportional_address_change_preference (void *solver,
  48                                                                                         struct GNUNET_CONTAINER_MultiHashMap *addresses,
  49                                                                                         const struct GNUNET_PeerIdentity *peer,
  50                                                                                         enum GNUNET_ATS_PreferenceKind kind,
  51                                                                                         double pref_rel);
  52
  53
  54 /**
  55  * Init the proportional problem solver
  56  *
  57  * Quotas:
  58  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
  59  * out_quota[i] contains outbound quota for network type i
  60  * in_quota[i] contains inbound quota for network type i
  61  *
  62  * Example
  63  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
  64  * network[2]   == GNUNET_ATS_NET_LAN
  65  * out_quota[2] == 65353
  66  * in_quota[2]  == 65353
  67  *
  68  * @param cfg configuration handle
  69  * @param stats the GNUNET_STATISTICS handle
  70  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  71  * @param out_quota array of outbound quotas
  72  * @param in_quota array of outbound quota
  73  * @param dest_length array length for quota arrays
  74  * @param bw_changed_cb callback for changed bandwidth amounts
  75  * @param bw_changed_cb_cls cls for callback
  76  * @return handle for the solver on success, NULL on fail
  77  */
  78 void *
  79 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
  80                      const struct GNUNET_STATISTICS_Handle *stats,
  81                      int *network,
  82                      unsigned long long *out_quota,
  83                      unsigned long long *in_quota,
  84                      int dest_length,
  85                      GAS_bandwidth_changed_cb bw_changed_cb,
  86                      void *bw_changed_cb_cls);
  87
  88
  89 /**
  90  * Shutdown the proportional problem solver
  91  *
  92  * @param solver the respective handle to shutdown
  93  */
  94 void
  95 GAS_proportional_done (void * solver);
  96
  97
  98 /**
  99  * Add a single address within a network to the solver
 100  *
 101  * @param solver the solver Handle
 102  * @param addresses the address hashmap containing all addresses
 103  * @param address the address to add
 104  * @param network network type of this address
 105  */
 106 void
 107 GAS_proportional_address_add (void *solver,
 108                                                         struct GNUNET_CONTAINER_MultiHashMap *addresses,
 109                                                         struct ATS_Address *address,
 110                                                         uint32_t network);
 111
 112
 113 /**
 114  * Updates a single address in the solve
 115  *
 116  * @param solver the solver Handle
 117  * @param addresses the address hashmap containing all addresses
 118  * @param address the update address
 119  * @param session the new session (if changed otherwise current)
 120  * @param in_use the new address in use state (if changed otherwise current)
 121  * @param prev_ats the latest ATS information
 122  * @param prev_atsi_count the atsi count
 123  */
 124 void
 125 GAS_proportional_address_update (void *solver,
 126     struct GNUNET_CONTAINER_MultiHashMap *addresses,
 127     struct ATS_Address *address,
 128     uint32_t session,
 129     int in_use,
 130     const struct GNUNET_ATS_Information *atsi,
 131     uint32_t atsi_count);
 132
 133
 134 /**
 135  * Remove an address from the solver
 136  *
 137  * @param solver the solver handle
 138  * @param addresses the address hashmap containing all addresses
 139  * @param address the address to remove
 140  * @param session_only delete only session not whole address
 141  */
 142 void
 143 GAS_proportional_address_delete (void *solver,
 144     struct GNUNET_CONTAINER_MultiHashMap * addresses,
 145     struct ATS_Address *address, int session_only);
 146
 147
 148 /**
 149  * Stop notifying about address and bandwidth changes for this peer
 150  *
 151  * @param solver the MLP handle
 152  * @param addresses address hashmap
 153  * @param peer the peer
 154  */
 155 void
 156 GAS_proportional_stop_get_preferred_address (void *solver,
 157                                      struct GNUNET_CONTAINER_MultiHashMap *addresses,
 158                                      const struct GNUNET_PeerIdentity *peer);
 159
 160
 161 /**
 162  * Get the prefered address for a specific peer
 163  *
 164  * @param solver the solver handle
 165  * @param addresses the address hashmap containing all addresses
 166  * @param peer the identity of the peer
 167  */
 168 const struct ATS_Address *
 169 GAS_proportional_get_preferred_address (void *solver,
 170                                struct GNUNET_CONTAINER_MultiHashMap * addresses,
 171                                const struct GNUNET_PeerIdentity *peer);
 172
 173 /* end of gnunet-service-ats-solver_proportional.c */