#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;
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)
} filter_param_t;
ARRAY(filter_param_t)
+/** Description of a filter.
+ */
typedef struct filter_t {
char *name;
filter_type_t type;
} filter_t;
ARRAY(filter_t)
+#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 \
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);
__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)
{
__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);
+const filter_hook_t *filter_run(const filter_t *filter, const query_t *query,
+ filter_context_t *context);
__attribute__((nonnull(1,2)))
-bool filter_test(const filter_t *filter, const query_t *query, filter_result_t expt);
+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) \
} 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