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
27 #ifndef GNUNET_SENSOR_UTIL_LIB_H
28 #define GNUNET_SENSOR_UTIL_LIB_H
33 #if 0 /* keep Emacsens' auto-indent happy */
39 * Structure containing sensor definition
41 struct GNUNET_SENSOR_SensorInfo
45 * The configuration handle
46 * carrying sensor information
48 struct GNUNET_CONFIGURATION_Handle *cfg;
56 * Path to definition file
61 * First part of version number
63 uint16_t version_major;
66 * Second part of version number
68 uint16_t version_minor;
76 * Sensor currently enabled
81 * Category under which the sensor falls (e.g. tcp, datastore)
86 * When does the sensor become active
88 struct GNUNET_TIME_Absolute *start_time;
91 * When does the sensor expire
93 struct GNUNET_TIME_Absolute *end_time;
96 * Time interval to collect sensor information (e.g. every 1 min)
98 struct GNUNET_TIME_Relative interval;
101 * Lifetime of an information sample after which it is deleted from storage
102 * If not supplied, will default to the interval value
104 struct GNUNET_TIME_Relative lifetime;
107 * A set of required peer capabilities for the sensor to collect meaningful information (e.g. ipv6)
112 * Either "gnunet-statistics" or external "process"
117 * Name of the GNUnet service that is the source for the gnunet-statistics entry
119 char *gnunet_stat_service;
122 * Name of the gnunet-statistics entry
124 char *gnunet_stat_name;
127 * Handle to statistics get request (OR GNUNET_SCHEDULER_NO_TASK)
129 struct GNUNET_STATISTICS_GetHandle *gnunet_stat_get_handle;
132 * Name of the external process to be executed
137 * Arguments to be passed to the external process
142 * Handle to the external process
144 struct GNUNET_OS_CommandHandle *ext_cmd;
147 * Did we already receive a value
148 * from the currently running external
149 * proccess ? #GNUNET_YES / #GNUNET_NO
151 int ext_cmd_value_received;
154 * The output datatype to be expected
156 char *expected_datatype;
159 * Peer-identity of peer running collection point
161 struct GNUNET_PeerIdentity *collection_point;
164 * Do we report received sensor values to collection point?
165 * #GNUNET_YES / #GNUNET_NO
170 * Time interval to send sensor values to collection point (e.g. every 30 mins)
172 struct GNUNET_TIME_Relative value_reporting_interval;
175 * Do we report anomalies to collection point?
176 * #GNUNET_YES / #GNUNET_NO
178 int report_anomalies;
181 * Execution task (OR GNUNET_SCHEDULER_NO_TASK)
183 GNUNET_SCHEDULER_TaskIdentifier execution_task;
186 * Is the sensor being executed
193 * Anomaly report received and stored by sensor dashboard.
194 * Sensor name and peer id are not included because they are part of the
197 struct GNUNET_SENSOR_DashboardAnomalyEntry
206 * Percentage of neighbors reported the same anomaly
208 float anomalous_neighbors;
212 GNUNET_NETWORK_STRUCT_BEGIN
215 * Used to communicate brief information about a sensor.
217 struct GNUNET_SENSOR_SensorBriefMessage
221 * GNUNET general message header.
223 struct GNUNET_MessageHeader header;
226 * Size of sensor name string, allocated at position 0 after this struct.
231 * First part of sensor version number
233 uint16_t version_major;
236 * Second part of sensor version number
238 uint16_t version_minor;
243 * Used to communicate full information about a sensor.
245 struct GNUNET_SENSOR_SensorFullMessage
249 * GNUNET general message header.
251 struct GNUNET_MessageHeader header;
254 * Size of sensor name.
255 * Name allocated at position 0 after this struct.
257 uint16_t sensorname_size;
260 * Size of the sensor definition file carrying full sensor information.
261 * The file content allocated at position 1 after this struct.
263 uint16_t sensorfile_size;
266 * Name of the file (usually script) associated with this sensor.
267 * At the moment we only support having one file per sensor.
268 * The file name is allocated at position 2 after this struct.
270 uint16_t scriptname_size;
273 * Size of the file (usually script) associated with this sensor.
274 * The file content is allocated at position 3 after this struct.
276 uint16_t scriptfile_size;
281 * Used to communicate sensor values to
282 * collection points (SENSORDASHBAORD service)
284 struct GNUNET_SENSOR_ValueMessage
288 * GNUNET general message header
290 struct GNUNET_MessageHeader header;
293 * Hash of sensor name
295 struct GNUNET_HashCode sensorname_hash;
298 * First part of sensor version number
300 uint16_t sensorversion_major;
303 * Second part of sensor version number
305 uint16_t sensorversion_minor;
308 * Timestamp of recorded reading
310 struct GNUNET_TIME_Absolute timestamp;
313 * Size of sensor value, allocated at poistion 0 after this struct
320 * Message carrying an anomaly status change report
322 struct GNUNET_SENSOR_AnomalyReportMessage
328 struct GNUNET_MessageHeader header;
331 * Hash of sensor name
333 struct GNUNET_HashCode sensorname_hash;
336 * First part of sensor version number
338 uint16_t sensorversion_major;
341 * Second part of sensor version name
343 uint16_t sensorversion_minor;
351 * Percentage of neighbors reported the same anomaly
353 float anomalous_neighbors;
357 GNUNET_NETWORK_STRUCT_END
360 * Given two version numbers as major and minor, compare them.
362 * @param v1_major First part of first version number
363 * @param v1_minor Second part of first version number
364 * @param v2_major First part of second version number
365 * @param v2_minor Second part of second version number
368 GNUNET_SENSOR_version_compare (uint16_t v1_major, uint16_t v1_minor,
369 uint16_t v2_major, uint16_t v2_minor);
373 * Reads sensor definitions from given sensor directory.
375 * @param sensordir Path to sensor directory.
376 * @return a multihashmap of loaded sensors
378 struct GNUNET_CONTAINER_MultiHashMap *
379 GNUNET_SENSOR_load_all_sensors (char *sensor_dir);
383 * Get path to the default directory containing the sensor definition files with
384 * a trailing directory separator.
386 * @return Default sensor files directory full path
389 GNUNET_SENSOR_get_default_sensor_dir ();
393 * Destroys a group of sensors in a hashmap and the hashmap itself
395 * @param sensors hashmap containing the sensors
398 GNUNET_SENSOR_destroy_sensors (struct GNUNET_CONTAINER_MultiHashMap *sensors);
400 #if 0 /* keep Emacsens' auto-indent happy */
407 /* ifndef GNUNET_SENSOR_UTIL_LIB_H */
409 /* end of gnunet_sensor_util_lib.h */