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                                                                                         const struct GNUNET_PeerIdentity *peer,
  49                                                                                         enum GNUNET_ATS_PreferenceKind kind,
  50                                                                                         double pref_rel);
  51
  52
  53 /**
  54  * Init the proportional problem solver
  55  *
  56  * Quotas:
  57  * network[i] contains the network type as type GNUNET_ATS_NetworkType[i]
  58  * out_quota[i] contains outbound quota for network type i
  59  * in_quota[i] contains inbound quota for network type i
  60  *
  61  * Example
  62  * network = {GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN}
  63  * network[2]   == GNUNET_ATS_NET_LAN
  64  * out_quota[2] == 65353
  65  * in_quota[2]  == 65353
  66  *
  67  * @param cfg configuration handle
  68  * @param stats the GNUNET_STATISTICS handle
  69  * @param network array of GNUNET_ATS_NetworkType with length dest_length
  70  * @param addresses hashmap containing all addresses
  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  * @param get_preference callback to get relative preferences for a peer
  77  * @param get_preference_cls cls for callback to get relative preferences
  78  * @return handle for the solver on success, NULL on fail
  79  */
  80 void *
  81 GAS_proportional_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
  82                      const struct GNUNET_STATISTICS_Handle *stats,
  83                      const struct GNUNET_CONTAINER_MultiHashMap *addresses,
  84                      int *network,
  85                      unsigned long long *out_quota,
  86                      unsigned long long *in_quota,
  87                      int dest_length,
  88                      GAS_bandwidth_changed_cb bw_changed_cb,
  89                      void *bw_changed_cb_cls,
  90                      GAS_get_preferences get_preference,
  91                      void *get_preference_cls,
  92                      GAS_get_properties get_properties,
  93                      void *get_properties_cls);
  94
  95 /**
  96  * Shutdown the proportional problem solver
  97  *
  98  * @param solver the respective handle to shutdown
  99  */
 100 void
 101 GAS_proportional_done (void * solver);
 102
 103
 104 /**
 105  * Add a single address within a network to the solver
 106  *
 107  * @param solver the solver Handle
 108  * @param addresses the address hashmap containing all addresses
 109  * @param address the address to add
 110  * @param network network type of this address
 111  */
 112 void
 113 GAS_proportional_address_add (void *solver,
 114                                                         struct ATS_Address *address,
 115                                                         uint32_t network);
 116
 117
 118 /**
 119  * Updates a single address in the solve
 120  *
 121  * @param solver the solver Handle
 122  * @param addresses the address hashmap containing all addresses
 123  * @param address the update address
 124  * @param session the new session (if changed otherwise current)
 125  * @param in_use the new address in use state (if changed otherwise current)
 126  * @param prev_ats the latest ATS information
 127  * @param prev_atsi_count the atsi count
 128  */
 129 void
 130 GAS_proportional_address_update (void *solver,
 131     struct ATS_Address *address,
 132     uint32_t session,
 133     int in_use,
 134     const struct GNUNET_ATS_Information *atsi,
 135     uint32_t atsi_count);
 136
 137
 138 /**
 139  * Remove an address from the solver
 140  *
 141  * @param solver the solver handle
 142  * @param addresses the address hashmap containing all addresses
 143  * @param address the address to remove
 144  * @param session_only delete only session not whole address
 145  */
 146 void
 147 GAS_proportional_address_delete (void *solver,
 148     struct ATS_Address *address, int session_only);
 149
 150
 151 /**
 152  * Start a bulk operation
 153  *
 154  * @param solver the solver
 155  */
 156 void
 157 GAS_proportional_bulk_start (void *solver);
 158
 159
 160 /**
 161  * Bulk operation done
 162  */
 163 void
 164 GAS_proportional_bulk_stop (void *solver);
 165
 166 /**
 167  * Stop notifying about address and bandwidth changes for this peer
 168  *
 169  * @param solver the MLP handle
 170  * @param addresses address hashmap
 171  * @param peer the peer
 172  */
 173 void
 174 GAS_proportional_stop_get_preferred_address (void *solver,
 175                                      const struct GNUNET_PeerIdentity *peer);
 176
 177
 178 /**
 179  * Get the prefered address for a specific peer
 180  *
 181  * @param solver the solver handle
 182  * @param addresses the address hashmap containing all addresses
 183  * @param peer the identity of the peer
 184  */
 185 const struct ATS_Address *
 186 GAS_proportional_get_preferred_address (void *solver,
 187                                const struct GNUNET_PeerIdentity *peer);
 188
 189 /* end of gnunet-service-ats-solver_proportional.c */