src/sensor/plugin_sensor_model_gaussian.c

   1 /*
   2  * This file is part of GNUnet
   3  * (C) 2013 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 sensor/plugin_sensor_model_gaussian.c
  23  * @brief Gaussian model for sensor analysis
  24  * @author Omar Tarabai
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_sensor_model_plugin.h"
  29 #include "gnunet_sensor_service.h"
  30 #include "sensor.h"
  31
  32 #define LOG(kind,...) GNUNET_log_from (kind, "sensor-model-gaussian", __VA_ARGS__)
  33
  34 /**
  35  * Plugin state information
  36  */
  37 struct Plugin
  38 {
  39
  40   /**
  41    * Configuration handle
  42    */
  43   const struct GNUNET_CONFIGURATION_Handle *cfg;
  44
  45   /**
  46    * Number of initial readings to be used for training only
  47    */
  48   int training_window;
  49
  50   /**
  51    * Number of standard deviations considered within "normal"
  52    */
  53   int confidence_interval;
  54
  55   /**
  56    * Increase in weight with each reading
  57    */
  58   float weight_inc;
  59
  60 };
  61
  62 /**
  63  * State of single model instance
  64  */
  65 struct Model
  66 {
  67
  68   /**
  69    * Pointer to the plugin state
  70    */
  71   struct Plugin *plugin;
  72
  73   /**
  74    * Gaussian sums
  75    */
  76   long double s[3];
  77
  78   /**
  79    * Number of readings so far
  80    */
  81   int n;
  82
  83   /**
  84    * Weight to be used for the next reading
  85    */
  86   double w;
  87
  88 };
  89
  90 /**
  91  * Update local sums of model with a new value.
  92  *
  93  * @param model Targe model
  94  * @param val New value
  95  */
  96 static void
  97 update_sums (struct Model *model, double val)
  98 {
  99   int i;
 100
 101   for (i = 0; i < 3; i++)
 102     model->s[i] += model->w * pow (val, (double) i);
 103   model->w += model->plugin->weight_inc;
 104   model->n++;
 105 }
 106
 107
 108 /**
 109  * Feed a new value to a model
 110  *
 111  * @param cls closure (model state)
 112  * @param val value to be fed to the model
 113  * @return #GNUNET_YES in case of a detected outlier, #GNUNET_NO otherwise
 114  */
 115 static int
 116 sensor_gaussian_model_feed (void *cls, double val)
 117 {
 118   struct Model *model = cls;
 119   struct Plugin *plugin = model->plugin;
 120   long double mean;
 121   long double stddev;
 122   long double allowed_variance;
 123
 124   if (model->n < plugin->training_window)
 125   {
 126     update_sums (model, val);
 127     return GNUNET_NO;
 128   }
 129   if (model->n == plugin->training_window)
 130     LOG (GNUNET_ERROR_TYPE_DEBUG, "Gaussian model out of training period.\n");
 131   mean = model->s[1] / model->s[0];
 132   stddev =
 133       (model->s[0] * model->s[2] -
 134        model->s[1] * model->s[1]) / (model->s[0] * (model->s[0] - 1));
 135   if (stddev < 0)               /* Value can be slightly less than 0 due to rounding errors */
 136     stddev = 0;
 137   stddev = sqrt (stddev);
 138   allowed_variance = (plugin->confidence_interval * stddev);
 139   if ((val < (mean - allowed_variance)) || (val > (mean + allowed_variance)))
 140     return GNUNET_YES;
 141   update_sums (model, val);
 142   return GNUNET_NO;
 143 }
 144
 145
 146 /**
 147  * Destroy a model instance
 148  *
 149  * @param cls closure (model state)
 150  */
 151 static void
 152 sensor_gaussian_model_destroy_model (void *cls)
 153 {
 154   struct Model *model = cls;
 155
 156   GNUNET_free (model);
 157 }
 158
 159
 160 /**
 161  * Create a model instance
 162  *
 163  * @param cls closure (plugin state)
 164  * @return model state to be used for later calls
 165  */
 166 static void *
 167 sensor_gaussian_model_create_model (void *cls)
 168 {
 169   struct Plugin *plugin = cls;
 170   struct Model *model;
 171
 172   model = GNUNET_new (struct Model);
 173
 174   model->plugin = plugin;
 175   model->w = 1;
 176   return model;
 177 }
 178
 179
 180 /**
 181  * Entry point for the plugin.
 182  *
 183  * @param cls The struct GNUNET_CONFIGURATION_Handle.
 184  * @return NULL on error, otherwise the plugin context
 185  */
 186 void *
 187 libgnunet_plugin_sensor_model_gaussian_init (void *cls)
 188 {
 189   static struct Plugin plugin;
 190   const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 191   struct GNUNET_SENSOR_ModelFunctions *api;
 192   unsigned long long num;
 193
 194   if (NULL != plugin.cfg)
 195     return NULL;                /* can only initialize once! */
 196   memset (&plugin, 0, sizeof (struct Plugin));
 197   plugin.cfg = cfg;
 198   if (GNUNET_OK !=
 199       GNUNET_CONFIGURATION_get_value_number (cfg, "sensor-model-gaussian",
 200                                              "TRAINING_WINDOW", &num))
 201   {
 202     LOG (GNUNET_ERROR_TYPE_ERROR,
 203          _("Missing `TRAINING_WINDOW' value in configuration.\n"));
 204     return NULL;
 205   }
 206   if (num < 1)
 207   {
 208     LOG (GNUNET_ERROR_TYPE_WARNING,
 209          "Minimum training window invalid (<1), setting to 1.\n");
 210     plugin.training_window = 1;
 211   }
 212   else
 213   {
 214     plugin.training_window = (int) num;
 215   }
 216   if (GNUNET_OK !=
 217       GNUNET_CONFIGURATION_get_value_number (cfg, "sensor-model-gaussian",
 218                                              "CONFIDENCE_INTERVAL", &num))
 219   {
 220     LOG (GNUNET_ERROR_TYPE_ERROR,
 221          _("Missing `CONFIDENCE_INTERVAL' value in configuration.\n"));
 222     return NULL;
 223   }
 224   if (GNUNET_OK !=
 225       GNUNET_CONFIGURATION_get_value_float (cfg, "sensor-model-gaussian",
 226                                             "WEIGHT_INC", &plugin.weight_inc))
 227   {
 228     LOG (GNUNET_ERROR_TYPE_ERROR,
 229          _("Missing `WEIGHT_INC' value in configuration.\n"));
 230     return NULL;
 231   }
 232   plugin.confidence_interval = (int) num;
 233   api = GNUNET_new (struct GNUNET_SENSOR_ModelFunctions);
 234
 235   api->cls = &plugin;
 236   api->create_model = &sensor_gaussian_model_create_model;
 237   api->destroy_model = &sensor_gaussian_model_destroy_model;
 238   api->feed_model = &sensor_gaussian_model_feed;
 239   LOG (GNUNET_ERROR_TYPE_DEBUG, "Gaussian model plugin is running.\n");
 240   return api;
 241 }
 242
 243
 244 /**
 245  * Exit point from the plugin.
 246  *
 247  * @param cls The plugin context (as returned by "init")
 248  * @return Always NULL
 249  */
 250 void *
 251 libgnunet_plugin_sensor_model_gaussian_done (void *cls)
 252 {
 253   struct GNUNET_SENSOR_ModelFunctions *api = cls;
 254   struct Plugin *plugin = api->cls;
 255
 256   plugin->cfg = NULL;
 257   GNUNET_free (api);
 258   LOG (GNUNET_ERROR_TYPE_DEBUG, "Guassian model plugin is finished\n");
 259   return NULL;
 260
 261 }
 262
 263 /* end of plugin_sensor_model_gaussian.c */