2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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 transport/test_quota_compliance.c
22 * @brief base test case for transport implementations
24 * This test case tests quota compliance both on transport level
27 #include "gnunet_common.h"
28 #include "gnunet_hello_lib.h"
29 #include "gnunet_getopt_lib.h"
30 #include "gnunet_os_lib.h"
31 #include "gnunet_program_lib.h"
32 #include "gnunet_scheduler_lib.h"
33 #include "gnunet_server_lib.h"
34 #include "gnunet_transport_service.h"
36 #include "transport.h"
37 #include "transport-testing.h"
39 #define VERBOSE GNUNET_NO
41 #define VERBOSE_ARM GNUNET_EXTRA_LOGGING
43 #define START_ARM GNUNET_YES
48 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
51 * How long until we give up on transmitting the message?
53 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 20)
55 #define DURATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
57 static char *test_source;
59 static char *test_plugin;
61 static char *test_name;
65 static GNUNET_SCHEDULER_TaskIdentifier die_task;
67 static GNUNET_SCHEDULER_TaskIdentifier measure_task;
69 struct PeerContext *p1;
71 struct PeerContext *p2;
73 struct PeerContext *sender;
75 struct PeerContext *receiver;
77 struct GNUNET_TRANSPORT_TransmitHandle *th;
81 unsigned long long quota_in_p1;
82 unsigned long long quota_out_p1;
86 unsigned long long quota_in_p2;
87 unsigned long long quota_out_p2;
89 struct GNUNET_TRANSPORT_TESTING_handle *tth;
91 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
95 * Testcase specific declarations
99 * Note that this value must not significantly exceed
100 * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
101 * messages may be dropped even for a reliable transport.
103 #define TOTAL_MSGS (1024 * 2)
109 struct GNUNET_MessageHeader header;
113 static int msg_scheduled;
115 static int msg_recv_expected;
118 static int test_failed;
119 static int test_connected;
121 static unsigned long long total_bytes_sent;
123 static struct GNUNET_TIME_Absolute start_time;
126 * END Testcase specific declarations
130 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
132 #define OKPP do { ok++; } while (0)
139 unsigned long long delta;
140 unsigned long long datarate;
142 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
144 delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value;
145 datarate = (total_bytes_sent * 1000) / delta;
147 fprintf (stderr, "Throughput was %llu b/s\n", datarate);
149 test_failed = GNUNET_NO;
150 if (datarate > quota_in_p2)
152 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
153 "Datarate of %llu b/s higher than allowed inbound quota of %llu b/s\n",
154 datarate, quota_in_p2);
155 test_failed = GNUNET_YES;
157 if (datarate > quota_out_p1)
159 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
160 "Datarate of %llu b/s higher than allowed outbound quota of %llu b/s\n",
161 datarate, quota_out_p1);
162 test_failed = GNUNET_YES;
164 if (test_failed == GNUNET_NO)
166 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
167 "Datarate of %llu b/s complied to allowed outbound quota of %llu b/s and inbound quota of %llu b/s\n",
168 datarate, quota_out_p1, quota_in_p2);
171 if (die_task != GNUNET_SCHEDULER_NO_TASK)
172 GNUNET_SCHEDULER_cancel (die_task);
175 GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
179 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
181 GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
182 GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
189 die_task = GNUNET_SCHEDULER_NO_TASK;
190 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
192 if (measure_task != GNUNET_SCHEDULER_NO_TASK)
193 GNUNET_SCHEDULER_cancel (measure_task);
195 if (test_connected == GNUNET_YES)
196 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Peers got connected\n");
198 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Peers got NOT connected\n");
201 GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
205 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
208 GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
210 GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
217 get_size (unsigned int iter)
221 ret = (iter * iter * iter);
222 return sizeof (struct TestMessage) + (ret % 60000);
227 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
228 const struct GNUNET_MessageHeader *message,
229 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
233 char cbuf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
234 const struct TestMessage *hdr;
236 hdr = (const struct TestMessage *) message;
238 if (MTYPE != ntohs (message->type))
240 msg_recv_expected = n;
241 msg_recv = ntohl (hdr->num);
242 if (ntohs (message->size) != (s))
244 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
245 "Expected message %u of size %u, got %u bytes of message %u\n",
246 n, s, ntohs (message->size), ntohl (hdr->num));
247 if (die_task != GNUNET_SCHEDULER_NO_TASK)
248 GNUNET_SCHEDULER_cancel (die_task);
249 test_failed = GNUNET_YES;
250 die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
253 if (ntohl (hdr->num) != n)
255 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
256 "Expected message %u of size %u, got %u bytes of message %u\n",
257 n, s, ntohs (message->size), ntohl (hdr->num));
258 if (die_task != GNUNET_SCHEDULER_NO_TASK)
259 GNUNET_SCHEDULER_cancel (die_task);
260 test_failed = GNUNET_YES;
261 die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
264 memset (cbuf, n, s - sizeof (struct TestMessage));
265 if (0 != memcmp (cbuf, &hdr[1], s - sizeof (struct TestMessage)))
267 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
268 "Expected message %u with bits %u, but body did not match\n", n,
270 if (die_task != GNUNET_SCHEDULER_NO_TASK)
271 GNUNET_SCHEDULER_cancel (die_task);
272 test_failed = GNUNET_YES;
273 die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
277 if (ntohl (hdr->num) % 5000 == 0)
279 struct PeerContext *p = cls;
280 char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
282 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
283 "Peer %u (`%s') got message %u of size %u from peer (`%s')\n",
284 p->no, ps, ntohl (hdr->num), ntohs (message->size),
294 notify_ready (void *cls, size_t size, void *buf)
298 struct TestMessage hdr;
305 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
306 "Timeout occurred while waiting for transmit_ready for message %u of %u\n",
307 msg_scheduled, TOTAL_MSGS);
308 if (GNUNET_SCHEDULER_NO_TASK != die_task)
309 GNUNET_SCHEDULER_cancel (die_task);
310 die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
317 GNUNET_assert (size >= s);
318 GNUNET_assert (buf != NULL);
322 hdr.header.size = htons (s);
323 hdr.header.type = htons (MTYPE);
326 memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
327 ret += sizeof (struct TestMessage);
328 memset (&cbuf[ret], n, s - sizeof (struct TestMessage));
329 ret += s - sizeof (struct TestMessage);
334 char *receiver_s = GNUNET_strdup (GNUNET_i2s (&receiver->id));
336 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
337 "Sending message of size %u from peer %u (`%4s') -> peer %u (`%s') !\n",
338 n, sender->no, GNUNET_i2s (&sender->id), receiver->no,
340 GNUNET_free (receiver_s);
345 if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
346 break; /* sometimes pack buffer full, sometimes not */
348 while (size - ret >= s);
352 th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, s, 0,
354 ¬ify_ready, NULL);
359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
360 "Returning total message block of size %u\n", ret);
362 total_bytes_sent += ret;
365 fprintf (stderr, "\n");
366 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "All messages sent\n");
373 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
374 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
377 struct PeerContext *p = cls;
379 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%4s') connected to us!\n",
380 p->no, GNUNET_i2s (peer));
385 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
387 struct PeerContext *p = cls;
389 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%4s') disconnected!\n", p->no,
392 GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
400 start_time = GNUNET_TIME_absolute_get ();
401 th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, get_size (0), 0,
402 TIMEOUT_TRANSMIT, ¬ify_ready,
408 measure (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
412 measure_task = GNUNET_SCHEDULER_NO_TASK;
415 if ((DURATION.rel_value / 1000) < counter)
417 fprintf (stderr, ".\n");
418 GNUNET_SCHEDULER_add_now (&end, NULL);
422 fprintf (stderr, ".");
424 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &measure, NULL);
430 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
432 char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
434 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %u (%s) <-> %u (%s)\n",
435 p1->no, p1_c, p2->no, GNUNET_i2s (&p2->id));
439 test_connected = GNUNET_YES;
442 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &measure, NULL);
443 GNUNET_SCHEDULER_add_now (&sendtask, NULL);
448 start_cb (struct PeerContext *p, void *cls)
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
455 GNUNET_i2s (&p->id));
460 test_connected = GNUNET_NO;
465 char *sender_c = GNUNET_strdup (GNUNET_i2s (&sender->id));
467 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
468 "Test tries to send from %u (%s) -> peer %u (%s)\n", sender->no,
469 sender_c, receiver->no, GNUNET_i2s (&receiver->id));
471 cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
477 generate_config (char *cfg_file, unsigned long long quota_in,
478 unsigned long long quota_out)
481 struct GNUNET_CONFIGURATION_Handle *cfg = GNUNET_CONFIGURATION_create ();
483 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (cfg, cfg_file));
484 GNUNET_asprintf (&fname, "q_in_%llu_q_out_%llu_%s", quota_in, quota_out,
486 GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "DEFAULTCONFIG", fname);
487 GNUNET_CONFIGURATION_set_value_number (cfg, "core", "TOTAL_QUOTA_OUT",
489 GNUNET_CONFIGURATION_set_value_number (cfg, "core", "TOTAL_QUOTA_IN",
491 GNUNET_CONFIGURATION_set_value_number (cfg, "ats", "TOTAL_QUOTA_IN",
493 GNUNET_CONFIGURATION_set_value_number (cfg, "ats", "TOTAL_QUOTA_OUT",
495 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_write (cfg, fname));
496 GNUNET_CONFIGURATION_destroy (cfg);
501 run_measurement (unsigned long long p1_quota_in,
502 unsigned long long p1_quota_out,
503 unsigned long long p2_quota_in,
504 unsigned long long p2_quota_out)
506 die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
508 /* setting ATS quota */
509 quota_out_p1 = p1_quota_out;
510 gen_cfg_p1 = generate_config (cfg_file_p1, p1_quota_in, p1_quota_out);
511 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Generated config file `%s'\n",
514 quota_in_p2 = p2_quota_in;
515 gen_cfg_p2 = generate_config (cfg_file_p2, p2_quota_in, p2_quota_out);
516 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Generated config file `%s'\n",
519 p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, gen_cfg_p1, 1, ¬ify_receive,
520 ¬ify_connect, ¬ify_disconnect,
523 p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, gen_cfg_p2, 2, ¬ify_receive,
524 ¬ify_connect, ¬ify_disconnect,
527 if ((p1 == NULL) || (p2 == NULL))
529 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
530 if (die_task != GNUNET_SCHEDULER_NO_TASK)
531 GNUNET_SCHEDULER_cancel (die_task);
532 die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
538 run (void *cls, char *const *args, const char *cfgfile,
539 const struct GNUNET_CONFIGURATION_Handle *cfg)
541 unsigned long long p1_quota_in = 10000;
542 unsigned long long p1_quota_out = 10000;
543 unsigned long long p2_quota_in = 10000;
544 unsigned long long p2_quota_out = 10000;
546 if (NULL != strstr (test_name, "asymmetric"))
548 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
549 "Running asymmetric test with sending peer unlimited, receiving peer (in/out): %llu/%llu b/s \n",
550 p2_quota_in, p2_quota_out);
551 p1_quota_out = 1024 * 1024 * 1024;
552 p1_quota_in = 1024 * 1024 * 1024;
556 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
557 "Running symmetric test with (in/out) %llu/%llu b/s \n",
558 p2_quota_in, p2_quota_out);
560 run_measurement (p1_quota_in, p1_quota_out, p2_quota_in, p2_quota_out);
566 static char *argv[] = { "test_transport-quota-compliance",
574 static struct GNUNET_GETOPT_CommandLineOption options[] = {
575 GNUNET_GETOPT_OPTION_END
579 GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
580 "nohelp", options, &run, &ok);
586 main (int argc, char *argv[])
590 GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
592 GNUNET_log_setup (test_name,
600 GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
601 GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
604 tth = GNUNET_TRANSPORT_TESTING_init ();
606 if ((strcmp (test_plugin, "tcp_nat") == 0) ||
607 (strcmp (test_plugin, "udp_nat") == 0))
609 nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
610 if (GNUNET_NO == nat_res)
612 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
613 "gnunet-nat-server", "SUID not set");
616 if (GNUNET_SYSERR == nat_res)
618 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
619 "gnunet-nat-server", "file not found");
624 GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
625 GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
629 GNUNET_free (cfg_file_p1);
630 GNUNET_free (cfg_file_p2);
632 if (GNUNET_YES == GNUNET_DISK_file_test (gen_cfg_p1))
634 GNUNET_DISK_directory_remove (gen_cfg_p1);
635 GNUNET_free (gen_cfg_p1);
638 if (GNUNET_YES == GNUNET_DISK_file_test (gen_cfg_p2))
640 GNUNET_DISK_directory_remove (gen_cfg_p2);
641 GNUNET_free (gen_cfg_p2);
644 GNUNET_free (test_source);
645 GNUNET_free (test_plugin);
646 GNUNET_free (test_name);
648 GNUNET_TRANSPORT_TESTING_done (tth);
654 /* end of test_quota_compliance.c */