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 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 /**
 191  * Carries a single reading from a sensor
 192  */
 193 struct GNUNET_SENSOR_Reading
 194 {
 195
 196   /**
 197    * Sensor this reading is related to
 198    */
 199   struct SensorInfo *sensor;
 200
 201   /**
 202    * Timestamp of taking the reading
 203    */
 204   uint64_t timestamp;
 205
 206   /**
 207    * Reading value
 208    */
 209   void *value;
 210
 211   /**
 212    * Size of @value
 213    */
 214   uint16_t value_size;
 215
 216 };
 217
 218 GNUNET_NETWORK_STRUCT_BEGIN
 219
 220 /**
 221  * Used to communicate sensor readings to
 222  * collection points (SENSORDASHBAORD service)
 223  */
 224 struct GNUNET_SENSOR_ReadingMessage
 225 {
 226
 227   /**
 228    * GNUNET general message header
 229    */
 230   struct GNUNET_MessageHeader header;
 231
 232   /**
 233    * Size of the sensor name value, allocated
 234    * at position 0 after this struct
 235    */
 236   uint16_t sensorname_size;
 237
 238   /**
 239    * First part of sensor version number
 240    */
 241   uint16_t sensorversion_major;
 242
 243   /**
 244    * Second part of sensor version number
 245    */
 246   uint16_t sensorversion_minor;
 247
 248   /**
 249    * Timestamp of recorded reading
 250    */
 251   uint64_t timestamp;
 252
 253   /**
 254    * Size of reading value, allocation
 255    * at poistion 1 after this struct
 256    */
 257   uint16_t value_size;
 258
 259 };
 260 GNUNET_NETWORK_STRUCT_END
 261
 262 /**
 263  * Reads sensor definitions from local data files
 264  *
 265  * @return a multihashmap of loaded sensors
 266  */
 267 struct GNUNET_CONTAINER_MultiHashMap *
 268 GNUNET_SENSOR_load_all_sensors ();
 269
 270 /*
 271  * Get path to the directory containing the sensor definition files
 272  *
 273  * @return sensor files directory
 274  */
 275 char *
 276 GNUNET_SENSOR_get_sensor_dir ();
 277
 278 /**
 279  * Parses a sensor reading message struct
 280  *
 281  * @param msg message header received
 282  * @param sensors multihashmap of loaded sensors
 283  * @return sensor reading struct or NULL if error
 284  */
 285 struct GNUNET_SENSOR_Reading *
 286 GNUNET_SENSOR_parse_reading_message (const struct GNUNET_MessageHeader *msg,
 287     struct GNUNET_CONTAINER_MultiHashMap *sensors);
 288
 289 /**
 290  * Destroys a group of sensors in a hashmap and the hashmap itself
 291  *
 292  * @param sensors hashmap containing the sensors
 293  */
 294 void
 295 GNUNET_SENSOR_destroy_sensors (struct GNUNET_CONTAINER_MultiHashMap *sensors);
 296
 297 #if 0                           /* keep Emacsens' auto-indent happy */
 298 {
 299 #endif
 300 #ifdef __cplusplus
 301 }
 302 #endif
 303
 304 /* ifndef GNUNET_SENSOR_UTIL_LIB_H */
 305 #endif
 306 /* end of gnunet_sensor_util_lib.h */