1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
10 /* 1. Redistributions of source code must retain the above copyright */
11 /* notice, this list of conditions and the following disclaimer. */
12 /* 2. Redistributions in binary form must reproduce the above copyright */
13 /* notice, this list of conditions and the following disclaimer in the */
14 /* documentation and/or other materials provided with the distribution. */
15 /* 3. The names of its contributors may not be used to endorse or promote */
16 /* products derived from this software without specific prior written */
19 /* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE */
21 /* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR */
22 /* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS */
23 /* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR */
24 /* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF */
25 /* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS */
26 /* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN */
27 /* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) */
28 /* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF */
29 /* THE POSSIBILITY OF SUCH DAMAGE. */
30 /******************************************************************************/
33 * Copyright © 2008 Florent Bruneau
36 #ifndef PFIXTOOLS_FILTER_H
37 #define PFIXTOOLS_FILTER_H
40 #include "filter_tokens.h"
41 #include "hook_tokens.h"
42 #include "param_tokens.h"
47 typedef filter_token filter_type_t;
48 typedef hook_token filter_result_t;
49 typedef param_token filter_param_id_t;
51 typedef struct filter_hook_t {
65 typedef struct filter_param_t {
66 filter_param_id_t type;
72 /** Description of a filter.
74 typedef struct filter_t {
78 A(filter_hook_t) hooks;
81 A(filter_param_t) params;
83 /* Loop checking flags.
89 #define MAX_COUNTERS (64)
91 /** Context of the query. To be filled with data to use when
92 * performing asynchronous filtering.
94 typedef struct filter_context_t {
97 const filter_t *current_filter;
98 void *contexts[FTK_count];
103 uint32_t counters[MAX_COUNTERS];
105 /* connection context
111 #define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT, -1 }
112 #define CHECK_FILTER(Filter) \
113 assert(Filter != FTK_UNKNOWN && Filter != FTK_count \
114 && "Unknown filter type")
115 #define CHECK_HOOK(Hook) \
116 assert(Hook != HTK_UNKNOWN && Hook != HTK_count \
118 #define CHECK_PARAM(Param) \
119 assert(Param != ATK_UNKNOWN && Param != ATK_count \
123 /* Callback to be implemented by a filter.
126 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
127 const query_t *query,
128 filter_context_t *context);
129 typedef bool (*filter_constructor_t)(filter_t *filter);
130 typedef void (*filter_destructor_t)(filter_t *filter);
132 typedef void *(*filter_context_constructor_t)(void);
133 typedef void (*filter_context_destructor_t)(void*);
135 typedef void (*filter_async_handler_t)(filter_context_t *context,
136 const filter_hook_t *result);
138 /** Number of filter currently running.
140 extern uint32_t filter_running;
145 __attribute__((nonnull(1,4)))
146 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
147 filter_destructor_t destructor, filter_runner_t runner,
148 filter_context_constructor_t context_constructor,
149 filter_context_destructor_t context_destructor);
151 __attribute__((nonnull(2)))
152 filter_result_t filter_hook_register(filter_type_t filter, const char *name);
154 __attribute__((nonnull(2)))
155 filter_param_id_t filter_param_register(filter_type_t filter, const char *name);
157 __attribute__((nonnull))
158 void filter_async_handler_register(filter_async_handler_t handler);
163 __attribute__((nonnull(1)))
164 static inline void filter_init(filter_t *filter)
166 const filter_t f = FILTER_INIT;
170 __attribute__((nonnull(1,2)))
171 void filter_set_name(filter_t *filter, const char *name, int len);
173 __attribute__((nonnull(1,2)))
174 bool filter_set_type(filter_t *filter, const char *type, int len);
176 __attribute__((nonnull(1,2,4)))
177 bool filter_add_param(filter_t *filter, const char *name, int name_len,
178 const char *value, int value_len);
180 __attribute__((nonnull(1,2,4)))
181 bool filter_add_hook(filter_t *filter, const char *name, int name_len,
182 const char *value, int value_len);
184 __attribute__((nonnull(1)))
185 bool filter_build(filter_t *filter);
187 __attribute__((nonnull(1,2)))
188 static inline int filter_find_with_name(const A(filter_t) *array, const char *name)
191 int end = array->len;
193 while (start < end) {
194 int mid = (start + end) / 2;
195 int cmp = strcmp(name, array_elt(*array, mid).name);
199 } else if (cmp < 0) {
208 __attribute__((nonnull(1,2)))
209 bool filter_update_references(filter_t *filter, A(filter_t) *array);
211 __attribute__((nonnull(1)))
212 bool filter_check_safety(A(filter_t) *array);
214 __attribute__((nonnull(1)))
215 static inline void filter_hook_wipe(filter_hook_t *hook)
217 p_delete(&hook->value);
220 __attribute__((nonnull(1)))
221 static inline void filter_params_wipe(filter_param_t *param)
223 p_delete(¶m->value);
226 __attribute__((nonnull(1)))
227 void filter_wipe(filter_t *filter);
233 __attribute__((nonnull(1,2)))
234 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query,
235 filter_context_t *context);
237 __attribute__((nonnull(1,2)))
238 bool filter_test(const filter_t *filter, const query_t *query,
239 filter_context_t *context, filter_result_t expt);
245 #define FILTER_PARAM_PARSE_STRING(Param, Dest) \
246 case ATK_ ## Param: { \
247 (Dest) = param->value; \
250 #define FILTER_PARAM_PARSE_INT(Param, Dest) \
251 case ATK_ ## Param: { \
253 (Dest) = strtol(param->value, &next, 10); \
254 PARSE_CHECK(!*next, "invalid %s value %.*s", atokens[ATK_ ## Param], \
255 param->value_len, param->value); \
258 #define FILTER_PARAM_PARSE_BOOLEAN(Param, Dest) \
259 case ATK_ ## Param: { \
260 if (param->value_len == 1 && param->value[0] == '1') { \
262 } else if (param->value_len == 1 && param->value[0] == '0') { \
264 } else if (param->value_len == 4 \
265 && ascii_tolower(param->value[0]) == 't' \
266 && ascii_tolower(param->value[1]) == 'r' \
267 && ascii_tolower(param->value[2]) == 'u' \
268 && ascii_tolower(param->value[3]) == 'e') { \
270 } else if (param->value_len == 5 \
271 && ascii_tolower(param->value[0]) == 'f' \
272 && ascii_tolower(param->value[1]) == 'a' \
273 && ascii_tolower(param->value[2]) == 'l' \
274 && ascii_tolower(param->value[3]) == 's' \
275 && ascii_tolower(param->value[4]) == 'e') { \
278 PARSE_CHECK(false, "invalid %s value %.*s", atokens[ATK_ ## Param],\
279 param->value_len, param->value); \
287 __attribute__((nonnull(1)))
288 void filter_context_prepare(filter_context_t *context, void* qctx);
290 __attribute__((nonnull))
291 void filter_context_wipe(filter_context_t *context);
293 __attribute__((nonnull))
294 void filter_context_clean(filter_context_t *context);
296 __attribute__((nonnull))
297 void filter_post_async_result(filter_context_t *context, filter_result_t result);