2 This file is part of GNUnet.
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file sensor/gnunet-service-sensor_analysis.c
23 * @brief sensor service analysis functionality
24 * @author Omar Tarabai
27 #include "gnunet_util_lib.h"
29 #include "gnunet_peerstore_service.h"
30 #include "gnunet_sensor_model_plugin.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "sensor-analysis",__VA_ARGS__)
35 * Carries information about the analysis model
36 * corresponding to one sensor
44 struct SensorModel *prev;
49 struct SensorModel *next;
52 * Pointer to sensor info structure
54 struct GNUNET_SENSOR_SensorInfo *sensor;
57 * Watcher of sensor values
59 struct GNUNET_PEERSTORE_WatchContext *wc;
62 * State of sensor. #GNUNET_YES if anomalous, #GNUNET_NO otherwise.
67 * Number of anomalous readings (positive) received in a row.
72 * Number of non-anomalous (negative) readings received in a row.
77 * Closure for model plugin.
78 * Usually, the instance of the model created for this sensor.
87 static const struct GNUNET_CONFIGURATION_Handle *cfg;
90 * Hashmap of loaded sensors
92 static struct GNUNET_CONTAINER_MultiHashMap *sensors;
97 static char *model_lib_name;
102 static struct GNUNET_SENSOR_ModelFunctions *model_api;
105 * Handle to peerstore service
107 static struct GNUNET_PEERSTORE_Handle *peerstore;
110 * Head of DLL of created models
112 static struct SensorModel *models_head;
115 * Tail of DLL of created models
117 static struct SensorModel *models_tail;
122 static struct GNUNET_PeerIdentity peerid;
125 * How many subsequent values required to flip anomaly label.
126 * E.g. After 3 subsequent anomaly reports, status change to anomalous.
128 static unsigned long long confirmation_count;
131 * Destroy a created model
134 destroy_sensor_model (struct SensorModel *sensor_model)
136 GNUNET_assert (NULL != sensor_model);
137 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying sensor model for `%s'.\n",
138 sensor_model->sensor->name);
139 if (NULL != sensor_model->wc)
141 GNUNET_PEERSTORE_watch_cancel (sensor_model->wc);
142 sensor_model->wc = NULL;
144 if (NULL != sensor_model->cls)
146 model_api->destroy_model (sensor_model->cls);
147 sensor_model->cls = NULL;
149 GNUNET_free (sensor_model);
155 * Stop the sensor analysis module
158 SENSOR_analysis_stop ()
160 struct SensorModel *sm;
162 LOG (GNUNET_ERROR_TYPE_DEBUG, "Stopping sensor analysis module.\n");
163 while (NULL != models_head)
166 GNUNET_CONTAINER_DLL_remove (models_head, models_tail, sm);
167 destroy_sensor_model (sm);
169 if (NULL != peerstore)
171 GNUNET_PEERSTORE_disconnect (peerstore, GNUNET_YES);
174 if (NULL != model_api)
176 GNUNET_break (NULL == GNUNET_PLUGIN_unload (model_lib_name, model_api));
177 GNUNET_free (model_lib_name);
178 model_lib_name = NULL;
184 * Sensor value watch callback
186 * @param cls Sensor model struct
187 * @param record Received record from peerstore, should contain new sensor value
188 * @param emsg Error message from peerstore if any, NULL if no errors
189 * @return #GNUNET_YES
192 sensor_watcher (void *cls,
193 const struct GNUNET_PEERSTORE_Record *record,
196 struct SensorModel *model = cls;
200 LOG (GNUNET_ERROR_TYPE_DEBUG,
201 "Received a sensor value, will feed to sensor model.\n");
202 if (sizeof (double) != record->value_size)
204 LOG (GNUNET_ERROR_TYPE_ERROR, _("Received an invalid sensor value."));
207 val = (double *) (record->value);
208 anomalous = model_api->feed_model (model->cls, *val);
209 if (GNUNET_YES == anomalous)
211 model->positive_count++;
212 model->negative_count = 0;
213 if (GNUNET_NO == model->anomalous &&
214 model->positive_count >= confirmation_count)
216 model->anomalous = GNUNET_YES;
217 LOG (GNUNET_ERROR_TYPE_WARNING,
218 "Anomaly state started for sensor `%s', value: %f.\n",
219 model->sensor->name, val);
220 SENSOR_reporting_anomaly_update (model->sensor, model->anomalous);
225 model->negative_count++;
226 model->positive_count = 0;
227 if (GNUNET_YES == model->anomalous &&
228 model->negative_count >= confirmation_count)
230 model->anomalous = GNUNET_NO;
231 LOG (GNUNET_ERROR_TYPE_INFO,
232 "Anomaly state stopped for sensor `%s', value: %f.\n",
233 model->sensor->name, val);
234 SENSOR_reporting_anomaly_update (model->sensor, model->anomalous);
242 * Iterator for defined sensors
243 * Creates sensor model for numeric sensors
247 * @param value a 'struct GNUNET_SENSOR_SensorInfo *' with sensor information
248 * @return #GNUNET_YES to continue iterations
251 init_sensor_model (void *cls, const struct GNUNET_HashCode *key, void *value)
253 struct GNUNET_SENSOR_SensorInfo *sensor = value;
254 struct SensorModel *sensor_model;
256 if (0 != strcmp ("numeric", sensor->expected_datatype))
258 sensor_model = GNUNET_new (struct SensorModel);
259 sensor_model->sensor = sensor;
261 GNUNET_PEERSTORE_watch (peerstore, "sensor", &peerid, sensor->name,
262 &sensor_watcher, sensor_model);
263 sensor_model->anomalous = GNUNET_NO;
264 sensor_model->positive_count = 0;
265 sensor_model->negative_count = 0;
266 sensor_model->cls = model_api->create_model (model_api->cls);
267 GNUNET_CONTAINER_DLL_insert (models_head, models_tail, sensor_model);
268 LOG (GNUNET_ERROR_TYPE_DEBUG, "Created sensor model for `%s'.\n",
275 * Start the sensor analysis module
277 * @param c our service configuration
278 * @param sensors multihashmap of loaded sensors
279 * @return #GNUNET_OK if started successfully, #GNUNET_SYSERR otherwise
282 SENSOR_analysis_start (const struct GNUNET_CONFIGURATION_Handle *c,
283 struct GNUNET_CONTAINER_MultiHashMap *s)
287 GNUNET_assert (NULL != s);
291 GNUNET_CONFIGURATION_get_value_string (cfg, "sensor-analysis", "MODEL",
294 LOG (GNUNET_ERROR_TYPE_ERROR,
295 _("Analysis model not defined in configuration.\n"));
296 return GNUNET_SYSERR;
298 GNUNET_asprintf (&model_lib_name, "libgnunet_plugin_sensor_model_%s",
300 model_api = GNUNET_PLUGIN_load (model_lib_name, (void *) cfg);
301 GNUNET_free (model_name);
302 if (NULL == model_api)
304 LOG (GNUNET_ERROR_TYPE_ERROR, _("Could not load analysis model `%s'.\n"),
306 return GNUNET_SYSERR;
308 peerstore = GNUNET_PEERSTORE_connect (cfg);
309 if (NULL == peerstore)
311 LOG (GNUNET_ERROR_TYPE_ERROR,
312 _("Could not connect to peerstore service.\n"));
313 SENSOR_analysis_stop ();
314 return GNUNET_SYSERR;
317 GNUNET_CONFIGURATION_get_value_number (cfg, "sensor-analysis",
318 "CONFIRMATION_COUNT",
319 &confirmation_count))
320 confirmation_count = 1;
321 GNUNET_CRYPTO_get_peer_identity (cfg, &peerid);
322 GNUNET_CONTAINER_multihashmap_iterate (sensors, &init_sensor_model, NULL);
326 /* end of gnunet-service-sensor_analysis.c */