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    * How often was the LP problem solved
 100    */
 101   unsigned int lp_solved;
 102
 103   /**
 104    * total duration of all lp solver executions
 105    */
 106   uint64_t lp_total_duration;
 107
 108   /**
 109    * How often was the MLP problem solved
 110    */
 111   unsigned int mlp_solved;
 112
 113   /**
 114    * total duration of all mlp solver executions
 115    */
 116   uint64_t mlp_total_duration;
 117 };
 118
 119
 120 /**
 121  * Address specific MLP information
 122  */
 123 struct MLP_information
 124 {
 125
 126 };
 127
 128
 129 /**
 130  * Init the MLP problem solving component
 131  *
 132  * @param stats the GNUNET_STATISTICS handle
 133  * @param max_duration maximum numbers of iterations for the LP/MLP Solver
 134  * @param max_iterations maximum time limit for the LP/MLP Solver
 135  * @return GNUNET_OK on success, GNUNET_SYSERR on fail
 136  */
 137 int
 138 GAS_mlp_init (const struct GNUNET_STATISTICS_Handle *stats,
 139               struct GNUNET_TIME_Relative max_duration,
 140               unsigned int max_iterations);
 141
 142 /**
 143  * Updates a single address in the MLP problem
 144  *
 145  * If the address did not exist before in the problem:
 146  * The MLP problem has to be recreated and the problem has to be resolved
 147  *
 148  * Otherwise the addresses' values can be updated and the existing base can
 149  * be reused
 150  */
 151 void
 152 GAS_mlp_address_update (struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
 153
 154
 155 /**
 156  * Deletes a single address in the MLP problem
 157  *
 158  * The MLP problem has to be recreated and the problem has to be resolved
 159  */
 160 void
 161 GAS_mlp_address_delete (struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
 162
 163
 164 /**
 165  * Deletes a single address in the MLP problem
 166  */
 167 void
 168 GAS_mlp_address_change_preference (struct GNUNET_CONTAINER_MultiHashMap * addresses, struct ATS_Address *address);
 169
 170
 171 /**
 172  * Shutdown the MLP problem solving component
 173  */
 174 void
 175 GAS_mlp_done ();
 176
 177 #endif
 178 /* end of gnunet-service-ats_addresses_mlp.h */