src/ats/gnunet-service-ats_plugins.h

   1 /*
   2  This file is part of GNUnet.
   3  (C) 2011-2014 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_plugins.h
  23  * @brief ats service plugin management
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_SERVICE_ATS_PLUGINS_H
  28 #define GNUNET_SERVICE_ATS_PLUGINS_H
  29
  30 #include "gnunet-service-ats_addresses.h"
  31
  32
  33 /**
  34  * Available ressource assignment modes
  35  */
  36 enum ATS_Mode
  37 {
  38   /**
  39    * proportional mode:
  40    *
  41    * Assign each peer an equal amount of bandwidth (bw)
  42    *
  43    * bw_per_peer = bw_total / #active addresses
  44    */
  45   MODE_PROPORTIONAL,
  46
  47   /**
  48    * MLP mode:
  49    *
  50    * Solve ressource assignment as an optimization problem
  51    * Uses an mixed integer programming solver
  52    */
  53   MODE_MLP,
  54
  55   /**
  56    * Reinforcement Learning mode:
  57    *
  58    * Solve resource assignment using a learning agent
  59    */
  60   MODE_RIL
  61 };
  62
  63
  64 /**
  65  * Initialize address subsystem. The addresses subsystem manages the addresses
  66  * known and current performance information. It has a solver component
  67  * responsible for the resource allocation. It tells the solver about changes
  68  * and receives updates when the solver changes the ressource allocation.
  69  *
  70  * @param cfg configuration to use
  71  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error (failed to load
  72  *         solver plugin)
  73  */
  74 int
  75 GAS_plugins_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
  76
  77
  78 /**
  79  * Shutdown address subsystem.
  80  */
  81 void
  82 GAS_plugins_done (void);
  83
  84
  85 /**
  86  * The preference changed for a peer, update solver.
  87  *
  88  * @param peer the peer
  89  * @param kind the ATS kind
  90  * @param pref_rel the new relative preference value
  91  */
  92 void
  93 GAS_normalized_preference_changed (const struct GNUNET_PeerIdentity *peer,
  94                                    enum GNUNET_ATS_PreferenceKind kind,
  95                                    double pref_rel);
  96
  97
  98 /**
  99  * The relative value for a property changed
 100  *
 101  * @param address the peer
 102  * @param type the ATS type
 103  * @param prop_rel the new relative preference value
 104  */
 105 void
 106 GAS_normalized_property_changed (struct ATS_Address *address,
 107                                  uint32_t type,
 108                                  double prop_rel);
 109
 110
 111 void
 112 GAS_plugin_new_address (struct ATS_Address *new_address,
 113                         enum GNUNET_ATS_Network_Type addr_net,
 114                         const struct GNUNET_ATS_Information *atsi,
 115                         uint32_t atsi_count);
 116
 117
 118 void
 119 GAS_plugin_update_address (struct ATS_Address *address,
 120                            const struct GNUNET_ATS_Information *atsi,
 121                            uint32_t atsi_count);
 122
 123
 124 void
 125 GAS_plugin_update_preferences (void *client,
 126                                const struct GNUNET_PeerIdentity *peer,
 127                                enum GNUNET_ATS_PreferenceKind kind,
 128                                float score_abs);
 129
 130
 131 void
 132 GAS_plugin_preference_feedback (void *application,
 133                                 const struct GNUNET_PeerIdentity *peer,
 134                                 const struct GNUNET_TIME_Relative scope,
 135                                 enum GNUNET_ATS_PreferenceKind kind,
 136                                 float score_abs);
 137
 138
 139 void
 140 GAS_plugin_delete_address (struct ATS_Address *address);
 141
 142
 143 void
 144 GAS_plugin_request_connect_start (const struct GNUNET_PeerIdentity *pid);
 145
 146
 147 void
 148 GAS_plugin_request_connect_stop (const struct GNUNET_PeerIdentity *pid);
 149
 150
 151 void
 152 GAS_plugin_solver_lock (void);
 153
 154
 155 void
 156 GAS_plugin_solver_unlock (void);
 157
 158
 159 #endif