-doxygen
[oweals/gnunet.git] / src / transport / test_quota_compliance.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20 /**
21  * @file transport/test_quota_compliance.c
22  * @brief base test case for transport implementations
23  *
24  * This test case tests quota compliance both on transport level
25  */
26 #include "platform.h"
27 #include "gnunet_transport_service.h"
28 #include "gnunet_ats_service.h"
29 #include "gauger.h"
30 #include "transport-testing.h"
31
32 /**
33  * Testcase timeout
34  */
35 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
36
37 /**
38  * How long until we give up on transmitting the message?
39  */
40 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 20)
41
42 #define DURATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
43
44 static char *test_source;
45
46 static char *test_plugin;
47
48 static char *test_name;
49
50 static GNUNET_SCHEDULER_TaskIdentifier die_task;
51
52 static GNUNET_SCHEDULER_TaskIdentifier measure_task;
53
54 struct PeerContext *p1;
55
56 struct PeerContext *p2;
57
58 struct PeerContext *sender;
59
60 struct PeerContext *receiver;
61
62 struct GNUNET_TRANSPORT_TransmitHandle *th;
63
64 char *cfg_file_p1;
65 char *gen_cfg_p2;
66 unsigned long long quota_in_p1;
67 unsigned long long quota_out_p1;
68
69 char *cfg_file_p2;
70 char *gen_cfg_p1;
71 unsigned long long quota_in_p2;
72 unsigned long long quota_out_p2;
73
74 struct GNUNET_TRANSPORT_TESTING_handle *tth;
75
76 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
77
78
79 /*
80  * Testcase specific declarations
81  */
82
83 /**
84  * Note that this value must not significantly exceed
85  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
86  * messages may be dropped even for a reliable transport.
87  */
88 #define TOTAL_MSGS (1024 * 2)
89
90 #define MTYPE 12345
91
92 GNUNET_NETWORK_STRUCT_BEGIN
93
94 struct TestMessage
95 {
96   struct GNUNET_MessageHeader header;
97   uint32_t num;
98 };
99 GNUNET_NETWORK_STRUCT_END
100
101 static int msg_scheduled;
102 static int msg_sent;
103 static int msg_recv_expected;
104 static int msg_recv;
105
106 static int test_failed;
107 static int test_connected;
108
109 static unsigned long long total_bytes_sent;
110
111 static struct GNUNET_TIME_Absolute start_time;
112
113 /*
114  * END Testcase specific declarations
115  */
116
117 #if VERBOSE
118 #define OKPP do { ok++; FPRINTF (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
119 #else
120 #define OKPP do { ok++; } while (0)
121 #endif
122
123
124 static void
125 end ()
126 {
127   unsigned long long delta;
128   unsigned long long datarate;
129
130   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
131
132   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value_us;
133   datarate = (total_bytes_sent * 1000 * 1000) / delta;
134
135   FPRINTF (stderr, "Throughput was %llu b/s\n", datarate);
136
137   test_failed = GNUNET_NO;
138   if (datarate > quota_in_p2)
139   {
140     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
141                 "Datarate of %llu b/s higher than allowed inbound quota of %llu b/s\n",
142                 datarate, quota_in_p2);
143     test_failed = GNUNET_YES;
144   }
145   if (datarate > quota_out_p1)
146   {
147     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
148                 "Datarate of %llu b/s higher than allowed outbound quota of %llu b/s\n",
149                 datarate, quota_out_p1);
150     test_failed = GNUNET_YES;
151   }
152   if (test_failed == GNUNET_NO)
153   {
154     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
155                 "Datarate of %llu b/s complied to allowed outbound quota of %llu b/s and inbound quota of %llu b/s\n",
156                 datarate, quota_out_p1, quota_in_p2);
157   }
158
159   if (die_task != GNUNET_SCHEDULER_NO_TASK)
160     GNUNET_SCHEDULER_cancel (die_task);
161
162   if (th != NULL)
163     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
164   th = NULL;
165
166   if (cc != NULL)
167     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
168
169   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
170   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
171
172 }
173
174 static void
175 end_badly ()
176 {
177   die_task = GNUNET_SCHEDULER_NO_TASK;
178   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
179
180   if (measure_task != GNUNET_SCHEDULER_NO_TASK)
181     GNUNET_SCHEDULER_cancel (measure_task);
182
183   if (test_connected == GNUNET_YES)
184     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Peers got connected\n");
185   else
186     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Peers got NOT connected\n");
187
188   if (th != NULL)
189     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
190   th = NULL;
191
192   if (cc != NULL)
193     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
194
195   if (p1 != NULL)
196     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
197   if (p2 != NULL)
198     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
199
200   test_failed = GNUNET_YES;
201 }
202
203
204 static unsigned int
205 get_size (unsigned int iter)
206 {
207   unsigned int ret;
208
209   ret = (iter * iter * iter);
210   return sizeof (struct TestMessage) + (ret % 60000);
211 }
212
213
214 static void
215 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
216                 const struct GNUNET_MessageHeader *message)
217 {
218   static int n;
219   unsigned int s;
220   char cbuf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
221   const struct TestMessage *hdr;
222
223   hdr = (const struct TestMessage *) message;
224   s = get_size (n);
225   if (MTYPE != ntohs (message->type))
226     return;
227   msg_recv_expected = n;
228   msg_recv = ntohl (hdr->num);
229   if (ntohs (message->size) != (s))
230   {
231     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
232                 "Expected message %u of size %u, got %u bytes of message %u\n",
233                 n, s, ntohs (message->size), ntohl (hdr->num));
234     if (die_task != GNUNET_SCHEDULER_NO_TASK)
235       GNUNET_SCHEDULER_cancel (die_task);
236     test_failed = GNUNET_YES;
237     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
238     return;
239   }
240   if (ntohl (hdr->num) != n)
241   {
242     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
243                 "Expected message %u of size %u, got %u bytes of message %u\n",
244                 n, s, ntohs (message->size), ntohl (hdr->num));
245     if (die_task != GNUNET_SCHEDULER_NO_TASK)
246       GNUNET_SCHEDULER_cancel (die_task);
247     test_failed = GNUNET_YES;
248     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
249     return;
250   }
251   memset (cbuf, n, s - sizeof (struct TestMessage));
252   if (0 != memcmp (cbuf, &hdr[1], s - sizeof (struct TestMessage)))
253   {
254     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
255                 "Expected message %u with bits %u, but body did not match\n", n,
256                 (unsigned char) n);
257     if (die_task != GNUNET_SCHEDULER_NO_TASK)
258       GNUNET_SCHEDULER_cancel (die_task);
259     test_failed = GNUNET_YES;
260     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
261     return;
262   }
263 #if VERBOSE
264   if (ntohl (hdr->num) % 5000 == 0)
265   {
266     struct PeerContext *p = cls;
267     char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
268
269     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
270                 "Peer %u (`%s') got message %u of size %u from peer (`%s')\n",
271                 p->no, ps, ntohl (hdr->num), ntohs (message->size),
272                 GNUNET_i2s (peer));
273     GNUNET_free (ps);
274   }
275 #endif
276   n++;
277 }
278
279
280 static size_t
281 notify_ready (void *cls, size_t size, void *buf)
282 {
283   static int n;
284   char *cbuf = buf;
285   struct TestMessage hdr;
286   unsigned int s;
287   unsigned int ret;
288
289   th = NULL;
290   if (buf == NULL)
291   {
292     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
293                 "Timeout occurred while waiting for transmit_ready for message %u of %u\n",
294                 msg_scheduled, TOTAL_MSGS);
295     if (GNUNET_SCHEDULER_NO_TASK != die_task)
296       GNUNET_SCHEDULER_cancel (die_task);
297     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
298     test_failed = 1;
299     return 0;
300   }
301
302   ret = 0;
303   s = get_size (n);
304   GNUNET_assert (size >= s);
305   GNUNET_assert (buf != NULL);
306   cbuf = buf;
307   do
308   {
309     hdr.header.size = htons (s);
310     hdr.header.type = htons (MTYPE);
311     hdr.num = htonl (n);
312     msg_sent = n;
313     memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
314     ret += sizeof (struct TestMessage);
315     memset (&cbuf[ret], n, s - sizeof (struct TestMessage));
316     ret += s - sizeof (struct TestMessage);
317 #if VERBOSE
318     if (n % 5000 == 0)
319     {
320
321       char *receiver_s = GNUNET_strdup (GNUNET_i2s (&receiver->id));
322
323       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
324                   "Sending message of size %u from peer %u (`%4s') -> peer %u (`%s') !\n",
325                   n, sender->no, GNUNET_i2s (&sender->id), receiver->no,
326                   receiver_s);
327       GNUNET_free (receiver_s);
328     }
329 #endif
330     n++;
331     s = get_size (n);
332     if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
333       break;                    /* sometimes pack buffer full, sometimes not */
334   }
335   while (size - ret >= s);
336   if (n < TOTAL_MSGS)
337   {
338     if (th == NULL)
339       th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, s, 0,
340                                                    TIMEOUT_TRANSMIT,
341                                                    &notify_ready, NULL);
342     msg_scheduled = n;
343   }
344   if (n % 5000 == 0)
345   {
346     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
347                 "Returning total message block of size %u\n", ret);
348   }
349   total_bytes_sent += ret;
350   if (n == TOTAL_MSGS)
351   {
352     FPRINTF (stderr, "%s",  "\n");
353     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "All messages sent\n");
354   }
355   return ret;
356 }
357
358
359 static void
360 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
361 {
362
363   struct PeerContext *p = cls;
364
365   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%4s') connected to us!\n",
366               p->no, GNUNET_i2s (peer));
367 }
368
369
370 static void
371 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
372 {
373   struct PeerContext *p = cls;
374
375   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%4s') disconnected!\n", p->no,
376               GNUNET_i2s (peer));
377   if (th != NULL)
378     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
379   th = NULL;
380
381 }
382
383 static void
384 sendtask ()
385 {
386   start_time = GNUNET_TIME_absolute_get ();
387   th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, get_size (0), 0,
388                                                TIMEOUT_TRANSMIT, &notify_ready,
389                                                NULL);
390 }
391
392
393 static void
394 measure (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
395 {
396   static int counter;
397
398   measure_task = GNUNET_SCHEDULER_NO_TASK;
399
400   counter++;
401   if ((DURATION.rel_value_us / 1000 / 1000LL) < counter)
402   {
403     FPRINTF (stderr, "%s",  ".\n");
404     GNUNET_SCHEDULER_add_now (&end, NULL);
405   }
406   else
407   {
408     FPRINTF (stderr, "%s",  ".");
409     measure_task =
410         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &measure, NULL);
411   }
412 }
413
414
415 static void
416 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
417 {
418   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
419
420   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %u (%s) <-> %u (%s)\n",
421               p1->no, p1_c, p2->no, GNUNET_i2s (&p2->id));
422   GNUNET_free (p1_c);
423
424   cc = NULL;
425   test_connected = GNUNET_YES;
426
427   measure_task =
428       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &measure, NULL);
429   GNUNET_SCHEDULER_add_now (&sendtask, NULL);
430
431 }
432
433 void
434 start_cb (struct PeerContext *p, void *cls)
435 {
436   static int started;
437
438   started++;
439
440   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
441               GNUNET_i2s (&p->id));
442
443   if (started != 2)
444     return;
445
446   test_connected = GNUNET_NO;
447
448   sender = p2;
449   receiver = p1;
450
451   char *sender_c = GNUNET_strdup (GNUNET_i2s (&sender->id));
452   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
453               "Test tries to send from %u (%s) -> peer %u (%s)\n", sender->no,
454               sender_c, receiver->no, GNUNET_i2s (&receiver->id));
455   GNUNET_free (sender_c);
456   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
457                                                NULL);
458
459 }
460
461 static char *
462 generate_config (char *cfg_file, unsigned long long quota_in,
463                  unsigned long long quota_out)
464 {
465   char *networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
466   char *in_name;
467   char *out_name;
468   char *fname = NULL;
469   struct GNUNET_CONFIGURATION_Handle *cfg = GNUNET_CONFIGURATION_create ();
470   int c;
471
472   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (cfg, cfg_file));
473   GNUNET_asprintf (&fname, "q_in_%llu_q_out_%llu_%s", quota_in, quota_out,
474                    cfg_file);
475
476   GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "DEFAULTCONFIG", fname);
477
478   for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
479   {
480       GNUNET_asprintf (&in_name, "%s_QUOTA_IN", networks[c]);
481       GNUNET_asprintf (&out_name, "%s_QUOTA_OUT", networks[c]);
482       GNUNET_CONFIGURATION_set_value_number (cfg, "ats", in_name, quota_in);
483       GNUNET_CONFIGURATION_set_value_number (cfg, "ats", out_name, quota_out);
484       GNUNET_free (in_name);
485       GNUNET_free (out_name);
486   }
487   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_write (cfg, fname));
488   GNUNET_CONFIGURATION_destroy (cfg);
489   return fname;
490 }
491
492 static void
493 run_measurement (unsigned long long p1_quota_in,
494                  unsigned long long p1_quota_out,
495                  unsigned long long p2_quota_in,
496                  unsigned long long p2_quota_out)
497 {
498   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
499
500   /* setting ATS quota */
501   quota_out_p1 = p1_quota_out;
502   gen_cfg_p1 = generate_config (cfg_file_p1, p1_quota_in, p1_quota_out);
503   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Generated config file `%s'\n",
504               gen_cfg_p1);
505
506   quota_in_p2 = p2_quota_in;
507   gen_cfg_p2 = generate_config (cfg_file_p2, p2_quota_in, p2_quota_out);
508   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Generated config file `%s'\n",
509               gen_cfg_p2);
510
511   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, gen_cfg_p1, 1, &notify_receive,
512                                             &notify_connect, &notify_disconnect,
513                                             &start_cb, NULL);
514
515   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, gen_cfg_p2, 2, &notify_receive,
516                                             &notify_connect, &notify_disconnect,
517                                             &start_cb, NULL);
518
519   if ((p1 == NULL) || (p2 == NULL))
520   {
521     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
522     if (die_task != GNUNET_SCHEDULER_NO_TASK)
523       GNUNET_SCHEDULER_cancel (die_task);
524     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
525     return;
526   }
527 }
528
529 static void
530 run (void *cls, char *const *args, const char *cfgfile,
531      const struct GNUNET_CONFIGURATION_Handle *cfg)
532 {
533   unsigned long long p1_quota_in = 10000;
534   unsigned long long p1_quota_out = 10000;
535   unsigned long long p2_quota_in = 10000;
536   unsigned long long p2_quota_out = 10000;
537
538   if (NULL != strstr (test_name, "asymmetric"))
539   {
540     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
541                 "Running asymmetric test with sending peer unlimited, receiving peer (in/out): %llu/%llu b/s \n",
542                 p2_quota_in, p2_quota_out);
543     p1_quota_out = 1024 * 1024 * 1024;
544     p1_quota_in = 1024 * 1024 * 1024;
545   }
546   else
547   {
548     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
549                 "Running symmetric test with (in/out) %llu/%llu b/s \n",
550                 p2_quota_in, p2_quota_out);
551   }
552   run_measurement (p1_quota_in, p1_quota_out, p2_quota_in, p2_quota_out);
553 }
554
555 static int
556 check ()
557 {
558   static char *argv[] = { "test_transport-quota-compliance",
559     "-c",
560     "test_quota_compliance_data.conf",
561     NULL
562   };
563   static struct GNUNET_GETOPT_CommandLineOption options[] = {
564     GNUNET_GETOPT_OPTION_END
565   };
566
567   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
568                       "nohelp", options, &run, NULL);
569   return test_failed;
570 }
571
572 int
573 main (int argc, char *argv[])
574 {
575   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
576
577   GNUNET_log_setup (test_name,
578                     "WARNING",
579                     NULL);
580
581   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
582   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
583                                                  &test_plugin);
584
585   tth = GNUNET_TRANSPORT_TESTING_init ();
586
587   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
588   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
589
590   check ();
591
592   GNUNET_free (cfg_file_p1);
593   GNUNET_free (cfg_file_p2);
594
595   if (GNUNET_YES == GNUNET_DISK_file_test (gen_cfg_p1))
596   {
597     GNUNET_DISK_directory_remove (gen_cfg_p1);
598     GNUNET_free (gen_cfg_p1);
599   }
600
601   if (GNUNET_YES == GNUNET_DISK_file_test (gen_cfg_p2))
602   {
603     GNUNET_DISK_directory_remove (gen_cfg_p2);
604     GNUNET_free (gen_cfg_p2);
605   }
606
607   GNUNET_free (test_source);
608   GNUNET_free (test_plugin);
609   GNUNET_free (test_name);
610
611   GNUNET_TRANSPORT_TESTING_done (tth);
612
613   return test_failed;
614 }
615
616
617 /* end of test_quota_compliance.c */