GNUnet  0.10.x
gnunet-regex-simulation-profiler.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2011, 2012 GNUnet e.V.
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 
31 #include "platform.h"
32 #include "gnunet_util_lib.h"
33 #include "regex_internal_lib.h"
34 #include "gnunet_mysql_lib.h"
35 #include "gnunet_my_lib.h"
36 #include <mysql/mysql.h>
37 
41 #define INSERT_EDGE_STMT "INSERT IGNORE INTO `%s` " \
42  "(`key`, `label`, `to_key`, `accepting`) " \
43  "VALUES (?, ?, ?, ?);"
44 
48 #define SELECT_KEY_STMT "SELECT COUNT(*) FROM `%s` " \
49  "WHERE `key` = ? AND `label` = ?;"
50 
55 struct ProgressMeter {
59  unsigned int total;
60 
64  unsigned int modnum;
65 
69  unsigned int dotnum;
70 
74  unsigned int completed;
75 
79  int print;
80 
85 };
86 
87 
91 static struct ProgressMeter *meter;
92 
97 
101 static int result;
102 
107 
112 
117 
121 static char *table_name;
122 
126 static char *policy_dir;
127 
131 static unsigned int num_policy_files;
132 
136 static unsigned int num_policies;
137 
141 static unsigned int max_path_compression;
142 
146 static unsigned long long num_merged_transitions;
147 
151 static unsigned long long num_merged_states;
152 
156 static char *regex_prefix;
157 
158 
169 static struct ProgressMeter *
170 create_meter(unsigned int total, char *start_string, int print)
171 {
172  struct ProgressMeter *ret;
173 
174  ret = GNUNET_new(struct ProgressMeter);
175  ret->print = print;
176  ret->total = total;
177  ret->modnum = total / 4;
178  if (ret->modnum == 0) /* Divide by zero check */
179  ret->modnum = 1;
180  ret->dotnum = (total / 50) + 1;
181  if (start_string != NULL)
182  ret->startup_string = GNUNET_strdup(start_string);
183  else
184  ret->startup_string = GNUNET_strdup("");
185 
186  return ret;
187 }
188 
189 
198 static int
200 {
201  if (meter->print == GNUNET_YES)
202  {
203  if (meter->completed % meter->modnum == 0)
204  {
205  if (meter->completed == 0)
206  {
207  fprintf(stdout, "%sProgress: [0%%", meter->startup_string);
208  }
209  else
210  fprintf(stdout, "%d%%",
211  (int)(((float)meter->completed / meter->total) * 100));
212  }
213  else if (meter->completed % meter->dotnum == 0)
214  fprintf(stdout, "%s", ".");
215 
216  if (meter->completed + 1 == meter->total)
217  fprintf(stdout, "%d%%]\n", 100);
218  fflush(stdout);
219  }
220  meter->completed++;
221 
222  if (meter->completed == meter->total)
223  return GNUNET_YES;
224  if (meter->completed > meter->total)
225  GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Progress meter overflow!!\n");
226  return GNUNET_NO;
227 }
228 
229 
238 static int
240 {
241  if (meter == NULL)
242  return GNUNET_SYSERR;
243 
244  meter->completed = 0;
245  return GNUNET_YES;
246 }
247 
248 
254 static void
255 free_meter(struct ProgressMeter *meter)
256 {
258  GNUNET_free(meter);
259 }
260 
261 
267 static void
268 do_shutdown(void *cls)
269 {
270  if (NULL != mysql_ctx)
271  {
272  GNUNET_MYSQL_context_destroy(mysql_ctx);
273  mysql_ctx = NULL;
274  }
275  if (NULL != meter)
276  {
277  free_meter(meter);
278  meter = NULL;
279  }
280 }
281 
282 
294 static void
295 do_abort(void *cls)
296 {
297  GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Aborting\n");
298  if (NULL != scan_task)
299  {
300  GNUNET_SCHEDULER_cancel(scan_task);
301  scan_task = NULL;
302  }
305 }
306 
317 static void
318 regex_iterator(void *cls,
319  const struct GNUNET_HashCode *key,
320  const char *proof,
321  int accepting,
322  unsigned int num_edges,
323  const struct REGEX_BLOCK_Edge *edges)
324 {
325  unsigned int i;
326  int result;
327 
328  uint32_t iaccepting = (uint32_t)accepting;
329  uint64_t total;
330 
331  GNUNET_assert(NULL != mysql_ctx);
332 
333  for (i = 0; i < num_edges; i++)
334  {
335  struct GNUNET_MY_QueryParam params_select[] = {
337  GNUNET_MY_query_param_string(edges[i].label),
339  };
340 
341  struct GNUNET_MY_ResultSpec results_select[] = {
344  };
345 
346  result =
347  GNUNET_MY_exec_prepared(mysql_ctx,
348  select_stmt_handle,
349  params_select);
350 
351  if (GNUNET_SYSERR == result)
352  {
354  "Error executing prepared mysql select statement\n");
356  return;
357  }
358 
359  result =
360  GNUNET_MY_extract_result(select_stmt_handle,
361  results_select);
362 
363  if (GNUNET_SYSERR == result)
364  {
366  "Error extracting result mysql select statement\n");
368  return;
369  }
370 
371  if (-1 != total && total > 0)
372  {
373  GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Total: %llu (%s, %s)\n",
374  (unsigned long long)total,
375  GNUNET_h2s(key), edges[i].label);
376  }
377 
378  struct GNUNET_MY_QueryParam params_stmt[] = {
380  GNUNET_MY_query_param_string(edges[i].label),
381  GNUNET_MY_query_param_auto_from_type(&edges[i].destination),
382  GNUNET_MY_query_param_uint32(&iaccepting),
384  };
385 
386  result =
387  GNUNET_MY_exec_prepared(mysql_ctx,
388  stmt_handle,
389  params_stmt);
390 
391  if (0 == result)
392  {
393  char *key_str = GNUNET_strdup(GNUNET_h2s(key));
394  char *to_key_str = GNUNET_strdup(GNUNET_h2s(&edges[i].destination));
395 
396  GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Merged (%s, %s, %s, %i)\n",
397  key_str,
398  edges[i].label,
399  to_key_str,
400  accepting);
401 
402  GNUNET_free(key_str);
403  GNUNET_free(to_key_str);
405  }
406  else if (-1 != total)
407  {
409  }
410 
411  if (GNUNET_SYSERR == result || (1 != result && 0 != result))
412  {
414  "Error executing prepared mysql statement for edge: Affected rows: %i, expected 0 or 1!\n",
415  result);
417  }
418  }
419 
420  if (0 == num_edges)
421  {
422  struct GNUNET_MY_QueryParam params_stmt[] = {
426  GNUNET_MY_query_param_uint32(&iaccepting),
428  };
429 
430  result =
431  GNUNET_MY_exec_prepared(mysql_ctx,
432  stmt_handle,
433  params_stmt);
434 
435  if (1 != result && 0 != result)
436  {
438  "Error executing prepared mysql statement for edge: Affected rows: %i, expected 0 or 1!\n",
439  result);
441  }
442  }
443 }
444 
445 
453 static int
454 announce_regex(const char *regex)
455 {
456  struct REGEX_INTERNAL_Automaton *dfa;
457 
458  dfa =
460  strlen(regex),
462 
463  if (NULL == dfa)
464  {
466  "Failed to create DFA for regex %s\n",
467  regex);
469  return GNUNET_SYSERR;
470  }
472  &regex_iterator, NULL);
474 
475  return GNUNET_OK;
476 }
477 
478 
487 static int
488 policy_filename_cb(void *cls, const char *filename)
489 {
490  char *regex;
491  char *data;
492  char *buf;
493  uint64_t filesize;
494  unsigned int offset;
495 
496  GNUNET_assert(NULL != filename);
497 
499  "Announcing regexes from file %s\n",
500  filename);
501 
502  if (GNUNET_YES != GNUNET_DISK_file_test(filename))
503  {
505  "Could not find policy file %s\n",
506  filename);
507  return GNUNET_OK;
508  }
509  if (GNUNET_OK !=
510  GNUNET_DISK_file_size(filename, &filesize,
512  filesize = 0;
513  if (0 == filesize)
514  {
515  GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Policy file %s is empty.\n",
516  filename);
517  return GNUNET_OK;
518  }
519  data = GNUNET_malloc(filesize);
520  if (filesize != GNUNET_DISK_fn_read(filename, data, filesize))
521  {
522  GNUNET_free(data);
524  "Could not read policy file %s.\n",
525  filename);
526  return GNUNET_OK;
527  }
528 
529  update_meter(meter);
530 
531  buf = data;
532  offset = 0;
533  regex = NULL;
534  while (offset < (filesize - 1))
535  {
536  offset++;
537  if (((data[offset] == '\n')) && (buf != &data[offset]))
538  {
539  data[offset] = '|';
540  num_policies++;
541  buf = &data[offset + 1];
542  }
543  else if ((data[offset] == '\n') || (data[offset] == '\0'))
544  buf = &data[offset + 1];
545  }
546  data[offset] = '\0';
547  GNUNET_asprintf(&regex, "%s(%s)", regex_prefix, data);
548  GNUNET_assert(NULL != regex);
550  "Announcing regex: %s\n", regex);
551 
552  if (GNUNET_OK != announce_regex(regex))
553  {
555  "Could not announce regex %s\n",
556  regex);
557  }
558  GNUNET_free(regex);
559  GNUNET_free(data);
560  return GNUNET_OK;
561 }
562 
563 
569 static void
571 {
572  struct GNUNET_TIME_Absolute start_time;
573  struct GNUNET_TIME_Relative duration;
574  char *stmt;
575 
576  /* Create an MySQL prepared statement for the inserts */
577  scan_task = NULL;
579  stmt_handle = GNUNET_MYSQL_statement_prepare(mysql_ctx, stmt);
580  GNUNET_free(stmt);
581 
583  select_stmt_handle = GNUNET_MYSQL_statement_prepare(mysql_ctx, stmt);
584  GNUNET_free(stmt);
585 
586  GNUNET_assert(NULL != stmt_handle);
587 
589  "Announcing policy files\n",
590  GNUNET_YES);
591  start_time = GNUNET_TIME_absolute_get();
594  stmt_handle);
595  duration = GNUNET_TIME_absolute_get_duration(start_time);
596  reset_meter(meter);
597  free_meter(meter);
598  meter = NULL;
599 
600  printf("Announced %u files containing %u policies in %s\n"
601  "Duplicate transitions: %llu\nMerged states: %llu\n",
603  num_policies,
607  result = GNUNET_OK;
609 }
610 
611 
620 static void
621 run(void *cls,
622  char *const *args,
623  const char *cfgfile,
624  const struct GNUNET_CONFIGURATION_Handle *config)
625 {
626  if (NULL == args[0])
627  {
628  fprintf(stderr,
629  _("No policy directory specified on command line. Exiting.\n"));
631  return;
632  }
633  if (GNUNET_YES !=
635  {
636  fprintf(stderr,
637  _("Specified policies directory does not exist. Exiting.\n"));
639  return;
640  }
641  policy_dir = args[0];
642 
644  NULL, NULL);
645  meter = NULL;
646 
647  if (NULL == table_name)
648  {
650  "No table name specified, using default \"NFA\".\n");
651  table_name = "NFA";
652  }
653 
654  mysql_ctx = GNUNET_MYSQL_context_create(config, "regex-mysql");
655  if (NULL == mysql_ctx)
656  {
658  "Failed to create mysql context\n");
660  return;
661  }
662 
663  if (GNUNET_OK !=
665  "regex-mysql",
666  "REGEX_PREFIX",
667  &regex_prefix))
668  {
670  "regex-mysql",
671  "REGEX_PREFIX");
673  return;
674  }
675 
676  result = GNUNET_OK;
678  NULL);
679  scan_task = GNUNET_SCHEDULER_add_now(&do_directory_scan, NULL);
680 }
681 
682 
690 int
691 main(int argc, char *const *argv)
692 {
693  struct GNUNET_GETOPT_CommandLineOption options[] = {
695  "table",
696  "TABLENAME",
697  gettext_noop("name of the table to write DFAs"),
698  &table_name),
699 
701  "max-path-compression",
702  "MAX_PATH_COMPRESSION",
703  gettext_noop("maximum path compression length"),
705 
707  };
708  int ret;
709 
710  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args(argc, argv, &argc, &argv))
711  return 2;
712 
714  ret =
715  GNUNET_PROGRAM_run(argc, argv,
716  "gnunet-regex-simulationprofiler [OPTIONS] policy-dir",
717  _("Profiler for regex library"), options, &run, NULL);
718  if (GNUNET_OK != ret)
719  return ret;
720  if (GNUNET_OK != result)
721  return 1;
722  return 0;
723 }
int GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory)...
Definition: disk.c:541
static int announce_regex(const char *regex)
Announce a regex by creating the DFA and iterating over each state, inserting each state into a MySQL...
#define GNUNET_MY_query_param_auto_from_type(x)
Generate fixed-size query parameter with size determined by variable type.
static char * table_name
MySQL table name.
struct GNUNET_MYSQL_Context * GNUNET_MYSQL_context_create(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
Create a mysql context.
Definition: mysql.c:319
#define GNUNET_MY_result_spec_end
End of result speceter specification.
Simple struct to keep track of progress, and print a nice little percentage meter for long running ta...
struct GNUNET_MY_ResultSpec GNUNET_MY_result_spec_uint64(uint64_t *u64)
uint64_t expected.
struct GNUNET_MY_QueryParam GNUNET_MY_query_param_fixed_size(const void *ptr, size_t ptr_size)
Generate query parameter for a buffer ptr of ptr_size bytes.FG.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1284
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1439
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static void do_directory_scan(void *cls)
Iterate over files contained in policy_dir.
#define INSERT_EDGE_STMT
MySQL statement to insert an edge.
static unsigned int max_path_compression
Maximal path compression length.
static unsigned long long num_merged_transitions
Number of merged transitions.
int GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:500
Information we pass to GNUNET_MY_exec_prepared() to initialize the arguments of the prepared statemen...
Definition: gnunet_my_lib.h:84
#define GNUNET_NO
Definition: gnunet_common.h:78
static unsigned long long num_merged_states
Number of merged states from different policies.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
static int reset_meter(struct ProgressMeter *meter)
Reset progress meter.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition of a command line option.
Handle for a prepared statement.
Definition: mysql.c:112
Automaton representation.
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:909
static unsigned int num_policy_files
Number of policy files.
int GNUNET_MY_exec_prepared(struct GNUNET_MYSQL_Context *mc, struct GNUNET_MYSQL_StatementHandle *sh, struct GNUNET_MY_QueryParam *params)
Run a prepared SELECT statement.
Definition: my.c:42
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:517
static int ret
Final status code.
Definition: gnunet-arm.c:89
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
unsigned int modnum
Intervall for printing percentage.
static char * policy_dir
Policy dir containing files that contain policies.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
Edge representation.
static struct GNUNET_MYSQL_Context * mysql_ctx
MySQL context.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a string.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
static void regex_iterator(void *cls, const struct GNUNET_HashCode *key, const char *proof, int accepting, unsigned int num_edges, const struct REGEX_BLOCK_Edge *edges)
Iterator over all states that inserts each state into the MySQL db.
int GNUNET_asprintf(char **buf, const char *format,...)
Like asprintf, just portable.
Information we pass to GNUNET_MY_extract_result() to initialize the arguments of the prepared stateme...
static void run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *config)
Main function that will be run by the scheduler.
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
library to parse regular expressions into dfa
static uint64_t proof
Definition: gnunet-scrypt.c:41
int main(int argc, char *const *argv)
Main function.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1264
void GNUNET_MYSQL_context_destroy(struct GNUNET_MYSQL_Context *mc)
Destroy a mysql context.
Definition: mysql.c:367
static struct ProgressMeter * meter
Handle for the progress meter.
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
unsigned int completed
Completed number.
static char buf[2048]
static char * filename
static const struct GNUNET_CONFIGURATION_Handle * config
static struct GNUNET_SCHEDULER_Task * scan_task
Scan task identifier;.
A 512-bit hashcode.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
int GNUNET_MY_extract_result(struct GNUNET_MYSQL_StatementHandle *sh, struct GNUNET_MY_ResultSpec *specs)
Extract results from a query result according to the given specification.
Definition: my.c:136
int GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
struct GNUNET_HashCode key
The key used in the DHT.
#define GNUNET_MY_query_param_end
End of query parameter specification.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
static unsigned int num_policies
Number of policies.
#define SELECT_KEY_STMT
MySQL statement to select a key count.
static void free_meter(struct ProgressMeter *meter)
Release resources for meter.
Mysql context.
Definition: mysql.c:76
struct GNUNET_MYSQL_StatementHandle * GNUNET_MYSQL_statement_prepare(struct GNUNET_MYSQL_Context *mc, const char *query)
Prepare a statement.
Definition: mysql.c:392
void REGEX_INTERNAL_automaton_destroy(struct REGEX_INTERNAL_Automaton *a)
Free the memory allocated by constructing the REGEX_INTERNAL_Automaton data structure.
void REGEX_INTERNAL_iterate_all_edges(struct REGEX_INTERNAL_Automaton *a, REGEX_INTERNAL_KeyIterator iterator, void *iterator_cls)
Iterate over all edges starting from start state of automaton &#39;a&#39;.
int print
Should the meter be printed?
int GNUNET_DISK_file_size(const char *filename, uint64_t *size, int include_symbolic_links, int single_file_mode)
Get the size of the file (or directory) of the given file (in bytes).
Definition: disk.c:254
static int update_meter(struct ProgressMeter *meter)
Update progress meter (increment by one).
static void do_shutdown(void *cls)
Shutdown task.
struct GNUNET_MY_QueryParam GNUNET_MY_query_param_uint32(const uint32_t *x)
Generate query parameter for an uint32_t in host byte order.
static int policy_filename_cb(void *cls, const char *filename)
Function called with a filename.
configuration data
Definition: configuration.c:83
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:373
struct REGEX_INTERNAL_Automaton * REGEX_INTERNAL_construct_dfa(const char *regex, const size_t len, unsigned int max_path_len)
Construct DFA for the given &#39;regex&#39; of length &#39;len&#39;.
#define GNUNET_log(kind,...)
Entry in list of pending tasks.
Definition: scheduler.c:131
unsigned int dotnum
Number of dots to print.
static char * regex_prefix
Prefix to add before every regex we&#39;re announcing.
static int result
Global testing status.
static struct GNUNET_MYSQL_StatementHandle * stmt_handle
MySQL prepared statement handle.
unsigned int total
Total number of elements.
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_YES
Definition: gnunet_common.h:77
static void do_abort(void *cls)
Abort task to run on test timed out.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_uint(char shortName, const char *name, const char *argumentHelp, const char *description, unsigned int *val)
Allow user to specify an unsigned int.
struct GNUNET_MY_QueryParam GNUNET_MY_query_param_string(const char *ptr)
Generate query parameter for a string.
char * startup_string
String to print on startup.
uint32_t data
The data value.
static struct ProgressMeter * create_meter(unsigned int total, char *start_string, int print)
Create a meter to keep track of the progress of some task.
static struct GNUNET_MYSQL_StatementHandle * select_stmt_handle
MySQL prepared statement handle for key select.
#define GNUNET_malloc(size)
Wrapper around malloc.
ssize_t GNUNET_DISK_fn_read(const char *fn, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:791
#define GNUNET_free(ptr)
Wrapper around free.
Time for relative time used by GNUnet, in microseconds.
#define gettext_noop(String)
Definition: gettext.h:69
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956