postlicyd/filter.h

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  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     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  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 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2008 Florent Bruneau
  34  */
  35
  36 #ifndef PFIXTOOLS_FILTER_H
  37 #define PFIXTOOLS_FILTER_H
  38
  39 #include "common.h"
  40 #include "filter_tokens.h"
  41 #include "hook_tokens.h"
  42 #include "param_tokens.h"
  43 #include "query.h"
  44 #include "array.h"
  45
  46
  47 typedef filter_token filter_type_t;
  48 typedef hook_token   filter_result_t;
  49 typedef param_token  filter_param_id_t;
  50
  51 typedef struct filter_hook_t {
  52     filter_result_t type;
  53     char *value;
  54
  55     unsigned postfix:1;
  56     unsigned async:1;
  57     int filter_id;
  58 } filter_hook_t;
  59 ARRAY(filter_hook_t)
  60
  61 typedef struct filter_param_t {
  62     filter_param_id_t type;
  63     char  *value;
  64     int    value_len;
  65 } filter_param_t;
  66 ARRAY(filter_param_t)
  67
  68 /** Description of a filter.
  69  */
  70 typedef struct filter_t {
  71     char *name;
  72     filter_type_t type;
  73
  74     A(filter_hook_t)   hooks;
  75     void *data;
  76
  77     A(filter_param_t) params;
  78
  79     /* Loop checking flags.
  80      */
  81     int last_seen;
  82 } filter_t;
  83 ARRAY(filter_t)
  84
  85 /** Context of the query. To be filled with data to use when
  86  * performing asynchronous filtering.
  87  */
  88 typedef struct filter_context_t {
  89     const filter_t *current_filter;
  90     void *contexts[FTK_count];
  91
  92     void *data;
  93 } filter_context_t;
  94
  95
  96 #define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT, -1 }
  97 #define CHECK_FILTER(Filter)                                                   \
  98     assert(Filter != FTK_UNKNOWN && Filter != FTK_count                        \
  99            && "Unknown filter type")
 100 #define CHECK_HOOK(Hook)                                                       \
 101     assert(Hook != HTK_UNKNOWN && Hook != HTK_count                            \
 102            && "Unknown hook")
 103 #define CHECK_PARAM(Param)                                                     \
 104     assert(Param != ATK_UNKNOWN && Param != ATK_count                          \
 105            && "Unknown param")
 106
 107
 108 /* Callback to be implemented by a filter.
 109  */
 110
 111 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
 112                                            const query_t *query,
 113                                            filter_context_t *context);
 114 typedef bool (*filter_constructor_t)(filter_t *filter);
 115 typedef void (*filter_destructor_t)(filter_t *filter);
 116
 117 typedef void *(*filter_context_constructor_t)(void);
 118 typedef void (*filter_context_destructor_t)(void*);
 119
 120 typedef void (*filter_async_handler_t)(filter_context_t *context,
 121                                        const filter_hook_t *result);
 122
 123 /** Number of filter currently running.
 124  */
 125 extern uint32_t filter_running;
 126
 127 /* Registration.
 128  */
 129
 130 __attribute__((nonnull(1,4)))
 131 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
 132                               filter_destructor_t destructor, filter_runner_t runner,
 133                               filter_context_constructor_t context_constructor,
 134                               filter_context_destructor_t context_destructor);
 135
 136 __attribute__((nonnull(2)))
 137 filter_result_t filter_hook_register(filter_type_t filter, const char *name);
 138
 139 __attribute__((nonnull(2)))
 140 filter_param_id_t filter_param_register(filter_type_t filter, const char *name);
 141
 142 __attribute__((nonnull))
 143 void filter_async_handler_register(filter_async_handler_t handler);
 144
 145 /* Filter builder.
 146  */
 147
 148 __attribute__((nonnull(1)))
 149 static inline void filter_init(filter_t *filter)
 150 {
 151     const filter_t f = FILTER_INIT;
 152     *filter = f;
 153 }
 154
 155 __attribute__((nonnull(1,2)))
 156 void filter_set_name(filter_t *filter, const char *name, int len);
 157
 158 __attribute__((nonnull(1,2)))
 159 bool filter_set_type(filter_t *filter, const char *type, int len);
 160
 161 __attribute__((nonnull(1,2,4)))
 162 bool filter_add_param(filter_t *filter, const char *name, int name_len,
 163                       const char *value, int value_len);
 164
 165 __attribute__((nonnull(1,2,4)))
 166 bool filter_add_hook(filter_t *filter, const char *name, int name_len,
 167                      const char *value, int value_len);
 168
 169 __attribute__((nonnull(1)))
 170 bool filter_build(filter_t *filter);
 171
 172 __attribute__((nonnull(1,2)))
 173 static inline int filter_find_with_name(const A(filter_t) *array, const char *name)
 174 {
 175     int start = 0;
 176     int end   = array->len;
 177
 178     while (start < end) {
 179         int mid = (start + end) / 2;
 180         int cmp = strcmp(name, array_elt(*array, mid).name);
 181
 182         if (cmp == 0) {
 183             return mid;
 184         } else if (cmp < 0) {
 185             end = mid;
 186         } else {
 187             start = mid + 1;
 188         }
 189     }
 190     return -1;
 191 }
 192
 193 __attribute__((nonnull(1,2)))
 194 bool filter_update_references(filter_t *filter, A(filter_t) *array);
 195
 196 __attribute__((nonnull(1)))
 197 bool filter_check_safety(A(filter_t) *array);
 198
 199 __attribute__((nonnull(1)))
 200 static inline void filter_hook_wipe(filter_hook_t *hook)
 201 {
 202     p_delete(&hook->value);
 203 }
 204
 205 __attribute__((nonnull(1)))
 206 static inline void filter_params_wipe(filter_param_t *param)
 207 {
 208     p_delete(&param->value);
 209 }
 210
 211 __attribute__((nonnull(1)))
 212 void filter_wipe(filter_t *filter);
 213
 214
 215 /* Runner.
 216  */
 217
 218 __attribute__((nonnull(1,2)))
 219 const filter_hook_t *filter_run(const filter_t *filter, const query_t *query,
 220                                 filter_context_t *context);
 221
 222 __attribute__((nonnull(1,2)))
 223 bool filter_test(const filter_t *filter, const query_t *query,
 224                  filter_context_t *context, filter_result_t expt);
 225
 226
 227 /* Parsing Helpers
 228  */
 229
 230 #define FILTER_PARAM_PARSE_STRING(Param, Dest)                                 \
 231     case ATK_ ## Param: {                                                      \
 232         (Dest) = param->value;                                                 \
 233     } break
 234
 235 #define FILTER_PARAM_PARSE_INT(Param, Dest)                                    \
 236     case ATK_ ## Param: {                                                      \
 237         char *next;                                                            \
 238         (Dest) = strtol(param->value, &next, 10);                              \
 239         PARSE_CHECK(!*next, "invalid %s value %.*s", atokens[ATK_ ## Param],   \
 240                     param->value_len, param->value);                           \
 241      } break
 242
 243 #define FILTER_PARAM_PARSE_BOOLEAN(Param, Dest)                                \
 244     case ATK_ ## Param: {                                                      \
 245         if (param->value_len == 1 && param->value[0] == '1') {                 \
 246             (Dest) = true;                                                     \
 247         } else if (param->value_len == 1 && param->value[0] == '0') {          \
 248             (Dest) = false;                                                    \
 249         } else if (param->value_len == 4                                       \
 250                    && ascii_tolower(param->value[0]) == 't') {                 \
 251             (Dest) = ascii_tolower(param->value[1]) == 'r'                     \
 252                   && ascii_tolower(param->value[2]) == 'u'                     \
 253                   && ascii_tolower(param->value[3]) == 'e';                    \
 254         } else if (param->value_len == 5                                       \
 255                    && ascii_tolower(param->value[0]) == 'f') {                 \
 256             (Dest) = ascii_tolower(param->value[1]) == 'a'                     \
 257                   && ascii_tolower(param->value[2]) == 'l'                     \
 258                   && ascii_tolower(param->value[3]) == 's'                     \
 259                   && ascii_tolower(param->value[4]) == 'e';                    \
 260         } else {                                                               \
 261             PARSE_CHECK(false, "invalid %s value %.*s", atokens[ATK_ ## Param],\
 262                         param->value_len, param->value);                       \
 263         }                                                                      \
 264     } break
 265
 266
 267 /* Filter context
 268  */
 269
 270 __attribute__((nonnull(1)))
 271 void filter_context_prepare(filter_context_t *context, void* qctx);
 272
 273 __attribute__((nonnull))
 274 void filter_context_wipe(filter_context_t *context);
 275
 276 __attribute__((nonnull))
 277 void filter_post_async_result(filter_context_t *context, filter_result_t result);
 278
 279 #endif