-more logging, avoid duplicate re-scheduling
[oweals/gnunet.git] / src / transport / test_transport_api_manipulation_recv_tcp.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2009, 2010 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., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, USA.
19 */
20 /**
21  * @file transport/test_transport_api_manipulation_recv_tcp.c
22  * @brief base test case for transport traffic manipulation implementation
23  *
24  * This test case will setup 2 peers and connect them, the first message
25  * will be sent without manipulation, then a receive delay of 1 second will
26  * be configured and 2 more message will be sent. Time will be measured
27  *
28  * In addition the distance on receiver side will be manipulated to be 10
29  */
30 #include "platform.h"
31 #include "gnunet_transport_service.h"
32 #include "transport-testing.h"
33
34 /**
35  * How long until we give up on transmitting the message?
36  */
37 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
38
39 /**
40  * How long until we give up on transmitting the message?
41  */
42 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
43
44 #define TEST_MESSAGE_SIZE 2600
45
46 #define TEST_MESSAGE_TYPE 12345
47
48 static char *test_source;
49
50 static char *test_plugin;
51
52 static char *test_name;
53
54 static int ok;
55
56 static int s_started;
57
58 static int s_connected;
59
60 static int s_sending;
61
62 static struct GNUNET_SCHEDULER_Task * die_task;
63
64 static struct GNUNET_SCHEDULER_Task * send_task;
65
66 static struct PeerContext *p1;
67
68 static struct PeerContext *p2;
69
70 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
71
72 static struct GNUNET_TRANSPORT_TransmitHandle *th;
73
74 static struct GNUNET_TRANSPORT_TESTING_handle *tth;
75
76 static char *cfg_file_p1;
77
78 static char *cfg_file_p2;
79
80 static int messages_recv;
81
82 static struct GNUNET_TIME_Absolute start_normal;
83 static struct GNUNET_TIME_Relative dur_normal;
84
85 static struct GNUNET_TIME_Absolute start_delayed;
86 static struct GNUNET_TIME_Relative dur_delayed;
87
88 static void
89 end ()
90 {
91   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
92
93   if (send_task != NULL)
94     GNUNET_SCHEDULER_cancel (send_task);
95
96   if (die_task != NULL)
97     GNUNET_SCHEDULER_cancel (die_task);
98
99   if (th != NULL)
100     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
101   th = NULL;
102
103   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
104   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
105 }
106
107 static void
108 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
109 {
110   die_task = NULL;
111
112   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
113
114
115   if (send_task != NULL)
116     GNUNET_SCHEDULER_cancel (send_task);
117
118   if (cc != NULL)
119   {
120     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Fail! Could not connect peers\n"));
121     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
122     cc = NULL;
123   }
124
125   if (th != NULL)
126     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
127   else
128     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were not ready to send data\n"));
129
130   if (s_started == GNUNET_NO)
131     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peers were not started \n"));
132   else
133     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peers were started \n"));
134
135   if (s_connected == GNUNET_NO)
136     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were not connected\n"));
137   else
138     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were connected\n"));
139
140   if (s_sending == GNUNET_NO)
141     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were not ready to send data\n"));
142   else
143     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were ready to send data\n"));
144
145   th = NULL;
146
147   if (p1 != NULL)
148     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
149   else
150     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer 1 was not started\n"));
151   if (p2 != NULL)
152     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
153   else
154     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer 2 was not started\n"));
155
156   ok = GNUNET_SYSERR;
157 }
158
159
160 static void
161 sendtask (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
162
163 static void
164 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
165                 const struct GNUNET_MessageHeader *message)
166 {
167   struct PeerContext *p = cls;
168   struct PeerContext *t = NULL;
169
170   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
171     t = p1;
172   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
173     t = p2;
174   GNUNET_assert (t != NULL);
175
176   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
177
178   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
179               "Peer %u (`%4s') received message of type %d and size %u size from peer %u (`%4s')!\n",
180               p->no, ps, ntohs (message->type), ntohs (message->size), t->no,
181               GNUNET_i2s (&t->id));
182   GNUNET_free (ps);
183
184   if ((TEST_MESSAGE_TYPE == ntohs (message->type)) &&
185       (TEST_MESSAGE_SIZE == ntohs (message->size)))
186   {
187     ok = 0;
188
189   }
190   else
191   {
192     GNUNET_break (0);
193     ok = 1;
194     end ();
195     return;
196   }
197
198   if (messages_recv <= 1)
199   {
200     /* Received non-delayed message */
201     dur_normal = GNUNET_TIME_absolute_get_duration(start_normal);
202     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
203                 "Received non-delayed message %u after %s\n",
204                 messages_recv,
205                 GNUNET_STRINGS_relative_time_to_string (dur_normal,
206                                                         GNUNET_YES));
207
208     struct GNUNET_ATS_Properties prop;
209     struct GNUNET_TIME_Relative delay;
210
211     delay.rel_value_us = 1000 * 1000LL;
212     memset (&prop, 0, sizeof (prop));
213     prop.distance = 10;
214     GNUNET_TRANSPORT_set_traffic_metric (p1->th,
215                                          &p2->id,
216                                          &prop,
217                                          delay,
218                                          GNUNET_TIME_UNIT_ZERO);
219     send_task = GNUNET_SCHEDULER_add_now (&sendtask, NULL);
220   }
221   if (2 == messages_recv)
222   {
223         /* Received manipulated message */
224         dur_delayed = GNUNET_TIME_absolute_get_duration(start_delayed);
225       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
226                   "Received delayed message %u after %s\n",
227                   messages_recv,
228                   GNUNET_STRINGS_relative_time_to_string (dur_delayed,
229                                                           GNUNET_YES));
230       if (dur_delayed.rel_value_us < 1000 * 1000LL)
231       {
232         GNUNET_break (0);
233         ok += 1;
234         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
235                     "Delayed message was not delayed correctly: took only %s\n",
236                     GNUNET_STRINGS_relative_time_to_string (dur_delayed,
237                                                             GNUNET_YES));
238       }
239       /* shutdown */
240       end ();
241   }
242
243   messages_recv ++;
244 }
245
246
247 static size_t
248 notify_ready (void *cls, size_t size, void *buf)
249 {
250   struct PeerContext *p = cls;
251   struct GNUNET_MessageHeader *hdr;
252
253   th = NULL;
254
255   if (buf == NULL)
256   {
257     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
258                 "Timeout occurred while waiting for transmit_ready\n");
259     if (NULL != die_task)
260       GNUNET_SCHEDULER_cancel (die_task);
261     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
262     ok = 42;
263     return 0;
264   }
265
266   GNUNET_assert (size >= TEST_MESSAGE_SIZE);
267   if (buf != NULL)
268   {
269     memset (buf, '\0', TEST_MESSAGE_SIZE);
270     hdr = buf;
271     hdr->size = htons (TEST_MESSAGE_SIZE);
272     hdr->type = htons (TEST_MESSAGE_TYPE);
273   }
274
275   char *ps = GNUNET_strdup (GNUNET_i2s (&p2->id));
276   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
277               "Peer %u (`%4s') sending message with type %u and size %u bytes to peer %u (`%4s')\n",
278               p2->no, ps, ntohs (hdr->type), ntohs (hdr->size), p->no,
279               GNUNET_i2s (&p->id));
280   GNUNET_free (ps);
281
282   return TEST_MESSAGE_SIZE;
283 }
284
285
286 static void
287 sendtask (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
288 {
289   send_task = NULL;
290
291   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
292     return;
293   char *receiver_s = GNUNET_strdup (GNUNET_i2s (&p1->id));
294
295   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
296               "Sending message from peer %u (`%4s') -> peer %u (`%s') !\n",
297               p2->no, GNUNET_i2s (&p2->id), p1->no, receiver_s);
298   GNUNET_free (receiver_s);
299
300
301   if (0 == messages_recv)
302   {
303         start_normal = GNUNET_TIME_absolute_get();
304   }
305   if (1 == messages_recv)
306   {
307                 start_delayed = GNUNET_TIME_absolute_get();
308   }
309
310   s_sending = GNUNET_YES;
311   th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, TEST_MESSAGE_SIZE,
312                                                TIMEOUT_TRANSMIT, &notify_ready,
313                                                p1);
314 }
315
316
317 static void
318 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
319 {
320   static int c;
321
322   c++;
323   struct PeerContext *p = cls;
324   struct PeerContext *t = NULL;
325
326   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
327     t = p1;
328   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
329     t = p2;
330   GNUNET_assert (t != NULL);
331
332   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
333
334   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
335               "Peer %u (`%4s'): peer %u (`%s') connected to me!\n", p->no, ps,
336               t->no, GNUNET_i2s (peer));
337   GNUNET_free (ps);
338 }
339
340
341 static void
342 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
343 {
344   struct PeerContext *p = cls;
345   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
346
347   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
348               "Peer %u (`%4s'): peer (`%s') disconnected from me!\n", p->no, ps,
349               GNUNET_i2s (peer));
350
351   GNUNET_free (ps);
352
353   if (th != NULL)
354     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
355   th = NULL;
356 }
357
358
359 static void
360 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
361 {
362   cc = NULL;
363   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
364
365   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %u (%s) <-> %u (%s)\n",
366               p1->no, p1_c, p2->no, GNUNET_i2s (&p2->id));
367   GNUNET_free (p1_c);
368
369   s_connected = GNUNET_YES;
370   send_task = GNUNET_SCHEDULER_add_now (&sendtask, NULL);
371 }
372
373
374 static void
375 start_cb (struct PeerContext *p, void *cls)
376 {
377   static int started;
378   started++;
379
380   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
381               GNUNET_i2s (&p->id));
382
383   if (started != 2)
384     return;
385   else
386     s_started = GNUNET_YES;
387   char *sender_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
388
389   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
390               "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
391               p1->no, sender_c, p2->no, GNUNET_i2s (&p2->id));
392   GNUNET_free (sender_c);
393
394   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
395                                                NULL);
396
397 }
398
399
400 static void
401 run (void *cls, char *const *args, const char *cfgfile,
402      const struct GNUNET_CONFIGURATION_Handle *cfg)
403 {
404   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
405
406   s_started = GNUNET_NO;
407   s_connected = GNUNET_NO;
408   s_sending = GNUNET_NO;
409
410   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
411                                             &notify_receive, &notify_connect,
412                                             &notify_disconnect, &start_cb,
413                                             NULL);
414
415   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
416                                             &notify_receive, &notify_connect,
417                                             &notify_disconnect, &start_cb,
418                                             NULL);
419
420   if ((p1 == NULL) || (p2 == NULL))
421   {
422     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
423     if (die_task != NULL)
424       GNUNET_SCHEDULER_cancel (die_task);
425     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
426     return;
427   }
428 }
429
430
431 static int
432 check ()
433 {
434   static char *const argv[] = { "test-transport-api-manipulation",
435     "-c",
436     "test_transport_api_data.conf",
437     NULL
438   };
439   static struct GNUNET_GETOPT_CommandLineOption options[] = {
440     GNUNET_GETOPT_OPTION_END
441   };
442
443   send_task = NULL;
444
445   ok = 1;
446   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
447                       "nohelp", options, &run, &ok);
448
449   return ok;
450 }
451
452 int
453 main (int argc, char *argv[])
454 {
455   int ret;
456
457   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
458   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
459   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
460                                                  &test_plugin);
461
462   GNUNET_log_setup (test_name,
463                     "WARNING",
464                     NULL);
465   tth = GNUNET_TRANSPORT_TESTING_init ();
466
467   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
468   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
469
470   ret = check ();
471
472   GNUNET_free (cfg_file_p1);
473   GNUNET_free (cfg_file_p2);
474
475   GNUNET_free (test_source);
476   GNUNET_free (test_plugin);
477   GNUNET_free (test_name);
478
479   GNUNET_TRANSPORT_TESTING_done (tth);
480
481   return ret;
482 }
483
484 /* end of test_transport_api_manipulation_recv_tcp.c */