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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file sensor/sensor_util_lib.c
23 * @brief senor utilities
24 * @author Omar Tarabai
28 #include "gnunet_util_lib.h"
29 #include "gnunet_sensor_util_lib.h"
30 #include "gnunet_statistics_service.h"
32 #define LOG(kind,...) GNUNET_log_from (kind, "sensor-util",__VA_ARGS__)
35 * Minimum sensor execution interval (in seconds)
37 #define MIN_INTERVAL 30
40 * Supported sources of sensor information
42 static const char *sources[] = { "gnunet-statistics", "process", NULL };
45 * Supported datatypes of sensor information
47 static const char *datatypes[] = { "numeric", "string", NULL };
50 * Parses a version number string into major and minor
52 * @param version full version string
53 * @param major pointer to parsed major value
54 * @param minor pointer to parsed minor value
55 * @return #GNUNET_OK if parsing went ok, #GNUNET_SYSERROR in case of error
58 version_parse(char *version, uint16_t *major, uint16_t *minor)
63 for(; isdigit(*version); version++)
66 majorval += *version - '0';
71 for(; isdigit(*version); version++)
74 minorval += *version - '0';
85 * Load sensor definition from configuration
87 * @param cfg configuration handle
88 * @param sectionname configuration section containing definition
90 static struct SensorInfo *
91 load_sensor_from_cfg(struct GNUNET_CONFIGURATION_Handle *cfg, const char *sectionname)
93 struct SensorInfo *sensor;
97 unsigned long long time_sec;
99 struct GNUNET_CRYPTO_EddsaPublicKey public_key;
101 sensor = GNUNET_new(struct SensorInfo);
103 sensor->name = GNUNET_strdup(sectionname);
105 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "VERSION", &version_str))
107 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor version\n"));
111 if(GNUNET_OK != version_parse(version_str, &(sensor->version_major), &(sensor->version_minor)))
113 LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid sensor version number, format should be major.minor\n"));
115 GNUNET_free(version_str);
118 GNUNET_free(version_str);
120 GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "DESCRIPTION", &sensor->description);
122 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "CATEGORY", &sensor->category) ||
123 NULL == sensor->category)
125 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor category\n"));
130 if(GNUNET_NO == GNUNET_CONFIGURATION_get_value_yesno(cfg, sectionname, "ENABLED"))
131 sensor->enabled = GNUNET_NO;
133 sensor->enabled = GNUNET_YES;
135 sensor->start_time = NULL;
136 if(GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "START_TIME", &starttime_str))
138 GNUNET_STRINGS_fancy_time_to_absolute(starttime_str, sensor->start_time);
139 LOG (GNUNET_ERROR_TYPE_DEBUG, "Start time loaded: `%s'. Parsed: %d\n", starttime_str, (NULL != sensor->start_time));
140 GNUNET_free(starttime_str);
143 sensor->end_time = NULL;
144 if(GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "END_TIME", &endtime_str))
146 GNUNET_STRINGS_fancy_time_to_absolute(endtime_str, sensor->end_time);
147 LOG (GNUNET_ERROR_TYPE_DEBUG, "End time loaded: `%s'. Parsed: %d\n", endtime_str, (NULL != sensor->end_time));
148 GNUNET_free(endtime_str);
151 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_number(cfg, sectionname, "INTERVAL", &time_sec))
153 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor run interval\n"));
157 if(time_sec < MIN_INTERVAL)
159 LOG (GNUNET_ERROR_TYPE_ERROR, _("Sensor run interval too low (%" PRIu64 " < %d)\n"),
160 time_sec, MIN_INTERVAL);
164 sensor->interval = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, time_sec);
166 if(GNUNET_OK == GNUNET_CONFIGURATION_get_value_number(cfg, sectionname, "LIFETIME", &time_sec))
168 sensor->lifetime = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, time_sec);
169 if (sensor->lifetime.rel_value_us < sensor->interval.rel_value_us)
170 LOG (GNUNET_ERROR_TYPE_WARNING,
171 "Lifetime of sensor data is preferred to be higher than interval for sensor `%s'.\n",
175 sensor->lifetime = GNUNET_TIME_UNIT_FOREVER_REL;
178 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_choice(cfg, sectionname, "SOURCE", sources, (const char **)&sensor->source))
180 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor source\n"));
184 if(sources[0] == sensor->source) //gnunet-statistics
186 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "GNUNET_STAT_SERVICE", &sensor->gnunet_stat_service) ||
187 GNUNET_OK != GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "GNUNET_STAT_NAME", &sensor->gnunet_stat_name))
189 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor gnunet-statistics source information\n"));
193 sensor->gnunet_stat_get_handle = NULL;
195 else if(sources[1] == sensor->source) //process
197 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "EXT_PROCESS", &sensor->ext_process))
199 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor process name\n"));
203 GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "EXT_ARGS", &sensor->ext_args);
206 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_choice(cfg, sectionname, "EXPECTED_DATATYPE", datatypes, (const char **)&sensor->expected_datatype))
208 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor expected datatype\n"));
212 if(sources[0] == sensor->source && datatypes[0] != sensor->expected_datatype)
214 LOG (GNUNET_ERROR_TYPE_ERROR, _("Invalid expected datatype, gnunet-statistics returns uint64 values\n"));
218 //reporting mechanism
219 sensor->collection_point = NULL;
220 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, sectionname, "COLLECTION_POINT", &dummy))
222 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_number(cfg, sectionname, "COLLECTION_INTERVAL", &time_sec))
224 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor collection interval\n"));
228 sensor->collection_interval = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, time_sec);
229 if (GNUNET_OK == GNUNET_CRYPTO_eddsa_public_key_from_string(dummy, strlen(dummy), &public_key))
231 sensor->collection_point = GNUNET_new(struct GNUNET_PeerIdentity);
232 sensor->collection_point->public_key = public_key;
237 sensor->p2p_report = GNUNET_NO;
238 if (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno(cfg, sectionname, "P2P_REPORT"))
240 if(GNUNET_OK != GNUNET_CONFIGURATION_get_value_number(cfg, sectionname, "P2P_INTERVAL", &time_sec))
242 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error reading sensor p2p reporting interval\n"));
246 sensor->p2p_interval = GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, time_sec);
247 sensor->p2p_report = GNUNET_YES;
251 sensor->execution_task = GNUNET_SCHEDULER_NO_TASK;
253 sensor->running = GNUNET_NO;
259 * Load sensor definition from file
261 * @param filename full path to file containing sensor definition
263 static struct SensorInfo *
264 load_sensor_from_file(const char *filename)
266 struct GNUNET_CONFIGURATION_Handle *sensorcfg;
267 const char *filebasename;
268 struct SensorInfo *sensor;
271 if(GNUNET_YES != GNUNET_DISK_file_test(filename))
273 LOG (GNUNET_ERROR_TYPE_ERROR, _("Failed to access sensor file: %s\n"), filename);
276 //load file as configuration
277 sensorcfg = GNUNET_CONFIGURATION_create();
278 if(GNUNET_SYSERR == GNUNET_CONFIGURATION_parse(sensorcfg, filename))
280 GNUNET_CONFIGURATION_destroy(sensorcfg);
281 LOG (GNUNET_ERROR_TYPE_ERROR, _("Failed to load sensor definition: %s\n"), filename);
284 //configuration section should be the same as filename
285 filebasename = GNUNET_STRINGS_get_short_name(filename);
286 sensor = load_sensor_from_cfg(sensorcfg, filebasename);
289 GNUNET_CONFIGURATION_destroy(sensorcfg);
292 sensor->def_file = GNUNET_strdup(filename);
293 sensor->cfg = sensorcfg;
299 * Compares version numbers of two sensors
301 * @param s1 first sensor
302 * @param s2 second sensor
303 * @return 1: s1 > s2, 0: s1 == s2, -1: s1 < s2
306 sensor_version_compare(struct SensorInfo *s1, struct SensorInfo *s2)
308 if(s1->version_major == s2->version_major)
309 return (s1->version_minor < s2->version_minor) ? -1 : (s1->version_minor > s2->version_minor);
311 return (s1->version_major < s2->version_major) ? -1 : (s1->version_major > s2->version_major);
315 * Adds a new sensor to given hashmap.
316 * If the same name exist, compares versions and update if old.
318 * @param sensor Sensor structure to add
319 * @param map Hashmap to add to
320 * @return #GNUNET_YES if added, #GNUNET_NO if not added which is not necessarily an error
323 add_sensor_to_hashmap(struct SensorInfo *sensor, struct GNUNET_CONTAINER_MultiHashMap *map)
325 struct GNUNET_HashCode key;
326 struct SensorInfo *existing;
328 GNUNET_CRYPTO_hash(sensor->name, strlen(sensor->name) + 1, &key);
329 existing = GNUNET_CONTAINER_multihashmap_get(map, &key);
330 if(NULL != existing) //sensor with same name already exists
332 if(sensor_version_compare(existing, sensor) >= 0) //same or newer version already exist
334 LOG (GNUNET_ERROR_TYPE_INFO, _("Sensor `%s' already exists with same or newer version\n"), sensor->name);
339 GNUNET_CONTAINER_multihashmap_remove(map, &key, existing); //remove the old version
340 GNUNET_free(existing);
341 LOG (GNUNET_ERROR_TYPE_INFO, "Upgrading sensor `%s' to a newer version\n", sensor->name);
344 if(GNUNET_SYSERR == GNUNET_CONTAINER_multihashmap_put(map, &key, sensor, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
346 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error adding new sensor `%s' to global hashmap, this should not happen\n"), sensor->name);
354 * Iterating over files in sensors directory
357 * @param filename complete filename (absolute path)
358 * @return #GNUNET_OK to continue to iterate
361 reload_sensors_dir_cb(void *cls, const char *filename)
363 struct GNUNET_CONTAINER_MultiHashMap *sensors = cls;
364 struct SensorInfo *sensor;
366 if(GNUNET_YES != GNUNET_DISK_file_test(filename))
368 sensor = load_sensor_from_file(filename);
371 LOG (GNUNET_ERROR_TYPE_ERROR,
372 _("Error loading sensor from file: %s\n"), filename);
375 if(GNUNET_YES != add_sensor_to_hashmap(sensor, sensors))
376 LOG (GNUNET_ERROR_TYPE_WARNING,
377 "Could not add sensor `%s' to global hashmap\n", sensor->name);
383 * Get path to the directory containing the sensor definition files
385 * @return sensor files directory
388 GNUNET_SENSOR_get_sensor_dir ()
393 datadir = GNUNET_OS_installation_get_path(GNUNET_OS_IPK_DATADIR);
394 GNUNET_asprintf(&sensordir, "%ssensors%s",
395 datadir, DIR_SEPARATOR_STR);
396 GNUNET_free(datadir);
402 * Reads sensor definitions from local data files
404 * @return a multihashmap of loaded sensors
406 struct GNUNET_CONTAINER_MultiHashMap *
407 GNUNET_SENSOR_load_all_sensors ()
410 struct GNUNET_CONTAINER_MultiHashMap *sensors;
412 sensors = GNUNET_CONTAINER_multihashmap_create(10, GNUNET_NO);
413 sensordir = GNUNET_SENSOR_get_sensor_dir ();
414 LOG (GNUNET_ERROR_TYPE_INFO,
415 "Loading sensor definitions from directory `%s'\n", sensordir);
416 GNUNET_assert(GNUNET_YES == GNUNET_DISK_directory_test(sensordir, GNUNET_YES));
418 //read all files in sensors directory
419 GNUNET_DISK_directory_scan(sensordir, &reload_sensors_dir_cb, sensors);
420 LOG (GNUNET_ERROR_TYPE_INFO, "Loaded %d sensors from directory `%s'\n",
421 GNUNET_CONTAINER_multihashmap_size(sensors), sensordir);
422 GNUNET_free(sensordir);
427 * Parses a sensor reading message struct
429 * @param msg message header received
430 * @param sensors multihashmap of loaded sensors
431 * @return sensor reading struct or NULL if error
433 struct GNUNET_SENSOR_Reading *
434 GNUNET_SENSOR_parse_reading_message (const struct GNUNET_MessageHeader *msg,
435 struct GNUNET_CONTAINER_MultiHashMap *sensors)
438 struct GNUNET_SENSOR_ReadingMessage *rm;
439 uint16_t sensorname_size;
443 struct GNUNET_HashCode key;
444 struct SensorInfo *sensor;
445 struct GNUNET_SENSOR_Reading *reading;
447 msg_size = ntohs (msg->size);
448 if (msg_size < sizeof (struct GNUNET_SENSOR_ReadingMessage))
450 LOG (GNUNET_ERROR_TYPE_WARNING, "Invalid reading message size.\n");
453 rm = (struct GNUNET_SENSOR_ReadingMessage *)msg;
454 sensorname_size = ntohs (rm->sensorname_size);
455 value_size = ntohs (rm->value_size);
456 if ((sizeof (struct GNUNET_SENSOR_ReadingMessage)
457 + sensorname_size + value_size) != msg_size)
459 LOG (GNUNET_ERROR_TYPE_WARNING, "Invalid reading message size.\n");
463 sensorname = GNUNET_malloc (sensorname_size);
464 memcpy (sensorname, dummy, sensorname_size);
465 GNUNET_CRYPTO_hash(sensorname, sensorname_size, &key);
466 GNUNET_free (sensorname);
467 sensor = GNUNET_CONTAINER_multihashmap_get (sensors, &key);
470 LOG (GNUNET_ERROR_TYPE_WARNING,
471 "Unknown sensor name in reading message.\n");
474 if ((sensor->version_minor != ntohs (rm->sensorversion_minor)) ||
475 (sensor->version_major != ntohs (rm->sensorversion_major)))
477 LOG (GNUNET_ERROR_TYPE_WARNING,
478 "Sensor version mismatch in reading message.\n");
481 if (0 == strcmp (sensor->expected_datatype, "numeric") &&
482 sizeof (double) != value_size)
484 LOG (GNUNET_ERROR_TYPE_WARNING,
485 "Invalid value size for a numerical sensor.\n");
488 reading = GNUNET_new (struct GNUNET_SENSOR_Reading);
489 reading->sensor = sensor;
490 reading->timestamp = GNUNET_be64toh (rm->timestamp);
491 reading->value_size = value_size;
492 reading->value = GNUNET_malloc (value_size);
493 dummy += sensorname_size;
494 memcpy (reading->value, dummy, value_size);
499 * Remove sensor execution from scheduler
502 * @param key hash of sensor name, key to hashmap
503 * @param value a 'struct SensorInfo *'
504 * @return #GNUNET_YES if we should continue to
508 static int destroy_sensor(void *cls,
509 const struct GNUNET_HashCode *key, void *value)
511 struct SensorInfo *sensorinfo = value;
513 if(GNUNET_SCHEDULER_NO_TASK != sensorinfo->execution_task)
515 GNUNET_SCHEDULER_cancel(sensorinfo->execution_task);
516 sensorinfo->execution_task = GNUNET_SCHEDULER_NO_TASK;
518 if(NULL != sensorinfo->gnunet_stat_get_handle)
520 GNUNET_STATISTICS_get_cancel(sensorinfo->gnunet_stat_get_handle);
521 sensorinfo->gnunet_stat_get_handle = NULL;
523 if(NULL != sensorinfo->ext_cmd)
525 GNUNET_OS_command_stop(sensorinfo->ext_cmd);
526 sensorinfo->ext_cmd = NULL;
528 if(NULL != sensorinfo->cfg)
529 GNUNET_CONFIGURATION_destroy(sensorinfo->cfg);
530 if(NULL != sensorinfo->name)
531 GNUNET_free(sensorinfo->name);
532 if(NULL != sensorinfo->def_file)
533 GNUNET_free(sensorinfo->def_file);
534 if(NULL != sensorinfo->description)
535 GNUNET_free(sensorinfo->description);
536 if(NULL != sensorinfo->category)
537 GNUNET_free(sensorinfo->category);
538 if(NULL != sensorinfo->capabilities)
539 GNUNET_free(sensorinfo->capabilities);
540 if(NULL != sensorinfo->gnunet_stat_service)
541 GNUNET_free(sensorinfo->gnunet_stat_service);
542 if(NULL != sensorinfo->gnunet_stat_name)
543 GNUNET_free(sensorinfo->gnunet_stat_name);
544 if(NULL != sensorinfo->ext_process)
545 GNUNET_free(sensorinfo->ext_process);
546 if(NULL != sensorinfo->ext_args)
547 GNUNET_free(sensorinfo->ext_args);
548 if (NULL != sensorinfo->collection_point)
549 GNUNET_free (sensorinfo->collection_point);
550 GNUNET_free(sensorinfo);
555 * Destroys a group of sensors in a hashmap and the hashmap itself
557 * @param sensors hashmap containing the sensors
560 GNUNET_SENSOR_destroy_sensors (struct GNUNET_CONTAINER_MultiHashMap *sensors)
562 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying sensor list.\n");
563 GNUNET_CONTAINER_multihashmap_iterate(sensors, &destroy_sensor, NULL);
564 GNUNET_CONTAINER_multihashmap_destroy(sensors);