2 This file is part of GNUnet.
3 (C) 2010-2013 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.
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"
38 print_op (enum OperationType op)
45 case START_PREFERENCE:
46 return "START_PREFERENCE";
48 return "STOP_PREFERENCE";
56 static struct Experiment *
60 e = GNUNET_new (struct Experiment);
65 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);
97 load_episode (struct Experiment *e, struct Episode *cur,
98 struct GNUNET_CONFIGURATION_Handle *cfg)
100 struct GNUNET_ATS_TEST_Operation *o;
107 fprintf (stderr, "Parsing episode %u\n",cur->id);
108 GNUNET_asprintf(&sec_name, "episode-%u", cur->id);
113 GNUNET_asprintf(&op_name, "op-%u-operation", op_counter);
114 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string(cfg,
115 sec_name, op_name, &op))
117 GNUNET_free (op_name);
120 o = GNUNET_new (struct GNUNET_ATS_TEST_Operation);
121 /* operations = set_rate, start_send, stop_send, set_preference */
122 if (0 == strcmp (op, "start_send"))
124 o->type = START_SEND;
126 else if (0 == strcmp (op, "stop_send"))
130 else if (0 == strcmp (op, "start_preference"))
132 o->type = START_PREFERENCE;
134 else if (0 == strcmp (op, "stop_preference"))
136 o->type = STOP_PREFERENCE;
140 fprintf (stderr, "Invalid operation %u `%s' in episode %u\n",
141 op_counter, op, cur->id);
143 GNUNET_free (op_name);
144 return GNUNET_SYSERR;
146 GNUNET_free (op_name);
149 GNUNET_asprintf(&op_name, "op-%u-src", op_counter);
150 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg,
151 sec_name, op_name, &o->src_id))
153 fprintf (stderr, "Missing src in operation %u `%s' in episode %u\n",
154 op_counter, op, cur->id);
156 GNUNET_free (op_name);
157 return GNUNET_SYSERR;
159 if (o->src_id > (e->num_masters - 1))
161 fprintf (stderr, "Invalid src %llu in operation %u `%s' in episode %u\n",
162 o->src_id, op_counter, op, cur->id);
164 GNUNET_free (op_name);
165 return GNUNET_SYSERR;
167 GNUNET_free (op_name);
169 /* Get destination */
170 GNUNET_asprintf(&op_name, "op-%u-dest", op_counter);
171 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg,
172 sec_name, op_name, &o->dest_id))
174 fprintf (stderr, "Missing src in operation %u `%s' in episode %u\n",
175 op_counter, op, cur->id);
177 GNUNET_free (op_name);
178 return GNUNET_SYSERR;
180 if (o->dest_id > (e->num_slaves - 1))
182 fprintf (stderr, "Invalid destination %llu in operation %u `%s' in episode %u\n",
183 o->dest_id, op_counter, op, cur->id);
185 GNUNET_free (op_name);
186 return GNUNET_SYSERR;
188 GNUNET_free (op_name);
190 GNUNET_asprintf(&op_name, "op-%u-type", op_counter);
191 if ( (GNUNET_SYSERR != GNUNET_CONFIGURATION_get_value_string(cfg,
192 sec_name, op_name, &type)) &&
193 ((STOP_SEND != o->type) || (STOP_PREFERENCE != o->type)))
195 /* Load arguments for set_rate, start_send, set_preference */
196 if (0 == strcmp (type, "constant"))
198 o->gen_type = GNUNET_ATS_TEST_TG_CONSTANT;
200 else if (0 == strcmp (type, "linear"))
202 o->gen_type = GNUNET_ATS_TEST_TG_LINEAR;
204 else if (0 == strcmp (type, "sinus"))
206 o->gen_type = GNUNET_ATS_TEST_TG_SINUS;
208 else if (0 == strcmp (type, "random"))
210 o->gen_type = GNUNET_ATS_TEST_TG_RANDOM;
214 fprintf (stderr, "Invalid type %u `%s' in episode %u\n",
215 op_counter, op, cur->id);
218 GNUNET_free (op_name);
219 return GNUNET_SYSERR;
221 GNUNET_free (op_name);
224 GNUNET_asprintf(&op_name, "op-%u-base-rate", op_counter);
225 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg,
226 sec_name, op_name, &o->base_rate))
228 fprintf (stderr, "Missing base rate in operation %u `%s' in episode %u\n",
229 op_counter, op, cur->id);
232 GNUNET_free (op_name);
233 return GNUNET_SYSERR;
235 GNUNET_free (op_name);
238 GNUNET_asprintf(&op_name, "op-%u-max-rate", op_counter);
239 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number (cfg,
240 sec_name, op_name, &o->max_rate))
242 if ((GNUNET_ATS_TEST_TG_LINEAR == o->gen_type) ||
243 (GNUNET_ATS_TEST_TG_RANDOM == o->gen_type) ||
244 (GNUNET_ATS_TEST_TG_SINUS == o->gen_type))
246 fprintf (stderr, "Missing max rate in operation %u `%s' in episode %u\n",
247 op_counter, op, cur->id);
249 GNUNET_free (op_name);
251 return GNUNET_SYSERR;
254 GNUNET_free (op_name);
257 GNUNET_asprintf(&op_name, "op-%u-period", op_counter);
258 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time (cfg,
259 sec_name, op_name, &o->period))
261 o->period = cur->duration;
263 GNUNET_free (op_name);
265 if (START_PREFERENCE == o->type)
268 GNUNET_asprintf(&op_name, "op-%u-frequency", op_counter);
269 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time (cfg,
270 sec_name, op_name, &o->frequency))
272 fprintf (stderr, "Missing frequency in operation %u `%s' in episode %u\n",
273 op_counter, op, cur->id);
275 GNUNET_free (op_name);
277 return GNUNET_SYSERR;
279 GNUNET_free (op_name);
282 GNUNET_asprintf(&op_name, "op-%u-pref", op_counter);
283 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string (cfg,
284 sec_name, op_name, &pref))
286 fprintf (stderr, "Missing preference in operation %u `%s' in episode %u\n",
287 op_counter, op, cur->id);
289 GNUNET_free (op_name);
291 GNUNET_free_non_null (pref);
292 return GNUNET_SYSERR;
295 if (0 == strcmp(pref, "bandwidth"))
296 o->pref_type = GNUNET_ATS_PREFERENCE_BANDWIDTH;
297 else if (0 == strcmp(pref, "latency"))
298 o->pref_type = GNUNET_ATS_PREFERENCE_LATENCY;
301 fprintf (stderr, "Invalid preference in operation %u `%s' in episode %u\n",
302 op_counter, op, cur->id);
304 GNUNET_free (op_name);
307 GNUNET_free_non_null (pref);
308 return GNUNET_SYSERR;
311 GNUNET_free (op_name);
316 if ((GNUNET_ATS_TEST_TG_LINEAR == o->gen_type) ||
317 (GNUNET_ATS_TEST_TG_SINUS == o->gen_type))
319 if ((o->max_rate - o->base_rate) > o->base_rate)
321 /* This will cause an underflow */
324 fprintf (stderr, "Selected max rate and base rate cannot be used for desired traffic form!\n");
327 if ((START_SEND == o->type) || (START_PREFERENCE == o->type))
328 fprintf (stderr, "Found operation %u in episode %u: %s [%llu]->[%llu] == %s, %llu -> %llu in %s\n",
329 op_counter, cur->id, print_op (o->type), o->src_id,
330 o->dest_id, (NULL != type) ? type : "",
331 o->base_rate, o->max_rate,
332 GNUNET_STRINGS_relative_time_to_string (o->period, GNUNET_YES));
334 fprintf (stderr, "Found operation %u in episode %u: %s [%llu]->[%llu]\n",
335 op_counter, cur->id, print_op (o->type), o->src_id, o->dest_id);
337 GNUNET_free_non_null (type);
340 GNUNET_CONTAINER_DLL_insert (cur->head,cur->tail, o);
343 GNUNET_free (sec_name);
349 load_episodes (struct Experiment *e, struct GNUNET_CONFIGURATION_Handle *cfg)
353 struct GNUNET_TIME_Relative e_duration;
355 struct Episode *last;
361 GNUNET_asprintf(&sec_name, "episode-%u", e_counter);
362 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time(cfg,
363 sec_name, "duration", &e_duration))
365 GNUNET_free (sec_name);
369 cur = GNUNET_new (struct Episode);
370 cur->duration = e_duration;
373 if (GNUNET_OK != load_episode (e, cur, cfg))
375 GNUNET_free (sec_name);
377 return GNUNET_SYSERR;
380 fprintf (stderr, "Found episode %u with duration %s \n",
382 GNUNET_STRINGS_relative_time_to_string(cur->duration, GNUNET_YES));
384 /* Update experiment */
386 e->total_duration = GNUNET_TIME_relative_add(e->total_duration, cur->duration);
387 /* Put in linked list */
393 GNUNET_free (sec_name);
401 timeout_experiment (void *cls, const struct GNUNET_SCHEDULER_TaskContext* tc)
403 struct Experiment *e = cls;
404 e->experiment_timeout_task = GNUNET_SCHEDULER_NO_TASK;
405 fprintf (stderr, "Experiment timeout!\n");
407 if (GNUNET_SCHEDULER_NO_TASK != e->episode_timeout_task)
409 GNUNET_SCHEDULER_cancel (e->episode_timeout_task);
410 e->episode_timeout_task = GNUNET_SCHEDULER_NO_TASK;
413 e->e_done_cb (e, GNUNET_TIME_absolute_get_duration(e->start_time),
418 enforce_start_send (struct GNUNET_ATS_TEST_Operation *op)
421 struct BenchmarkPeer *peer;
422 struct BenchmarkPartner *partner;
424 peer = GNUNET_ATS_TEST_get_peer (op->src_id);
431 partner = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
438 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
440 if (NULL != partner->tg)
442 fprintf (stderr, "Stopping traffic between master %llu slave %llu\n",op->src_id, op->dest_id);
443 GNUNET_ATS_TEST_generate_traffic_stop(partner->tg);
447 partner->tg = GNUNET_ATS_TEST_generate_traffic_start(peer, partner,
448 op->tg_type, op->base_rate, op->max_rate, op->period,
449 GNUNET_TIME_UNIT_FOREVER_REL);
454 enforce_stop_send (struct GNUNET_ATS_TEST_Operation *op)
457 struct BenchmarkPartner *p;
458 p = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
465 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
469 fprintf (stderr, "Stopping traffic between master %llu slave %llu\n",
470 op->src_id, op->dest_id);
471 GNUNET_ATS_TEST_generate_traffic_stop(p->tg);
479 enforce_start_preference (struct GNUNET_ATS_TEST_Operation *op)
482 struct BenchmarkPeer *peer;
483 struct BenchmarkPartner *partner;
485 peer = GNUNET_ATS_TEST_get_peer (op->src_id);
492 partner = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
499 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
501 if (NULL != partner->pg)
503 fprintf (stderr, "Stopping traffic between master %llu slave %llu\n",
504 op->src_id, op->dest_id);
505 GNUNET_ATS_TEST_generate_preferences_stop(partner->pg);
509 partner->pg = GNUNET_ATS_TEST_generate_preferences_start(peer, partner,
510 op->tg_type, op->base_rate, op->max_rate, op->period, op->frequency,
516 enforce_stop_preference (struct GNUNET_ATS_TEST_Operation *op)
519 struct BenchmarkPartner *p;
520 p = GNUNET_ATS_TEST_get_partner (op->src_id, op->dest_id);
527 fprintf (stderr, "Found master %llu slave %llu\n",op->src_id, op->dest_id);
531 fprintf (stderr, "Stopping preference between master %llu slave %llu\n",
532 op->src_id, op->dest_id);
533 GNUNET_ATS_TEST_generate_preferences_stop (p->pg);
539 static void enforce_episode (struct Episode *ep)
541 struct GNUNET_ATS_TEST_Operation *cur;
542 for (cur = ep->head; NULL != cur; cur = cur->next)
545 fprintf (stderr, "Enforcing operation: %s [%llu]->[%llu] == %llu\n",
546 print_op (cur->type), cur->src_id, cur->dest_id, cur->base_rate);
549 enforce_start_send (cur);
552 enforce_stop_send (cur);
554 case START_PREFERENCE:
555 enforce_start_preference (cur);
557 case STOP_PREFERENCE:
558 enforce_stop_preference (cur);
567 timeout_episode (void *cls, const struct GNUNET_SCHEDULER_TaskContext* tc)
569 struct Experiment *e = cls;
570 e->episode_timeout_task = GNUNET_SCHEDULER_NO_TASK;
571 if (NULL != e->ep_done_cb)
572 e->ep_done_cb (e->cur);
574 /* Scheduling next */
575 e->cur = e->cur->next;
579 fprintf (stderr, "Last episode done!\n");
580 if (GNUNET_SCHEDULER_NO_TASK != e->experiment_timeout_task)
582 GNUNET_SCHEDULER_cancel (e->experiment_timeout_task);
583 e->experiment_timeout_task = GNUNET_SCHEDULER_NO_TASK;
585 e->e_done_cb (e, GNUNET_TIME_absolute_get_duration(e->start_time), GNUNET_OK);
589 fprintf (stderr, "Running episode %u with timeout %s\n",
591 GNUNET_STRINGS_relative_time_to_string(e->cur->duration, GNUNET_YES));
592 enforce_episode(e->cur);
594 e->episode_timeout_task = GNUNET_SCHEDULER_add_delayed (e->cur->duration,
595 &timeout_episode, e);
600 GNUNET_ATS_solvers_experimentation_run (struct Experiment *e,
601 GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb,
602 GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb)
604 fprintf (stderr, "Running experiment `%s' with timeout %s\n", e->name,
605 GNUNET_STRINGS_relative_time_to_string(e->max_duration, GNUNET_YES));
606 e->e_done_cb = e_done_cb;
607 e->ep_done_cb = ep_done_cb;
608 e->start_time = GNUNET_TIME_absolute_get();
610 /* Start total time out */
611 e->experiment_timeout_task = GNUNET_SCHEDULER_add_delayed (e->max_duration,
612 &timeout_experiment, e);
616 fprintf (stderr, "Running episode %u with timeout %s\n",
618 GNUNET_STRINGS_relative_time_to_string(e->cur->duration, GNUNET_YES));
619 enforce_episode(e->cur);
620 e->episode_timeout_task = GNUNET_SCHEDULER_add_delayed (e->cur->duration,
621 &timeout_episode, e);
628 GNUNET_ATS_solvers_experimentation_load (char *filename)
630 struct Experiment *e;
631 struct GNUNET_CONFIGURATION_Handle *cfg;
634 cfg = GNUNET_CONFIGURATION_create();
635 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_load (cfg, filename))
637 fprintf (stderr, "Failed to load `%s'\n", filename);
638 GNUNET_CONFIGURATION_destroy (cfg);
642 e = create_experiment ();
644 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_string(cfg, "experiment",
647 fprintf (stderr, "Invalid %s", "name");
652 fprintf (stderr, "Experiment name: `%s'\n", e->name);
654 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_filename (cfg, "experiment",
655 "cfg_file", &e->cfg_file))
657 fprintf (stderr, "Invalid %s", "cfg_file");
662 fprintf (stderr, "Experiment name: `%s'\n", e->cfg_file);
664 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number(cfg, "experiment",
665 "masters", &e->num_masters))
667 fprintf (stderr, "Invalid %s", "masters");
672 fprintf (stderr, "Experiment masters: `%llu'\n",
675 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_number(cfg, "experiment",
676 "slaves", &e->num_slaves))
678 fprintf (stderr, "Invalid %s", "slaves");
683 fprintf (stderr, "Experiment slaves: `%llu'\n",
686 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time(cfg, "experiment",
687 "log_freq", &e->log_freq))
689 fprintf (stderr, "Invalid %s", "log_freq");
694 fprintf (stderr, "Experiment logging frequency: `%s'\n",
695 GNUNET_STRINGS_relative_time_to_string (e->log_freq, GNUNET_YES));
697 if (GNUNET_SYSERR == GNUNET_CONFIGURATION_get_value_time(cfg, "experiment",
698 "max_duration", &e->max_duration))
700 fprintf (stderr, "Invalid %s", "max_duration");
705 fprintf (stderr, "Experiment duration: `%s'\n",
706 GNUNET_STRINGS_relative_time_to_string (e->max_duration, GNUNET_YES));
708 load_episodes (e, cfg);
709 fprintf (stderr, "Loaded %u episodes with total duration %s\n",
711 GNUNET_STRINGS_relative_time_to_string (e->total_duration, GNUNET_YES));
713 GNUNET_CONFIGURATION_destroy (cfg);
718 GNUNET_ATS_solvers_experimentation_stop (struct Experiment *e)
720 if (GNUNET_SCHEDULER_NO_TASK != e->experiment_timeout_task)
722 GNUNET_SCHEDULER_cancel (e->experiment_timeout_task);
723 e->experiment_timeout_task = GNUNET_SCHEDULER_NO_TASK;
725 if (GNUNET_SCHEDULER_NO_TASK != e->episode_timeout_task)
727 GNUNET_SCHEDULER_cancel (e->episode_timeout_task);
728 e->episode_timeout_task = GNUNET_SCHEDULER_NO_TASK;
737 struct GNUNET_ATS_TESTING_SolverHandle
740 struct GNUNET_ATS_PluginEnvironment env;
744 enum GNUNET_ATS_Solvers
746 GNUNET_ATS_SOLVER_PROPORTIONAL,
747 GNUNET_ATS_SOLVER_MLP,
748 GNUNET_ATS_SOLVER_RIL,
752 GNUNET_ATS_solvers_solver_stop (struct GNUNET_ATS_TESTING_SolverHandle *sh)
754 GNUNET_PLUGIN_unload (sh->plugin, sh->solver);
755 GNUNET_free (sh->plugin);
759 struct GNUNET_ATS_TESTING_SolverHandle *
760 GNUNET_ATS_solvers_solver_start (enum GNUNET_ATS_Solvers type)
762 struct GNUNET_ATS_TESTING_SolverHandle *sh;
766 case GNUNET_ATS_SOLVER_PROPORTIONAL:
767 solver_str = "proportional";
769 case GNUNET_ATS_SOLVER_MLP:
772 case GNUNET_ATS_SOLVER_RIL:
781 sh = GNUNET_new (struct GNUNET_ATS_TESTING_SolverHandle);
782 GNUNET_asprintf (&sh->plugin, "libgnunet_plugin_ats_%s", solver_str);
783 //sh->solver = GNUNET_PLUGIN_load (sh->plugin, &sh->env);
784 if (NULL == sh->solver)
786 fprintf (stderr, "Failed to load solver `%s'\n", sh->plugin);
793 static struct Experiment *e;
795 static struct GNUNET_ATS_TESTING_SolverHandle *sh;
798 * cmd option -e: experiment file
800 static char *opt_exp_file;
802 static char *opt_solver;
805 * cmd option -l: enable logging
810 * cmd option -p: enable plots
815 * cmd option -v: verbose logs
817 static int opt_verbose;
820 run (void *cls, char * const *args, const char *cfgfile,
821 const struct GNUNET_CONFIGURATION_Handle *cfg)
823 enum GNUNET_ATS_Solvers solver;
825 if (NULL == opt_exp_file)
827 fprintf (stderr, "No experiment given ...\n");
831 if (NULL == opt_solver)
833 fprintf (stderr, "No solver given ...\n");
837 if (0 == strcmp(opt_solver, "mlp"))
839 solver = GNUNET_ATS_SOLVER_MLP;
841 else if (0 == strcmp(opt_solver, "proportional"))
843 solver = GNUNET_ATS_SOLVER_PROPORTIONAL;
845 else if (0 == strcmp(opt_solver, "ril"))
847 solver = GNUNET_ATS_SOLVER_RIL;
851 fprintf (stderr, "No solver given ...");
855 /* load experiment */
856 e = GNUNET_ATS_solvers_experimentation_load (opt_exp_file);
859 fprintf (stderr, "Failed to load experiment ...\n");
864 sh = GNUNET_ATS_solvers_solver_start (solver);
867 fprintf (stderr, "Failed to start solver ...\n");
880 * Main function of the benchmark
882 * @param argc argument count
883 * @param argv argument values
886 main (int argc, char *argv[])
892 opt_plot = GNUNET_NO;
894 static struct GNUNET_GETOPT_CommandLineOption options[] =
896 { 's', "solver", NULL,
897 gettext_noop ("solver to use"),
898 1, &GNUNET_GETOPT_set_string, &opt_solver},
899 { 'e', "experiment", NULL,
900 gettext_noop ("experiment to use"),
901 1, &GNUNET_GETOPT_set_string, &opt_exp_file},
902 { 'e', "experiment", NULL,
903 gettext_noop ("experiment to use"),
904 1, &GNUNET_GETOPT_set_one, &opt_verbose},
905 GNUNET_GETOPT_OPTION_END
908 GNUNET_PROGRAM_run (argc, argv, argv[0], NULL, options, &run, argv[0]);
912 /* end of file ats-testing-experiment.c*/