2 This file is part of GNUnet.
3 Copyright (C) 2010-2013 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file ats-tests/ats-testing-experiment.c
22 * @brief ats benchmark: controlled experiment execution
23 * @author Christian Grothoff
24 * @author Matthias Wachs
27 #include "gnunet_util_lib.h"
28 #include "gnunet_ats_plugin.h"
29 #include "gnunet_ats_service.h"
30 #include "ats-testing.h"
37 print_op (enum OperationType op)
44 case START_PREFERENCE:
45 return "START_PREFERENCE";
47 return "STOP_PREFERENCE";
55 static struct Experiment *
59 e = GNUNET_new (struct Experiment);
64 e->total_duration = GNUNET_TIME_UNIT_ZERO;
70 free_experiment (struct Experiment *e)
74 struct GNUNET_ATS_TEST_Operation *cur_o;
75 struct GNUNET_ATS_TEST_Operation *next_o;
78 for (cur = next; NULL != cur; cur = next)
83 for (cur_o = next_o; NULL != cur_o; cur_o = next_o)
91 GNUNET_free_non_null (e->name);
92 GNUNET_free_non_null (e->cfg_file);
98 load_episode (struct Experiment *e,
100 struct GNUNET_CONFIGURATION_Handle *cfg)
102 struct GNUNET_ATS_TEST_Operation *o;
109 fprintf (stderr, "Parsing episode %u\n",cur->id);
110 GNUNET_asprintf(&sec_name, "episode-%u", cur->id);
115 GNUNET_asprintf(&op_name, "op-%u-operation", op_counter);
116 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string(cfg,
117 sec_name, op_name, &op))
119 GNUNET_free (op_name);
122 o = GNUNET_new (struct GNUNET_ATS_TEST_Operation);
123 /* operations = set_rate, start_send, stop_send, set_preference */
124 if (0 == strcmp (op, "start_send"))
126 o->type = START_SEND;
128 else if (0 == strcmp (op, "stop_send"))
132 else if (0 == strcmp (op, "start_preference"))
134 o->type = START_PREFERENCE;
136 else if (0 == strcmp (op, "stop_preference"))
138 o->type = STOP_PREFERENCE;
142 fprintf (stderr, "Invalid operation %u `%s' in episode %u\n",
143 op_counter, op, cur->id);
145 GNUNET_free (op_name);
146 GNUNET_free (sec_name);
148 return GNUNET_SYSERR;
150 GNUNET_free (op_name);
153 GNUNET_asprintf(&op_name, "op-%u-src", op_counter);
154 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg,
155 sec_name, op_name, &o->src_id))
157 fprintf (stderr, "Missing src in operation %u `%s' in episode %u\n",
158 op_counter, op, cur->id);
160 GNUNET_free (op_name);
161 GNUNET_free (sec_name);
163 return GNUNET_SYSERR;
165 if (o->src_id > (e->num_masters - 1))
167 fprintf (stderr, "Invalid src %llu in operation %u `%s' in episode %u\n",
168 o->src_id, op_counter, op, cur->id);
170 GNUNET_free (op_name);
171 GNUNET_free (sec_name);
173 return GNUNET_SYSERR;
175 GNUNET_free (op_name);
177 /* Get destination */
178 GNUNET_asprintf(&op_name, "op-%u-dest", op_counter);
179 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg,
180 sec_name, op_name, &o->dest_id))
182 fprintf (stderr, "Missing src in operation %u `%s' in episode %u\n",
183 op_counter, op, cur->id);
185 GNUNET_free (op_name);
186 GNUNET_free (sec_name);
188 return GNUNET_SYSERR;
190 if (o->dest_id > (e->num_slaves - 1))
193 "Invalid destination %llu in operation %u `%s' in episode %u\n",
199 GNUNET_free (op_name);
200 GNUNET_free (sec_name);
202 return GNUNET_SYSERR;
204 GNUNET_free (op_name);
206 GNUNET_asprintf(&op_name, "op-%u-type", op_counter);
207 if ( (GNUNET_SYSERR !=
208 GNUNET_CONFIGURATION_get_value_string(cfg,
212 (STOP_SEND != o->type) &&
213 (STOP_PREFERENCE != o->type) )
215 /* Load arguments for set_rate, start_send, set_preference */
216 if (0 == strcmp (type, "constant"))
218 o->gen_type = GNUNET_ATS_TEST_TG_CONSTANT;
220 else if (0 == strcmp (type, "linear"))
222 o->gen_type = GNUNET_ATS_TEST_TG_LINEAR;
224 else if (0 == strcmp (type, "sinus"))
226 o->gen_type = GNUNET_ATS_TEST_TG_SINUS;
228 else if (0 == strcmp (type, "random"))
230 o->gen_type = GNUNET_ATS_TEST_TG_RANDOM;
234 fprintf (stderr, "Invalid type %u `%s' in episode %u\n",
235 op_counter, op, cur->id);
238 GNUNET_free (op_name);
239 GNUNET_free (sec_name);
241 return GNUNET_SYSERR;
243 GNUNET_free (op_name);
246 GNUNET_asprintf(&op_name, "op-%u-base-rate", op_counter);
247 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg,
248 sec_name, op_name, &o->base_rate))
250 fprintf (stderr, "Missing base rate in operation %u `%s' in episode %u\n",
251 op_counter, op, cur->id);
254 GNUNET_free (op_name);
255 GNUNET_free (sec_name);
257 return GNUNET_SYSERR;
259 GNUNET_free (op_name);
262 GNUNET_asprintf(&op_name, "op-%u-max-rate", op_counter);
264 GNUNET_CONFIGURATION_get_value_number (cfg,
269 if ((GNUNET_ATS_TEST_TG_LINEAR == o->gen_type) ||
270 (GNUNET_ATS_TEST_TG_RANDOM == o->gen_type) ||
271 (GNUNET_ATS_TEST_TG_SINUS == o->gen_type))
273 fprintf (stderr, "Missing max rate in operation %u `%s' in episode %u\n",
274 op_counter, op, cur->id);
276 GNUNET_free (op_name);
278 GNUNET_free (sec_name);
280 return GNUNET_SYSERR;
283 GNUNET_free (op_name);
286 GNUNET_asprintf(&op_name, "op-%u-period", op_counter);
287 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time (cfg,
288 sec_name, op_name, &o->period))
290 o->period = cur->duration;
292 GNUNET_free (op_name);
294 if (START_PREFERENCE == o->type)
297 GNUNET_asprintf(&op_name, "op-%u-frequency", op_counter);
298 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time (cfg,
299 sec_name, op_name, &o->frequency))
301 fprintf (stderr, "Missing frequency in operation %u `%s' in episode %u\n",
302 op_counter, op, cur->id);
304 GNUNET_free (op_name);
306 GNUNET_free (sec_name);
308 return GNUNET_SYSERR;
310 GNUNET_free (op_name);
313 GNUNET_asprintf(&op_name, "op-%u-pref", op_counter);
314 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg,
315 sec_name, op_name, &pref))
317 fprintf (stderr, "Missing preference in operation %u `%s' in episode %u\n",
318 op_counter, op, cur->id);
320 GNUNET_free (op_name);
322 GNUNET_free (sec_name);
323 GNUNET_free_non_null (pref);
325 return GNUNET_SYSERR;
328 if (0 == strcmp(pref, "bandwidth"))
329 o->pref_type = GNUNET_ATS_PREFERENCE_BANDWIDTH;
330 else if (0 == strcmp(pref, "latency"))
331 o->pref_type = GNUNET_ATS_PREFERENCE_LATENCY;
334 fprintf (stderr, "Invalid preference in operation %u `%s' in episode %u\n",
335 op_counter, op, cur->id);
337 GNUNET_free (op_name);
340 GNUNET_free (sec_name);
341 GNUNET_free_non_null (pref);
343 return GNUNET_SYSERR;
346 GNUNET_free (op_name);
351 if ((GNUNET_ATS_TEST_TG_LINEAR == o->gen_type) ||
352 (GNUNET_ATS_TEST_TG_SINUS == o->gen_type))
354 if ((o->max_rate - o->base_rate) > o->base_rate)
356 /* This will cause an underflow */
359 fprintf (stderr, "Selected max rate and base rate cannot be used for desired traffic form!\n");
362 if ((START_SEND == o->type) || (START_PREFERENCE == o->type))
363 fprintf (stderr, "Found operation %u in episode %u: %s [%llu]->[%llu] == %s, %llu -> %llu in %s\n",
364 op_counter, cur->id, print_op (o->type), o->src_id,
365 o->dest_id, (NULL != type) ? type : "",
366 o->base_rate, o->max_rate,
367 GNUNET_STRINGS_relative_time_to_string (o->period, GNUNET_YES));
369 fprintf (stderr, "Found operation %u in episode %u: %s [%llu]->[%llu]\n",
370 op_counter, cur->id, print_op (o->type), o->src_id, o->dest_id);
372 GNUNET_free_non_null (type);
375 GNUNET_CONTAINER_DLL_insert (cur->head,cur->tail, o);
378 GNUNET_free (sec_name);
384 load_episodes (struct Experiment *e, struct GNUNET_CONFIGURATION_Handle *cfg)
388 struct GNUNET_TIME_Relative e_duration;
390 struct Episode *last;
396 GNUNET_asprintf(&sec_name, "episode-%u", e_counter);
397 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time(cfg,
398 sec_name, "duration", &e_duration))
400 GNUNET_free (sec_name);
404 cur = GNUNET_new (struct Episode);
405 cur->duration = e_duration;
408 if (GNUNET_OK != load_episode (e, cur, cfg))
410 GNUNET_free (sec_name);
412 return GNUNET_SYSERR;
415 fprintf (stderr, "Found episode %u with duration %s \n",
417 GNUNET_STRINGS_relative_time_to_string(cur->duration, GNUNET_YES));
419 /* Update experiment */
421 e->total_duration = GNUNET_TIME_relative_add(e->total_duration, cur->duration);
422 /* Put in linked list */
428 GNUNET_free (sec_name);
437 timeout_experiment (void *cls)
439 struct Experiment *e = cls;
440 e->experiment_timeout_task = NULL;
441 fprintf (stderr, "Experiment timeout!\n");
443 if (NULL != e->episode_timeout_task)
445 GNUNET_SCHEDULER_cancel (e->episode_timeout_task);
446 e->episode_timeout_task = NULL;
449 e->e_done_cb (e, GNUNET_TIME_absolute_get_duration(e->start_time),
455 enforce_start_send (struct GNUNET_ATS_TEST_Operation *op)
458 struct BenchmarkPeer *peer;
459 struct BenchmarkPartner *partner;
461 peer = GNUNET_ATS_TEST_get_peer (op->src_id);
468 partner = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
475 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
477 if (NULL != partner->tg)
479 fprintf (stderr, "Stopping traffic between master %llu slave %llu\n",op->src_id, op->dest_id);
480 GNUNET_ATS_TEST_generate_traffic_stop(partner->tg);
484 partner->tg = GNUNET_ATS_TEST_generate_traffic_start(peer, partner,
485 op->tg_type, op->base_rate, op->max_rate, op->period,
486 GNUNET_TIME_UNIT_FOREVER_REL);
491 enforce_stop_send (struct GNUNET_ATS_TEST_Operation *op)
494 struct BenchmarkPartner *p;
495 p = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
502 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
506 fprintf (stderr, "Stopping traffic between master %llu slave %llu\n",
507 op->src_id, op->dest_id);
508 GNUNET_ATS_TEST_generate_traffic_stop(p->tg);
516 enforce_start_preference (struct GNUNET_ATS_TEST_Operation *op)
519 struct BenchmarkPeer *peer;
520 struct BenchmarkPartner *partner;
522 peer = GNUNET_ATS_TEST_get_peer (op->src_id);
529 partner = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
536 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
538 if (NULL != partner->pg)
540 fprintf (stderr, "Stopping traffic between master %llu slave %llu\n",
541 op->src_id, op->dest_id);
542 GNUNET_ATS_TEST_generate_preferences_stop(partner->pg);
546 partner->pg = GNUNET_ATS_TEST_generate_preferences_start(peer, partner,
547 op->tg_type, op->base_rate, op->max_rate, op->period, op->frequency,
553 enforce_stop_preference (struct GNUNET_ATS_TEST_Operation *op)
556 struct BenchmarkPartner *p;
557 p = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
564 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
568 fprintf (stderr, "Stopping preference between master %llu slave %llu\n",
569 op->src_id, op->dest_id);
570 GNUNET_ATS_TEST_generate_preferences_stop (p->pg);
576 static void enforce_episode (struct Episode *ep)
578 struct GNUNET_ATS_TEST_Operation *cur;
579 for (cur = ep->head; NULL != cur; cur = cur->next)
582 fprintf (stderr, "Enforcing operation: %s [%llu]->[%llu] == %llu\n",
583 print_op (cur->type), cur->src_id, cur->dest_id, cur->base_rate);
586 enforce_start_send (cur);
589 enforce_stop_send (cur);
591 case START_PREFERENCE:
592 enforce_start_preference (cur);
594 case STOP_PREFERENCE:
595 enforce_stop_preference (cur);
605 timeout_episode (void *cls)
607 struct Experiment *e = cls;
608 e->episode_timeout_task = NULL;
609 if (NULL != e->ep_done_cb)
610 e->ep_done_cb (e->cur);
612 /* Scheduling next */
613 e->cur = e->cur->next;
617 fprintf (stderr, "Last episode done!\n");
618 if (NULL != e->experiment_timeout_task)
620 GNUNET_SCHEDULER_cancel (e->experiment_timeout_task);
621 e->experiment_timeout_task = NULL;
623 e->e_done_cb (e, GNUNET_TIME_absolute_get_duration(e->start_time), GNUNET_OK);
627 fprintf (stderr, "Running episode %u with timeout %s\n",
629 GNUNET_STRINGS_relative_time_to_string(e->cur->duration, GNUNET_YES));
630 enforce_episode(e->cur);
632 e->episode_timeout_task = GNUNET_SCHEDULER_add_delayed (e->cur->duration,
633 &timeout_episode, e);
638 GNUNET_ATS_solvers_experimentation_run (struct Experiment *e,
639 GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb,
640 GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb)
642 fprintf (stderr, "Running experiment `%s' with timeout %s\n", e->name,
643 GNUNET_STRINGS_relative_time_to_string(e->max_duration, GNUNET_YES));
644 e->e_done_cb = e_done_cb;
645 e->ep_done_cb = ep_done_cb;
646 e->start_time = GNUNET_TIME_absolute_get();
648 /* Start total time out */
649 e->experiment_timeout_task = GNUNET_SCHEDULER_add_delayed (e->max_duration,
650 &timeout_experiment, e);
654 fprintf (stderr, "Running episode %u with timeout %s\n",
656 GNUNET_STRINGS_relative_time_to_string(e->cur->duration, GNUNET_YES));
657 enforce_episode(e->cur);
658 e->episode_timeout_task = GNUNET_SCHEDULER_add_delayed (e->cur->duration,
659 &timeout_episode, e);
666 GNUNET_ATS_solvers_experimentation_load (char *filename)
668 struct Experiment *e;
669 struct GNUNET_CONFIGURATION_Handle *cfg;
672 cfg = GNUNET_CONFIGURATION_create();
673 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, filename))
675 fprintf (stderr, "Failed to load `%s'\n", filename);
676 GNUNET_CONFIGURATION_destroy (cfg);
680 e = create_experiment ();
682 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string(cfg, "experiment",
685 fprintf (stderr, "Invalid %s", "name");
690 fprintf (stderr, "Experiment name: `%s'\n", e->name);
692 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_filename (cfg, "experiment",
693 "cfg_file", &e->cfg_file))
695 fprintf (stderr, "Invalid %s", "cfg_file");
700 fprintf (stderr, "Experiment name: `%s'\n", e->cfg_file);
702 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number(cfg, "experiment",
703 "masters", &e->num_masters))
705 fprintf (stderr, "Invalid %s", "masters");
710 fprintf (stderr, "Experiment masters: `%llu'\n",
713 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number(cfg, "experiment",
714 "slaves", &e->num_slaves))
716 fprintf (stderr, "Invalid %s", "slaves");
721 fprintf (stderr, "Experiment slaves: `%llu'\n",
724 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time(cfg, "experiment",
725 "log_freq", &e->log_freq))
727 fprintf (stderr, "Invalid %s", "log_freq");
732 fprintf (stderr, "Experiment logging frequency: `%s'\n",
733 GNUNET_STRINGS_relative_time_to_string (e->log_freq, GNUNET_YES));
735 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time(cfg, "experiment",
736 "max_duration", &e->max_duration))
738 fprintf (stderr, "Invalid %s", "max_duration");
743 fprintf (stderr, "Experiment duration: `%s'\n",
744 GNUNET_STRINGS_relative_time_to_string (e->max_duration, GNUNET_YES));
746 load_episodes (e, cfg);
747 fprintf (stderr, "Loaded %u episodes with total duration %s\n",
749 GNUNET_STRINGS_relative_time_to_string (e->total_duration, GNUNET_YES));
751 GNUNET_CONFIGURATION_destroy (cfg);
756 GNUNET_ATS_solvers_experimentation_stop (struct Experiment *e)
758 if (NULL != e->experiment_timeout_task)
760 GNUNET_SCHEDULER_cancel (e->experiment_timeout_task);
761 e->experiment_timeout_task = NULL;
763 if (NULL != e->episode_timeout_task)
765 GNUNET_SCHEDULER_cancel (e->episode_timeout_task);
766 e->episode_timeout_task = NULL;
775 struct GNUNET_ATS_TESTING_SolverHandle
778 struct GNUNET_ATS_PluginEnvironment env;
782 enum GNUNET_ATS_Solvers
784 GNUNET_ATS_SOLVER_PROPORTIONAL,
785 GNUNET_ATS_SOLVER_MLP,
786 GNUNET_ATS_SOLVER_RIL,
790 GNUNET_ATS_solvers_solver_stop (struct GNUNET_ATS_TESTING_SolverHandle *sh)
792 GNUNET_PLUGIN_unload (sh->plugin, sh->solver);
793 GNUNET_free (sh->plugin);
797 struct GNUNET_ATS_TESTING_SolverHandle *
798 GNUNET_ATS_solvers_solver_start (enum GNUNET_ATS_Solvers type)
800 struct GNUNET_ATS_TESTING_SolverHandle *sh;
804 case GNUNET_ATS_SOLVER_PROPORTIONAL:
805 solver_str = "proportional";
807 case GNUNET_ATS_SOLVER_MLP:
810 case GNUNET_ATS_SOLVER_RIL:
819 sh = GNUNET_new (struct GNUNET_ATS_TESTING_SolverHandle);
820 GNUNET_asprintf (&sh->plugin, "libgnunet_plugin_ats_%s", solver_str);
821 //sh->solver = GNUNET_PLUGIN_load (sh->plugin, &sh->env);
822 if (NULL == sh->solver)
824 fprintf (stderr, "Failed to load solver `%s'\n", sh->plugin);
831 static struct Experiment *e;
833 static struct GNUNET_ATS_TESTING_SolverHandle *sh;
836 * cmd option -e: experiment file
838 static char *opt_exp_file;
840 static char *opt_solver;
843 * cmd option -l: enable logging
848 * cmd option -p: enable plots
853 * cmd option -v: verbose logs
855 static int opt_verbose;
858 run (void *cls, char * const *args, const char *cfgfile,
859 const struct GNUNET_CONFIGURATION_Handle *cfg)
861 enum GNUNET_ATS_Solvers solver;
863 if (NULL == opt_exp_file)
865 fprintf (stderr, "No experiment given ...\n");
869 if (NULL == opt_solver)
871 fprintf (stderr, "No solver given ...\n");
875 if (0 == strcmp(opt_solver, "mlp"))
877 solver = GNUNET_ATS_SOLVER_MLP;
879 else if (0 == strcmp(opt_solver, "proportional"))
881 solver = GNUNET_ATS_SOLVER_PROPORTIONAL;
883 else if (0 == strcmp(opt_solver, "ril"))
885 solver = GNUNET_ATS_SOLVER_RIL;
889 fprintf (stderr, "No solver given ...");
893 /* load experiment */
894 e = GNUNET_ATS_solvers_experimentation_load (opt_exp_file);
897 fprintf (stderr, "Failed to load experiment ...\n");
902 sh = GNUNET_ATS_solvers_solver_start (solver);
905 fprintf (stderr, "Failed to start solver ...\n");
918 * Main function of the benchmark
920 * @param argc argument count
921 * @param argv argument values
924 main (int argc, char *argv[])
930 opt_plot = GNUNET_NO;
932 static struct GNUNET_GETOPT_CommandLineOption options[] =
934 { 's', "solver", NULL,
935 gettext_noop ("solver to use"),
936 1, &GNUNET_GETOPT_set_string, &opt_solver},
937 { 'e', "experiment", NULL,
938 gettext_noop ("experiment to use"),
939 1, &GNUNET_GETOPT_set_string, &opt_exp_file},
940 { 'e', "experiment", NULL,
941 gettext_noop ("experiment to use"),
942 1, &GNUNET_GETOPT_set_one, &opt_verbose},
943 GNUNET_GETOPT_OPTION_END
946 GNUNET_PROGRAM_run (argc, argv, argv[0], NULL, options, &run, argv[0]);
950 /* end of file ats-testing-experiment.c*/