2 This file is part of GNUnet.
3 (C) 2012, 2013 Christian Grothoff
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.
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.
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.
22 * @file regex/gnunet-daemon-regexprofiler.c
23 * @brief daemon that uses mesh 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 mesh service running on the
26 * peer from within the profiler.
27 * @author Maximilian Szengel
28 * @author Bartlomiej Polot
31 #include "gnunet_util_lib.h"
32 #include "gnunet_regex_lib.h"
33 #include "gnunet_dht_service.h"
34 #include "gnunet_statistics_service.h"
37 * Return value from 'main'.
39 static int global_ret;
42 * Configuration we use.
44 static const struct GNUNET_CONFIGURATION_Handle *cfg;
47 * Handle to the statistics service.
49 static struct GNUNET_STATISTICS_Handle *stats_handle;
54 static struct GNUNET_DHT_Handle *dht_handle;
57 * Peer's regex announce handle.
59 static struct GNUNET_REGEX_announce_handle *announce_handle;
62 * Periodically reannounce regex.
64 static GNUNET_SCHEDULER_TaskIdentifier reannounce_task;
67 * How often reannounce regex.
69 static struct GNUNET_TIME_Relative reannounce_freq;
72 * Random delay to spread out load on the DHT.
74 static struct GNUNET_TIME_Relative announce_delay;
77 * Maximal path compression length for regex announcing.
79 static unsigned long long max_path_compression;
82 * Name of the file containing policies that this peer should announce. One
85 static char * policy_filename;
88 * Prefix to add before every regex we're announcing.
90 static char * regex_prefix;
95 static char *rx_with_pfx;
99 * Task run during shutdown.
105 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
107 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "shutting down\n");
109 if (NULL != announce_handle)
111 GNUNET_REGEX_announce_cancel (announce_handle);
112 announce_handle = NULL;
115 if (NULL != dht_handle)
117 GNUNET_DHT_disconnect (dht_handle);
121 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "shut down\n");
126 * Announce a previously announced regex re-using cached data.
128 * @param cls Closure (regex to announce if needed).
129 * @param tc TaskContext.
132 reannounce_regex (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
134 struct GNUNET_PeerIdentity id;
137 reannounce_task = GNUNET_SCHEDULER_NO_TASK;
138 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
144 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Announcing regex: %s\n", regex);
145 GNUNET_STATISTICS_update (stats_handle, "# regexes announced", 1, GNUNET_NO);
146 if (NULL == announce_handle && NULL != regex)
148 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
149 "First time, creating regex: %s\n",
151 memset (&id, 0, sizeof (struct GNUNET_PeerIdentity));
152 announce_handle = GNUNET_REGEX_announce (dht_handle,
155 (unsigned int) max_path_compression,
160 GNUNET_assert (NULL != announce_handle);
161 GNUNET_REGEX_reannounce (announce_handle);
165 GNUNET_SCHEDULER_add_delayed (
166 GNUNET_TIME_relative_add (reannounce_freq,
167 GNUNET_TIME_relative_multiply (
168 GNUNET_TIME_UNIT_SECONDS,
169 GNUNET_CRYPTO_random_u32 (
170 GNUNET_CRYPTO_QUALITY_WEAK,
178 * Announce the given regular expression using Mesh and the path compression
179 * length read from config.
181 * @param regex regular expression to announce on this peer's mesh.
184 announce_regex (const char * regex)
188 if (NULL == regex || 0 == strlen (regex))
190 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Cannot announce empty regex\n");
194 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == reannounce_task);
195 copy = GNUNET_strdup (regex);
196 reannounce_task = GNUNET_SCHEDULER_add_delayed (announce_delay,
203 * Load regular expressions from filename into 'rxes' array. Array needs to be freed.
205 * @param filename filename of the file containing the regexes, one per line.
206 * @param rx string with the union of all regular expressions.
208 * @return number of regular expressions read from filename and in rxes array.
209 * FIXME use load regex lib function
212 load_regexes (const char *filename, char **rx)
220 if (GNUNET_YES != GNUNET_DISK_file_test (policy_filename))
222 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
223 "Could not find policy file %s\n", policy_filename);
226 if (GNUNET_OK != GNUNET_DISK_file_size (policy_filename, &filesize, GNUNET_YES, GNUNET_YES))
230 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Policy file %s is empty.\n", policy_filename);
233 data = GNUNET_malloc (filesize);
234 if (filesize != GNUNET_DISK_fn_read (policy_filename, data, filesize))
237 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not read policy file %s.\n",
244 while (offset < (filesize - 1))
247 if ((data[offset] == '\n') && (buf != &data[offset]))
250 buf = &data[offset + 1];
253 else if ((data[offset] == '\n') || (data[offset] == '\0'))
254 buf = &data[offset + 1];
264 * @brief Main function that will be run by the scheduler.
267 * @param args remaining command-line arguments
268 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
269 * @param cfg_ configuration
272 run (void *cls, char *const *args GNUNET_UNUSED,
273 const char *cfgfile GNUNET_UNUSED,
274 const struct GNUNET_CONFIGURATION_Handle *cfg_)
281 GNUNET_CONFIGURATION_get_value_number (cfg, "REGEXPROFILER", "MAX_PATH_COMPRESSION",
282 &max_path_compression))
284 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
286 ("%s service is lacking key configuration settings (%s). Exiting.\n"),
287 "regexprofiler", "max_path_compression");
288 global_ret = GNUNET_SYSERR;
289 GNUNET_SCHEDULER_shutdown ();
294 GNUNET_CONFIGURATION_get_value_filename (cfg, "REGEXPROFILER",
295 "POLICY_FILE", &policy_filename))
297 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
299 ("%s service is lacking key configuration settings (%s). Exiting.\n"),
300 "regexprofiler", "policy_file");
301 global_ret = GNUNET_SYSERR;
302 GNUNET_SCHEDULER_shutdown ();
307 GNUNET_CONFIGURATION_get_value_string (cfg, "REGEXPROFILER",
308 "REGEX_PREFIX", ®ex_prefix))
310 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
312 ("%s service is lacking key configuration settings (%s). Exiting.\n"),
313 "regexprofiler", "regex_prefix");
314 global_ret = GNUNET_SYSERR;
315 GNUNET_SCHEDULER_shutdown ();
320 GNUNET_CONFIGURATION_get_value_time (cfg, "REGEXPROFILER",
321 "REANNOUNCE_FREQ", &reannounce_freq))
323 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
324 "reannounce_freq not given. Using 10 minutes.\n");
326 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 10);
330 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
331 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 600));
333 stats_handle = GNUNET_STATISTICS_create ("regexprofiler", cfg);
335 dht_handle = GNUNET_DHT_connect (cfg, 1);
337 if (NULL == dht_handle)
339 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
340 "Could not acquire dht handle. Exiting.\n");
341 global_ret = GNUNET_SYSERR;
342 GNUNET_SCHEDULER_shutdown ();
346 /* Read regexes from policy files */
347 if (0 == load_regexes (policy_filename, ®ex))
349 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
350 "Policy file %s contains no policies. Exiting.\n",
352 global_ret = GNUNET_SYSERR;
353 GNUNET_SCHEDULER_shutdown ();
357 /* Announcing regexes from policy_filename */
358 GNUNET_asprintf (&rx_with_pfx, "%s(%s)", regex_prefix, regex);
359 announce_regex (rx_with_pfx);
361 GNUNET_free (rx_with_pfx);
363 /* Scheduled the task to clean up when shutdown is called */
364 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
370 * The main function of the regexprofiler service.
372 * @param argc number of arguments from the command line
373 * @param argv command line arguments
374 * @return 0 ok, 1 on error
377 main (int argc, char *const *argv)
379 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
380 GNUNET_GETOPT_OPTION_END
383 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
386 GNUNET_PROGRAM_run (argc, argv, "regexprofiler",
388 ("Daemon to announce regular expressions for the peer using mesh."),
389 options, &run, NULL)) ? global_ret : 1;
397 * MINIMIZE heap size (way below 128k) since this process doesn't need much.
399 void __attribute__ ((constructor)) GNUNET_ARM_memory_init ()
401 mallopt (M_TRIM_THRESHOLD, 4 * 1024);
402 mallopt (M_TOP_PAD, 1 * 1024);
408 /* end of gnunet-daemon-regexprofiler.c */