2 This file is part of GNUnet.
3 Copyright (C) 2010-2013, 2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @file ats/perf_ats.c
22 * @brief ats benchmark: start peers and modify preferences, monitor change over time
23 * @author Christian Grothoff
24 * @author Matthias Wachs
27 #include "gnunet_util_lib.h"
28 #include "gnunet_testbed_service.h"
29 #include "gnunet_ats_service.h"
30 #include "gnunet_core_service.h"
31 #include "ats-testing.h"
34 #define TEST_ATS_PREFRENCE_FREQUENCY GNUNET_TIME_relative_multiply ( \
35 GNUNET_TIME_UNIT_SECONDS, 1)
36 #define TEST_ATS_PREFRENCE_START 1.0
37 #define TEST_ATS_PREFRENCE_DELTA 1.0
39 #define TEST_MESSAGE_FREQUENCY GNUNET_TIME_relative_multiply ( \
40 GNUNET_TIME_UNIT_SECONDS, 1)
42 #define TEST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, \
44 #define BENCHMARK_DURATION GNUNET_TIME_relative_multiply ( \
45 GNUNET_TIME_UNIT_SECONDS, 10)
46 #define LOGGING_FREQUENCY GNUNET_TIME_relative_multiply ( \
47 GNUNET_TIME_UNIT_MILLISECONDS, 500)
48 #define TESTNAME_PREFIX "perf_ats_"
49 #define DEFAULT_SLAVES_NUM 2
50 #define DEFAULT_MASTERS_NUM 1
55 static struct GNUNET_SCHEDULER_Task *timeout_task;
60 static struct GNUNET_SCHEDULER_Task *progress_task;
73 * Test core (#GNUNET_YES) or transport (#GNUNET_NO)
85 static char *testname;
90 static char *pref_str;
93 * ATS preference value
100 static struct GNUNET_TIME_Relative perf_duration;
105 static struct GNUNET_TIME_Relative log_frequency;
108 * Number master peers
110 static unsigned int num_masters;
113 * Array of master peers
115 static struct BenchmarkPeer *mps;
120 static unsigned int num_slaves;
123 * Array of master peers
125 static struct BenchmarkPeer *sps;
127 static struct LoggingHandle *l;
135 unsigned int duration;
136 struct BenchmarkPeer *mp;
137 struct BenchmarkPartner *p;
139 unsigned int kb_sent_sec;
140 double kb_sent_percent;
141 unsigned int kb_recv_sec;
142 double kb_recv_percent;
145 duration = 1 + (perf_duration.rel_value_us / (1000 * 1000));
146 for (c_m = 0; c_m < num_masters; c_m++)
150 "Master [%u]: sent: %u KiB in %u sec. = %u KiB/s, received: %u KiB in %u sec. = %u KiB/s\n",
151 mp->no, mp->total_bytes_sent / 1024, duration,
152 (mp->total_bytes_sent / 1024) / duration,
153 mp->total_bytes_received / 1024, duration,
154 (mp->total_bytes_received / 1024) / duration);
156 for (c_s = 0; c_s < num_slaves; c_s++)
158 p = &mp->partners[c_s];
161 kb_sent_percent = 0.0;
162 kb_recv_percent = 0.0;
167 kb_sent_sec = (p->bytes_sent / 1024) / duration;
168 kb_recv_sec = (p->bytes_received / 1024) / duration;
171 if (mp->total_bytes_sent > 0)
172 kb_sent_percent = ((double) p->bytes_sent * 100) / mp->total_bytes_sent;
173 if (mp->total_bytes_received > 0)
174 kb_recv_percent = ((double) p->bytes_received * 100)
175 / mp->total_bytes_received;
176 if (1000 * p->messages_sent > 0)
177 rtt = p->total_app_rtt / (1000 * p->messages_sent);
179 "%c Master [%u] -> Slave [%u]: sent %u KiB/s (%.2f %%), received %u KiB/s (%.2f %%)\n",
180 (mp->pref_partner == p->dest) ? '*' : ' ',
182 kb_sent_sec, kb_sent_percent,
183 kb_recv_sec, kb_recv_percent);
185 "%c Master [%u] -> Slave [%u]: Average application layer RTT: %u ms\n",
186 (mp->pref_partner == p->dest) ? '*' : ' ',
187 mp->no, p->dest->no, rtt);
199 do_shutdown (void *cls)
201 if (GNUNET_YES == logging)
202 GNUNET_ATS_TEST_logging_clean_up (l);
203 if (NULL != timeout_task)
205 GNUNET_SCHEDULER_cancel (timeout_task);
208 if (NULL != progress_task)
210 fprintf (stderr, "0\n");
211 GNUNET_SCHEDULER_cancel (progress_task);
212 progress_task = NULL;
214 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
215 "Benchmarking done\n");
216 GNUNET_ATS_TEST_shutdown_topology ();
226 do_timeout (void *cls)
228 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
229 "Terminating with timeout\n");
232 GNUNET_SCHEDULER_shutdown ();
237 print_progress (void *cls)
241 progress_task = NULL;
244 (long long unsigned) perf_duration.rel_value_us / (1000 * 1000)
248 progress_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
255 ats_pref_task (void *cls)
257 struct BenchmarkPeer *me = cls;
261 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
262 " Master [%u] set preference for slave [%u] to %f\n",
263 me->no, me->pref_partner->no, me->pref_value);
264 GNUNET_ATS_performance_change_preference (me->ats_perf_handle,
265 &me->pref_partner->id,
266 pref_val, me->pref_value,
267 GNUNET_ATS_PREFERENCE_END);
268 me->pref_value += TEST_ATS_PREFRENCE_DELTA;
269 me->ats_task = GNUNET_SCHEDULER_add_delayed (TEST_ATS_PREFRENCE_FREQUENCY,
270 &ats_pref_task, cls);
275 start_benchmark (void *cls)
280 progress_task = GNUNET_SCHEDULER_add_now (&print_progress,
283 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
284 "Topology connected, start benchmarking...\n");
286 /* Start sending test messages */
287 for (c_m = 0; c_m < num_masters; c_m++)
289 for (c_s = 0; c_s < num_slaves; c_s++)
291 GNUNET_ATS_TEST_generate_traffic_start (&mps[c_m],
292 &mps[c_m].partners[c_s],
293 GNUNET_ATS_TEST_TG_LINEAR,
296 GNUNET_TIME_UNIT_MINUTES,
297 GNUNET_TIME_UNIT_FOREVER_REL);
299 if (pref_val != GNUNET_ATS_PREFERENCE_END)
300 mps[c_m].ats_task = GNUNET_SCHEDULER_add_now (&ats_pref_task,
304 if (GNUNET_YES == logging)
305 l = GNUNET_ATS_TEST_logging_start (log_frequency,
307 num_masters, num_slaves,
313 do_benchmark (void *cls,
314 struct BenchmarkPeer *masters,
315 struct BenchmarkPeer *slaves)
319 GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
321 timeout_task = GNUNET_SCHEDULER_add_delayed (perf_duration,
324 progress_task = GNUNET_SCHEDULER_add_now (&start_benchmark,
329 static struct BenchmarkPartner *
330 find_partner (struct BenchmarkPeer *me,
331 const struct GNUNET_PeerIdentity *peer)
335 GNUNET_assert (NULL != me);
336 GNUNET_assert (NULL != peer);
338 for (c_m = 0; c_m < me->num_partners; c_m++)
340 /* Find a partner with other as destination */
341 if (0 == GNUNET_memcmp (peer, &me->partners[c_m].dest->id))
343 return &me->partners[c_m];
351 log_request_cb (void *cls,
352 const struct GNUNET_HELLO_Address *address,
354 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
355 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
356 const struct GNUNET_ATS_Properties *ats)
358 struct BenchmarkPeer *me = cls;
359 struct BenchmarkPartner *p;
362 p = find_partner (me, &address->peer);
365 /* This is not one of my partners
366 * Will happen since the peers will connect to each other due to gossiping
370 peer_id = GNUNET_strdup (GNUNET_i2s (&me->id));
372 if ((p->bandwidth_in != ntohl (bandwidth_in.value__)) ||
373 (p->bandwidth_out != ntohl (bandwidth_out.value__)))
374 p->bandwidth_in = ntohl (bandwidth_in.value__);
375 p->bandwidth_out = ntohl (bandwidth_out.value__);
377 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
378 "%s [%u] received ATS information for peers `%s'\n",
379 (GNUNET_YES == p->me->master) ? "Master" : "Slave",
381 GNUNET_i2s (&p->dest->id));
383 GNUNET_free (peer_id);
385 GNUNET_ATS_TEST_logging_now (l);
390 * Start the performance test case
393 main (int argc, char *argv[])
401 char *prefs[] = GNUNET_ATS_PreferenceTypeString;
406 /* Determine testname
407 * perf_ats_<solver>_<transport>_<preference>[.exe]*/
409 /* Find test prefix, store in temp */
410 tmp = strstr (argv[0], TESTNAME_PREFIX);
413 fprintf (stderr, "Unable to parse test name `%s'\n", argv[0]);
414 return GNUNET_SYSERR;
417 /* Set tmp to end of test name prefix */
418 tmp += strlen (TESTNAME_PREFIX);
420 /* Determine solver name */
421 solver = GNUNET_strdup (tmp);
422 /* Remove .exe prefix */
423 if ((NULL != (dotexe = strstr (solver, ".exe"))) && (dotexe[4] == '\0'))
426 /* Determine first '_' after solver */
427 tmp_sep = strchr (solver, '_');
430 fprintf (stderr, "Unable to parse test name `%s'\n", argv[0]);
431 GNUNET_free (solver);
432 return GNUNET_SYSERR;
435 comm_name = GNUNET_strdup (&tmp_sep[1]);
436 tmp_sep = strchr (comm_name, '_');
439 fprintf (stderr, "Unable to parse test name `%s'\n", argv[0]);
440 GNUNET_free (solver);
441 return GNUNET_SYSERR;
444 for (c = 0; c <= strlen (comm_name); c++)
445 comm_name[c] = toupper (comm_name[c]);
446 if (0 == strcmp (comm_name, "CORE"))
447 test_core = GNUNET_YES;
448 else if (0 == strcmp (comm_name, "TRANSPORT"))
449 test_core = GNUNET_NO;
452 GNUNET_free (comm_name);
453 GNUNET_free (solver);
454 return GNUNET_SYSERR;
457 pref_str = GNUNET_strdup (tmp_sep + 1);
459 GNUNET_asprintf (&conf_name, "%s%s_%s.conf", TESTNAME_PREFIX, solver,
461 GNUNET_asprintf (&test_name, "%s%s_%s", TESTNAME_PREFIX, solver, pref_str);
463 for (c = 0; c <= strlen (pref_str); c++)
464 pref_str[c] = toupper (pref_str[c]);
467 if (0 != strcmp (pref_str, "NONE"))
469 for (c = 0; c < GNUNET_ATS_PREFERENCE_END; c++)
471 if (0 == strcmp (pref_str, prefs[c]))
480 /* abuse terminator to indicate no pref */
481 pref_val = GNUNET_ATS_PREFERENCE_END;
485 fprintf (stderr, "Unknown preference: `%s'\n", pref_str);
486 GNUNET_free (solver);
487 GNUNET_free (pref_str);
488 GNUNET_free (comm_name);
492 for (c = 0; c < (argc - 1); c++)
494 if (0 == strcmp (argv[c], "-d"))
499 if (GNUNET_OK != GNUNET_STRINGS_fancy_time_to_relative (argv[c + 1],
501 fprintf (stderr, "Failed to parse duration `%s'\n", argv[c + 1]);
505 perf_duration = BENCHMARK_DURATION;
507 fprintf (stderr, "Running benchmark for %llu secs\n", (unsigned long
508 long) (perf_duration.
512 for (c = 0; c < (argc - 1); c++)
514 if (0 == strcmp (argv[c], "-s"))
519 if ((0L != (num_slaves = strtol (argv[c + 1], NULL, 10)))
520 && (num_slaves >= 1))
521 fprintf (stderr, "Starting %u slave peers\n", num_slaves);
523 num_slaves = DEFAULT_SLAVES_NUM;
526 num_slaves = DEFAULT_SLAVES_NUM;
528 for (c = 0; c < (argc - 1); c++)
530 if (0 == strcmp (argv[c], "-m"))
535 if ((0L != (num_masters = strtol (argv[c + 1], NULL, 10)))
536 && (num_masters >= 2))
537 fprintf (stderr, "Starting %u master peers\n", num_masters);
539 num_masters = DEFAULT_MASTERS_NUM;
542 num_masters = DEFAULT_MASTERS_NUM;
545 for (c = 0; c < argc; c++)
547 if (0 == strcmp (argv[c], "-l"))
548 logging = GNUNET_YES;
551 if (GNUNET_YES == logging)
553 for (c = 0; c < (argc - 1); c++)
555 if (0 == strcmp (argv[c], "-f"))
560 if (GNUNET_OK != GNUNET_STRINGS_fancy_time_to_relative (argv[c + 1],
562 fprintf (stderr, "Failed to parse duration `%s'\n", argv[c + 1]);
566 log_frequency = LOGGING_FREQUENCY;
568 fprintf (stderr, "Using log frequency %llu ms\n",
569 (unsigned long long) (log_frequency.rel_value_us) / (1000));
572 GNUNET_asprintf (&testname, "%s_%s_%s", solver, comm_name, pref_str);
574 if (num_slaves < num_masters)
577 "Number of master peers is lower than slaves! exit...\n");
578 GNUNET_free (test_name);
579 GNUNET_free (solver);
580 GNUNET_free (pref_str);
581 GNUNET_free (comm_name);
582 return GNUNET_SYSERR;
588 GNUNET_ATS_TEST_create_topology ("perf-ats",
601 /* end of file perf_ats.c */