src/regex/gnunet-daemon-regexprofiler.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012, 2013 Christian Grothoff
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19 */
  20
  21 /**
  22  * @file regex/gnunet-daemon-regexprofiler.c
  23  * @brief daemon that uses cadet to announce a regular expression. Used in
  24  * conjunction with gnunet-regex-profiler to announce regexes on serveral peers
  25  * without the need to explicitly connect to the cadet service running on the
  26  * peer from within the profiler.
  27  * @author Maximilian Szengel
  28  * @author Bartlomiej Polot
  29  */
  30 #include "platform.h"
  31 #include "gnunet_util_lib.h"
  32 #include "regex_internal_lib.h"
  33 #include "regex_test_lib.h"
  34 #include "gnunet_dht_service.h"
  35 #include "gnunet_statistics_service.h"
  36
  37 /**
  38  * Return value from 'main'.
  39  */
  40 static int global_ret;
  41
  42 /**
  43  * Configuration we use.
  44  */
  45 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  46
  47 /**
  48  * Handle to the statistics service.
  49  */
  50 static struct GNUNET_STATISTICS_Handle *stats_handle;
  51
  52 /**
  53  * Peer's dht handle.
  54  */
  55 static struct GNUNET_DHT_Handle *dht_handle;
  56
  57 /**
  58  * Peer's regex announce handle.
  59  */
  60 static struct REGEX_INTERNAL_Announcement *announce_handle;
  61
  62 /**
  63  * Periodically reannounce regex.
  64  */
  65 static struct GNUNET_SCHEDULER_Task * reannounce_task;
  66
  67 /**
  68  * What's the maximum reannounce period.
  69  */
  70 static struct GNUNET_TIME_Relative reannounce_period_max;
  71
  72 /**
  73  * Maximal path compression length for regex announcing.
  74  */
  75 static unsigned long long max_path_compression;
  76
  77 /**
  78  * Name of the file containing policies that this peer should announce. One
  79  * policy per line.
  80  */
  81 static char * policy_filename;
  82
  83 /**
  84  * Prefix to add before every regex we're announcing.
  85  */
  86 static char * regex_prefix;
  87
  88 /**
  89  * Regex with prefix.
  90  */
  91 static char *rx_with_pfx;
  92
  93 /**
  94  * How many put rounds should we do.
  95  */
  96 static unsigned int rounds = 3;
  97
  98 /**
  99  * Private key for this peer.
 100  */
 101 static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
 102
 103
 104
 105 /**
 106  * Task run during shutdown.
 107  *
 108  * @param cls unused
 109  */
 110 static void
 111 shutdown_task (void *cls)
 112 {
 113   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "shutting down\n");
 114
 115   if (NULL != announce_handle)
 116   {
 117     REGEX_INTERNAL_announce_cancel (announce_handle);
 118     announce_handle = NULL;
 119   }
 120   if (NULL != reannounce_task)
 121   {
 122     GNUNET_free (GNUNET_SCHEDULER_cancel (reannounce_task));
 123     reannounce_task = NULL;
 124   }
 125   if (NULL != dht_handle)
 126   {
 127     GNUNET_DHT_disconnect (dht_handle);
 128     dht_handle = NULL;
 129   }
 130   GNUNET_free (my_private_key);
 131   my_private_key = NULL;
 132
 133   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 134               "Daemon for %s shutting down\n",
 135               policy_filename);
 136 }
 137
 138
 139 /**
 140  * Announce a previously announced regex re-using cached data.
 141  *
 142  * @param cls Closure (regex to announce if needed).
 143  */
 144 static void
 145 reannounce_regex (void *cls)
 146 {
 147   char *regex = cls;
 148   struct GNUNET_TIME_Relative random_delay;
 149
 150   reannounce_task = NULL;
 151   if (0 == rounds--)
 152   {
 153     global_ret = 0;
 154     GNUNET_SCHEDULER_shutdown ();
 155     GNUNET_free (regex);
 156     return;
 157   }
 158   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Announcing regex: %s\n", regex);
 159   GNUNET_STATISTICS_update (stats_handle, "# regexes announced", 1, GNUNET_NO);
 160   if (NULL == announce_handle && NULL != regex)
 161   {
 162     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 163                 "First time, creating regex: %s\n",
 164                 regex);
 165     announce_handle = REGEX_INTERNAL_announce (dht_handle,
 166                                                my_private_key,
 167                                                regex,
 168                                                (unsigned int) max_path_compression,
 169                                                stats_handle);
 170   }
 171   else
 172   {
 173     GNUNET_assert (NULL != announce_handle);
 174     REGEX_INTERNAL_reannounce (announce_handle);
 175   }
 176
 177   random_delay =
 178     GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MICROSECONDS,
 179                                    GNUNET_CRYPTO_random_u32 (
 180                                      GNUNET_CRYPTO_QUALITY_WEAK,
 181                                      reannounce_period_max.rel_value_us));
 182   reannounce_task = GNUNET_SCHEDULER_add_delayed (random_delay,
 183                                                   &reannounce_regex, cls);
 184 }
 185
 186
 187 /**
 188  * Announce the given regular expression using regex and the path compression
 189  * length read from config.
 190  *
 191  * @param regex regular expression to announce on this peer's cadet.
 192  */
 193 static void
 194 announce_regex (const char *regex)
 195 {
 196   char *copy;
 197
 198   if (NULL == regex || 0 == strlen (regex))
 199   {
 200     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Cannot announce empty regex\n");
 201     return;
 202   }
 203
 204   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 205               "Daemon for %s starting\n",
 206               policy_filename);
 207   GNUNET_assert (NULL == reannounce_task);
 208   copy = GNUNET_strdup (regex);
 209   reannounce_task = GNUNET_SCHEDULER_add_now (&reannounce_regex,
 210                                               (void *) copy);
 211 }
 212
 213
 214 /**
 215  * Scan through the policy_dir looking for the n-th filename.
 216  *
 217  * @param cls Closure (target number n).
 218  * @param filename complete filename (absolute path).
 219  * @return GNUNET_OK to continue to iterate,
 220  *  GNUNET_NO to stop when found
 221  */
 222 static int
 223 scan (void *cls, const char *filename)
 224 {
 225   long n = (long) cls;
 226   static long c = 0;
 227
 228   if (c == n)
 229   {
 230     policy_filename = GNUNET_strdup (filename);
 231     return GNUNET_NO;
 232   }
 233   c++;
 234   return GNUNET_OK;
 235 }
 236
 237
 238 /**
 239  * @brief Main function that will be run by the scheduler.
 240  *
 241  * @param cls closure
 242  * @param args remaining command-line arguments
 243  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 244  * @param cfg_ configuration
 245  */
 246 static void
 247 run (void *cls, char *const *args GNUNET_UNUSED,
 248      const char *cfgfile GNUNET_UNUSED,
 249      const struct GNUNET_CONFIGURATION_Handle *cfg_)
 250 {
 251   char *regex = NULL;
 252   char **components;
 253   char *policy_dir;
 254   long long unsigned int peer_id;
 255
 256   cfg = cfg_;
 257
 258   my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_configuration (cfg);
 259   GNUNET_assert (NULL != my_private_key);
 260   if (GNUNET_OK !=
 261       GNUNET_CONFIGURATION_get_value_number (cfg, "REGEXPROFILER",
 262                                              "MAX_PATH_COMPRESSION",
 263                                              &max_path_compression))
 264   {
 265     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 266                 _
 267                 ("%s service is lacking key configuration settings (%s).  Exiting.\n"),
 268                 "regexprofiler", "max_path_compression");
 269     global_ret = GNUNET_SYSERR;
 270     GNUNET_SCHEDULER_shutdown ();
 271     return;
 272   }
 273   if (GNUNET_OK !=
 274       GNUNET_CONFIGURATION_get_value_string (cfg, "REGEXPROFILER",
 275                                              "POLICY_DIR", &policy_dir))
 276   {
 277     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "REGEXPROFILER", "POLICY_DIR");
 278     global_ret = GNUNET_SYSERR;
 279     GNUNET_SCHEDULER_shutdown ();
 280     return;
 281   }
 282   if (GNUNET_OK !=
 283       GNUNET_CONFIGURATION_get_value_number (cfg, "TESTBED",
 284                                              "PEERID", &peer_id))
 285   {
 286     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "TESTBED", "PEERID");
 287     global_ret = GNUNET_SYSERR;
 288     GNUNET_free (policy_dir);
 289     GNUNET_SCHEDULER_shutdown ();
 290     return;
 291   }
 292
 293   if (GNUNET_OK !=
 294       GNUNET_CONFIGURATION_get_value_string (cfg, "REGEXPROFILER",
 295                                              "REGEX_PREFIX", &regex_prefix))
 296   {
 297     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "REGEXPROFILER", "REGEX_PREFIX");
 298     global_ret = GNUNET_SYSERR;
 299     GNUNET_free (policy_dir);
 300     GNUNET_SCHEDULER_shutdown ();
 301     return;
 302   }
 303
 304   if (GNUNET_OK !=
 305       GNUNET_CONFIGURATION_get_value_time (cfg, "REGEXPROFILER",
 306                                            "REANNOUNCE_PERIOD_MAX",
 307                                            &reannounce_period_max))
 308   {
 309     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 310                 "reannounce_period_max not given. Using 10 minutes.\n");
 311     reannounce_period_max =
 312       GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 10);
 313   }
 314
 315   stats_handle = GNUNET_STATISTICS_create ("regexprofiler", cfg);
 316
 317   dht_handle = GNUNET_DHT_connect (cfg, 1);
 318
 319   if (NULL == dht_handle)
 320   {
 321     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 322                 "Could not acquire dht handle. Exiting.\n");
 323     global_ret = GNUNET_SYSERR;
 324     GNUNET_free (policy_dir);
 325     GNUNET_SCHEDULER_shutdown ();
 326     return;
 327   }
 328
 329   /* Read regexes from policy files */
 330   GNUNET_assert (-1 != GNUNET_DISK_directory_scan (policy_dir, &scan,
 331                                                    (void *) (long) peer_id));
 332   if (NULL == (components = REGEX_TEST_read_from_file (policy_filename)))
 333   {
 334     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 335                 "Policy file %s contains no policies. Exiting.\n",
 336                 policy_filename);
 337     global_ret = GNUNET_SYSERR;
 338     GNUNET_free (policy_dir);
 339     GNUNET_SCHEDULER_shutdown ();
 340     return;
 341   }
 342   GNUNET_free (policy_dir);
 343   regex = REGEX_TEST_combine (components, 16);
 344   REGEX_TEST_free_from_file (components);
 345
 346   /* Announcing regexes from policy_filename */
 347   GNUNET_asprintf (&rx_with_pfx,
 348                    "%s(%s)(0|1|2|3|4|5|6|7|8|9|a|b|c|d|e|f)*",
 349                    regex_prefix,
 350                    regex);
 351   announce_regex (rx_with_pfx);
 352   GNUNET_free (regex);
 353   GNUNET_free (rx_with_pfx);
 354
 355   /* Scheduled the task to clean up when shutdown is called */
 356   GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
 357                                  NULL);
 358 }
 359
 360
 361 /**
 362  * The main function of the regexprofiler service.
 363  *
 364  * @param argc number of arguments from the command line
 365  * @param argv command line arguments
 366  * @return 0 ok, 1 on error
 367  */
 368 int
 369 main (int argc, char *const *argv)
 370 {
 371   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 372     GNUNET_GETOPT_OPTION_END
 373   };
 374
 375   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 376     return 2;
 377   return (GNUNET_OK ==
 378           GNUNET_PROGRAM_run (argc, argv, "regexprofiler",
 379                               gettext_noop
 380                               ("Daemon to announce regular expressions for the peer using cadet."),
 381                               options, &run, NULL)) ? global_ret : 1;
 382 }
 383
 384
 385 #if defined(LINUX) && defined(__GLIBC__)
 386 #include <malloc.h>
 387
 388 /**
 389  * MINIMIZE heap size (way below 128k) since this process doesn't need much.
 390  */
 391 void __attribute__ ((constructor)) GNUNET_ARM_memory_init ()
 392 {
 393   mallopt (M_TRIM_THRESHOLD, 4 * 1024);
 394   mallopt (M_TOP_PAD, 1 * 1024);
 395   malloc_trim (0);
 396 }
 397 #endif
 398
 399
 400 /* end of gnunet-daemon-regexprofiler.c */