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 *GED_stats;
  53
  54
  55 /**
  56  * Configuration handle shared between components
  57  */
  58 extern struct GNUNET_CONFIGURATION_Handle *GED_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         struct ExperimentStartCtx *e_req_head;
 170         struct ExperimentStartCtx *e_req_tail;
 171 };
 172
 173 struct Experimentation_Issuer
 174 {
 175         struct GNUNET_PeerIdentity issuer_id;
 176 };
 177
 178 /**
 179  * Experimentation request message
 180  * Used to detect experimentation capability
 181  *
 182  * This struct is followed by issuer identities:
 183  * (issuer_count * struct Experimentation_Request_Issuer)
 184  *
 185  */
 186 struct Experimentation_Request
 187 {
 188         struct GNUNET_MessageHeader msg;
 189
 190         uint32_t capabilities;
 191
 192         uint32_t issuer_count;
 193 };
 194
 195 /**
 196  * Experimentation response message
 197  * Sent if peer is running the daemon
 198  *
 199  * This struct is followed by issuer identities:
 200  * (issuer_count * struct Experimentation_Request_Issuer)
 201  */
 202 struct Experimentation_Response
 203 {
 204         struct GNUNET_MessageHeader msg;
 205
 206         uint32_t capabilities;
 207
 208         uint32_t issuer_count;
 209 };
 210
 211 int
 212 GED_nodes_rts (struct Node *n);
 213
 214 int
 215 GED_nodes_request_start (struct Node *n, struct Experiment *e);
 216
 217
 218 /**
 219  * Start the nodes management
 220  */
 221 void
 222 GED_nodes_start ();
 223
 224
 225 /**
 226  * Stop the nodes management
 227  */
 228 void
 229 GED_nodes_stop ();
 230
 231
 232 /**
 233  * Print a single capability value
 234  *
 235  * @param cap capability value
 236  * @return the string to print
 237  */
 238 const char *
 239 GED_capability_to_str (uint32_t cap);
 240
 241
 242 /**
 243  * Are the capabilities provided?
 244  *
 245  * @param have bitstring containing the provided capabilities
 246  * @param desired bitstring containing the desired capabilities\
 247  * @return GNUNET_YES or GNUNET_NO
 248  */
 249 int
 250 GED_capabilities_have (uint32_t have, uint32_t desired);
 251
 252
 253 /**
 254  * Start the detecting capabilities
 255  */
 256 void
 257 GED_capabilities_start ();
 258
 259
 260 /**
 261  * Stop the detecting capabilities
 262  */
 263 void
 264 GED_capabilities_stop ();
 265
 266
 267 /**
 268  * Start experiments management
 269  *
 270  * @return GNUNET_YES or GNUNET_NO
 271  */
 272 int
 273 GED_experiments_issuer_accepted (struct GNUNET_PeerIdentity *issuer_ID);
 274
 275
 276 typedef void (*GNUNET_EXPERIMENTATION_experiments_get_cb) (struct Node *n, struct Experiment *e);
 277
 278 void
 279 GED_experiments_get (struct Node *n,
 280                                                                                                                                                                 struct GNUNET_PeerIdentity *issuer,
 281                                                                                                                                                                 GNUNET_EXPERIMENTATION_experiments_get_cb get_cb);
 282
 283 /**
 284  * Start experiments management
 285  *
 286  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 287  */
 288 int
 289 GED_experiments_start ();
 290
 291
 292 /**
 293  * Stop experiments management
 294  */
 295 void
 296 GED_experiments_stop ();
 297
 298 /**
 299  * Handle a START message from a remote node
 300  *
 301  * @param n the node
 302  * @param e the experiment
 303  */
 304 void
 305 GED_scheduler_handle_start (struct Node *n, struct Experiment *e);
 306
 307
 308 /**
 309  * Handle a START_ACL message from a remote node
 310  *
 311  * @param n the node
 312  * @param e the experiment
 313  */
 314 void
 315 GED_scheduler_handle_start_ack (struct Node *n, struct Experiment *e);
 316
 317 /**
 318  * Handle a STOP message from a remote node
 319  *
 320  * @param n the node
 321  * @param e the experiment
 322  */
 323 void
 324 GED_scheduler_handle_stop (struct Node *n, struct Experiment *e);
 325
 326
 327 /**
 328  * Start the scheduler component
 329  */
 330 void
 331 GED_scheduler_add (struct Node *n, struct Experiment *e);
 332
 333 /**
 334  * Start the scheduler component
 335  */
 336 void
 337 GED_scheduler_start ();
 338
 339
 340 /**
 341  * Stop the scheduler component
 342  */
 343 void
 344 GED_scheduler_stop ();
 345
 346
 347 /**
 348  * Start the storage component
 349  */
 350 void
 351 GED_storage_start ();
 352
 353
 354
 355 /**
 356  * Stop the storage component
 357  */
 358 void
 359 GED_storage_stop ();
 360
 361
 362 /* end of gnunet-daemon-experimentation.h */