src/include/gnunet_sensor_util_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C)
   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/sensor_util_lib.c
  23  * @brief senor utilities
  24  * @author Omar Tarabai
  25  */
  26
  27 #ifndef GNUNET_SENSOR_UTIL_LIB_H
  28 #define GNUNET_SENSOR_UTIL_LIB_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 /**
  39  * Structure containing sensor definition
  40  */
  41 struct GNUNET_SENSOR_SensorInfo
  42 {
  43
  44   /**
  45    * The configuration handle
  46    * carrying sensor information
  47    */
  48   struct GNUNET_CONFIGURATION_Handle *cfg;
  49
  50   /*
  51    * Sensor name
  52    */
  53   char *name;
  54
  55   /*
  56    * Path to definition file
  57    */
  58   char *def_file;
  59
  60   /*
  61    * First part of version number
  62    */
  63   uint16_t version_major;
  64
  65   /*
  66    * Second part of version number
  67    */
  68   uint16_t version_minor;
  69
  70   /*
  71    * Sensor description
  72    */
  73   char *description;
  74
  75   /*
  76    * Sensor currently enabled
  77    */
  78   int enabled;
  79
  80   /*
  81    * Category under which the sensor falls (e.g. tcp, datastore)
  82    */
  83   char *category;
  84
  85   /*
  86    * When does the sensor become active
  87    */
  88   struct GNUNET_TIME_Absolute *start_time;
  89
  90   /*
  91    * When does the sensor expire
  92    */
  93   struct GNUNET_TIME_Absolute *end_time;
  94
  95   /*
  96    * Time interval to collect sensor information (e.g. every 1 min)
  97    */
  98   struct GNUNET_TIME_Relative interval;
  99
 100   /*
 101    * Lifetime of an information sample after which it is deleted from storage
 102    * If not supplied, will default to the interval value
 103    */
 104   struct GNUNET_TIME_Relative lifetime;
 105
 106   /*
 107    * A set of required peer capabilities for the sensor to collect meaningful information (e.g. ipv6)
 108    */
 109   char *capabilities;
 110
 111   /*
 112    * Either "gnunet-statistics" or external "process"
 113    */
 114   char *source;
 115
 116   /*
 117    * Name of the GNUnet service that is the source for the gnunet-statistics entry
 118    */
 119   char *gnunet_stat_service;
 120
 121   /*
 122    * Name of the gnunet-statistics entry
 123    */
 124   char *gnunet_stat_name;
 125
 126   /**
 127    * Handle to statistics get request (OR GNUNET_SCHEDULER_NO_TASK)
 128    */
 129   struct GNUNET_STATISTICS_GetHandle *gnunet_stat_get_handle;
 130
 131   /*
 132    * Name of the external process to be executed
 133    */
 134   char *ext_process;
 135
 136   /*
 137    * Arguments to be passed to the external process
 138    */
 139   char *ext_args;
 140
 141   /*
 142    * Handle to the external process
 143    */
 144   struct GNUNET_OS_CommandHandle *ext_cmd;
 145
 146   /*
 147    * Did we already receive a value
 148    * from the currently running external
 149    * proccess ? #GNUNET_YES / #GNUNET_NO
 150    */
 151   int ext_cmd_value_received;
 152
 153   /*
 154    * The output datatype to be expected
 155    */
 156   char *expected_datatype;
 157
 158   /*
 159    * Peer-identity of peer running collection point
 160    */
 161   struct GNUNET_PeerIdentity *collection_point;
 162
 163   /*
 164    * Time interval to send sensor information to collection point (e.g. every 30 mins)
 165    */
 166   struct GNUNET_TIME_Relative collection_interval;
 167
 168   /*
 169    * Flag specifying if value is to be communicated to the p2p network
 170    */
 171   int p2p_report;
 172
 173   /*
 174    * Time interval to communicate value to the p2p network
 175    */
 176   struct GNUNET_TIME_Relative p2p_interval;
 177
 178   /*
 179    * Execution task (OR GNUNET_SCHEDULER_NO_TASK)
 180    */
 181   GNUNET_SCHEDULER_TaskIdentifier execution_task;
 182
 183   /*
 184    * Is the sensor being executed
 185    */
 186   int running;
 187
 188 };
 189
 190 GNUNET_NETWORK_STRUCT_BEGIN
 191 /**
 192  * Used to communicate sensor readings to
 193  * collection points (SENSORDASHBAORD service)
 194  */
 195     struct GNUNET_SENSOR_ReadingMessage
 196 {
 197
 198   /**
 199    * GNUNET general message header
 200    */
 201   struct GNUNET_MessageHeader header;
 202
 203   /**
 204    * Size of the sensor name value, allocated
 205    * at position 0 after this struct
 206    */
 207   uint16_t sensorname_size;
 208
 209   /**
 210    * First part of sensor version number
 211    */
 212   uint16_t sensorversion_major;
 213
 214   /**
 215    * Second part of sensor version number
 216    */
 217   uint16_t sensorversion_minor;
 218
 219   /**
 220    * Timestamp of recorded reading
 221    */
 222   uint64_t timestamp;
 223
 224   /**
 225    * Size of reading value, allocation
 226    * at poistion 1 after this struct
 227    */
 228   uint16_t value_size;
 229
 230 };
 231
 232 /**
 233  * Used to communicate brief information about a sensor.
 234  */
 235 struct GNUNET_SENSOR_SensorBriefMessage
 236 {
 237
 238   /**
 239    * GNUNET general message header.
 240    */
 241   struct GNUNET_MessageHeader header;
 242
 243   /**
 244    * Size of sensor name string, allocated at position 0 after this struct.
 245    */
 246   uint16_t name_size;
 247
 248   /**
 249    * First part of sensor version number
 250    */
 251   uint16_t version_major;
 252
 253   /**
 254    * Second part of sensor version number
 255    */
 256   uint16_t version_minor;
 257
 258 };
 259
 260 /**
 261  * Used to communicate full information about a sensor.
 262  */
 263 struct GNUNET_SENSOR_SensorFullMessage
 264 {
 265
 266   /**
 267    * GNUNET general message header.
 268    */
 269   struct GNUNET_MessageHeader header;
 270
 271   /**
 272    * Size of sensor name.
 273    * Name allocated at position 0 after this struct.
 274    */
 275   uint16_t sensorname_size;
 276
 277   /**
 278    * Size of the sensor definition file carrying full sensor information.
 279    * The file content allocated at position 1 after this struct.
 280    */
 281   uint16_t sensorfile_size;
 282
 283   /**
 284    * Name of the file (usually script) associated with this sensor.
 285    * At the moment we only support having one file per sensor.
 286    * The file name is allocated at position 2 after this struct.
 287    */
 288   uint16_t scriptname_size;
 289
 290   /**
 291    * Size of the file (usually script) associated with this sensor.
 292    * The file content is allocated at position 3 after this struct.
 293    */
 294   uint16_t scriptfile_size;
 295
 296 };
 297
 298 GNUNET_NETWORK_STRUCT_END
 299 /**
 300  * Given two version numbers as major and minor, compare them.
 301  *
 302  * @param v1_major First part of first version number
 303  * @param v1_minor Second part of first version number
 304  * @param v2_major First part of second version number
 305  * @param v2_minor Second part of second version number
 306  */
 307     int
 308 GNUNET_SENSOR_version_compare (uint16_t v1_major, uint16_t v1_minor,
 309                                uint16_t v2_major, uint16_t v2_minor);
 310
 311
 312 /**
 313  * Reads sensor definitions from local data files
 314  *
 315  * @return a multihashmap of loaded sensors
 316  */
 317 struct GNUNET_CONTAINER_MultiHashMap *
 318 GNUNET_SENSOR_load_all_sensors ();
 319
 320
 321 /*
 322  * Get path to the directory containing the sensor definition files
 323  *
 324  * @return sensor files directory string
 325  */
 326 char *
 327 GNUNET_SENSOR_get_sensor_dir ();
 328
 329
 330 /**
 331  * Destroys a group of sensors in a hashmap and the hashmap itself
 332  *
 333  * @param sensors hashmap containing the sensors
 334  */
 335 void
 336 GNUNET_SENSOR_destroy_sensors (struct GNUNET_CONTAINER_MultiHashMap *sensors);
 337
 338 #if 0                           /* keep Emacsens' auto-indent happy */
 339 {
 340 #endif
 341 #ifdef __cplusplus
 342 }
 343 #endif
 344
 345 /* ifndef GNUNET_SENSOR_UTIL_LIB_H */
 346 #endif
 347 /* end of gnunet_sensor_util_lib.h */