even nicer indentation, thanks to LRN's indent patch
[oweals/gnunet.git] / src / core / test_core_api_reliability.c
1 /*
2      This file is part of GNUnet.
3      (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., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20 /**
21  * @file core/test_core_api_reliability.c
22  * @brief testcase for core_api.c focusing on reliable transmission (with TCP)
23  *
24  * FIXME:
25  * - make sure connect callback is invoked properly as well!
26  */
27 #include "platform.h"
28 #include "gnunet_common.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_arm_service.h"
31 #include "gnunet_core_service.h"
32 #include "gnunet_getopt_lib.h"
33 #include "gnunet_os_lib.h"
34 #include "gnunet_program_lib.h"
35 #include "gnunet_scheduler_lib.h"
36 #include "gnunet_transport_service.h"
37 #include <gauger.h>
38
39 #define VERBOSE GNUNET_NO
40
41 #define START_ARM GNUNET_YES
42
43 /**
44  * Note that this value must not significantly exceed
45  * 'MAX_PENDING' in 'gnunet-service-transport.c', otherwise
46  * messages may be dropped even for a reliable transport.
47  */
48 #define TOTAL_MSGS (600 * 10)
49
50 /**
51  * How long until we give up on transmitting the message?
52  */
53 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 6000)
54
55 /**
56  * What delay do we request from the core service for transmission?
57  */
58 #define FAST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
59
60 #define MTYPE 12345
61
62
63 static unsigned long long total_bytes;
64
65 static struct GNUNET_TIME_Absolute start_time;
66
67 static GNUNET_SCHEDULER_TaskIdentifier err_task;
68
69
70 struct PeerContext
71 {
72   struct GNUNET_CONFIGURATION_Handle *cfg;
73   struct GNUNET_CORE_Handle *ch;
74   struct GNUNET_PeerIdentity id;
75   struct GNUNET_TRANSPORT_Handle *th;
76   struct GNUNET_MessageHeader *hello;
77   int connect_status;
78 #if START_ARM
79   struct GNUNET_OS_Process *arm_proc;
80 #endif
81 };
82
83 static struct PeerContext p1;
84
85 static struct PeerContext p2;
86
87 static int ok;
88
89 static int32_t tr_n;
90
91
92 #if VERBOSE
93 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
94 #else
95 #define OKPP do { ok++; } while (0)
96 #endif
97
98 struct TestMessage
99 {
100   struct GNUNET_MessageHeader header;
101   uint32_t num;
102 };
103
104
105 static unsigned int
106 get_size (unsigned int iter)
107 {
108   unsigned int ret;
109
110   if (iter < 60000)
111     return iter + sizeof (struct TestMessage);
112   ret = (iter * iter * iter);
113   return sizeof (struct TestMessage) + (ret % 60000);
114 }
115
116 static void
117 process_hello (void *cls, const struct GNUNET_MessageHeader *message);
118
119 static void
120 terminate_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
121 {
122   unsigned long long delta;
123
124   GNUNET_TRANSPORT_get_hello_cancel (p1.th, &process_hello, &p1);
125   GNUNET_TRANSPORT_get_hello_cancel (p2.th, &process_hello, &p2);
126   GNUNET_CORE_disconnect (p1.ch);
127   p1.ch = NULL;
128   GNUNET_CORE_disconnect (p2.ch);
129   p2.ch = NULL;
130   GNUNET_TRANSPORT_disconnect (p1.th);
131   p1.th = NULL;
132   GNUNET_TRANSPORT_disconnect (p2.th);
133   p2.th = NULL;
134   delta = GNUNET_TIME_absolute_get_duration (start_time).rel_value;
135   fprintf (stderr, "\nThroughput was %llu kb/s\n",
136            total_bytes * 1000 / 1024 / delta);
137   GAUGER ("CORE", "Core throughput/s", total_bytes * 1000 / 1024 / delta,
138           "kb/s");
139   ok = 0;
140 }
141
142
143 static void
144 terminate_task_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
145 {
146   GNUNET_break (0);
147   if (p1.ch != NULL)
148   {
149     GNUNET_CORE_disconnect (p1.ch);
150     p1.ch = NULL;
151   }
152   if (p2.ch != NULL)
153   {
154     GNUNET_CORE_disconnect (p2.ch);
155     p2.ch = NULL;
156   }
157   if (p1.th != NULL)
158   {
159     GNUNET_TRANSPORT_get_hello_cancel (p1.th, &process_hello, &p1);
160     GNUNET_TRANSPORT_disconnect (p1.th);
161     p1.th = NULL;
162   }
163   if (p2.th != NULL)
164   {
165     GNUNET_TRANSPORT_get_hello_cancel (p2.th, &process_hello, &p2);
166     GNUNET_TRANSPORT_disconnect (p2.th);
167     p2.th = NULL;
168   }
169   ok = 42;
170 }
171
172
173 static size_t
174 transmit_ready (void *cls, size_t size, void *buf)
175 {
176   char *cbuf = buf;
177   struct TestMessage hdr;
178   unsigned int s;
179   unsigned int ret;
180
181   GNUNET_assert (size <= GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE);
182   if (buf == NULL)
183   {
184     if (p1.ch != NULL)
185       GNUNET_break (NULL !=
186                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
187                                                        FAST_TIMEOUT, &p2.id,
188                                                        get_size (tr_n),
189                                                        &transmit_ready, &p1));
190     return 0;
191   }
192   GNUNET_assert (tr_n < TOTAL_MSGS);
193   ret = 0;
194   s = get_size (tr_n);
195   GNUNET_assert (size >= s);
196   GNUNET_assert (buf != NULL);
197   cbuf = buf;
198   do
199   {
200 #if VERBOSE
201     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
202                 "Sending message %u of size %u at offset %u\n", tr_n, s, ret);
203 #endif
204     hdr.header.size = htons (s);
205     hdr.header.type = htons (MTYPE);
206     hdr.num = htonl (tr_n);
207     memcpy (&cbuf[ret], &hdr, sizeof (struct TestMessage));
208     ret += sizeof (struct TestMessage);
209     memset (&cbuf[ret], tr_n, s - sizeof (struct TestMessage));
210     ret += s - sizeof (struct TestMessage);
211     tr_n++;
212     s = get_size (tr_n);
213     if (0 == GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16))
214       break;                    /* sometimes pack buffer full, sometimes not */
215   }
216   while (size - ret >= s);
217   GNUNET_SCHEDULER_cancel (err_task);
218   err_task =
219       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
220   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
221               "Returning total message block of size %u\n", ret);
222   total_bytes += ret;
223   return ret;
224 }
225
226
227
228 static void
229 connect_notify (void *cls, const struct GNUNET_PeerIdentity *peer,
230                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
231 {
232   struct PeerContext *pc = cls;
233
234   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
235     return;
236   GNUNET_assert (pc->connect_status == 0);
237   pc->connect_status = 1;
238   if (pc == &p1)
239   {
240     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
241                 "Encrypted connection established to peer `%4s'\n",
242                 GNUNET_i2s (peer));
243     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
244                 "Asking core (1) for transmission to peer `%4s'\n",
245                 GNUNET_i2s (&p2.id));
246     GNUNET_SCHEDULER_cancel (err_task);
247     err_task =
248         GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
249     start_time = GNUNET_TIME_absolute_get ();
250     GNUNET_break (NULL !=
251                   GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
252                                                      TIMEOUT, &p2.id,
253                                                      get_size (0),
254                                                      &transmit_ready, &p1));
255   }
256 }
257
258
259 static void
260 disconnect_notify (void *cls, const struct GNUNET_PeerIdentity *peer)
261 {
262   struct PeerContext *pc = cls;
263
264   if (0 == memcmp (&pc->id, peer, sizeof (struct GNUNET_PeerIdentity)))
265     return;
266   pc->connect_status = 0;
267   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Encrypted connection to `%4s' cut\n",
268               GNUNET_i2s (peer));
269 }
270
271
272 static int
273 inbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
274                 const struct GNUNET_MessageHeader *message,
275                 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
276 {
277 #if VERBOSE
278   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
279               "Core provides inbound data from `%4s'.\n", GNUNET_i2s (other));
280 #endif
281   return GNUNET_OK;
282 }
283
284
285 static int
286 outbound_notify (void *cls, const struct GNUNET_PeerIdentity *other,
287                  const struct GNUNET_MessageHeader *message,
288                  const struct GNUNET_TRANSPORT_ATS_Information *atsi)
289 {
290 #if VERBOSE
291   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
292               "Core notifies about outbound data for `%4s'.\n",
293               GNUNET_i2s (other));
294 #endif
295   return GNUNET_OK;
296 }
297
298
299 static size_t
300 transmit_ready (void *cls, size_t size, void *buf);
301
302 static int
303 process_mtype (void *cls, const struct GNUNET_PeerIdentity *peer,
304                const struct GNUNET_MessageHeader *message,
305                const struct GNUNET_TRANSPORT_ATS_Information *atsi)
306 {
307   static int n;
308   unsigned int s;
309   const struct TestMessage *hdr;
310
311   hdr = (const struct TestMessage *) message;
312   s = get_size (n);
313   if (MTYPE != ntohs (message->type))
314     return GNUNET_SYSERR;
315   if (ntohs (message->size) != s)
316   {
317     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
318                 "Expected message %u of size %u, got %u bytes of message %u\n",
319                 n, s, ntohs (message->size), ntohl (hdr->num));
320     GNUNET_SCHEDULER_cancel (err_task);
321     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
322     return GNUNET_SYSERR;
323   }
324   if (ntohl (hdr->num) != n)
325   {
326     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
327                 "Expected message %u of size %u, got %u bytes of message %u\n",
328                 n, s, ntohs (message->size), ntohl (hdr->num));
329     GNUNET_SCHEDULER_cancel (err_task);
330     err_task = GNUNET_SCHEDULER_add_now (&terminate_task_error, NULL);
331     return GNUNET_SYSERR;
332   }
333 #if VERBOSE
334   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message %u of size %u\n",
335               ntohl (hdr->num), ntohs (message->size));
336 #endif
337   n++;
338   if (0 == (n % (TOTAL_MSGS / 100)))
339     fprintf (stderr, ".");
340   if (n == TOTAL_MSGS)
341   {
342     GNUNET_SCHEDULER_cancel (err_task);
343     GNUNET_SCHEDULER_add_now (&terminate_task, NULL);
344   }
345   else
346   {
347     if (n == tr_n)
348       GNUNET_break (NULL !=
349                     GNUNET_CORE_notify_transmit_ready (p1.ch, GNUNET_NO, 0,
350                                                        FAST_TIMEOUT, &p2.id,
351                                                        get_size (tr_n),
352                                                        &transmit_ready, &p1));
353   }
354   return GNUNET_OK;
355 }
356
357
358 static struct GNUNET_CORE_MessageHandler handlers[] = {
359   {&process_mtype, MTYPE, 0},
360   {NULL, 0, 0}
361 };
362
363
364
365 static void
366 init_notify (void *cls, struct GNUNET_CORE_Handle *server,
367              const struct GNUNET_PeerIdentity *my_identity,
368              const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
369 {
370   struct PeerContext *p = cls;
371
372   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
373               "Connection to CORE service of `%4s' established\n",
374               GNUNET_i2s (my_identity));
375   GNUNET_assert (server != NULL);
376   p->id = *my_identity;
377   p->ch = server;
378   if (cls == &p1)
379   {
380     GNUNET_assert (ok == 2);
381     OKPP;
382     /* connect p2 */
383     GNUNET_CORE_connect (p2.cfg, 1, &p2, &init_notify, &connect_notify,
384                          &disconnect_notify, NULL, &inbound_notify, GNUNET_YES,
385                          &outbound_notify, GNUNET_YES, handlers);
386   }
387   else
388   {
389     GNUNET_assert (ok == 3);
390     OKPP;
391     GNUNET_assert (cls == &p2);
392     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
393                 "Asking core (1) to connect to peer `%4s'\n",
394                 GNUNET_i2s (&p2.id));
395     GNUNET_CORE_peer_request_connect (p1.ch, &p2.id, NULL, NULL);
396   }
397 }
398
399
400 static void
401 process_hello (void *cls, const struct GNUNET_MessageHeader *message)
402 {
403   struct PeerContext *p = cls;
404
405   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
406               "Received (my) `%s' from transport service\n", "HELLO");
407   GNUNET_assert (message != NULL);
408   p->hello = GNUNET_malloc (ntohs (message->size));
409   memcpy (p->hello, message, ntohs (message->size));
410   if ((p == &p1) && (p2.th != NULL))
411     GNUNET_TRANSPORT_offer_hello (p2.th, message, NULL, NULL);
412   if ((p == &p2) && (p1.th != NULL))
413     GNUNET_TRANSPORT_offer_hello (p1.th, message, NULL, NULL);
414
415   if ((p == &p1) && (p2.hello != NULL))
416     GNUNET_TRANSPORT_offer_hello (p1.th, p2.hello, NULL, NULL);
417   if ((p == &p2) && (p1.hello != NULL))
418     GNUNET_TRANSPORT_offer_hello (p2.th, p1.hello, NULL, NULL);
419 }
420
421
422
423 static void
424 setup_peer (struct PeerContext *p, const char *cfgname)
425 {
426   p->cfg = GNUNET_CONFIGURATION_create ();
427 #if START_ARM
428   p->arm_proc =
429       GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
430                                "gnunet-service-arm",
431 #if VERBOSE
432                                "-L", "DEBUG",
433 #endif
434                                "-c", cfgname, NULL);
435 #endif
436   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
437   p->th = GNUNET_TRANSPORT_connect (p->cfg, NULL, p, NULL, NULL, NULL);
438   GNUNET_assert (p->th != NULL);
439   GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
440 }
441
442
443 static void
444 run (void *cls, char *const *args, const char *cfgfile,
445      const struct GNUNET_CONFIGURATION_Handle *cfg)
446 {
447   GNUNET_assert (ok == 1);
448   OKPP;
449   setup_peer (&p1, "test_core_api_peer1.conf");
450   setup_peer (&p2, "test_core_api_peer2.conf");
451   err_task =
452       GNUNET_SCHEDULER_add_delayed (TIMEOUT, &terminate_task_error, NULL);
453   GNUNET_CORE_connect (p1.cfg, 1, &p1, &init_notify, &connect_notify,
454                        &disconnect_notify, NULL, &inbound_notify, GNUNET_YES,
455                        &outbound_notify, GNUNET_YES, handlers);
456 }
457
458
459 static void
460 stop_arm (struct PeerContext *p)
461 {
462 #if START_ARM
463   if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
464     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
465   if (GNUNET_OS_process_wait (p->arm_proc) != GNUNET_OK)
466     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
467   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM process %u stopped\n",
468               GNUNET_OS_process_get_pid (p->arm_proc));
469   GNUNET_OS_process_close (p->arm_proc);
470   p->arm_proc = NULL;
471 #endif
472   GNUNET_CONFIGURATION_destroy (p->cfg);
473 }
474
475 static int
476 check ()
477 {
478   char *const argv[] = { "test-core-api-reliability",
479     "-c",
480     "test_core_api_data.conf",
481 #if VERBOSE
482     "-L", "DEBUG",
483 #endif
484     NULL
485   };
486   struct GNUNET_GETOPT_CommandLineOption options[] = {
487     GNUNET_GETOPT_OPTION_END
488   };
489   ok = 1;
490   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
491                       "test-core-api-reliability", "nohelp", options, &run,
492                       &ok);
493   stop_arm (&p1);
494   stop_arm (&p2);
495   return ok;
496 }
497
498 int
499 main (int argc, char *argv[])
500 {
501   int ret;
502
503   GNUNET_log_setup ("test-core-api",
504 #if VERBOSE
505                     "DEBUG",
506 #else
507                     "WARNING",
508 #endif
509                     NULL);
510   ret = check ();
511   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-1");
512   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-core-peer-2");
513
514   return ret;
515 }
516
517 /* end of test_core_api_reliability.c */