missing fi
[oweals/gnunet.git] / src / regex / regex_internal_lib.h
1 /*
2      This file is part of GNUnet
3      (C) 2012, 2013 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 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, const size_t len,
68                             unsigned int max_path_len);
69
70
71 /**
72  * Free the memory allocated by constructing the REGEX_INTERNAL_Automaton.
73  * data structure.
74  *
75  * @param a automaton to be destroyed.
76  */
77 void
78 REGEX_INTERNAL_automaton_destroy (struct REGEX_INTERNAL_Automaton *a);
79
80
81 /**
82  * Evaluates the given 'string' against the given compiled regex.
83  *
84  * @param a automaton.
85  * @param string string to check.
86  *
87  * @return 0 if string matches, non 0 otherwise.
88  */
89 int
90 REGEX_INTERNAL_eval (struct REGEX_INTERNAL_Automaton *a,
91                    const char *string);
92
93
94 /**
95  * Get the first key for the given 'input_string'. This hashes
96  * the first x bits of the 'input_string'.
97  *
98  * @param input_string string.
99  * @param string_len length of the 'input_string'.
100  * @param key pointer to where to write the hash code.
101  *
102  * @return number of bits of '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, size_t string_len,
107                             struct GNUNET_HashCode * key);
108
109
110 /**
111  * Iterator callback function.
112  *
113  * @param cls closure.
114  * @param key hash for current state.
115  * @param proof proof for current state
116  * @param accepting GNUNET_YES if this is an accepting state, GNUNET_NO if not.
117  * @param num_edges number of edges leaving current state.
118  * @param edges edges leaving current state.
119  */
120 typedef void (*REGEX_INTERNAL_KeyIterator)(void *cls,
121                                          const struct GNUNET_HashCode *key,
122                                          const char *proof,
123                                          int accepting,
124                                          unsigned int num_edges,
125                                          const struct REGEX_BLOCK_Edge *edges);
126
127
128 /**
129  * Iterate over all edges starting from start state of automaton 'a'. Calling
130  * iterator for each edge.
131  *
132  * @param a automaton.
133  * @param iterator iterator called for each edge.
134  * @param iterator_cls closure.
135  */
136 void
137 REGEX_INTERNAL_iterate_all_edges (struct REGEX_INTERNAL_Automaton *a,
138                                 REGEX_INTERNAL_KeyIterator iterator,
139                                 void *iterator_cls);
140
141
142 /**
143  * Iterate over all edges of automaton 'a' that are reachable from a state with
144  * a proof of at least GNUNET_REGEX_INITIAL_BYTES characters.
145  *
146  * Call the iterator for each such edge.
147  *
148  * @param a automaton.
149  * @param iterator iterator called for each reachable edge.
150  * @param iterator_cls closure.
151  */
152 void
153 REGEX_INTERNAL_iterate_reachable_edges (struct REGEX_INTERNAL_Automaton *a,
154                                         REGEX_INTERNAL_KeyIterator iterator,
155                                         void *iterator_cls);
156
157
158
159 /**
160  * Handle to store cached data about a regex announce.
161  */
162 struct REGEX_INTERNAL_Announcement;
163
164 /**
165  * Handle to store data about a regex search.
166  */
167 struct REGEX_INTERNAL_Search;
168
169
170 /**
171  * Announce a regular expression: put all states of the automaton in the DHT.
172  * Does not free resources, must call REGEX_INTERNAL_announce_cancel for that.
173  *
174  * @param dht An existing and valid DHT service handle. CANNOT be NULL.
175  * @param priv our private key, must remain valid until the announcement is cancelled
176  * @param regex Regular expression to announce.
177  * @param compression How many characters per edge can we squeeze?
178  * @param stats Optional statistics handle to report usage. Can be NULL.
179  *
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 Lenght of get_path.
218  * @param put_path Path of the put request.
219  * @param put_path_length Length of the put_path.
220  */
221 typedef void (*REGEX_INTERNAL_Found)(void *cls,
222                                    const struct GNUNET_PeerIdentity *id,
223                                    const struct GNUNET_PeerIdentity *get_path,
224                                    unsigned int get_path_length,
225                                    const struct GNUNET_PeerIdentity *put_path,
226                                    unsigned int put_path_length);
227
228
229 /**
230  * Search for a peer offering a regex matching certain string in the DHT.
231  * The search runs until REGEX_INTERNAL_search_cancel is called, even if results
232  * are returned.
233  *
234  * @param dht An existing and valid DHT service handle.
235  * @param string String to match against the regexes in the DHT.
236  * @param callback Callback for found peers.
237  * @param callback_cls Closure for @c callback.
238  * @param stats Optional statistics handle to report usage. Can be NULL.
239  *
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