2 * This file is part of GNUnet
3 * Copyright (C) 2012-2017 GNUnet e.V.
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.
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.
16 * @file src/regex/regex_test_lib.c
17 * @brief library to read regexes representing IP networks from a file.
18 * and simplyfinying the into one big regex, in order to run
19 * tests (regex performance, cadet profiler).
20 * @author Bartlomiej Polot
24 #include "gnunet_util_lib.h"
28 * Struct to hold the tree formed by prefix-combining the regexes.
30 struct RegexCombineCtx
33 * Child nodes with same prefix and token.
35 struct RegexCombineCtx **children;
38 * Alphabet size (how many @a children there are)
52 * Convert a character into its int value depending on the base used
55 * @param size base (2, 8 or 16(hex))
57 * @return Int in range [0, (base-1)]
60 c2i (char c, int size)
69 if (c >= '0' && c <= '9')
71 else if (c >= 'A' && c <= 'F')
73 else if (c >= 'a' && c <= 'f')
77 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
78 "Cannot convert char %c in base %u\n",
90 * Printf spaces to indent the regex tree
92 * @param n Indentation level
97 for (int i = 0; i < n; i++)
98 fprintf (stderr, "| ");
103 * Printf the combined regex ctx.
105 * @param ctx The ctx to printf
106 * @param level Indentation level to start with
109 debugctx (struct RegexCombineCtx *ctx, int level)
115 fprintf (stderr, "%u:'%s'\n", c2i(ctx->s[0], ctx->size), ctx->s);
118 fprintf (stderr, "ROOT (base %u)\n", ctx->size);
119 for (unsigned int i = 0; i < ctx->size; i++)
121 if (NULL != ctx->children[i])
124 debugctx (ctx->children[i], level + 1);
133 * Add a single regex to a context, combining with exisiting regex by-prefix.
135 * @param ctx Context with 0 or more regexes.
136 * @param regex Regex to add.
139 regex_add (struct RegexCombineCtx *ctx,
144 * Create and initialize a new RegexCombineCtx.
146 * @param alphabet_size Size of the alphabet (and the Trie array)
148 static struct RegexCombineCtx *
149 new_regex_ctx (unsigned int alphabet_size)
151 struct RegexCombineCtx *ctx;
154 array_size = sizeof(struct RegexCombineCtx *) * alphabet_size;
155 ctx = GNUNET_new (struct RegexCombineCtx);
156 ctx->children = GNUNET_malloc (array_size);
157 ctx->size = alphabet_size;
164 move_children (struct RegexCombineCtx *dst,
165 const struct RegexCombineCtx *src)
169 array_size = sizeof(struct RegexCombineCtx *) * src->size;
170 GNUNET_memcpy (dst->children,
173 for (unsigned int i = 0; i < src->size; i++)
175 src->children[i] = NULL;
181 * Extract a string from all prefix-combined regexes.
183 * @param ctx Context with 0 or more regexes.
185 * @return Regex that matches any of the added regexes.
188 regex_combine (struct RegexCombineCtx *ctx)
190 struct RegexCombineCtx *p;
198 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "new combine %s\n", ctx->s);
199 regex = GNUNET_strdup ("");
201 for (i = 0; i < ctx->size; i++)
203 p = ctx->children[i];
206 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
207 "adding '%s' to innner %s\n",
209 s = regex_combine (p);
210 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " total '%s'\n", s);
217 GNUNET_asprintf (&tmp, "%s%s|", regex, s);
218 GNUNET_free_non_null (regex);
221 GNUNET_free_non_null (s);
222 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " so far '%s' for inner %s\n", regex, ctx->s);
225 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "opt: %d, innner: '%s'\n", opt, regex);
226 len = strlen (regex);
229 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "empty, returning ''\n");
231 return NULL == ctx->s ? NULL : GNUNET_strdup (ctx->s);
234 if ('|' == regex[len - 1])
235 regex[len - 1] = '\0';
240 GNUNET_asprintf (&s, "%s(%s)?", ctx->s, regex);
242 GNUNET_asprintf (&s, "%s(%s)", ctx->s, regex);
247 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "partial: %s\n", regex);
253 * Get the number of matching characters on the prefix of both strings.
255 * @param s1 String 1.
256 * @param s2 String 2.
258 * @return Number of characters of matching prefix.
261 get_prefix_length (const char *s1, const char *s2)
270 limit = l1 > l2 ? l2 : l1;
272 for (i = 0; i < limit; i++)
282 * Return the child context with the longest prefix match with the regex.
283 * Usually only one child will match, search all just in case.
285 * @param ctx Context whose children to search.
286 * @param regex String to match.
288 * @return Child with the longest prefix, NULL if no child matches.
290 static struct RegexCombineCtx *
291 get_longest_prefix (struct RegexCombineCtx *ctx, const char *regex)
293 struct RegexCombineCtx *p;
294 struct RegexCombineCtx *best;
302 for (i = 0; i < ctx->size; i++)
304 p = ctx->children[i];
308 l = get_prefix_length (p->s, regex);
311 GNUNET_break (0 == best_l);
320 regex_add_multiple (struct RegexCombineCtx *ctx,
322 struct RegexCombineCtx **children)
327 struct RegexCombineCtx *newctx;
335 /* Does the regex cover *all* possible children? Then don't add any,
336 * as it will be covered by the post-regex "(a-z)*"
340 for (i = 1UL; i < l; i++)
342 if (regex[i] != '|' && regex[i] != ')')
347 if (count == ctx->size)
352 /* Add every component as a child node */
354 for (i = 1UL; i < l; i++)
356 if (regex[i] != '|' && regex[i] != ')')
359 newctx = new_regex_ctx(ctx->size);
360 newctx->s = GNUNET_strdup (tmp);
361 if (children != NULL)
362 GNUNET_memcpy (newctx->children,
364 sizeof (*children) * ctx->size);
365 ctx->children[c2i(tmp[0], ctx->size)] = newctx;
371 * Add a single regex to a context, splitting the exisiting state.
373 * We only had a partial match, split existing state, truncate the current node
374 * so it only contains the prefix, add suffix(es) as children.
376 * @param ctx Context to split.
377 * @param len Lenght of ctx->s
378 * @param prefix_l Lenght of common prefix of the new regex and @a ctx->s
381 regex_split (struct RegexCombineCtx *ctx,
383 unsigned int prefix_l)
385 struct RegexCombineCtx *newctx;
389 suffix = GNUNET_malloc (len - prefix_l + 1);
390 strncpy (suffix, &ctx->s[prefix_l], len - prefix_l + 1);
392 /* Suffix saved, truncate current node so it only contains the prefix,
393 * copy any children nodes to put as grandchildren and initialize new empty
396 ctx->s[prefix_l] = '\0';
398 /* If the suffix is an OR expression, add multiple children */
399 if ('(' == suffix[0])
401 struct RegexCombineCtx **tmp;
404 ctx->children = GNUNET_malloc (sizeof(*tmp) * ctx->size);
405 regex_add_multiple (ctx, suffix, tmp);
406 GNUNET_free (suffix);
411 /* The suffix is a normal string, add as one node */
412 newctx = new_regex_ctx (ctx->size);
414 move_children (newctx, ctx);
415 idx = c2i(suffix[0], ctx->size);
416 ctx->children[idx] = newctx;
421 * Add a single regex to a context, combining with exisiting regex by-prefix.
423 * @param ctx Context with 0 or more regexes.
424 * @param regex Regex to add.
427 regex_add (struct RegexCombineCtx *ctx, const char *regex)
429 struct RegexCombineCtx *p;
430 struct RegexCombineCtx *newctx;
432 unsigned int prefix_l;
438 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
439 "regex_add '%s' into '%s'\n",
445 /* If the regex is in the form of (a|b|c), add every character separately */
448 regex_add_multiple (ctx, regex, NULL);
452 p = get_longest_prefix (ctx, regex);
455 /* There is some prefix match, reduce regex and try again */
456 prefix_l = get_prefix_length (p->s, regex);
457 rest_s = &p->s[prefix_l];
458 rest_r = ®ex[prefix_l];
459 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "chosen '%s' [%u]\n", p->s, prefix_l);
460 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "prefix r '%.*s'\n", prefix_l, p->s);
461 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "rest r '%s'\n", rest_r);
462 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "rest s '%s'\n", rest_s);
466 regex_split (p, len, prefix_l);
468 regex_add (p, rest_r);
472 /* There is no prefix match, add new */
473 idx = c2i(regex[0], ctx->size);
474 if (NULL == ctx->children[idx] && NULL != ctx->s)
476 /* this was the end before, add empty string */
477 newctx = new_regex_ctx (ctx->size);
478 newctx->s = GNUNET_strdup ("");
479 ctx->children[idx] = newctx;
481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " no match\n");
482 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " new state %s\n", regex);
483 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " under %s\n", ctx->s);
484 newctx = new_regex_ctx(ctx->size);
485 newctx->s = GNUNET_strdup (regex);
486 ctx->children[idx] = newctx;
491 * Free all resources used by the context node and all its children.
493 * @param ctx Context to free.
496 regex_ctx_destroy (struct RegexCombineCtx *ctx)
503 for (i = 0; i < ctx->size; i++)
505 regex_ctx_destroy (ctx->children[i]);
507 GNUNET_free_non_null (ctx->s); /* 's' on root node is null */
508 GNUNET_free (ctx->children);
514 * Combine an array of regexes into a single prefix-shared regex.
515 * Returns a prefix-combine regex that matches the same strings as
516 * any of the original regexes.
518 * WARNING: only useful for reading specific regexes for specific applications,
519 * namely the gnunet-regex-profiler / gnunet-regex-daemon.
520 * This function DOES NOT support arbitrary regex combining.
522 * @param regexes A NULL-terminated array of regexes.
523 * @param alphabet_size Size of the alphabet the regex uses.
525 * @return A string with a single regex that matches any of the original regexes
528 REGEX_TEST_combine (char * const regexes[], unsigned int alphabet_size)
533 struct RegexCombineCtx *ctx;
535 ctx = new_regex_ctx (alphabet_size);
536 for (i = 0; regexes[i]; i++)
538 current = regexes[i];
539 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Regex %u: %s\n", i, current);
540 regex_add (ctx, current);
543 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "\nCombining...\n");
546 combined = regex_combine (ctx);
548 regex_ctx_destroy (ctx);
555 * Read a set of regexes from a file, one per line and return them in an array
556 * suitable for REGEX_TEST_combine.
557 * The array must be free'd using REGEX_TEST_free_from_file.
559 * @param filename Name of the file containing the regexes.
561 * @return A newly allocated, NULL terminated array of regexes.
564 REGEX_TEST_read_from_file (const char *filename)
566 struct GNUNET_DISK_FileHandle *f;
575 f = GNUNET_DISK_file_open (filename,
576 GNUNET_DISK_OPEN_READ,
577 GNUNET_DISK_PERM_NONE);
580 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
581 "Can't open file %s for reading\n", filename);
584 if (GNUNET_OK != GNUNET_DISK_file_handle_size (f, &size))
586 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
587 "Can't get size of file %s\n", filename);
588 GNUNET_DISK_file_close (f);
591 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
592 "using file %s, size %llu\n",
593 filename, (unsigned long long) size);
595 buffer = GNUNET_malloc (size + 1);
596 GNUNET_DISK_file_read (f, buffer, size);
597 GNUNET_DISK_file_close (f);
598 regexes = GNUNET_malloc (sizeof (char *));
605 regex = GNUNET_malloc (size + 1);
606 len = (size_t) sscanf (&buffer[offset], "%s", regex);
609 len = strlen (regex);
614 regex = GNUNET_realloc (regex, len + 1);
615 GNUNET_array_grow (regexes, nr, nr + 1);
616 GNUNET_assert (NULL == regexes[nr - 2]);
617 regexes[nr - 2] = regex;
618 regexes[nr - 1] = NULL;
620 } while (offset < size);
621 GNUNET_free_non_null (regex);
622 GNUNET_free (buffer);
629 * Free all memory reserved for a set of regexes created by read_from_file.
631 * @param regexes NULL-terminated array of regexes.
634 REGEX_TEST_free_from_file (char **regexes)
638 for (i = 0; regexes[i]; i++)
639 GNUNET_free (regexes[i]);
640 GNUNET_free (regexes);
643 /* end of regex_test_lib.c */