social cli
[oweals/gnunet.git] / src / regex / gnunet-regex-profiler.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2011 - 2013 GNUnet e.V.
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 /**
22  * @file regex/gnunet-regex-profiler.c
23  * @brief Regex profiler for testing distributed regex use.
24  * @author Bartlomiej Polot
25  * @author Maximilian Szengel
26  *
27  */
28
29 #include <string.h>
30
31 #include "platform.h"
32 #include "gnunet_applications.h"
33 #include "gnunet_util_lib.h"
34 #include "regex_internal_lib.h"
35 #include "gnunet_arm_service.h"
36 #include "gnunet_dht_service.h"
37 #include "gnunet_testbed_service.h"
38
39 #define FIND_TIMEOUT \
40         GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 90)
41
42 /**
43  * DLL of operations
44  */
45 struct DLLOperation
46 {
47   /**
48    * The testbed operation handle
49    */
50   struct GNUNET_TESTBED_Operation *op;
51
52   /**
53    * Closure
54    */
55   void *cls;
56
57   /**
58    * The next pointer for DLL
59    */
60   struct DLLOperation *next;
61
62   /**
63    * The prev pointer for DLL
64    */
65   struct DLLOperation *prev;
66 };
67
68
69 /**
70  * Available states during profiling
71  */
72 enum State
73 {
74   /**
75    * Initial state
76    */
77   STATE_INIT = 0,
78
79   /**
80    * Starting slaves
81    */
82   STATE_SLAVES_STARTING,
83
84   /**
85    * Creating peers
86    */
87   STATE_PEERS_CREATING,
88
89   /**
90    * Starting peers
91    */
92   STATE_PEERS_STARTING,
93
94   /**
95    * Linking peers
96    */
97   STATE_PEERS_LINKING,
98
99   /**
100    * Matching strings against announced regexes
101    */
102   STATE_SEARCH_REGEX,
103
104   /**
105    * Destroying peers; we can do this as the controller takes care of stopping a
106    * peer if it is running
107    */
108   STATE_PEERS_DESTROYING
109 };
110
111
112 /**
113  * Peer handles.
114  */
115 struct RegexPeer
116 {
117   /**
118    * Peer id.
119    */
120   unsigned int id;
121
122   /**
123    * Peer configuration handle.
124    */
125   struct GNUNET_CONFIGURATION_Handle *cfg;
126
127   /**
128    * The actual testbed peer handle.
129    */
130   struct GNUNET_TESTBED_Peer *peer_handle;
131
132   /**
133    * Peer's search string.
134    */
135   const char *search_str;
136
137   /**
138    * Set to GNUNET_YES if the peer successfully matched the above
139    * search string. GNUNET_NO if the string could not be matched
140    * during the profiler run. GNUNET_SYSERR if the string matching
141    * timed out. Undefined if search_str is NULL
142    */
143   int search_str_matched;
144
145   /**
146    * Peer's DHT handle.
147    */
148   struct GNUNET_DHT_Handle *dht_handle;
149
150   /**
151    * Handle to a running regex search.
152    */
153    struct REGEX_INTERNAL_Search *search_handle;
154
155   /**
156    * Testbed operation handle for DHT.
157    */
158   struct GNUNET_TESTBED_Operation *op_handle;
159
160   /**
161    * Peers's statistics handle.
162    */
163   struct GNUNET_STATISTICS_Handle *stats_handle;
164
165   /**
166    * The starting time of a profiling step.
167    */
168   struct GNUNET_TIME_Absolute prof_start_time;
169
170   /**
171    * Operation timeout
172    */
173   struct GNUNET_SCHEDULER_Task * timeout;
174
175   /**
176    * Deamon start
177    */
178   struct GNUNET_TESTBED_Operation *daemon_op;
179 };
180
181 /**
182  * Set when shutting down to avoid making more queries.
183  */
184 static int in_shutdown;
185
186 /**
187  * The array of peers; we fill this as the peers are given to us by the testbed
188  */
189 static struct RegexPeer *peers;
190
191 /**
192  * Host registration handle
193  */
194 static struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
195
196 /**
197  * Handle to the master controller process
198  */
199 static struct GNUNET_TESTBED_ControllerProc *mc_proc;
200
201 /**
202  * Handle to the master controller
203  */
204 static struct GNUNET_TESTBED_Controller *mc;
205
206 /**
207  * Handle to global configuration
208  */
209 static struct GNUNET_CONFIGURATION_Handle *cfg;
210
211 /**
212  * Abort task identifier
213  */
214 static struct GNUNET_SCHEDULER_Task * abort_task;
215
216 /**
217  * Host registration task identifier
218  */
219 static struct GNUNET_SCHEDULER_Task * register_hosts_task;
220
221 /**
222  * Global event mask for all testbed events
223  */
224 static uint64_t event_mask;
225
226 /**
227  * The starting time of a profiling step
228  */
229 static struct GNUNET_TIME_Absolute prof_start_time;
230
231 /**
232  * Duration profiling step has taken
233  */
234 static struct GNUNET_TIME_Relative prof_time;
235
236 /**
237  * Number of peers to be started by the profiler
238  */
239 static unsigned int num_peers;
240
241 /**
242  * Global testing status
243  */
244 static int result;
245
246 /**
247  * current state of profiling
248  */
249 enum State state;
250
251 /**
252  * Folder where policy files are stored.
253  */
254 static char * policy_dir;
255
256 /**
257  * File with hostnames where to execute the test.
258  */
259 static char *hosts_file;
260
261 /**
262  * File with the strings to look for.
263  */
264 static char *strings_file;
265
266 /**
267  * Search strings (num_peers of them).
268  */
269 static char **search_strings;
270
271 /**
272  * How many searches are we going to start in parallel
273  */
274 static long long unsigned int init_parallel_searches;
275
276 /**
277  * How many searches are running in parallel
278  */
279 static unsigned int parallel_searches;
280
281 /**
282  * Number of strings found in the published regexes.
283  */
284 static unsigned int strings_found;
285
286 /**
287  * Index of peer to start next announce/search.
288  */
289 static unsigned int next_search;
290
291 /**
292  * Search timeout task identifier.
293  */
294 static struct GNUNET_SCHEDULER_Task * search_timeout_task;
295
296 /**
297  * Search timeout in seconds.
298  */
299 static struct GNUNET_TIME_Relative search_timeout_time = { 60000 };
300
301 /**
302  * File to log statistics to.
303  */
304 static struct GNUNET_DISK_FileHandle *data_file;
305
306 /**
307  * Filename to log statistics to.
308  */
309 static char *data_filename;
310
311 /**
312  * Prefix used for regex announcing. We need to prefix the search
313  * strings with it, in order to find something.
314  */
315 static char * regex_prefix;
316
317 /**
318  * What's the maximum regex reannounce period.
319  */
320 static struct GNUNET_TIME_Relative reannounce_period_max;
321
322
323 /******************************************************************************/
324 /******************************  DECLARATIONS  ********************************/
325 /******************************************************************************/
326
327 /**
328  * DHT connect callback.
329  *
330  * @param cls internal peer id.
331  * @param op operation handle.
332  * @param ca_result connect adapter result.
333  * @param emsg error message.
334  */
335 static void
336 dht_connect_cb (void *cls, struct GNUNET_TESTBED_Operation *op,
337                 void *ca_result, const char *emsg);
338
339 /**
340  * DHT connect adapter.
341  *
342  * @param cls not used.
343  * @param cfg configuration handle.
344  *
345  * @return
346  */
347 static void *
348 dht_ca (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg);
349
350
351 /**
352  * Adapter function called to destroy a connection to
353  * the DHT service
354  *
355  * @param cls closure
356  * @param op_result service handle returned from the connect adapter
357  */
358 static void
359 dht_da (void *cls, void *op_result);
360
361
362 /**
363  * Function called by testbed once we are connected to stats
364  * service. Get the statistics for the services of interest.
365  *
366  * @param cls the 'struct RegexPeer' for which we connected to stats
367  * @param op connect operation handle
368  * @param ca_result handle to stats service
369  * @param emsg error message on failure
370  */
371 static void
372 stats_connect_cb (void *cls,
373                   struct GNUNET_TESTBED_Operation *op,
374                   void *ca_result,
375                   const char *emsg);
376
377
378 /**
379  * Start announcing the next regex in the DHT.
380  *
381  * @param cls Index of the next peer in the peers array.
382  */
383 static void
384 announce_next_regex (void *cls);
385
386
387 /******************************************************************************/
388 /********************************  SHUTDOWN  **********************************/
389 /******************************************************************************/
390
391
392 /**
393  * Shutdown nicely
394  *
395  * @param cls NULL
396  */
397 static void
398 do_shutdown (void *cls)
399 {
400   struct RegexPeer *peer;
401   unsigned int peer_cnt;
402   unsigned int search_str_cnt;
403   char output_buffer[512];
404   size_t size;
405
406   if (NULL != abort_task)
407   {
408     GNUNET_SCHEDULER_cancel (abort_task);
409     abort_task = NULL;
410   }
411   if (NULL != register_hosts_task)
412   {
413     GNUNET_SCHEDULER_cancel (register_hosts_task);
414     register_hosts_task = NULL;
415   }
416   for (peer_cnt = 0; peer_cnt < num_peers; peer_cnt++)
417   {
418     peer = &peers[peer_cnt];
419
420     if (GNUNET_YES != peer->search_str_matched && NULL != data_file)
421     {
422       prof_time = GNUNET_TIME_absolute_get_duration (peer->prof_start_time);
423       size =
424         GNUNET_snprintf (output_buffer,
425                          sizeof (output_buffer),
426                          "%p Search string not found: %s (%d)\n"
427                          "%p On peer: %u (%p)\n"
428                          "%p After: %s\n",
429                          peer, peer->search_str, peer->search_str_matched,
430                          peer, peer->id, peer,
431                          peer,
432                          GNUNET_STRINGS_relative_time_to_string (prof_time,
433                                                                  GNUNET_NO));
434       if (size != GNUNET_DISK_file_write (data_file, output_buffer, size))
435         GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
436     }
437
438     if (NULL != peers[peer_cnt].op_handle)
439       GNUNET_TESTBED_operation_done (peers[peer_cnt].op_handle);
440   }
441
442   if (NULL != data_file)
443   {
444     GNUNET_DISK_file_close (data_file);
445     data_file = NULL;
446   }
447   for (search_str_cnt = 0;
448        search_str_cnt < num_peers && NULL != search_strings;
449        search_str_cnt++)
450   {
451     GNUNET_free_non_null (search_strings[search_str_cnt]);
452   }
453   GNUNET_free_non_null (search_strings);
454   search_strings = NULL;
455
456   if (NULL != reg_handle)
457   {
458     GNUNET_TESTBED_cancel_registration (reg_handle);
459     reg_handle = NULL;
460   }
461   if (NULL != mc)
462   {
463     GNUNET_TESTBED_controller_disconnect (mc);
464     mc = NULL;
465   }
466   if (NULL != mc_proc)
467   {
468     GNUNET_TESTBED_controller_stop (mc_proc);
469     mc_proc = NULL;
470   }
471   if (NULL != cfg)
472   {
473     GNUNET_CONFIGURATION_destroy (cfg);
474     cfg = NULL;
475   }
476 }
477
478
479 /**
480  * abort task to run on test timed out
481  *
482  * @param cls NULL
483  */
484 static void
485 do_abort (void *cls)
486 {
487   unsigned long i = (unsigned long) cls;
488
489   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
490               "Aborting from line %lu...\n", i);
491   abort_task = NULL;
492   result = GNUNET_SYSERR;
493   GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
494 }
495
496
497 /******************************************************************************/
498 /*********************  STATISTICS SERVICE CONNECTIONS  ***********************/
499 /******************************************************************************/
500
501 /**
502  * Adapter function called to establish a connection to
503  * statistics service.
504  *
505  * @param cls closure
506  * @param cfg configuration of the peer to connect to; will be available until
507  *          GNUNET_TESTBED_operation_done() is called on the operation returned
508  *          from GNUNET_TESTBED_service_connect()
509  * @return service handle to return in 'op_result', NULL on error
510  */
511 static void *
512 stats_ca (void *cls,
513           const struct GNUNET_CONFIGURATION_Handle *cfg)
514 {
515   return GNUNET_STATISTICS_create ("<driver>", cfg);
516 }
517
518
519 /**
520  * Adapter function called to destroy a connection to
521  * statistics service.
522  *
523  * @param cls closure
524  * @param op_result service handle returned from the connect adapter
525  */
526 static void
527 stats_da (void *cls, void *op_result)
528 {
529   struct RegexPeer *peer = cls;
530
531   GNUNET_assert (op_result == peer->stats_handle);
532
533   GNUNET_STATISTICS_destroy (peer->stats_handle, GNUNET_NO);
534   peer->stats_handle = NULL;
535 }
536
537
538 /**
539  * Process statistic values. Write all values to global 'data_file', if present.
540  *
541  * @param cls closure
542  * @param subsystem name of subsystem that created the statistic
543  * @param name the name of the datum
544  * @param value the current value
545  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
546  * @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
547  */
548 static int
549 stats_iterator (void *cls,
550                 const char *subsystem,
551                 const char *name,
552                 uint64_t value, int is_persistent)
553 {
554   struct RegexPeer *peer = cls;
555   char output_buffer[512];
556   size_t size;
557
558   if (NULL == data_file)
559   {
560     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
561                 "%p -> %s [%s]: %llu\n",
562                 peer, subsystem, name, value);
563     return GNUNET_OK;
564   }
565   size =
566     GNUNET_snprintf (output_buffer,
567                      sizeof (output_buffer),
568                      "%p [%s] %llu %s\n",
569                      peer,
570                      subsystem, value, name);
571   if (size != GNUNET_DISK_file_write (data_file, output_buffer, size))
572     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
573
574   return GNUNET_OK;
575 }
576
577
578 /**
579  * Stats callback. Finish the stats testbed operation and when all stats have
580  * been iterated, shutdown the profiler.
581  *
582  * @param cls closure
583  * @param success GNUNET_OK if statistics were
584  *        successfully obtained, GNUNET_SYSERR if not.
585  */
586 static void
587 stats_cb (void *cls,
588           int success)
589 {
590   static unsigned int peer_cnt;
591   struct RegexPeer *peer = cls;
592
593   if (GNUNET_OK != success)
594   {
595     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
596                 "Getting statistics for peer %u failed!\n",
597                 peer->id);
598     return;
599   }
600
601   GNUNET_assert (NULL != peer->op_handle);
602
603   GNUNET_TESTBED_operation_done (peer->op_handle);
604   peer->op_handle = NULL;
605
606   peer_cnt++;
607   peer = &peers[peer_cnt];
608
609   fprintf (stderr, "s");
610   if (peer_cnt == num_peers)
611   {
612     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
613                 "\nCollecting stats finished. Shutting down.\n");
614     GNUNET_SCHEDULER_shutdown ();
615     result = GNUNET_OK;
616   }
617   else
618   {
619     peer->op_handle =
620       GNUNET_TESTBED_service_connect (NULL,
621                                       peer->peer_handle,
622                                       "statistics",
623                                       &stats_connect_cb,
624                                       peer,
625                                       &stats_ca,
626                                       &stats_da,
627                                       peer);
628   }
629 }
630
631
632 /**
633  * Function called by testbed once we are connected to stats
634  * service. Get the statistics for the services of interest.
635  *
636  * @param cls the 'struct RegexPeer' for which we connected to stats
637  * @param op connect operation handle
638  * @param ca_result handle to stats service
639  * @param emsg error message on failure
640  */
641 static void
642 stats_connect_cb (void *cls,
643                   struct GNUNET_TESTBED_Operation *op,
644                   void *ca_result,
645                   const char *emsg)
646 {
647   struct RegexPeer *peer = cls;
648
649   if (NULL == ca_result || NULL != emsg)
650   {
651     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
652                 "Failed to connect to statistics service on peer %u: %s\n",
653                 peer->id, emsg);
654
655     peer->stats_handle = NULL;
656     return;
657   }
658
659   peer->stats_handle = ca_result;
660
661   if (NULL == GNUNET_STATISTICS_get (peer->stats_handle, NULL, NULL,
662                                      GNUNET_TIME_UNIT_FOREVER_REL,
663                                      &stats_cb,
664                                      &stats_iterator, peer))
665   {
666     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
667                 "Could not get statistics of peer %u!\n", peer->id);
668   }
669 }
670
671
672 /**
673  * Task to collect all statistics from all peers, will shutdown the
674  * profiler, when done.
675  *
676  * @param cls NULL
677  */
678 static void
679 do_collect_stats (void *cls)
680 {
681   struct RegexPeer *peer = &peers[0];
682
683   GNUNET_assert (NULL != peer->peer_handle);
684
685   peer->op_handle =
686     GNUNET_TESTBED_service_connect (NULL,
687                                     peer->peer_handle,
688                                     "statistics",
689                                     &stats_connect_cb,
690                                     peer,
691                                     &stats_ca,
692                                     &stats_da,
693                                     peer);
694 }
695
696
697 /******************************************************************************/
698 /************************   REGEX FIND CONNECTIONS   **************************/
699 /******************************************************************************/
700
701
702 /**
703  * Start searching for the next string in the DHT.
704  *
705  * @param cls Index of the next peer in the peers array.
706  */
707 static void
708 find_string (void *cls);
709
710
711 /**
712  * Method called when we've found a peer that announced a regex
713  * that matches our search string. Now get the statistics.
714  *
715  * @param cls Closure provided in REGEX_INTERNAL_search.
716  * @param id Peer providing a regex that matches the string.
717  * @param get_path Path of the get request.
718  * @param get_path_length Lenght of get_path.
719  * @param put_path Path of the put request.
720  * @param put_path_length Length of the put_path.
721  */
722 static void
723 regex_found_handler (void *cls,
724                      const struct GNUNET_PeerIdentity *id,
725                      const struct GNUNET_PeerIdentity *get_path,
726                      unsigned int get_path_length,
727                      const struct GNUNET_PeerIdentity *put_path,
728                      unsigned int put_path_length)
729 {
730   struct RegexPeer *peer = cls;
731   char output_buffer[512];
732   size_t size;
733
734   if (GNUNET_YES == peer->search_str_matched)
735   {
736     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
737                 "String %s on peer %u already matched!\n",
738                 peer->search_str, peer->id);
739     return;
740   }
741
742   strings_found++;
743   parallel_searches--;
744
745   if (NULL != peer->timeout)
746   {
747     GNUNET_SCHEDULER_cancel (peer->timeout);
748     peer->timeout = NULL;
749     if (GNUNET_NO == in_shutdown)
750       GNUNET_SCHEDULER_add_now (&announce_next_regex, NULL);
751   }
752
753   if (NULL == id)
754   {
755     // FIXME not possible right now
756     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
757                 "String matching timed out for string %s on peer %u (%i/%i)\n",
758                 peer->search_str, peer->id, strings_found, num_peers);
759     peer->search_str_matched = GNUNET_SYSERR;
760   }
761   else
762   {
763     prof_time = GNUNET_TIME_absolute_get_duration (peer->prof_start_time);
764
765     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
766                 "String %s found on peer %u after %s (%i/%i) (%u||)\n",
767                 peer->search_str, peer->id,
768                 GNUNET_STRINGS_relative_time_to_string (prof_time, GNUNET_NO),
769                 strings_found, num_peers, parallel_searches);
770
771     peer->search_str_matched = GNUNET_YES;
772
773     if (NULL != data_file)
774     {
775       size =
776         GNUNET_snprintf (output_buffer,
777                          sizeof (output_buffer),
778                          "%p Peer: %u\n"
779                          "%p Search string: %s\n"
780                          "%p Search duration: %s\n\n",
781                          peer, peer->id,
782                          peer, peer->search_str,
783                          peer,
784                          GNUNET_STRINGS_relative_time_to_string (prof_time,
785                                                                  GNUNET_NO));
786
787       if (size != GNUNET_DISK_file_write (data_file, output_buffer, size))
788         GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
789     }
790   }
791
792   GNUNET_TESTBED_operation_done (peer->op_handle);
793   peer->op_handle = NULL;
794
795   if (strings_found == num_peers)
796   {
797     prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
798     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
799                 "All strings successfully matched in %s\n",
800                 GNUNET_STRINGS_relative_time_to_string (prof_time, GNUNET_NO));
801
802     if (NULL != search_timeout_task)
803     {
804       GNUNET_SCHEDULER_cancel (search_timeout_task);
805       search_timeout_task = NULL;
806     }
807
808     GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Collecting stats.\n");
809     GNUNET_SCHEDULER_add_now (&do_collect_stats, NULL);
810   }
811 }
812
813
814 /**
815  * Connect by string timeout task. This will cancel the profiler after the
816  * specified timeout 'search_timeout'.
817  *
818  * @param cls NULL
819  */
820 static void
821 search_timed_out (void *cls)
822 {
823   unsigned int i;
824
825   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
826               "Finding matches to all strings did not succeed after %s.\n",
827               GNUNET_STRINGS_relative_time_to_string (search_timeout_time,
828                                                       GNUNET_NO));
829   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
830               "Found %i of %i strings\n", strings_found, num_peers);
831
832   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
833               "Search timed out after %s."
834               "Collecting stats and shutting down.\n",
835               GNUNET_STRINGS_relative_time_to_string (search_timeout_time,
836                                                       GNUNET_NO));
837
838   in_shutdown = GNUNET_YES;
839   for (i = 0; i < num_peers; i++)
840   {
841     if (NULL != peers[i].op_handle)
842     {
843       GNUNET_TESTBED_operation_done (peers[i].op_handle);
844       peers[i].op_handle = NULL;
845     }
846   }
847   GNUNET_SCHEDULER_add_now (&do_collect_stats, NULL);
848 }
849
850
851 /**
852  * Search timed out. It might still complete in the future,
853  * but we should start another one.
854  *
855  * @param cls Index of the next peer in the peers array.
856  */
857 static void
858 find_timed_out (void *cls)
859 {
860   struct RegexPeer *p = cls;
861
862   p->timeout = NULL;
863   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
864               "Searching for string \"%s\" on peer %d timed out.\n",
865               p->search_str,
866               p->id);
867   if (GNUNET_NO == in_shutdown)
868     GNUNET_SCHEDULER_add_now (&announce_next_regex, NULL);
869 }
870
871
872 /**
873  * Start searching for a string in the DHT.
874  *
875  * @param cls Index of the next peer in the peers array.
876  */
877 static void
878 find_string (void *cls)
879 {
880   unsigned int search_peer = (unsigned int) (long) cls;
881
882   if ( (search_peer >= num_peers) ||
883        (GNUNET_YES == in_shutdown) )
884     return;
885
886   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
887               "Searching for string \"%s\" on peer %d (%u||)\n",
888               peers[search_peer].search_str,
889               search_peer,
890               parallel_searches);
891
892   peers[search_peer].op_handle =
893     GNUNET_TESTBED_service_connect (NULL,
894                                     peers[search_peer].peer_handle,
895                                     "dht",
896                                     &dht_connect_cb,
897                                     &peers[search_peer],
898                                     &dht_ca,
899                                     &dht_da,
900                                     &peers[search_peer]);
901   GNUNET_assert (NULL != peers[search_peer].op_handle);
902   peers[search_peer].timeout
903     = GNUNET_SCHEDULER_add_delayed (FIND_TIMEOUT,
904                                     &find_timed_out,
905                                     &peers[search_peer]);
906 }
907
908
909 /**
910  * Callback called when testbed has started the daemon we asked for.
911  *
912  * @param cls NULL
913  * @param op the operation handle
914  * @param emsg NULL on success; otherwise an error description
915  */
916 static void
917 daemon_started (void *cls,
918                 struct GNUNET_TESTBED_Operation *op,
919                 const char *emsg)
920 {
921   struct RegexPeer *peer = (struct RegexPeer *) cls;
922   unsigned long search_peer;
923   unsigned int i;
924
925   GNUNET_TESTBED_operation_done (peer->daemon_op);
926   peer->daemon_op = NULL;
927   if (NULL != emsg)
928   {
929     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
930                 "Failed to start/stop daemon at peer %u: %s\n", peer->id, emsg);
931     GNUNET_assert (0);
932   }
933   else
934   {
935     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
936                 "Deamon %u started successfully\n", peer->id);
937   }
938
939   /* Find a peer to look for a string matching the regex announced */
940   search_peer = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
941                                           num_peers);
942   for (i = 0; peers[search_peer].search_str != NULL; i++)
943   {
944     search_peer = (search_peer + 1) % num_peers;
945     if (i > num_peers)
946       GNUNET_assert (0); /* we ran out of peers, must be a bug */
947   }
948   peers[search_peer].search_str = search_strings[peer->id];
949   peers[search_peer].search_str_matched = GNUNET_NO;
950   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply(
951                                   reannounce_period_max,
952                                   2),
953                                 &find_string,
954                                 (void *) search_peer);
955 }
956
957
958 /**
959  * Task to start the daemons on each peer so that the regexes are announced
960  * into the DHT.
961  *
962  * @param cls NULL
963  * @param tc the task context
964  */
965 static void
966 do_announce (void *cls)
967 {
968   unsigned int i;
969
970   if (GNUNET_YES == in_shutdown)
971     return;
972   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
973               "Starting announce.\n");
974   for (i = 0; i < init_parallel_searches; i++)
975   {
976     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
977                 "  scheduling announce %u\n",
978                 i);
979     (void) GNUNET_SCHEDULER_add_now (&announce_next_regex, NULL);
980   }
981 }
982
983
984 /**
985  * Start announcing the next regex in the DHT.
986  *
987  * @param cls Closure (unused).
988  */
989 static void
990 announce_next_regex (void *cls)
991 {
992   struct RegexPeer *peer;
993
994   if (GNUNET_YES == in_shutdown)
995     return;
996   if (next_search >= num_peers)
997   {
998     if (strings_found != num_peers)
999     {
1000       struct GNUNET_TIME_Relative new_delay;
1001       if (NULL != search_timeout_task)
1002         GNUNET_SCHEDULER_cancel (search_timeout_task);
1003       new_delay = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15);
1004       search_timeout_task = GNUNET_SCHEDULER_add_delayed (new_delay,
1005                                                           &search_timed_out,
1006                                                           NULL);
1007     }
1008     return;
1009   }
1010
1011   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Starting daemon %u\n", next_search);
1012   peer = &peers[next_search];
1013   peer->daemon_op =
1014   GNUNET_TESTBED_peer_manage_service (NULL,
1015                                       peer->peer_handle,
1016                                       "regexprofiler",
1017                                       &daemon_started,
1018                                       peer,
1019                                       1);
1020   next_search++;
1021   parallel_searches++;
1022 }
1023
1024
1025 /**
1026  * DHT connect callback. Called when we are connected to the dht service for
1027  * the peer in 'cls'. If successfull we connect to the stats service of this
1028  * peer and then try to match the search string of this peer.
1029  *
1030  * @param cls internal peer id.
1031  * @param op operation handle.
1032  * @param ca_result connect adapter result.
1033  * @param emsg error message.
1034  */
1035 static void
1036 dht_connect_cb (void *cls,
1037                 struct GNUNET_TESTBED_Operation *op,
1038                 void *ca_result,
1039                 const char *emsg)
1040 {
1041   struct RegexPeer *peer = (struct RegexPeer *) cls;
1042
1043   if (NULL != emsg || NULL == op || NULL == ca_result)
1044   {
1045     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "DHT connect failed: %s\n", emsg);
1046     GNUNET_assert (0);
1047   }
1048
1049   GNUNET_assert (NULL != peer->dht_handle);
1050   GNUNET_assert (peer->op_handle == op);
1051   GNUNET_assert (peer->dht_handle == ca_result);
1052
1053   peer->search_str_matched = GNUNET_NO;
1054   peer->search_handle = REGEX_INTERNAL_search (peer->dht_handle,
1055                                              peer->search_str,
1056                                              &regex_found_handler, peer,
1057                                              NULL);
1058   peer->prof_start_time = GNUNET_TIME_absolute_get ();
1059 }
1060
1061
1062 /**
1063  * DHT connect adapter. Opens a connection to the dht service.
1064  *
1065  * @param cls Closure (peer).
1066  * @param cfg Configuration handle.
1067  *
1068  * @return
1069  */
1070 static void *
1071 dht_ca (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
1072 {
1073   struct RegexPeer *peer = cls;
1074
1075   peer->dht_handle = GNUNET_DHT_connect (cfg, 32);
1076
1077   return peer->dht_handle;
1078 }
1079
1080
1081 /**
1082  * Adapter function called to destroy a connection to the dht service.
1083  *
1084  * @param cls Closure (peer).
1085  * @param op_result Service handle returned from the connect adapter.
1086  */
1087 static void
1088 dht_da (void *cls, void *op_result)
1089 {
1090   struct RegexPeer *peer = (struct RegexPeer *) cls;
1091
1092   GNUNET_assert (peer->dht_handle == op_result);
1093
1094   if (NULL != peer->search_handle)
1095   {
1096     REGEX_INTERNAL_search_cancel (peer->search_handle);
1097     peer->search_handle = NULL;
1098   }
1099
1100   if (NULL != peer->dht_handle)
1101   {
1102     GNUNET_DHT_disconnect (peer->dht_handle);
1103     peer->dht_handle = NULL;
1104   }
1105 }
1106
1107
1108 /**
1109  * Signature of a main function for a testcase.
1110  *
1111  * @param cls NULL
1112  * @param h the run handle
1113  * @param num_peers_ number of peers in 'peers'
1114  * @param testbed_peers handle to peers run in the testbed.  NULL upon timeout (see
1115  *          GNUNET_TESTBED_test_run()).
1116  * @param links_succeeded the number of overlay link connection attempts that
1117  *          succeeded
1118  * @param links_failed the number of overlay link connection attempts that
1119  *          failed
1120  */
1121 static void
1122 test_master (void *cls,
1123              struct GNUNET_TESTBED_RunHandle *h,
1124              unsigned int num_peers_,
1125              struct GNUNET_TESTBED_Peer **testbed_peers,
1126              unsigned int links_succeeded,
1127              unsigned int links_failed)
1128 {
1129   unsigned int i;
1130
1131   GNUNET_assert (num_peers_ == num_peers);
1132
1133   prof_time = GNUNET_TIME_absolute_get_duration (prof_start_time);
1134   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1135               "Testbed started in %s\n",
1136               GNUNET_STRINGS_relative_time_to_string (prof_time, GNUNET_NO));
1137
1138   if (NULL != abort_task)
1139   {
1140     GNUNET_SCHEDULER_cancel (abort_task);
1141     abort_task = NULL;
1142   }
1143
1144   for (i = 0; i < num_peers; i++)
1145   {
1146     peers[i].peer_handle = testbed_peers[i];
1147   }
1148   if (GNUNET_NO ==
1149       GNUNET_CONFIGURATION_get_value_yesno (cfg, "DHT", "DISABLE_TRY_CONNECT"))
1150   {
1151     struct GNUNET_TIME_Relative settle_time;
1152
1153     settle_time =
1154       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
1155                                      10 * num_peers);
1156     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1157                 "Waiting for DHT for %s to settle new connections.\n\n",
1158                 GNUNET_STRINGS_relative_time_to_string(settle_time, GNUNET_NO));
1159     GNUNET_SCHEDULER_add_delayed (settle_time, &do_announce, NULL);
1160   }
1161   else
1162   {
1163     GNUNET_SCHEDULER_add_now (&do_announce, NULL);
1164   }
1165   search_timeout_task =
1166       GNUNET_SCHEDULER_add_delayed (search_timeout_time, &search_timed_out, NULL);
1167 }
1168
1169 /**
1170  * Function that will be called whenever something in the testbed changes.
1171  *
1172  * @param cls closure, NULL
1173  * @param event information on what is happening
1174  */
1175 static void
1176 master_controller_cb (void *cls,
1177                       const struct GNUNET_TESTBED_EventInformation *event)
1178 {
1179   switch (event->type)
1180   {
1181   case GNUNET_TESTBED_ET_CONNECT:
1182     printf(".");
1183     break;
1184   case GNUNET_TESTBED_ET_PEER_START:
1185     printf("#");
1186     break;
1187   default:
1188     break;
1189   }
1190   fflush(stdout);
1191 }
1192
1193
1194 /******************************************************************************/
1195 /***************************  TESTBED PEER SETUP  *****************************/
1196 /******************************************************************************/
1197
1198
1199 /**
1200  * Load search strings from given filename. One search string per line.
1201  *
1202  * @param filename filename of the file containing the search strings.
1203  * @param strings set of strings loaded from file. Caller needs to free this
1204  *                if number returned is greater than zero.
1205  * @param limit upper limit on the number of strings read from the file
1206  * @return number of strings found in the file. #GNUNET_SYSERR on error.
1207  */
1208 static int
1209 load_search_strings (const char *filename,
1210                      char ***strings,
1211                      unsigned int limit)
1212 {
1213   char *data;
1214   char *buf;
1215   uint64_t filesize;
1216   unsigned int offset;
1217   int str_cnt;
1218   unsigned int i;
1219
1220   if (NULL == filename)
1221   {
1222     return GNUNET_SYSERR;
1223   }
1224
1225   if (GNUNET_YES != GNUNET_DISK_file_test (filename))
1226   {
1227     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1228                 "Could not find search strings file %s\n", filename);
1229     return GNUNET_SYSERR;
1230   }
1231   if (GNUNET_OK != GNUNET_DISK_file_size (filename, &filesize, GNUNET_YES, GNUNET_YES))
1232     filesize = 0;
1233   if (0 == filesize)
1234   {
1235     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Search strings file %s is empty.\n", filename);
1236     return GNUNET_SYSERR;
1237   }
1238   data = GNUNET_malloc (filesize);
1239   if (filesize != GNUNET_DISK_fn_read (filename, data, filesize))
1240   {
1241     GNUNET_free (data);
1242     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Could not read search strings file %s.\n",
1243          filename);
1244     return GNUNET_SYSERR;
1245   }
1246   buf = data;
1247   offset = 0;
1248   str_cnt = 0;
1249   while (offset < (filesize - 1) && str_cnt < limit)
1250   {
1251     offset++;
1252     if (((data[offset] == '\n')) && (buf != &data[offset]))
1253     {
1254       data[offset] = '\0';
1255       str_cnt++;
1256       buf = &data[offset + 1];
1257     }
1258     else if ((data[offset] == '\n') || (data[offset] == '\0'))
1259       buf = &data[offset + 1];
1260   }
1261   *strings = GNUNET_malloc (sizeof (char *) * str_cnt);
1262   offset = 0;
1263   for (i = 0; i < str_cnt; i++)
1264   {
1265     GNUNET_asprintf (&(*strings)[i], "%s%s", regex_prefix, &data[offset]);
1266     offset += strlen (&data[offset]) + 1;
1267   }
1268   GNUNET_free (data);
1269   return str_cnt;
1270 }
1271
1272
1273 /**
1274  * Main function that will be run by the scheduler.
1275  *
1276  * @param cls closure
1277  * @param args remaining command-line arguments
1278  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
1279  * @param config configuration
1280  */
1281 static void
1282 run (void *cls,
1283      char *const *args,
1284      const char *cfgfile,
1285      const struct GNUNET_CONFIGURATION_Handle *config)
1286 {
1287   unsigned int nsearchstrs;
1288   unsigned int i;
1289   struct GNUNET_TIME_Relative abort_time;
1290
1291   in_shutdown = GNUNET_NO;
1292
1293   /* Check config */
1294   if (NULL == config)
1295   {
1296     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1297                 _("No configuration file given. Exiting\n"));
1298     GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
1299     return;
1300   }
1301   cfg = GNUNET_CONFIGURATION_dup (config);
1302   if (GNUNET_OK !=
1303       GNUNET_CONFIGURATION_get_value_string (cfg, "REGEXPROFILER",
1304                                              "REGEX_PREFIX",
1305                                              &regex_prefix))
1306   {
1307     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1308                                "regexprofiler",
1309                                "regex_prefix");
1310     GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
1311     return;
1312   }
1313   if (GNUNET_OK !=
1314       GNUNET_CONFIGURATION_get_value_number (cfg, "REGEXPROFILER",
1315                                              "PARALLEL_SEARCHES",
1316                                              &init_parallel_searches))
1317   {
1318     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1319                 "Configuration option \"PARALLEL_SEARCHES\" missing."
1320                 " Using default (%d)\n", 10);
1321     init_parallel_searches = 10;
1322   }
1323   if (GNUNET_OK !=
1324       GNUNET_CONFIGURATION_get_value_time (cfg, "REGEXPROFILER",
1325                                            "REANNOUNCE_PERIOD_MAX",
1326                                            &reannounce_period_max))
1327   {
1328     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1329                 "reannounce_period_max not given. Using 10 minutes.\n");
1330     reannounce_period_max =
1331       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 10);
1332   }
1333
1334   /* Check arguments */
1335   if (NULL == policy_dir)
1336   {
1337     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1338                 _("No policy directory specified on command line. Exiting.\n"));
1339     return;
1340   }
1341   if (GNUNET_YES != GNUNET_DISK_directory_test (policy_dir, GNUNET_YES))
1342   {
1343     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1344                 _("Specified policies directory does not exist. Exiting.\n"));
1345     GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
1346     return;
1347   }
1348   if (0 >= (int) (num_peers = GNUNET_DISK_directory_scan (policy_dir, NULL, NULL)))
1349   {
1350     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1351                 _("No files found in `%s'\n"),
1352                 policy_dir);
1353     return;
1354   }
1355   GNUNET_CONFIGURATION_set_value_string (cfg, "REGEXPROFILER",
1356                                          "POLICY_DIR", policy_dir);
1357   if (GNUNET_YES != GNUNET_DISK_file_test (strings_file))
1358   {
1359     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1360                 _("No search strings file given. Exiting.\n"));
1361     GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
1362     return;
1363   }
1364   nsearchstrs = load_search_strings (strings_file,
1365                                      &search_strings,
1366                                      num_peers);
1367   if (num_peers != nsearchstrs)
1368   {
1369     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1370                 "Error loading search strings.\n");
1371     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1372                 "File (%s) does not contain enough strings (%u/%u).\n",
1373                 strings_file, nsearchstrs, num_peers);
1374     GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
1375     return;
1376   }
1377   if ( (0 == num_peers) || (NULL == search_strings))
1378   {
1379     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1380                 _("Error loading search strings. Exiting.\n"));
1381     GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
1382     return;
1383   }
1384   for (i = 0; i < num_peers; i++)
1385     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1386                 "search string: %s\n",
1387                 search_strings[i]);
1388
1389   /* Check logfile */
1390   if ( (NULL != data_filename) &&
1391        (NULL == (data_file =
1392                  GNUNET_DISK_file_open (data_filename,
1393                                         GNUNET_DISK_OPEN_READWRITE |
1394                                         GNUNET_DISK_OPEN_TRUNCATE |
1395                                         GNUNET_DISK_OPEN_CREATE,
1396                                         GNUNET_DISK_PERM_USER_READ |
1397                                         GNUNET_DISK_PERM_USER_WRITE))) )
1398   {
1399     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
1400                               "open",
1401                               data_filename);
1402     return;
1403   }
1404
1405   /* Initialize peers */
1406   peers = GNUNET_malloc (sizeof (struct RegexPeer) * num_peers);
1407   for (i = 0; i < num_peers; i++)
1408     peers[i].id = i;
1409
1410   GNUNET_CONFIGURATION_set_value_number (cfg,
1411                                          "TESTBED", "OVERLAY_RANDOM_LINKS",
1412                                          num_peers * 20);
1413   GNUNET_CONFIGURATION_set_value_number (cfg,
1414                                          "DHT", "FORCE_NSE",
1415                                          (long long unsigned)
1416                                          (log (num_peers) / log (2.0)));
1417   event_mask = 0LL;
1418 /* For feedback about the start process activate these and pass master_cb */
1419   event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
1420 //   event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_STOP);
1421   event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
1422 //   event_mask |= (1LL << GNUNET_TESTBED_ET_DISCONNECT);
1423   prof_start_time = GNUNET_TIME_absolute_get ();
1424   GNUNET_TESTBED_run (hosts_file,
1425                       cfg,
1426                       num_peers,
1427                       event_mask,
1428                       &master_controller_cb,
1429                       NULL,     /* master_controller_cb cls */
1430                       &test_master,
1431                       NULL);    /* test_master cls */
1432   if (GNUNET_OK !=
1433       GNUNET_CONFIGURATION_get_value_time (cfg, "TESTBED",
1434                                            "SETUP_TIMEOUT",
1435                                            &abort_time))
1436   {
1437     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1438                 "SETUP_TIMEOUT not given. Using 15 minutes.\n");
1439     abort_time =
1440       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15);
1441   }
1442   abort_time = GNUNET_TIME_relative_add (abort_time, GNUNET_TIME_UNIT_MINUTES);
1443   abort_task =
1444       GNUNET_SCHEDULER_add_delayed (abort_time,
1445                                     &do_abort,
1446                                     (void*) __LINE__);
1447   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1448               "setup_timeout: %s\n",
1449               GNUNET_STRINGS_relative_time_to_string (abort_time, GNUNET_YES));
1450 }
1451
1452
1453 /**
1454  * Main function.
1455  *
1456  * @param argc argument count
1457  * @param argv argument values
1458  * @return 0 on success
1459  */
1460 int
1461 main (int argc, char *const *argv)
1462 {
1463   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
1464     {'o', "output-file", "FILENAME",
1465      gettext_noop ("name of the file for writing statistics"),
1466      GNUNET_YES, &GNUNET_GETOPT_set_string, &data_filename},
1467     {'t', "matching-timeout", "TIMEOUT",
1468       gettext_noop ("wait TIMEOUT before ending the experiment"),
1469       GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &search_timeout_time},
1470     {'p', "policy-dir", "DIRECTORY",
1471       gettext_noop ("directory with policy files"),
1472       GNUNET_YES, &GNUNET_GETOPT_set_filename, &policy_dir},
1473     {'s', "strings-file", "FILENAME",
1474       gettext_noop ("name of file with input strings"),
1475       GNUNET_YES, &GNUNET_GETOPT_set_filename, &strings_file},
1476     {'H', "hosts-file", "FILENAME",
1477       gettext_noop ("name of file with hosts' names"),
1478       GNUNET_YES, &GNUNET_GETOPT_set_filename, &hosts_file},
1479     GNUNET_GETOPT_OPTION_END
1480   };
1481   int ret;
1482
1483   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
1484     return 2;
1485   result = GNUNET_SYSERR;
1486   ret =
1487       GNUNET_PROGRAM_run (argc, argv,
1488                           "gnunet-regex-profiler",
1489                           _("Profiler for regex"),
1490                           options, &run, NULL);
1491   if (GNUNET_OK != ret)
1492     return ret;
1493   if (GNUNET_OK != result)
1494     return 1;
1495   return 0;
1496 }