src/ats/gnunet-service-ats_addresses_mlp.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_addresses_mlp.h
  23  * @brief ats mlp problem 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 #if HAVE_LIBGLPK
  31 #include "glpk.h"
  32 #endif
  33
  34 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_MLP_H
  35 #define GNUNET_SERVICE_ATS_ADDRESSES_MLP_H
  36
  37 #define VERBOSE GNUNET_EXTRA_LOGGING
  38 #define DEBUG_MLP GNUNET_EXTRA_LOGGING
  39
  40 #define MLP_MAX_EXEC_DURATION   GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 3)
  41 #define MLP_MAX_ITERATIONS      INT_MAX
  42
  43 /**
  44  * MLP Handle
  45  */
  46 struct GAS_MLP_Handle
  47 {
  48   /**
  49    * Statistics handle
  50    */
  51   struct GNUNET_STATISTICS_Handle *stats;
  52
  53   /**
  54    * GLPK (MLP) problem object
  55    */
  56 #if HAVE_LIBGLPK
  57   glp_prob *prob;
  58 #else
  59   void *prob;
  60 #endif
  61
  62   /**
  63    * GLPK LP control parameter
  64    */
  65   glp_smcp control_param_lp;
  66
  67   /**
  68    * GLPK LP control parameter
  69    */
  70   glp_iocp control_param_mlp;
  71
  72   /**
  73    * Maximum execution time per problem solving
  74    */
  75   struct GNUNET_TIME_Relative max_exec_duration;
  76
  77   /**
  78    * Maximum number of LP iterations per problem solving
  79    */
  80   unsigned int max_iterations;
  81
  82   /* state information */
  83
  84   /**
  85    * Do we need to use the LP presolver?
  86    *
  87    * If the problem addresses were added or removed and the last basis was we
  88    * need to use the presolver.
  89    * presolver_required == GNUNET_YES
  90    *
  91    * If values were modified, we can reuse a valid basis
  92    * presolver_required == GNUNET_NO
  93    */
  94   int presolver_required;
  95
  96   /* statistics */
  97
  98   /**
  99    * Time of last execution
 100    */
 101   struct GNUNET_TIME_Absolute last_execution;
 102
 103
 104   /**
 105    * How often was the LP problem solved
 106    */
 107   unsigned int lp_solved;
 108
 109   /**
 110    * total duration of all lp solver executions
 111    */
 112   uint64_t lp_total_duration;
 113
 114   /**
 115    * How often was the MLP problem solved
 116    */
 117   unsigned int mlp_solved;
 118
 119   /**
 120    * total duration of all mlp solver executions
 121    */
 122   uint64_t mlp_total_duration;
 123
 124   /* Information about the problem */
 125
 126
 127   /* column index Diversity (D) column */
 128   int c_d;
 129   double co_D;
 130
 131   /* column index Utilization (U) column */
 132   int c_u;
 133   double co_U;
 134
 135   /* column index Proportionality (R) column */
 136   int c_r;
 137   double co_R;
 138
 139   /* column index first quality metric (q_1) column */
 140   int c_q_start;
 141
 142   /* column index last quality metric (q_n) column */
 143   int c_q_end;
 144
 145   /* Array of quality metric coefficients (m elements) */
 146   double *co_Q;
 147
 148   /* number of quality metrics */
 149   int m;
 150
 151   /* minimum bandwidth assigned to an address */
 152   unsigned int b_min;
 153
 154   /* minimum number of addresses with bandwidth assigned */
 155   unsigned int n_min;
 156 };
 157
 158
 159 /**
 160  * Address specific MLP information
 161  */
 162 struct MLP_information
 163 {
 164   /* bandwidth column index */
 165   signed int c_b;
 166
 167   /* address usage column */
 168   signed int c_n;
 169 };
 170
 171
 172 /**
 173  * Init the MLP problem solving component
 174  *
 175  * @param stats the GNUNET_STATISTICS handle
 176  * @param max_duration maximum numbers of iterations for the LP/MLP Solver
 177  * @param max_iterations maximum time limit for the LP/MLP Solver
 178  * @param D Diversity coefficient
 179  * @param U Utilization coefficient
 180  * @param R Proportionality coefficient
 181  * @param b_min minimum bandwidth assigned to an address
 182  * @param n_min minimum number of addresses with bandwidth assigned
 183  *
 184  * @return struct GAS_MLP_Handle * on success, NULL on fail
 185  */
 186 struct GAS_MLP_Handle *
 187 GAS_mlp_init (const struct GNUNET_STATISTICS_Handle *stats,
 188               struct GNUNET_TIME_Relative max_duration,
 189               unsigned int max_iterations,
 190               double D, double U, double R,
 191               unsigned int b_min,
 192               unsigned int n_min);
 193
 194
 195 /**
 196  * Updates a single address in the MLP problem
 197  *
 198  * If the address did not exist before in the problem:
 199  * The MLP problem has to be recreated and the problem has to be resolved
 200  *
 201  * Otherwise the addresses' values can be updated and the existing base can
 202  * be reused
 203  *
 204  * @param mlp the MLP Handle
 205  * @param addresses the address hashmap
 206  * @param address the address to update
 207  */
 208 void
 209 GAS_mlp_address_update (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
 210
 211
 212 /**
 213  * Deletes a single address in the MLP problem
 214  *
 215  * The MLP problem has to be recreated and the problem has to be resolved
 216  *
 217  * @param mlp the MLP Handle
 218  * @param addresses the address hashmap
 219  * @param address the address to delete
 220  */
 221 void
 222 GAS_mlp_address_delete (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
 223
 224
 225 /**
 226  * Deletes a single address in the MLP problem
 227  *
 228  * @param mlp the MLP Handle
 229  * @param addresses the address hashmap
 230  * @param address the address to change the preference
 231  */
 232 void
 233 GAS_mlp_address_change_preference (struct GAS_MLP_Handle *mlp, struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
 234
 235
 236 /**
 237  * Shutdown the MLP problem solving component
 238  */
 239 void
 240 GAS_mlp_done ();
 241
 242 #endif
 243 /* end of gnunet-service-ats_addresses_mlp.h */