src/experimentation/gnunet-daemon-experimentation.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   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 experimentation/gnunet-daemon-experimentation.h
  23  * @brief experimentation daemon
  24  * @author Christian Grothoff
  25  * @author Matthias Wachs
  26  */
  27 #include "platform.h"
  28 #include "gnunet_getopt_lib.h"
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_core_service.h"
  31 #include "gnunet_statistics_service.h"
  32
  33
  34 /**
  35  * Timeout between request and expected response
  36  */
  37 #define EXP_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  38
  39 /**
  40  * Default experiment frequency
  41  */
  42 #define EXP_DEFAULT_EXP_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 6)
  43
  44 /**
  45  * Default experiment duration
  46  */
  47 #define EXP_DEFAULT_EXP_DUR GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  48
  49 /**
  50  * Statistics handle shared between components
  51  */
  52 extern struct GNUNET_STATISTICS_Handle *GSE_stats;
  53
  54
  55 /**
  56  * Configuration handle shared between components
  57  */
  58 extern struct GNUNET_CONFIGURATION_Handle *GSE_cfg;
  59
  60
  61 /**
  62  * Capability value shared between components
  63  */
  64 extern uint32_t GSE_node_capabilities;
  65
  66
  67 extern uint32_t GSE_my_issuer_count;
  68
  69 extern struct Experimentation_Issuer *GSE_my_issuer;
  70
  71 /**
  72  * Capabilities a node has or an experiment requires
  73  */
  74 enum GNUNET_EXPERIMENTATION_capabilities
  75 {
  76         NONE = 0,
  77         PLUGIN_TCP = 1,
  78         PLUGIN_UDP = 2,
  79         PLUGIN_UNIX = 4,
  80         PLUGIN_HTTP_CLIENT = 8,
  81         PLUGIN_HTTP_SERVER = 16,
  82         PLUGIN_HTTPS_CLIENT = 32,
  83         PLUGIN_HTTPS_SERVER = 64,
  84         PLUGIN_WLAN = 128,
  85         HAVE_IPV6 = 256,
  86         BEHIND_NAT = 512
  87 };
  88
  89
  90 /**
  91  * Struct to store information about a specific experiment
  92  */
  93 struct Experiment
  94 {
  95         /* Header */
  96         /* ----------------- */
  97         char *name;
  98
  99         /* Experiment issuer */
 100         struct GNUNET_PeerIdentity issuer;
 101
 102         /* Experiment version as timestamp of creation */
 103         struct GNUNET_TIME_Absolute version;
 104
 105         /* Description */
 106         char *description;
 107
 108         /* Required capabilities  */
 109         uint32_t required_capabilities;
 110
 111         /* Experiment timing */
 112         /* ----------------- */
 113
 114         /* When to start experiment */
 115         struct GNUNET_TIME_Absolute start;
 116
 117         /* When to end experiment */
 118         struct GNUNET_TIME_Absolute stop;
 119
 120         /* How often to run experiment */
 121         struct GNUNET_TIME_Relative frequency;
 122
 123         /* How long to run each execution  */
 124         struct GNUNET_TIME_Relative duration;
 125
 126
 127         /* Experiment itself */
 128         /* ----------------- */
 129
 130         /* TBD */
 131 };
 132
 133
 134 /**
 135  * A experimentation node
 136  */
 137 struct Node
 138 {
 139         /**
 140          * Peer id
 141          */
 142         struct GNUNET_PeerIdentity id;
 143
 144         /**
 145          * Task for response timeout
 146          */
 147         GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 148
 149         /**
 150          * Core transmission handle
 151          */
 152         struct GNUNET_CORE_TransmitHandle *cth;
 153
 154         /**
 155          * Node capabilities
 156          */
 157         uint32_t capabilities;
 158
 159         /* Experiment version as timestamp of creation */
 160         struct GNUNET_TIME_Absolute version;
 161
 162         uint32_t issuer_count;
 163
 164         /**
 165          * Array of fssuer ids
 166          */
 167         struct GNUNET_PeerIdentity *issuer_id;
 168 };
 169
 170 struct Experimentation_Issuer
 171 {
 172         struct GNUNET_PeerIdentity issuer_id;
 173 };
 174
 175 /**
 176  * Experimentation request message
 177  * Used to detect experimentation capability
 178  *
 179  * This struct is followed by issuer identities:
 180  * (issuer_count * struct Experimentation_Request_Issuer)
 181  *
 182  */
 183 struct Experimentation_Request
 184 {
 185         struct GNUNET_MessageHeader msg;
 186
 187         uint32_t capabilities;
 188
 189         uint32_t issuer_count;
 190 };
 191
 192 /**
 193  * Experimentation response message
 194  * Sent if peer is running the daemon
 195  *
 196  * This struct is followed by issuer identities:
 197  * (issuer_count * struct Experimentation_Request_Issuer)
 198  */
 199 struct Experimentation_Response
 200 {
 201         struct GNUNET_MessageHeader msg;
 202
 203         uint32_t capabilities;
 204
 205         uint32_t issuer_count;
 206 };
 207
 208 void
 209 GNUNET_EXPERIMENT_nodes_request_start (struct Node *n, struct Experiment *e);
 210
 211
 212 /**
 213  * Start the nodes management
 214  */
 215 void
 216 GNUNET_EXPERIMENTATION_nodes_start ();
 217
 218
 219 /**
 220  * Stop the nodes management
 221  */
 222 void
 223 GNUNET_EXPERIMENTATION_nodes_stop ();
 224
 225
 226 /**
 227  * Print a single capability value
 228  *
 229  * @param cap capability value
 230  * @return the string to print
 231  */
 232 const char *
 233 GNUNET_EXPERIMENTATION_capability_to_str (uint32_t cap);
 234
 235
 236 /**
 237  * Are the capabilities provided?
 238  *
 239  * @param have bitstring containing the provided capabilities
 240  * @param desired bitstring containing the desired capabilities\
 241  * @return GNUNET_YES or GNUNET_NO
 242  */
 243 int
 244 GNUNET_EXPERIMENTATION_capabilities_have (uint32_t have, uint32_t desired);
 245
 246
 247 /**
 248  * Start the detecting capabilities
 249  */
 250 void
 251 GNUNET_EXPERIMENTATION_capabilities_start ();
 252
 253
 254 /**
 255  * Stop the detecting capabilities
 256  */
 257 void
 258 GNUNET_EXPERIMENTATION_capabilities_stop ();
 259
 260
 261 /**
 262  * Start experiments management
 263  *
 264  * @return GNUNET_YES or GNUNET_NO
 265  */
 266 int
 267 GNUNET_EXPERIMENTATION_experiments_issuer_accepted (struct GNUNET_PeerIdentity *issuer_ID);
 268
 269
 270 typedef void (*GNUNET_EXPERIMENTATION_experiments_get_cb) (struct Node *n, struct Experiment *e);
 271
 272 void
 273 GNUNET_EXPERIMENTATION_experiments_get (struct Node *n,
 274                                                                                                                                                                 struct GNUNET_PeerIdentity *issuer,
 275                                                                                                                                                                 GNUNET_EXPERIMENTATION_experiments_get_cb get_cb);
 276
 277 /**
 278  * Start experiments management
 279  *
 280  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 281  */
 282 int
 283 GNUNET_EXPERIMENTATION_experiments_start ();
 284
 285
 286 /**
 287  * Stop experiments management
 288  */
 289 void
 290 GNUNET_EXPERIMENTATION_experiments_stop ();
 291
 292
 293 /**
 294  * Start the scheduler component
 295  */
 296 void
 297 GNUNET_EXPERIMENTATION_scheduler_add (struct Node *n, struct Experiment *e);
 298
 299 /**
 300  * Start the scheduler component
 301  */
 302 void
 303 GNUNET_EXPERIMENTATION_scheduler_start ();
 304
 305
 306 /**
 307  * Stop the scheduler component
 308  */
 309 void
 310 GNUNET_EXPERIMENTATION_scheduler_stop ();
 311
 312
 313 /**
 314  * Start the storage component
 315  */
 316 void
 317 GNUNET_EXPERIMENTATION_storage_start ();
 318
 319
 320
 321 /**
 322  * Stop the storage component
 323  */
 324 void
 325 GNUNET_EXPERIMENTATION_storage_stop ();
 326
 327
 328 /* end of gnunet-daemon-experimentation.h */