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_experiments.c
23 * @brief experimentation daemon: experiment management
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"
32 #include "gnunet-daemon-experimentation.h"
37 * Struct to store information about an experiment issuer
41 struct GNUNET_CRYPTO_EccPublicSignKey pubkey;
46 * Hashmap containing valid experiment issuer
48 static struct GNUNET_CONTAINER_MultiHashMap *valid_issuers;
52 * Hashmap containing valid experiments
54 static struct GNUNET_CONTAINER_MultiHashMap *experiments;
57 uint32_t GSE_my_issuer_count;
60 * Valid experiment issuer for this daemon
62 * Array Experimentation_Issuer with GSE_my_issuer_count elements
64 struct Experimentation_Issuer *GSE_my_issuer;
68 * Verify experiment signature
72 * @return GNUNET_OK or GNUNET_SYSERR
75 experiment_verify (struct Issuer *i, struct Experiment *e)
77 GNUNET_assert (NULL != i);
78 GNUNET_assert (NULL != e);
80 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Verification: to be implemented\n");
84 int free_experiment (void *cls,
85 const struct GNUNET_HashCode * key,
88 struct Experiment *e = value;
89 GNUNET_break (0 == GNUNET_CONTAINER_multihashmap_remove (experiments, key, value));
90 GNUNET_free_non_null (e->description);
91 GNUNET_free_non_null (e->name);
102 * @param value the issuer element to free
103 * @return GNUNET_OK to continue
105 int free_issuer (void *cls,
106 const struct GNUNET_HashCode * key,
109 struct Issuer *i = value;
110 GNUNET_break (0 == GNUNET_CONTAINER_multihashmap_remove (valid_issuers, key, value));
115 int create_issuer (void *cls,
116 const struct GNUNET_HashCode * key,
120 GNUNET_assert (i < GSE_my_issuer_count);
121 GSE_my_issuer[i].issuer_id.hashPubKey = *key;
131 * Is peer a valid issuer
133 * @return GNUNET_YES or GNUNET_NO
136 GED_experiments_issuer_accepted (struct GNUNET_PeerIdentity *issuer_ID)
138 if (GNUNET_CONTAINER_multihashmap_contains (valid_issuers, &issuer_ID->hashPubKey))
147 struct GNUNET_TIME_Absolute version;
148 struct Experiment *res;
153 const struct GNUNET_HashCode * key,
156 struct FindCtx *find_ctx = cls;
157 struct Experiment *e = (struct Experiment *) value;
159 if (0 != strcmp(e->name, find_ctx->name))
161 if (e->version.abs_value_us != find_ctx->version.abs_value_us)
170 * Find an experiment based on issuer name and version
172 * @param issuer the issuer
173 * @param name experiment name
174 * @param version experiment version
175 * @return the experiment or NULL if not found
178 GED_experiments_find (const struct GNUNET_PeerIdentity *issuer,
180 const struct GNUNET_TIME_Absolute version)
182 struct FindCtx find_ctx;
184 find_ctx.name = name;
185 find_ctx.version = version;
188 GNUNET_CONTAINER_multihashmap_get_multiple (experiments,
189 &issuer->hashPubKey, &find_it, &find_ctx);
196 GNUNET_EXPERIMENTATION_experiments_get_cb get_cb;
202 const struct GNUNET_HashCode * key,
205 struct GetCtx *get_ctx = cls;
206 struct Experiment *e = value;
208 get_ctx->get_cb (get_ctx->n, e);
214 GED_experiments_get (struct Node *n,
215 struct GNUNET_PeerIdentity *issuer,
216 GNUNET_EXPERIMENTATION_experiments_get_cb get_cb)
218 struct GetCtx get_ctx;
220 GNUNET_assert (NULL != n);
221 GNUNET_assert (NULL != experiments);
222 GNUNET_assert (NULL != get_cb);
225 get_ctx.get_cb = get_cb;
227 GNUNET_CONTAINER_multihashmap_get_multiple (experiments,
228 &issuer->hashPubKey, &get_it, &get_ctx);
234 * Add a new experiment
236 int GNUNET_EXPERIMENTATION_experiments_add (struct Issuer *i,
238 struct GNUNET_PeerIdentity issuer_id,
239 struct GNUNET_TIME_Absolute version,
241 uint32_t required_capabilities,
242 struct GNUNET_TIME_Absolute start,
243 struct GNUNET_TIME_Relative frequency,
244 struct GNUNET_TIME_Relative duration,
245 struct GNUNET_TIME_Absolute stop)
247 struct Experiment *e;
248 e = GNUNET_malloc (sizeof (struct Experiment));
250 e->name = GNUNET_strdup (name);
251 e->issuer = issuer_id;
252 e->version = version;
253 if (NULL != description)
254 e->description = GNUNET_strdup (description);
255 e->required_capabilities = required_capabilities;
257 e->frequency = frequency;
258 e->duration = duration;
261 /* verify experiment */
262 if (GNUNET_SYSERR == experiment_verify (i, e))
264 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Experiment `%s': Experiment signature is invalid\n"), name);
266 GNUNET_free_non_null (e->name);
267 GNUNET_free_non_null (e->description);
268 return GNUNET_SYSERR;
271 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Adding experiment `%s' running from `%s' to `%s' every %llu sec. for %llu sec. \n"),
273 GNUNET_STRINGS_absolute_time_to_string (start),
274 GNUNET_STRINGS_absolute_time_to_string (stop),
275 (long long unsigned int) frequency.rel_value_us / 1000000LL,
276 (long long unsigned int) duration.rel_value_us / 1000000LL);
277 GNUNET_CONTAINER_multihashmap_put (experiments, &e->issuer.hashPubKey, e, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
278 GNUNET_STATISTICS_set (GED_stats, "# experiments", GNUNET_CONTAINER_multihashmap_size (experiments), GNUNET_NO);
285 * Parse a configuration section containing experiments
287 * @param cls configuration handle
288 * @param name section name
290 void exp_file_iterator (void *cls,
293 struct GNUNET_CONFIGURATION_Handle *exp = cls;
297 unsigned long long number;
299 /* Experiment values */
300 struct GNUNET_PeerIdentity issuer;
301 struct GNUNET_TIME_Absolute version;
303 uint32_t required_capabilities;
304 struct GNUNET_TIME_Absolute start ;
305 struct GNUNET_TIME_Absolute stop;
306 struct GNUNET_TIME_Relative frequency;
307 struct GNUNET_TIME_Relative duration;
309 //GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Parsing section `%s'\n", name);
311 /* Mandatory fields */
314 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (exp, name, "ISSUER", &val))
316 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Experiment `%s': Issuer missing\n"), name);
319 if (GNUNET_SYSERR == GNUNET_CRYPTO_hash_from_string (val, &issuer.hashPubKey))
321 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Experiment `%s': Issuer invalid\n"), name);
325 if (NULL == (i = GNUNET_CONTAINER_multihashmap_get (valid_issuers, &issuer.hashPubKey)))
327 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Experiment `%s': Issuer not accepted!\n"), name);
334 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (exp, name, "VERSION", &number))
336 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Experiment `%s': Version missing or invalid \n"), name);
339 version.abs_value_us = number; // FIXME: what is this supposed to be? Version != TIME!???
341 /* Required capabilities */
342 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (exp, name, "CAPABILITIES", &number))
344 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Experiment `%s': Required capabilities missing \n"), name);
347 if (number > UINT32_MAX)
349 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Experiment `%s': Required capabilities invalid \n"), name);
352 required_capabilities = number;
354 /* Optional fields */
357 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (exp, name, "DESCRIPTION", &description))
360 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (exp, name, "START", (long long unsigned int *) &start.abs_value_us))
361 start = GNUNET_TIME_UNIT_ZERO_ABS;
363 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time (exp, name, "FREQUENCY", &frequency))
364 frequency = EXP_DEFAULT_EXP_FREQ;
365 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time (exp, name, "DURATION", &duration))
366 duration = EXP_DEFAULT_EXP_DUR;
367 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (exp, name, "STOP", (long long unsigned int *)&stop.abs_value_us))
368 stop = GNUNET_TIME_UNIT_FOREVER_ABS;
370 GNUNET_EXPERIMENTATION_experiments_add (i, name, issuer, version,
371 description, required_capabilities,
372 start, frequency, duration, stop);
373 GNUNET_free_non_null (description);
378 * Load experiments from file
380 * @param file source file
383 load_file (const char * file)
385 struct GNUNET_CONFIGURATION_Handle *exp = GNUNET_CONFIGURATION_create();
389 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_parse (exp, file))
391 GNUNET_CONFIGURATION_destroy (exp);
392 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Failed to parse file `%s'\n"), file);
395 GNUNET_CONFIGURATION_iterate_sections (exp, &exp_file_iterator, exp);
396 GNUNET_CONFIGURATION_destroy (exp);
401 * Start experiments management
404 GED_experiments_start ()
411 struct GNUNET_PeerIdentity issuer_ID;
412 struct GNUNET_CRYPTO_EccPublicSignKey pub;
413 struct GNUNET_HashCode hash;
415 /* Load valid issuer */
416 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (GED_cfg, "EXPERIMENTATION", "ISSUERS", &issuers))
418 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("No valid experiment issuers configured! Set value to peer id of issuer! Exit...\n"));
419 return GNUNET_SYSERR;
422 valid_issuers = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
423 for (pos = strtok (issuers, " "); pos != NULL; pos = strtok (NULL, " "))
426 if (GNUNET_SYSERR == GNUNET_CRYPTO_hash_from_string (pos, &issuer_ID.hashPubKey))
428 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Invalid value `%s'\n"), pos);
432 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' is a valid issuer \n", GNUNET_i2s (&issuer_ID));
433 i = GNUNET_malloc (sizeof (struct Issuer));
434 GNUNET_CONTAINER_multihashmap_put (valid_issuers, &issuer_ID.hashPubKey,
435 i, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
439 GNUNET_free (issuers);
441 if (0 == GNUNET_CONTAINER_multihashmap_size (valid_issuers))
443 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("No valid experiment issuers configured! Set value to peer id of issuer! Exit...\n"));
444 GED_experiments_stop ();
445 return GNUNET_SYSERR;
447 GNUNET_STATISTICS_set (GED_stats, "# issuer", GNUNET_CONTAINER_multihashmap_size (valid_issuers), GNUNET_NO);
449 if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (GED_cfg, "EXPERIMENTATION", "PUBKEY", &pubkey))
451 if (GNUNET_OK != GNUNET_CRYPTO_ecc_public_sign_key_from_string(pubkey, strlen (pubkey), &pub))
452 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Invalid public key `%s'\n"), pubkey);
455 GNUNET_CRYPTO_hash( &pub, sizeof (pub), &hash);
456 if (NULL != (i = GNUNET_CONTAINER_multihashmap_get (valid_issuers, &hash)))
459 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _("Found issuer for public key `%s'\n"), pubkey);
462 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("No issuer for public key `%s'\n"), pubkey);
464 GNUNET_free (pubkey);
467 GSE_my_issuer_count = GNUNET_CONTAINER_multihashmap_size (valid_issuers);
468 GSE_my_issuer = GNUNET_malloc (GSE_my_issuer_count * sizeof (struct Experimentation_Issuer));
469 GNUNET_CONTAINER_multihashmap_iterate (valid_issuers, &create_issuer, GSE_my_issuer);
470 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Daemon has %u issuers\n", GSE_my_issuer_count);
472 experiments = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
473 /* Load experiments from file */
474 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (GED_cfg, "EXPERIMENTATION", "EXPERIMENTS", &file))
477 if (GNUNET_YES != GNUNET_DISK_file_test (file))
479 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Cannot read experiments file `%s'\n"), file);
490 * Stop experiments management
493 GED_experiments_stop ()
495 if (NULL != GSE_my_issuer)
497 GNUNET_free (GSE_my_issuer);
498 GSE_my_issuer = NULL;
499 GSE_my_issuer_count = 0;
501 if (NULL != valid_issuers)
503 GNUNET_CONTAINER_multihashmap_iterate (valid_issuers, &free_issuer, NULL);
504 GNUNET_CONTAINER_multihashmap_destroy (valid_issuers);
506 valid_issuers = NULL;
507 if (NULL != experiments)
509 GNUNET_CONTAINER_multihashmap_iterate (experiments, &free_experiment, NULL);
510 GNUNET_CONTAINER_multihashmap_destroy (experiments);
515 /* end of gnunet-daemon-experimentation_experiments.c */