src/include/gnunet_regex_lib.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2012 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file include/gnunet_regex_lib.h
  22  * @brief library to parse regular expressions into dfa
  23  * @author Maximilian Szengel
  24  *
  25  */
  26
  27 #ifndef GNUNET_REGEX_LIB_H
  28 #define GNUNET_REGEX_LIB_H
  29
  30 #include "gnunet_util_lib.h"
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40
  41 /**
  42  * Maximum regex string length for use with GNUNET_REGEX_ipv4toregex
  43  */
  44 #define GNUNET_REGEX_IPV4_REGEXLEN 32 + 6
  45
  46
  47 /**
  48  * Maximum regex string length for use with GNUNET_REGEX_ipv6toregex
  49  */
  50 #define GNUNET_REGEX_IPV6_REGEXLEN 128 + 6
  51
  52
  53 /**
  54  * Automaton (NFA/DFA) representation.
  55  */
  56 struct GNUNET_REGEX_Automaton;
  57
  58
  59 /**
  60  * Edge representation.
  61  */
  62 struct GNUNET_REGEX_Edge
  63 {
  64   /**
  65    * Label of the edge.  FIXME: might want to not consume exactly multiples of 8 bits, need length?
  66    */
  67   const char *label;
  68
  69   /**
  70    * Destionation of the edge.
  71    */
  72   struct GNUNET_HashCode destination;
  73 };
  74
  75
  76 /**
  77  * Construct an NFA by parsing the regex string of length 'len'.
  78  *
  79  * @param regex regular expression string.
  80  * @param len length of the string.
  81  *
  82  * @return NFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  83  */
  84 struct GNUNET_REGEX_Automaton *
  85 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
  86
  87
  88 /**
  89  * Construct DFA for the given 'regex' of length 'len'.
  90  *
  91  * @param regex regular expression string.
  92  * @param len length of the regular expression.
  93  *
  94  * @return DFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  95  */
  96 struct GNUNET_REGEX_Automaton *
  97 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
  98
  99
 100 /**
 101  * Free the memory allocated by constructing the GNUNET_REGEX_Automaton.
 102  * data structure.
 103  *
 104  * @param a automaton to be destroyed.
 105  */
 106 void
 107 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
 108
 109
 110 /**
 111  * Options for graph creation function
 112  * GNUNET_REGEX_automaton_save_graph.
 113  */
 114 enum GNUNET_REGEX_GraphSavingOptions
 115 {
 116   /**
 117    * Default. Do nothing special.
 118    */
 119   GNUNET_REGEX_GRAPH_DEFAULT = 0,
 120
 121   /**
 122    * The generated graph will include extra information such as the NFA states
 123    * that were used to generate the DFA state.
 124    */
 125   GNUNET_REGEX_GRAPH_VERBOSE = 1,
 126
 127   /**
 128    * Enable graph coloring. Will color each SCC in a different color.
 129    */
 130   GNUNET_REGEX_GRAPH_COLORING = 2
 131 };
 132
 133
 134 /**
 135  * Save the given automaton as a GraphViz dot file.
 136  *
 137  * @param a the automaton to be saved.
 138  * @param filename where to save the file.
 139  * @param options options for graph generation that include coloring or verbose
 140  *                mode
 141  */
 142 void
 143 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
 144                                    const char *filename,
 145                                    enum GNUNET_REGEX_GraphSavingOptions options);
 146
 147
 148 /**
 149  * Evaluates the given 'string' against the given compiled regex.
 150  *
 151  * @param a automaton.
 152  * @param string string to check.
 153  *
 154  * @return 0 if string matches, non 0 otherwise.
 155  */
 156 int
 157 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
 158                    const char *string);
 159
 160
 161 /**
 162  * Get the first key for the given 'input_string'. This hashes
 163  * the first x bits of the 'input_string'.
 164  *
 165  * @param input_string string.
 166  * @param string_len length of the 'input_string'.
 167  * @param key pointer to where to write the hash code.
 168  *
 169  * @return number of bits of 'input_string' that have been consumed
 170  *         to construct the key
 171  */
 172 size_t
 173 GNUNET_REGEX_get_first_key (const char *input_string, size_t string_len,
 174                             struct GNUNET_HashCode * key);
 175
 176
 177 /**
 178  * Check if the given 'proof' matches the given 'key'.
 179  *
 180  * @param proof partial regex of a state.
 181  * @param key hash of a state.
 182  *
 183  * @return GNUNET_OK if the proof is valid for the given key.
 184  */
 185 int
 186 GNUNET_REGEX_check_proof (const char *proof,
 187                           const struct GNUNET_HashCode *key);
 188
 189
 190 /**
 191  * Iterator callback function.
 192  *
 193  * @param cls closure.
 194  * @param key hash for current state.
 195  * @param proof proof for current state.
 196  * @param accepting GNUNET_YES if this is an accepting state, GNUNET_NO if not.
 197  * @param num_edges number of edges leaving current state.
 198  * @param edges edges leaving current state.
 199  */
 200 typedef void (*GNUNET_REGEX_KeyIterator)(void *cls,
 201                                          const struct GNUNET_HashCode *key,
 202                                          const char *proof,
 203                                          int accepting,
 204                                          unsigned int num_edges,
 205                                          const struct GNUNET_REGEX_Edge *edges);
 206
 207
 208 /**
 209  * Iterate over all edges starting from start state of automaton 'a'. Calling
 210  * iterator for each edge.
 211  *
 212  * @param a automaton.
 213  * @param iterator iterator called for each edge.
 214  * @param iterator_cls closure.
 215  */
 216 void
 217 GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
 218                                 GNUNET_REGEX_KeyIterator iterator,
 219                                 void *iterator_cls);
 220
 221
 222 /**
 223  * Create a regex in 'rxstr' from the given 'ip' and 'netmask'.
 224  *
 225  * @param ip IPv4 representation.
 226  * @param netmask netmask for the ip.
 227  * @param rxstr generated regex, must be at least GNUNET_REGEX_IPV4_REGEXLEN
 228  *              bytes long.
 229  */
 230 void
 231 GNUNET_REGEX_ipv4toregex (const struct in_addr *ip, const char *netmask,
 232                           char *rxstr);
 233
 234
 235 /**
 236  * Create a regex in 'rxstr' from the given 'ipv6' and 'prefixlen'.
 237  *
 238  * @param ipv6 IPv6 representation.
 239  * @param prefixlen length of the ipv6 prefix.
 240  * @param rxstr generated regex, must be at least GNUNET_REGEX_IPV6_REGEXLEN
 241  *              bytes long.
 242  */
 243 void
 244 GNUNET_REGEX_ipv6toregex (const struct in6_addr *ipv6,
 245                           unsigned int prefixlen, char *rxstr);
 246
 247
 248 #if 0                           /* keep Emacsens' auto-indent happy */
 249 {
 250 #endif
 251 #ifdef __cplusplus
 252 }
 253 #endif
 254
 255 /* end of gnunet_regex_lib.h */
 256 #endif