Fix boolean parser (sic).
[apps/pfixtools.git] / postlicyd / filter.h
index f53b917..39c3119 100644 (file)
@@ -43,6 +43,7 @@
 #include "query.h"
 #include "array.h"
 
+
 typedef filter_token filter_type_t;
 typedef hook_token   filter_result_t;
 typedef param_token  filter_param_id_t;
@@ -51,18 +52,25 @@ typedef struct filter_hook_t {
     filter_result_t type;
     char *value;
 
-    bool postfix;
+    int counter;
+    int cost;
+
+    unsigned postfix:1;
+    unsigned async:1;
     int filter_id;
+
 } filter_hook_t;
 ARRAY(filter_hook_t)
 
 typedef struct filter_param_t {
     filter_param_id_t type;
-    char    *value;
-    ssize_t value_len;
+    char  *value;
+    int    value_len;
 } filter_param_t;
 ARRAY(filter_param_t)
 
+/** Description of a filter.
+ */
 typedef struct filter_t {
     char *name;
     filter_type_t type;
@@ -72,14 +80,35 @@ typedef struct filter_t {
 
     A(filter_param_t) params;
 
-    /* Internal: to check the filter tree structure.
+    /* Loop checking flags.
      */
-    unsigned safe   :1;
-    unsigned seen   :1;
+    int last_seen;
 } filter_t;
 ARRAY(filter_t)
 
-#define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT, false, false }
+#define MAX_COUNTERS (64)
+
+/** Context of the query. To be filled with data to use when
+ * performing asynchronous filtering.
+ */
+typedef struct filter_context_t {
+    /* filter context
+     */
+    const filter_t *current_filter;
+    void *contexts[FTK_count];
+
+    /* message context
+     */
+    char instance[64];
+    uint32_t counters[MAX_COUNTERS];
+
+    /* connection context
+     */
+    void *data;
+} filter_context_t;
+
+
+#define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT, -1 }
 #define CHECK_FILTER(Filter)                                                   \
     assert(Filter != FTK_UNKNOWN && Filter != FTK_count                        \
            && "Unknown filter type")
@@ -90,14 +119,34 @@ ARRAY(filter_t)
     assert(Param != ATK_UNKNOWN && Param != ATK_count                          \
            && "Unknown param")
 
+
+/* Callback to be implemented by a filter.
+ */
+
 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
-                                           const query_t *query);
+                                           const query_t *query,
+                                           filter_context_t *context);
 typedef bool (*filter_constructor_t)(filter_t *filter);
 typedef void (*filter_destructor_t)(filter_t *filter);
 
+typedef void *(*filter_context_constructor_t)(void);
+typedef void (*filter_context_destructor_t)(void*);
+
+typedef void (*filter_async_handler_t)(filter_context_t *context,
+                                       const filter_hook_t *result);
+
+/** Number of filter currently running.
+ */
+extern uint32_t filter_running;
+
+/* Registration.
+ */
+
 __attribute__((nonnull(1,4)))
 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
-                              filter_destructor_t destructor, filter_runner_t runner);
+                              filter_destructor_t destructor, filter_runner_t runner,
+                              filter_context_constructor_t context_constructor,
+                              filter_context_destructor_t context_destructor);
 
 __attribute__((nonnull(2)))
 filter_result_t filter_hook_register(filter_type_t filter, const char *name);
@@ -105,6 +154,12 @@ filter_result_t filter_hook_register(filter_type_t filter, const char *name);
 __attribute__((nonnull(2)))
 filter_param_id_t filter_param_register(filter_type_t filter, const char *name);
 
+__attribute__((nonnull))
+void filter_async_handler_register(filter_async_handler_t handler);
+
+/* Filter builder.
+ */
+
 __attribute__((nonnull(1)))
 static inline void filter_init(filter_t *filter)
 {
@@ -113,24 +168,24 @@ static inline void filter_init(filter_t *filter)
 }
 
 __attribute__((nonnull(1,2)))
-void filter_set_name(filter_t *filter, const char *name, ssize_t len);
+void filter_set_name(filter_t *filter, const char *name, int len);
 
 __attribute__((nonnull(1,2)))
-bool filter_set_type(filter_t *filter, const char *type, ssize_t len);
+bool filter_set_type(filter_t *filter, const char *type, int len);
 
 __attribute__((nonnull(1,2,4)))
-bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
-                      const char *value, ssize_t value_len);
+bool filter_add_param(filter_t *filter, const char *name, int name_len,
+                      const char *value, int value_len);
 
 __attribute__((nonnull(1,2,4)))
-bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
-                     const char *value, ssize_t value_len);
+bool filter_add_hook(filter_t *filter, const char *name, int name_len,
+                     const char *value, int value_len);
 
 __attribute__((nonnull(1)))
 bool filter_build(filter_t *filter);
 
 __attribute__((nonnull(1,2)))
-static inline int filter_find_with_name(A(filter_t) *array, const char *name)
+static inline int filter_find_with_name(const A(filter_t) *array, const char *name)
 {
     int start = 0;
     int end   = array->len;
@@ -171,11 +226,20 @@ static inline void filter_params_wipe(filter_param_t *param)
 __attribute__((nonnull(1)))
 void filter_wipe(filter_t *filter);
 
+
+/* Runner.
+ */
+
+__attribute__((nonnull(1,2)))
+const filter_hook_t *filter_run(const filter_t *filter, const query_t *query,
+                                filter_context_t *context);
+
 __attribute__((nonnull(1,2)))
-const filter_hook_t *filter_run(const filter_t *filter, const query_t *query);
+bool filter_test(const filter_t *filter, const query_t *query,
+                 filter_context_t *context, filter_result_t expt);
 
 
-/* Helpers
+/* Parsing Helpers
  */
 
 #define FILTER_PARAM_PARSE_STRING(Param, Dest)                                 \
@@ -198,20 +262,38 @@ const filter_hook_t *filter_run(const filter_t *filter, const query_t *query);
         } else if (param->value_len == 1 && param->value[0] == '0') {          \
             (Dest) = false;                                                    \
         } else if (param->value_len == 4                                       \
-                   && ascii_tolower(param->value[0]) == 't') {                 \
-            (Dest) = ascii_tolower(param->value[1]) == 'r'                     \
-                  && ascii_tolower(param->value[2]) == 'u'                     \
-                  && ascii_tolower(param->value[3]) == 'e';                    \
+                   && ascii_tolower(param->value[0]) == 't'                    \
+                   && ascii_tolower(param->value[1]) == 'r'                    \
+                   && ascii_tolower(param->value[2]) == 'u'                    \
+                   && ascii_tolower(param->value[3]) == 'e') {                 \
+            (Dest) = true;                                                     \
         } else if (param->value_len == 5                                       \
-                   && ascii_tolower(param->value[0]) == 'f') {                 \
-            (Dest) = ascii_tolower(param->value[1]) == 'a'                     \
-                  && ascii_tolower(param->value[2]) == 'l'                     \
-                  && ascii_tolower(param->value[3]) == 's'                     \
-                  && ascii_tolower(param->value[4]) == 'e';                    \
+                   && ascii_tolower(param->value[0]) == 'f'                    \
+                   && ascii_tolower(param->value[1]) == 'a'                    \
+                   && ascii_tolower(param->value[2]) == 'l'                    \
+                   && ascii_tolower(param->value[3]) == 's'                    \
+                   && ascii_tolower(param->value[4]) == 'e') {                 \
+            (Dest) = false;                                                    \
         } else {                                                               \
             PARSE_CHECK(false, "invalid %s value %.*s", atokens[ATK_ ## Param],\
                         param->value_len, param->value);                       \
         }                                                                      \
     } break
 
+
+/* Filter context
+ */
+
+__attribute__((nonnull(1)))
+void filter_context_prepare(filter_context_t *context, void* qctx);
+
+__attribute__((nonnull))
+void filter_context_wipe(filter_context_t *context);
+
+__attribute__((nonnull))
+void filter_context_clean(filter_context_t *context);
+
+__attribute__((nonnull))
+void filter_post_async_result(filter_context_t *context, filter_result_t result);
+
 #endif