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
  57 /*
  58  * State of single model instance
  59  */
  60 struct Model
  61 {
  62
  63   /*
  64    * Pointer to the plugin state
  65    */
  66   struct Plugin *plugin;
  67
  68   /*
  69    * Number of readings so far
  70    */
  71   int n;
  72
  73   /*
  74    * Sum of readings
  75    */
  76   long double sum;
  77
  78   /*
  79    * Sum square of readings
  80    */
  81   long double sumsq;
  82
  83 };
  84
  85 /**
  86  * Update local sums of model with a new value.
  87  *
  88  * @param model Targe model
  89  * @param val New value
  90  */
  91 static void
  92 update_sums (struct Model *model, double val)
  93 {
  94   model->sum += val;
  95   model->sumsq += val * val;
  96   model->n++;
  97 }
  98
  99
 100 /**
 101  * Feed a new value to a model
 102  *
 103  * @param cls closure (model state)
 104  * @param val value to be fed to the model
 105  * @return #GNUNET_YES in case of a detected outlier, #GNUNET_NO otherwise
 106  */
 107 static int
 108 sensor_gaussian_model_feed (void *cls, double val)
 109 {
 110   struct Model *model = cls;
 111   struct Plugin *plugin = model->plugin;
 112   long double mean;
 113   long double stddev;
 114   long double allowed_variance;
 115
 116   if (model->n < plugin->training_window)
 117   {
 118     update_sums (model, val);
 119     return GNUNET_NO;
 120   }
 121   mean = model->sum / model->n;
 122   stddev =
 123       sqrt ((model->sumsq - 2 * mean * model->sum +
 124              model->n * mean * mean) / (model->n - 1));
 125   allowed_variance = (plugin->confidence_interval * stddev);
 126   if ((val < (mean - allowed_variance)) || (val > (mean + allowed_variance)))
 127     return GNUNET_YES;
 128   update_sums (model, val);
 129   return GNUNET_NO;
 130 }
 131
 132
 133 /**
 134  * Destroy a model instance
 135  *
 136  * @param cls closure (model state)
 137  */
 138 static void
 139 sensor_gaussian_model_destroy_model (void *cls)
 140 {
 141   struct Model *model = cls;
 142
 143   GNUNET_free (model);
 144 }
 145
 146
 147 /**
 148  * Create a model instance
 149  *
 150  * @param cls closure (plugin state)
 151  * @return model state to be used for later calls
 152  */
 153 static void *
 154 sensor_gaussian_model_create_model (void *cls)
 155 {
 156   struct Plugin *plugin = cls;
 157   struct Model *model;
 158
 159   model = GNUNET_new (struct Model);
 160
 161   model->plugin = plugin;
 162   return model;
 163 }
 164
 165
 166 /**
 167  * Entry point for the plugin.
 168  *
 169  * @param cls The struct GNUNET_CONFIGURATION_Handle.
 170  * @return NULL on error, otherwise the plugin context
 171  */
 172 void *
 173 libgnunet_plugin_sensor_model_gaussian_init (void *cls)
 174 {
 175   static struct Plugin plugin;
 176   const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 177   struct GNUNET_SENSOR_ModelFunctions *api;
 178   unsigned long long num;
 179
 180   if (NULL != plugin.cfg)
 181     return NULL;                /* can only initialize once! */
 182   memset (&plugin, 0, sizeof (struct Plugin));
 183   plugin.cfg = cfg;
 184   if (GNUNET_OK !=
 185       GNUNET_CONFIGURATION_get_value_number (cfg, "sensor-model-gaussian",
 186                                              "TRAINING_WINDOW", &num))
 187   {
 188     LOG (GNUNET_ERROR_TYPE_ERROR,
 189          _("Missing `TRAINING_WINDOW' value in configuration.\n"));
 190     return NULL;
 191   }
 192   plugin.training_window = (int) num;
 193   if (GNUNET_OK !=
 194       GNUNET_CONFIGURATION_get_value_number (cfg, "sensor-model-gaussian",
 195                                              "CONFIDENCE_INTERVAL", &num))
 196   {
 197     LOG (GNUNET_ERROR_TYPE_ERROR,
 198          _("Missing `CONFIDENCE_INTERVAL' value in configuration.\n"));
 199     return NULL;
 200   }
 201   plugin.confidence_interval = (int) num;
 202   api = GNUNET_new (struct GNUNET_SENSOR_ModelFunctions);
 203
 204   api->cls = &plugin;
 205   api->create_model = &sensor_gaussian_model_create_model;
 206   api->destroy_model = &sensor_gaussian_model_destroy_model;
 207   api->feed_model = &sensor_gaussian_model_feed;
 208   LOG (GNUNET_ERROR_TYPE_DEBUG, "Gaussian model plugin is running.\n");
 209   return api;
 210 }
 211
 212
 213 /**
 214  * Exit point from the plugin.
 215  *
 216  * @param cls The plugin context (as returned by "init")
 217  * @return Always NULL
 218  */
 219 void *
 220 libgnunet_plugin_sensor_model_gaussian_done (void *cls)
 221 {
 222   struct GNUNET_SENSOR_ModelFunctions *api = cls;
 223   struct Plugin *plugin = api->cls;
 224
 225   plugin->cfg = NULL;
 226   GNUNET_free (api);
 227   LOG (GNUNET_ERROR_TYPE_DEBUG, "Guassian model plugin is finished\n");
 228   return NULL;
 229
 230 }
 231
 232 /* end of plugin_sensor_model_gaussian.c */