src/regex/regex_internal_lib.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2012, 2013 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  * @file regex/regex_internal_lib.h
  22  * @brief library to parse regular expressions into dfa
  23  * @author Maximilian Szengel
  24  */
  25
  26 #ifndef REGEX_INTERNAL_LIB_H
  27 #define REGEX_INTERNAL_LIB_H
  28
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_dht_service.h"
  31 #include "gnunet_statistics_service.h"
  32 #include "regex_block_lib.h"
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #if 0                           /* keep Emacsens' auto-indent happy */
  38 }
  39 #endif
  40 #endif
  41
  42
  43 /**
  44  * Automaton (NFA/DFA) representation.
  45  */
  46 struct REGEX_INTERNAL_Automaton;
  47
  48
  49 /**
  50  * Construct DFA for the given 'regex' of length 'len'.
  51  *
  52  * Path compression means, that for example a DFA o -> a -> b -> c -> o will be
  53  * compressed to o -> abc -> o. Note that this parameter influences the
  54  * non-determinism of states of the resulting NFA in the DHT (number of outgoing
  55  * edges with the same label). For example for an application that stores IPv4
  56  * addresses as bitstrings it could make sense to limit the path compression to
  57  * 4 or 8.
  58  *
  59  * @param regex regular expression string.
  60  * @param len length of the regular expression.
  61  * @param max_path_len limit the path compression length to the
  62  *        given value. If set to 1, no path compression is applied. Set to 0 for
  63  *        maximal possible path compression (generally not desireable).
  64  * @return DFA, needs to be freed using #REGEX_INTERNAL_automaton_destroy().
  65  */
  66 struct REGEX_INTERNAL_Automaton *
  67 REGEX_INTERNAL_construct_dfa (const char *regex,
  68                               const size_t len,
  69                               unsigned int max_path_len);
  70
  71
  72 /**
  73  * Free the memory allocated by constructing the REGEX_INTERNAL_Automaton.
  74  * data structure.
  75  *
  76  * @param a automaton to be destroyed.
  77  */
  78 void
  79 REGEX_INTERNAL_automaton_destroy (struct REGEX_INTERNAL_Automaton *a);
  80
  81
  82 /**
  83  * Evaluates the given 'string' against the given compiled regex.
  84  *
  85  * @param a automaton.
  86  * @param string string to check.
  87  *
  88  * @return 0 if string matches, non 0 otherwise.
  89  */
  90 int
  91 REGEX_INTERNAL_eval (struct REGEX_INTERNAL_Automaton *a,
  92                      const char *string);
  93
  94
  95 /**
  96  * Get the first key for the given @a input_string. This hashes
  97  * the first x bits of the @a input_string.
  98  *
  99  * @param input_string string.
 100  * @param string_len length of the @a input_string.
 101  * @param key pointer to where to write the hash code.
 102  * @return number of bits of @a input_string that have been consumed
 103  *         to construct the key
 104  */
 105 size_t
 106 REGEX_INTERNAL_get_first_key (const char *input_string,
 107                               size_t string_len,
 108                               struct GNUNET_HashCode *key);
 109
 110
 111 /**
 112  * Iterator callback function.
 113  *
 114  * @param cls closure.
 115  * @param key hash for current state.
 116  * @param proof proof for current state
 117  * @param accepting #GNUNET_YES if this is an accepting state, #GNUNET_NO if not.
 118  * @param num_edges number of edges leaving current state.
 119  * @param edges edges leaving current state.
 120  */
 121 typedef void
 122 (*REGEX_INTERNAL_KeyIterator)(void *cls,
 123                               const struct GNUNET_HashCode *key,
 124                               const char *proof,
 125                               int accepting,
 126                               unsigned int num_edges,
 127                               const struct REGEX_BLOCK_Edge *edges);
 128
 129
 130 /**
 131  * Iterate over all edges starting from start state of automaton 'a'. Calling
 132  * iterator for each edge.
 133  *
 134  * @param a automaton.
 135  * @param iterator iterator called for each edge.
 136  * @param iterator_cls closure.
 137  */
 138 void
 139 REGEX_INTERNAL_iterate_all_edges (struct REGEX_INTERNAL_Automaton *a,
 140                                   REGEX_INTERNAL_KeyIterator iterator,
 141                                   void *iterator_cls);
 142
 143
 144 /**
 145  * Iterate over all edges of automaton 'a' that are reachable from a state with
 146  * a proof of at least #GNUNET_REGEX_INITIAL_BYTES characters.
 147  *
 148  * Call the iterator for each such edge.
 149  *
 150  * @param a automaton.
 151  * @param iterator iterator called for each reachable edge.
 152  * @param iterator_cls closure.
 153  */
 154 void
 155 REGEX_INTERNAL_iterate_reachable_edges (struct REGEX_INTERNAL_Automaton *a,
 156                                         REGEX_INTERNAL_KeyIterator iterator,
 157                                         void *iterator_cls);
 158
 159
 160 /**
 161  * Handle to store cached data about a regex announce.
 162  */
 163 struct REGEX_INTERNAL_Announcement;
 164
 165 /**
 166  * Handle to store data about a regex search.
 167  */
 168 struct REGEX_INTERNAL_Search;
 169
 170
 171 /**
 172  * Announce a regular expression: put all states of the automaton in the DHT.
 173  * Does not free resources, must call #REGEX_INTERNAL_announce_cancel() for that.
 174  *
 175  * @param dht An existing and valid DHT service handle. CANNOT be NULL.
 176  * @param priv our private key, must remain valid until the announcement is cancelled
 177  * @param regex Regular expression to announce.
 178  * @param compression How many characters per edge can we squeeze?
 179  * @param stats Optional statistics handle to report usage. Can be NULL.
 180  * @return Handle to reuse o free cached resources.
 181  *         Must be freed by calling #REGEX_INTERNAL_announce_cancel().
 182  */
 183 struct REGEX_INTERNAL_Announcement *
 184 REGEX_INTERNAL_announce (struct GNUNET_DHT_Handle *dht,
 185                          const struct GNUNET_CRYPTO_EddsaPrivateKey *priv,
 186                          const char *regex,
 187                          uint16_t compression,
 188                          struct GNUNET_STATISTICS_Handle *stats);
 189
 190
 191 /**
 192  * Announce again a regular expression previously announced.
 193  * Does use caching to speed up process.
 194  *
 195  * @param h Handle returned by a previous #REGEX_INTERNAL_announce() call.
 196  */
 197 void
 198 REGEX_INTERNAL_reannounce (struct REGEX_INTERNAL_Announcement *h);
 199
 200
 201 /**
 202  * Clear all cached data used by a regex announce.
 203  * Does not close DHT connection.
 204  *
 205  * @param h Handle returned by a previous #REGEX_INTERNAL_announce() call.
 206  */
 207 void
 208 REGEX_INTERNAL_announce_cancel (struct REGEX_INTERNAL_Announcement *h);
 209
 210
 211 /**
 212  * Search callback function.
 213  *
 214  * @param cls Closure provided in #REGEX_INTERNAL_search().
 215  * @param id Peer providing a regex that matches the string.
 216  * @param get_path Path of the get request.
 217  * @param get_path_length Length of @a get_path.
 218  * @param put_path Path of the put request.
 219  * @param put_path_length Length of the @a put_path.
 220  */
 221 typedef void
 222 (*REGEX_INTERNAL_Found)(void *cls,
 223                         const struct GNUNET_PeerIdentity *id,
 224                         const struct GNUNET_PeerIdentity *get_path,
 225                         unsigned int get_path_length,
 226                         const struct GNUNET_PeerIdentity *put_path,
 227                         unsigned int put_path_length);
 228
 229
 230 /**
 231  * Search for a peer offering a regex matching certain string in the DHT.
 232  * The search runs until #REGEX_INTERNAL_search_cancel() is called, even if results
 233  * are returned.
 234  *
 235  * @param dht An existing and valid DHT service handle.
 236  * @param string String to match against the regexes in the DHT.
 237  * @param callback Callback for found peers.
 238  * @param callback_cls Closure for @c callback.
 239  * @param stats Optional statistics handle to report usage. Can be NULL.
 240  * @return Handle to stop search and free resources.
 241  *         Must be freed by calling #REGEX_INTERNAL_search_cancel().
 242  */
 243 struct REGEX_INTERNAL_Search *
 244 REGEX_INTERNAL_search (struct GNUNET_DHT_Handle *dht,
 245                        const char *string,
 246                        REGEX_INTERNAL_Found callback,
 247                        void *callback_cls,
 248                        struct GNUNET_STATISTICS_Handle *stats);
 249
 250 /**
 251  * Stop search and free all data used by a #REGEX_INTERNAL_search() call.
 252  * Does not close DHT connection.
 253  *
 254  * @param h Handle returned by a previous #REGEX_INTERNAL_search() call.
 255  */
 256 void
 257 REGEX_INTERNAL_search_cancel (struct REGEX_INTERNAL_Search *h);
 258
 259
 260 #if 0                           /* keep Emacsens' auto-indent happy */
 261 {
 262 #endif
 263 #ifdef __cplusplus
 264 }
 265 #endif
 266
 267 /* end of regex_internal_lib.h */
 268 #endif