2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
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 experimentation/gnunet-daemon-experimentation.h
23 * @brief experimentation daemon
24 * @author Christian Grothoff
25 * @author Matthias Wachs
28 #include "gnunet_getopt_lib.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_core_service.h"
31 #include "gnunet_statistics_service.h"
35 * Timeout between request and expected response
37 #define EXP_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
40 * Default experiment frequency
42 #define EXP_DEFAULT_EXP_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 6)
45 * Default experiment duration
47 #define EXP_DEFAULT_EXP_DUR GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
50 * Statistics handle shared between components
52 extern struct GNUNET_STATISTICS_Handle *GSE_stats;
56 * Configuration handle shared between components
58 extern struct GNUNET_CONFIGURATION_Handle *GSE_cfg;
62 * Capability value shared between components
64 extern uint32_t GSE_node_capabilities;
67 extern uint32_t GSE_my_issuer_count;
69 extern struct Experimentation_Issuer *GSE_my_issuer;
72 * Capabilities a node has or an experiment requires
74 enum GNUNET_EXPERIMENTATION_capabilities
80 PLUGIN_HTTP_CLIENT = 8,
81 PLUGIN_HTTP_SERVER = 16,
82 PLUGIN_HTTPS_CLIENT = 32,
83 PLUGIN_HTTPS_SERVER = 64,
91 * Struct to store information about a specific experiment
96 /* ----------------- */
99 /* Experiment issuer */
100 struct GNUNET_PeerIdentity issuer;
102 /* Experiment version as timestamp of creation */
103 struct GNUNET_TIME_Absolute version;
108 /* Required capabilities */
109 uint32_t required_capabilities;
111 /* Experiment timing */
112 /* ----------------- */
114 /* When to start experiment */
115 struct GNUNET_TIME_Absolute start;
117 /* When to end experiment */
118 struct GNUNET_TIME_Absolute stop;
120 /* How often to run experiment */
121 struct GNUNET_TIME_Relative frequency;
123 /* How long to run each execution */
124 struct GNUNET_TIME_Relative duration;
127 /* Experiment itself */
128 /* ----------------- */
135 * A experimentation node
142 struct GNUNET_PeerIdentity id;
145 * Task for response timeout
147 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
150 * Core transmission handle
152 struct GNUNET_CORE_TransmitHandle *cth;
157 uint32_t capabilities;
159 /* Experiment version as timestamp of creation */
160 struct GNUNET_TIME_Absolute version;
162 uint32_t issuer_count;
165 * Array of fssuer ids
167 struct GNUNET_PeerIdentity *issuer_id;
170 struct Experimentation_Issuer
172 struct GNUNET_PeerIdentity issuer_id;
176 * Experimentation request message
177 * Used to detect experimentation capability
179 * This struct is followed by issuer identities:
180 * (issuer_count * struct Experimentation_Request_Issuer)
183 struct Experimentation_Request
185 struct GNUNET_MessageHeader msg;
187 uint32_t capabilities;
189 uint32_t issuer_count;
193 * Experimentation response message
194 * Sent if peer is running the daemon
196 * This struct is followed by issuer identities:
197 * (issuer_count * struct Experimentation_Request_Issuer)
199 struct Experimentation_Response
201 struct GNUNET_MessageHeader msg;
203 uint32_t capabilities;
205 uint32_t issuer_count;
209 GNUNET_EXPERIMENT_nodes_request_start (struct Node *n, struct Experiment *e);
213 * Start the nodes management
216 GNUNET_EXPERIMENTATION_nodes_start ();
220 * Stop the nodes management
223 GNUNET_EXPERIMENTATION_nodes_stop ();
227 * Print a single capability value
229 * @param cap capability value
230 * @return the string to print
233 GNUNET_EXPERIMENTATION_capability_to_str (uint32_t cap);
237 * Are the capabilities provided?
239 * @param have bitstring containing the provided capabilities
240 * @param desired bitstring containing the desired capabilities\
241 * @return GNUNET_YES or GNUNET_NO
244 GNUNET_EXPERIMENTATION_capabilities_have (uint32_t have, uint32_t desired);
248 * Start the detecting capabilities
251 GNUNET_EXPERIMENTATION_capabilities_start ();
255 * Stop the detecting capabilities
258 GNUNET_EXPERIMENTATION_capabilities_stop ();
262 * Start experiments management
264 * @return GNUNET_YES or GNUNET_NO
267 GNUNET_EXPERIMENTATION_experiments_issuer_accepted (struct GNUNET_PeerIdentity *issuer_ID);
270 typedef void (*GNUNET_EXPERIMENTATION_experiments_get_cb) (struct Node *n, struct Experiment *e);
273 GNUNET_EXPERIMENTATION_experiments_get (struct Node *n,
274 struct GNUNET_PeerIdentity *issuer,
275 GNUNET_EXPERIMENTATION_experiments_get_cb get_cb);
278 * Start experiments management
280 * @return GNUNET_OK on success, GNUNET_SYSERR on error
283 GNUNET_EXPERIMENTATION_experiments_start ();
287 * Stop experiments management
290 GNUNET_EXPERIMENTATION_experiments_stop ();
294 * Start the scheduler component
297 GNUNET_EXPERIMENTATION_scheduler_add (struct Node *n, struct Experiment *e);
300 * Start the scheduler component
303 GNUNET_EXPERIMENTATION_scheduler_start ();
307 * Stop the scheduler component
310 GNUNET_EXPERIMENTATION_scheduler_stop ();
314 * Start the storage component
317 GNUNET_EXPERIMENTATION_storage_start ();
322 * Stop the storage component
325 GNUNET_EXPERIMENTATION_storage_stop ();
328 /* end of gnunet-daemon-experimentation.h */