2 This file is part of GNUnet.
3 (C) 2009, 2010 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 core and 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"
35 #include "transport.h"
37 #define VERBOSE GNUNET_YES
39 #define VERBOSE_ARM GNUNET_NO
41 #define START_ARM GNUNET_YES
42 #define DEBUG_MEASUREMENT GNUNET_NO
43 #define DEBUG_CONNECTIONS GNUNET_NO
45 #define MEASUREMENT_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
46 #define MEASUREMENT_MSG_SIZE 10000
47 #define MEASUREMENT_MSG_SIZE_BIG 32768
48 #define MEASUREMENT_MAX_QUOTA 1024 * 1024 * 1024
49 #define MEASUREMENT_MIN_QUOTA 1024 * 10
50 #define SEND_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 35)
54 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 200)
62 struct GNUNET_CONFIGURATION_Handle *cfg;
63 struct GNUNET_TRANSPORT_Handle *th;
64 struct GNUNET_PeerIdentity id;
71 * Handle for a transmission-ready request.
73 struct GNUNET_TRANSPORT_TransmitHandle
77 * Neighbour for this handle, NULL for control-traffic.
79 struct NeighbourList *neighbour;
82 * Function to call when notify_size bytes are available
85 GNUNET_CONNECTION_TransmitReadyNotify notify;
93 * transmit_ready task Id. The task is used to introduce the
94 * artificial delay that may be required to maintain the bandwidth
95 * limits. Later, this will be the ID of the "transmit_timeout"
96 * task which is used to signal a timeout if the transmission could
97 * not be done in a timely fashion.
99 GNUNET_SCHEDULER_TaskIdentifier notify_delay_task;
102 * Timeout for this request.
104 struct GNUNET_TIME_Absolute timeout;
107 * How many bytes is our notify callback waiting for?
112 * How important is this message?
114 unsigned int priority;
118 static struct PeerContext p1;
120 static struct PeerContext p2;
122 static struct GNUNET_SCHEDULER_Handle *sched;
126 static int connected;
127 static int measurement_running;
128 static int send_running;
129 static int recv_running;
131 static unsigned long long total_bytes;
132 static unsigned long long current_quota_p1;
133 static unsigned long long current_quota_p2;
136 static int is_tcp_nat;
140 static int is_asymmetric_send_constant;
141 static int is_asymmetric_recv_constant;
143 static struct GNUNET_TIME_Absolute start_time;
145 static GNUNET_SCHEDULER_TaskIdentifier die_task;
146 static GNUNET_SCHEDULER_TaskIdentifier measurement_task;
147 static GNUNET_SCHEDULER_TaskIdentifier measurement_counter_task;
149 struct GNUNET_TRANSPORT_TransmitHandle * transmit_handle;
152 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
154 #define OKPP do { ok++; } while (0)
168 GNUNET_SCHEDULER_cancel (sched, die_task);
169 die_task = GNUNET_SCHEDULER_NO_TASK;
171 if (measurement_task != GNUNET_SCHEDULER_NO_TASK)
173 GNUNET_SCHEDULER_cancel (sched, measurement_task);
174 measurement_task = GNUNET_SCHEDULER_NO_TASK;
176 if (measurement_counter_task != GNUNET_SCHEDULER_NO_TASK)
178 GNUNET_SCHEDULER_cancel (sched, measurement_counter_task);
179 measurement_counter_task = GNUNET_SCHEDULER_NO_TASK;
181 GNUNET_SCHEDULER_shutdown (sched);
182 #if DEBUG_CONNECTIONS
183 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from transports!\n");
185 GNUNET_TRANSPORT_disconnect (p1.th);
186 GNUNET_TRANSPORT_disconnect (p2.th);
187 #if DEBUG_CONNECTIONS
188 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
189 "Transports disconnected, returning success!\n");
191 GNUNET_SCHEDULER_shutdown (sched);
197 stop_arm (struct PeerContext *p)
200 if (0 != PLIBC_KILL (p->arm_pid, SIGTERM))
201 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
202 GNUNET_OS_process_wait (p->arm_pid);
204 GNUNET_CONFIGURATION_destroy (p->cfg);
209 end_badly (void *cls,
210 const struct GNUNET_SCHEDULER_TaskContext *tc)
212 if (measurement_task != GNUNET_SCHEDULER_NO_TASK)
214 GNUNET_SCHEDULER_cancel (sched, measurement_task);
215 measurement_task = GNUNET_SCHEDULER_NO_TASK;
217 if (measurement_counter_task != GNUNET_SCHEDULER_NO_TASK)
219 GNUNET_SCHEDULER_cancel (sched, measurement_counter_task);
220 measurement_counter_task = GNUNET_SCHEDULER_NO_TASK;
224 GNUNET_TRANSPORT_disconnect (p1.th);
226 GNUNET_TRANSPORT_disconnect (p2.th);
232 struct GNUNET_MessageHeader header;
237 get_size (unsigned int iter)
239 return MEASUREMENT_MSG_SIZE + sizeof (struct TestMessage);
243 notify_receive_new (void *cls,
244 const struct GNUNET_PeerIdentity *peer,
245 const struct GNUNET_MessageHeader *message,
246 struct GNUNET_TIME_Relative latency,
251 const struct TestMessage *hdr;
253 hdr = (const struct TestMessage*) message;
255 if (measurement_running == GNUNET_NO)
257 if (MTYPE != ntohs (message->type))
259 #if DEBUG_MEASUREMENT
260 if (ntohl(hdr->num) % 5000 == 0)
262 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
263 "Got message %u of size %u\n",
265 ntohs (message->size));
272 notify_ready_new (void *cls, size_t size, void *buf)
276 struct TestMessage hdr;
280 transmit_handle = NULL;
282 if (measurement_task == GNUNET_SCHEDULER_NO_TASK)
291 if (measurement_running != GNUNET_YES)
293 send_running = GNUNET_NO;
298 send_running = GNUNET_YES;
301 GNUNET_assert (size >= s);
302 GNUNET_assert (buf != NULL);
306 hdr.header.size = htons (s);
307 hdr.header.type = htons (MTYPE);
309 memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
310 ret += sizeof (struct TestMessage);
311 memset (&cbuf[ret], n, s - sizeof (struct TestMessage));
312 ret += s - sizeof (struct TestMessage);
313 #if DEBUG_MEASUREMENT
316 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
317 "Sending message %u\n",n);
322 if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
323 break; /* sometimes pack buffer full, sometimes not */
325 while (size - ret >= s);
326 transmit_handle = GNUNET_TRANSPORT_notify_transmit_ready (p2.th,
335 static void measure (unsigned long long quota_p1, unsigned long long quota_p2 );
337 static void measurement_counter
339 const struct GNUNET_SCHEDULER_TaskContext *tc)
341 measurement_counter_task = GNUNET_SCHEDULER_NO_TASK;
343 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
349 measurement_counter_task = GNUNET_SCHEDULER_add_delayed (sched,
350 GNUNET_TIME_UNIT_SECONDS,
351 &measurement_counter,
356 measurement_end (void *cls,
357 const struct GNUNET_SCHEDULER_TaskContext *tc)
359 measurement_task = GNUNET_SCHEDULER_NO_TASK;
360 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
363 measurement_running = GNUNET_NO;
364 struct GNUNET_TIME_Relative duration = GNUNET_TIME_absolute_get_difference(start_time, GNUNET_TIME_absolute_get());
367 if (measurement_counter_task != GNUNET_SCHEDULER_NO_TASK)
369 GNUNET_SCHEDULER_cancel (sched, measurement_counter_task);
370 measurement_counter_task = GNUNET_SCHEDULER_NO_TASK;
373 fprintf(stderr,"\n");
376 if (transmit_handle != NULL)
378 GNUNET_TRANSPORT_notify_transmit_ready_cancel(transmit_handle);
379 transmit_handle = NULL;
382 if ((total_bytes/(duration.rel_value / 1000)) > (current_quota_p1 + (current_quota_p1 / 10)))
384 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
385 "\nQuota compliance failed: \n"\
386 "Quota allowed: %10llu kB/s\n"\
387 "Throughput : %10llu kB/s\n", (current_quota_p1 / (1024)) , (total_bytes/(duration.rel_value / 1000)/1024));
395 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
396 "\nQuota compliance ok: \n"\
397 "Quota allowed: %10llu kB/s\n"\
398 "Throughput : %10llu kB/s\n", (current_quota_p1 / (1024)) , (total_bytes/(duration.rel_value / 1000)/1024));
402 if ((current_quota_p1 < MEASUREMENT_MIN_QUOTA) || (current_quota_p2 < MEASUREMENT_MIN_QUOTA))
410 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
411 "Scheduling next measurement\n");
413 if (is_asymmetric_send_constant == GNUNET_YES)
414 measure (current_quota_p1 / 10, MEASUREMENT_MAX_QUOTA);
415 else if (is_asymmetric_recv_constant == GNUNET_YES)
416 measure (MEASUREMENT_MAX_QUOTA, current_quota_p2 / 10);
418 measure (current_quota_p1 / 10, current_quota_p2 / 10);
422 static void measure (unsigned long long quota_p1, unsigned long long quota_p2 )
424 current_quota_p1 = quota_p1;
425 current_quota_p2 = quota_p2;
427 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
428 "Starting transport level measurement for %u seconds and p1 quota %llu kB/s p2 quota %llu\n", MEASUREMENT_INTERVALL.rel_value / 1000 , current_quota_p1 / 1024, current_quota_p2 / 1024);
430 GNUNET_TRANSPORT_set_quota (p1.th,
432 GNUNET_BANDWIDTH_value_init (current_quota_p1 ),
433 GNUNET_BANDWIDTH_value_init (current_quota_p1 ),
434 GNUNET_TIME_UNIT_FOREVER_REL,
436 GNUNET_TRANSPORT_set_quota (p2.th,
438 GNUNET_BANDWIDTH_value_init (current_quota_p2),
439 GNUNET_BANDWIDTH_value_init (current_quota_p2),
440 GNUNET_TIME_UNIT_FOREVER_REL,
443 GNUNET_SCHEDULER_cancel (sched, die_task);
444 die_task = GNUNET_SCHEDULER_add_delayed (sched,
448 if (measurement_counter_task != GNUNET_SCHEDULER_NO_TASK)
449 GNUNET_SCHEDULER_cancel (sched, measurement_counter_task);
450 measurement_counter_task = GNUNET_SCHEDULER_add_delayed (sched,
451 GNUNET_TIME_UNIT_SECONDS,
452 &measurement_counter,
454 measurement_task = GNUNET_SCHEDULER_add_delayed (sched,
455 MEASUREMENT_INTERVALL,
459 measurement_running = GNUNET_YES;
460 start_time = GNUNET_TIME_absolute_get ();
462 if (transmit_handle != NULL)
463 GNUNET_TRANSPORT_notify_transmit_ready_cancel(transmit_handle);
464 transmit_handle = GNUNET_TRANSPORT_notify_transmit_ready (p2.th,
466 get_size (0), 0, SEND_TIMEOUT,
472 notify_connect (void *cls,
473 const struct GNUNET_PeerIdentity *peer,
474 struct GNUNET_TIME_Relative latency,
479 #if DEBUG_CONNECTIONS
480 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
481 "Peer 1 `%4s' connected to us (%p)!\n", GNUNET_i2s (peer), cls);
487 #if DEBUG_CONNECTIONS
488 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
489 "Peer 2 `%4s' connected to us (%p)!\n", GNUNET_i2s (peer), cls);
495 measure(MEASUREMENT_MAX_QUOTA,MEASUREMENT_MAX_QUOTA);
501 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
503 #if DEBUG_CONNECTIONS
504 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
505 "Peer `%4s' disconnected (%p)!\n",
506 GNUNET_i2s (peer), cls);
512 setup_peer (struct PeerContext *p, const char *cfgname)
514 p->cfg = GNUNET_CONFIGURATION_create ();
516 p->arm_pid = GNUNET_OS_start_process (NULL, NULL,
517 "gnunet-service-arm",
518 "gnunet-service-arm",
522 "-c", cfgname, NULL);
525 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
526 p->th = GNUNET_TRANSPORT_connect (sched, p->cfg, NULL,
531 GNUNET_assert (p->th != NULL);
536 exchange_hello_last (void *cls,
537 const struct GNUNET_MessageHeader *message)
539 struct PeerContext *me = cls;
541 GNUNET_TRANSPORT_get_hello_cancel (p2.th, &exchange_hello_last, me);
543 GNUNET_assert (ok >= 3);
545 GNUNET_assert (message != NULL);
546 GNUNET_assert (GNUNET_OK ==
547 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
549 /* both HELLOs exchanged, get ready to test transmission! */
554 exchange_hello (void *cls,
555 const struct GNUNET_MessageHeader *message)
557 struct PeerContext *me = cls;
559 GNUNET_TRANSPORT_get_hello_cancel (p1.th, &exchange_hello, me);
560 GNUNET_assert (ok >= 2);
562 GNUNET_assert (message != NULL);
563 GNUNET_assert (GNUNET_OK ==
564 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
566 GNUNET_TRANSPORT_offer_hello (p2.th, message);
567 GNUNET_TRANSPORT_get_hello (p2.th, &exchange_hello_last, &p2);
572 struct GNUNET_SCHEDULER_Handle *s,
574 const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
576 GNUNET_assert (ok == 1);
580 die_task = GNUNET_SCHEDULER_add_delayed (sched,
584 measurement_running = GNUNET_NO;
585 send_running = GNUNET_NO;
586 recv_running = GNUNET_NO;
590 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing quota compliance for TCP transport plugin\n");
591 setup_peer (&p1, "test_quota_compliance_tcp_peer1.conf");
592 setup_peer (&p2, "test_quota_compliance_tcp_peer2.conf");
596 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing quota compliance for HTTP transport plugin\n");
597 setup_peer (&p1, "test_quota_compliance_http_peer1.conf");
598 setup_peer (&p2, "test_quota_compliance_http_peer2.conf");
602 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing quota compliance for HTTPS transport plugin\n");
603 setup_peer (&p1, "test_quota_compliance_https_peer1.conf");
604 setup_peer (&p2, "test_quota_compliance_https_peer2.conf");
608 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing quota compliance for UDP transport plugin\n");
609 setup_peer (&p1, "test_quota_compliance_udp_peer1.conf");
610 setup_peer (&p2, "test_quota_compliance_udp_peer2.conf");
614 setup_peer (&p1, "test_quota_compliance_tcp_peer1.conf");
615 setup_peer (&p2, "test_quota_compliance_tcp_peer2.conf");
620 GNUNET_assert(p1.th != NULL);
621 GNUNET_assert(p2.th != NULL);
622 GNUNET_TRANSPORT_get_hello (p1.th, &exchange_hello, &p1);
626 main (int argc, char *argv[])
630 return GNUNET_SYSERR;
632 if (strstr(argv[0], "tcp_nat") != NULL)
634 is_tcp_nat = GNUNET_YES;
636 else if (strstr(argv[0], "tcp") != NULL)
640 else if (strstr(argv[0], "https") != NULL)
642 is_https = GNUNET_YES;
644 else if (strstr(argv[0], "http") != NULL)
646 is_http = GNUNET_YES;
648 else if (strstr(argv[0], "udp") != NULL)
653 GNUNET_log_setup ("test-quota-compliance",
660 char *const argv1[] = { "test-quota-compliance",
662 "test_quota_compliance_data.conf",
668 struct GNUNET_GETOPT_CommandLineOption options[] = {
669 GNUNET_GETOPT_OPTION_END
672 if (strstr(argv[0], "asymmetric_recv") != NULL)
674 is_asymmetric_recv_constant = GNUNET_YES;
677 is_asymmetric_recv_constant = GNUNET_NO;
678 if (strstr(argv[0], "asymmetric_send") != NULL)
680 is_asymmetric_send_constant = GNUNET_YES;
683 is_asymmetric_send_constant = GNUNET_NO;
685 GNUNET_PROGRAM_run ((sizeof (argv1) / sizeof (char *)) - 1,
686 argv1, "test-quota-compliance", "nohelp",
691 GNUNET_DISK_directory_remove ("/tmp/test_quota_compliance_peer1");
692 GNUNET_DISK_directory_remove ("/tmp/test_quota_compliance_peer2");
696 /* end of test_quota_compliance.c */