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, 1)
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;
68 * Capabilities a node has or an experiment requires
70 enum GNUNET_EXPERIMENTATION_capabilities
76 PLUGIN_HTTP_CLIENT = 8,
77 PLUGIN_HTTP_SERVER = 16,
78 PLUGIN_HTTPS_CLIENT = 32,
79 PLUGIN_HTTPS_SERVER = 64,
87 * Struct to store information about a specific experiment
92 /* ----------------- */
95 /* Experiment issuer */
96 struct GNUNET_PeerIdentity issuer;
98 /* Experiment version as timestamp of creation */
99 struct GNUNET_TIME_Absolute version;
104 /* Required capabilities */
105 uint32_t required_capabilities;
107 /* Experiment timing */
108 /* ----------------- */
110 /* When to start experiment */
111 struct GNUNET_TIME_Absolute start;
113 /* When to end experiment */
114 struct GNUNET_TIME_Absolute stop;
116 /* How often to run experiment */
117 struct GNUNET_TIME_Relative frequency;
119 /* How long to run each execution */
120 struct GNUNET_TIME_Relative duration;
123 /* Experiment itself */
124 /* ----------------- */
131 * A experimentation node
138 struct GNUNET_PeerIdentity id;
141 * Task for response timeout
143 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
146 * Core transmission handle
148 struct GNUNET_CORE_TransmitHandle *cth;
150 uint32_t capabilities;
154 * Experimentation request message
155 * Used to detect experimentation capability
157 struct Experimentation_Request
159 struct GNUNET_MessageHeader msg;
161 uint32_t capabilities;
165 * Experimentation response message
166 * Sent if peer is running the daemon
168 struct Experimentation_Response
170 struct GNUNET_MessageHeader msg;
172 uint32_t capabilities;
177 * Start the nodes management
180 GNUNET_EXPERIMENTATION_nodes_start ();
184 * Stop the nodes management
187 GNUNET_EXPERIMENTATION_nodes_stop ();
191 * Print a single capability value
193 * @param cap capability value
194 * @return the string to print
197 GNUNET_EXPERIMENTATION_capability_to_str (uint32_t cap);
201 * Are the capabilities provided?
203 * @param have bitstring containing the provided capabilities
204 * @param desired bitstring containing the desired capabilities\
205 * @return GNUNET_YES or GNUNET_NO
208 GNUNET_EXPERIMENTATION_capabilities_have (uint32_t have, uint32_t desired);
212 * Start the detecting capabilities
215 GNUNET_EXPERIMENTATION_capabilities_start ();
219 * Stop the detecting capabilities
222 GNUNET_EXPERIMENTATION_capabilities_stop ();
226 * Start experiments management
228 * @return GNUNET_YES or GNUNET_NO
231 GNUNET_EXPERIMENTATION_experiments_issuer_accepted (struct GNUNET_PeerIdentity *issuer_ID);
235 * Start experiments management
237 * @return GNUNET_OK on success, GNUNET_SYSERR on error
240 GNUNET_EXPERIMENTATION_experiments_start ();
244 * Stop experiments management
247 GNUNET_EXPERIMENTATION_experiments_stop ();
251 * Start the scheduler component
254 GNUNET_EXPERIMENTATION_scheduler_add (struct Experiment *e);
257 * Start the scheduler component
260 GNUNET_EXPERIMENTATION_scheduler_start ();
264 * Stop the scheduler component
267 GNUNET_EXPERIMENTATION_scheduler_stop ();
271 * Start the storage component
274 GNUNET_EXPERIMENTATION_storage_start ();
279 * Stop the storage component
282 GNUNET_EXPERIMENTATION_storage_stop ();
285 /* end of gnunet-daemon-experimentation.h */