![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index e273e7ca1aedb59702de8014c9efeb2c7ba7ffd9..494f8d648c241834100c56a29560b6d58fd5ca6f 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
#include "core/object.h"
#include "core/data.h"
#include "core/time.h"
-#include "utils/llist.h"
#include "utils/strbuf.h"
#include <stdio.h>
: ((t) == SDB_SERVICE) ? "service" \
: ((t) == SDB_ATTRIBUTE) ? "attribute" : "unknown")
-
/*
* sdb_store_obj_t represents the super-class of any object stored in the
* database. It inherits from sdb_object_t and may safely be cast to a generic
struct sdb_store_obj;
typedef struct sdb_store_obj sdb_store_obj_t;
+/*
+ * Queryable fields of a stored object.
+ */
+enum {
+ SDB_FIELD_LAST_UPDATE = 1, /* datetime */
+ SDB_FIELD_AGE, /* datetime */
+ SDB_FIELD_INTERVAL, /* datetime */
+ SDB_FIELD_BACKEND, /* string */
+};
+
+#define SDB_FIELD_TO_NAME(f) \
+ (((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
+ : ((f) == SDB_FIELD_AGE) ? "age" \
+ : ((f) == SDB_FIELD_INTERVAL) ? "interval" \
+ : ((f) == SDB_FIELD_BACKEND) ? "backend" : "unknown")
+
/*
* sdb_store_clear:
* Clear the entire store and remove all stored objects.
sdb_store_service(const char *hostname, const char *name,
sdb_time_t last_update);
+/*
+ * sdb_store_service_attr:
+ * Add/update a service's attribute in the store. If the attribute, identified
+ * by its key, already exists for the specified service, it will be updated to
+ * the specified value. If the references service (for the specified host)
+ * does not exist, an error will be reported. Any memory required for storing
+ * the entry will be allocated and managed by the store itself.
+ *
+ * Returns:
+ * - 0 on success
+ * - a positive value if the new entry is older than the currently stored
+ * entry (in this case, no update will happen)
+ * - a negative value on error
+ */
+int
+sdb_store_service_attr(const char *hostname, const char *service,
+ const char *key, const sdb_data_t *value, sdb_time_t last_update);
+
+/*
+ * Expressions specify arithmetic expressions.
+ *
+ * A expression object inherits from sdb_object_t and, thus, may safely be
+ * cast to a generic object.
+ */
+struct sdb_store_expr;
+typedef struct sdb_store_expr sdb_store_expr_t;
+#define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
+
+/*
+ * sdb_store_expr_create:
+ * Creates an arithmetic expression implementing the specified operator on the
+ * specified left and right operand.
+ *
+ * Returns:
+ * - an expression object on success
+ * - NULL else
+ */
+sdb_store_expr_t *
+sdb_store_expr_create(int op, sdb_store_expr_t *left, sdb_store_expr_t *right);
+
+/*
+ * sdb_store_expr_constvalue:
+ * Creates an expression which evaluates to the specified constant value.
+ *
+ * Returns:
+ * - an expression object on success
+ * - NULL else
+ */
+sdb_store_expr_t *
+sdb_store_expr_constvalue(const sdb_data_t *value);
+
+/*
+ * sdb_store_expr_eval:
+ * Evaluate an expression and stores the result in 'res'. The result's value
+ * will be allocated dynamically if necessary and, thus, should be free'd by
+ * the caller (e.g. using sdb_data_free_datum);
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_data_t *res);
+
/*
* Conditionals may be used to lookup hosts from the store based on a
* conditional expression.
/*
* sdb_store_attr_cond:
* Creates a conditional based on attribute values. The value of stored
- * attributes is compared against the specified value. See sdb_data_cmp for
- * details about the comparison.
+ * attributes is compared against the value the expression evaluates to. See
+ * sdb_data_cmp for details about the comparison.
+ */
+sdb_store_cond_t *
+sdb_store_attr_cond(const char *name, sdb_store_expr_t *expr);
+
+/*
+ * sdb_store_obj_cond:
+ * Creates a conditional based on queryable object fields. The respective
+ * field of *any* object type is compared against the value the expression
+ * evaluates to.
*/
sdb_store_cond_t *
-sdb_store_attr_cond(const char *name, const sdb_data_t *value);
+sdb_store_obj_cond(int field, sdb_store_expr_t *expr);
/*
* Store matchers may be used to lookup hosts from the store based on their
sdb_store_matcher_t *
sdb_store_attr_matcher(const char *name, const char *value, _Bool re);
+/*
+ * sdb_store_isnull_matcher:
+ * Creates a matcher matching "missing" attributes.
+ */
+sdb_store_matcher_t *
+sdb_store_isnull_matcher(const char *attr_name);
+
/*
* sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
* sdb_store_ge_matcher, sdb_store_gt_matcher:
/*
* sdb_store_matcher_parse_cmp:
- * Parse a simple compare expression (<obj_type>.<attr> <op> <value>).
+ * Parse a simple compare expression (<obj_type>.<attr> <op> <expression>).
*
* Returns:
* - a matcher object on success
*/
sdb_store_matcher_t *
sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr,
- const char *op, const sdb_data_t *value);
+ const char *op, sdb_store_expr_t *expr);
/*
* sdb_store_dis_matcher:
/*
* sdb_store_matcher_matches:
- * Check whether the specified matcher matches the specified store object.
+ * Check whether the specified matcher matches the specified store object. If
+ * specified, the filter will be used to preselect objects for further
+ * evaluation. It is applied to any object that's used during the evaluation
+ * of the matcher. Only those objects matching the filter will be considered.
+ *
+ * Note that the filter is applied to all object types (hosts, service,
+ * attribute). Thus, any object-specific matchers are mostly unsuited for this
+ * purpose and, if used, may result in unexpected behavior.
*
* Returns:
* - 1 if the object matches
* - 0 else
*/
int
-sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj);
+sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj,
+ sdb_store_matcher_t *filter);
/*
* sdb_store_matcher_tostring:
typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj, void *user_data);
/*
- * sdb_store_lookup:
+ * sdb_store_scan:
* Look up objects in the store. The specified callback function is called for
- * each object in the store matching 'm'.
+ * each object in the store matching 'm'. The function performs a full scan of
+ * all hosts stored in the database. If specified, the filter will be used to
+ * preselect objects for further evaluation. See the description of
+ * 'sdb_store_matcher_matches' for details.
*
* Returns:
* - 0 on success
* - a negative value else
*/
int
-sdb_store_lookup(sdb_store_matcher_t *m, sdb_store_lookup_cb cb,
- void *user_data);
+sdb_store_scan(sdb_store_matcher_t *m, sdb_store_matcher_t *filter,
+ sdb_store_lookup_cb cb, void *user_data);
/*
* Flags for serialization functions.
/*
* sdb_store_tojson:
* Serialize the entire store to JSON and append the result to the specified
- * buffer.
+ * buffer. If specified, only objects matching the filter will be included in
+ * the result (see sdb_store_host_tojson for details).
*
* Returns:
* - 0 on success
* - a negative value on error
*/
int
-sdb_store_tojson(sdb_strbuf_t *buf, int flags);
+sdb_store_tojson(sdb_strbuf_t *buf, sdb_store_matcher_t *filter, int flags);
/*
* sdb_store_host_tojson:
* Serialize a host object to JSON and append the result to the specified
- * buffer.
+ * buffer. If specified, only objects matching the filter will be included in
+ * the result. The filter is applied to each object individually and, thus,
+ * should not be of any object-type specific kind. If the filter rejects the
+ * host object, the function returns success but leaves the buffer unmodified.
*
* Returns:
* - 0 on success
* - a negative value on error
*/
int
-sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf, int flags);
+sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf,
+ sdb_store_matcher_t *filter, int flags);
/*
* sdb_store_iter_cb: