X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fstore.h;h=494f8d648c241834100c56a29560b6d58fd5ca6f;hb=ab0cdca7fb4f505307f5f0fc4cdcb3ef804e32d8;hp=856e19c5220894e558e5e0f1d03afb68ac7dda23;hpb=b0af45ebf920955095b9fdeaddbde0107c6e519f;p=sysdb.git diff --git a/src/include/core/store.h b/src/include/core/store.h index 856e19c..494f8d6 100644 --- a/src/include/core/store.h +++ b/src/include/core/store.h @@ -32,7 +32,6 @@ #include "core/object.h" #include "core/data.h" #include "core/time.h" -#include "utils/llist.h" #include "utils/strbuf.h" #include @@ -54,14 +53,29 @@ enum { : ((t) == SDB_SERVICE) ? "service" \ : ((t) == SDB_ATTRIBUTE) ? "attribute" : "unknown") - /* - * sdb_store_base_t represents the super-class of any object stored in the + * 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 * object to access its name. */ -struct sdb_store_base; -typedef struct sdb_store_base sdb_store_base_t; +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: @@ -98,7 +112,7 @@ sdb_store_host(const char *name, sdb_time_t last_update); _Bool sdb_store_has_host(const char *name); -sdb_store_base_t * +sdb_store_obj_t * sdb_store_get_host(const char *name); /* @@ -123,7 +137,7 @@ sdb_store_attribute(const char *hostname, /* * sdb_store_service: - * Add/update a store in the store. If the service, identified by its name, + * Add/update a service in the store. If the service, identified by its name, * already exists for the specified host, it will be updated according to the * specified 'service' object. If the referenced host does not exist, an error * will be reported. Else, a new entry will be created in the store. Any @@ -141,14 +155,105 @@ int 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. + * + * A conditional object inherits from sdb_object_t and, thus, may safely be + * cast to a generic object. + */ +struct sdb_store_cond; +typedef struct sdb_store_cond sdb_store_cond_t; +#define SDB_STORE_COND(obj) ((sdb_store_cond_t *)(obj)) + +/* + * sdb_store_attr_cond: + * Creates a conditional based on attribute values. The value of stored + * 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_obj_cond(int field, sdb_store_expr_t *expr); + /* * Store matchers may be used to lookup hosts from the store based on their * various attributes. Service and attribute matchers are applied to a host's * services and attributes and evaluate to true if *any* service or attribute * matches. * - * For each matcher object, *all* specified attributes have to match. - * * A store matcher object inherits from sdb_object_t and, thus, may safely be * cast to a generic object. */ @@ -160,32 +265,49 @@ typedef struct sdb_store_matcher sdb_store_matcher_t; * sdb_store_name_matcher: * Creates a matcher matching by the specified object type's name. If 're' is * true, the specified name is treated as a POSIX extended regular expression. - * Else, the exact name has to match. + * Else, the exact name has to match (case-insensitive). */ sdb_store_matcher_t * sdb_store_name_matcher(int type, const char *name, _Bool re); /* * sdb_store_attr_matcher: - * Creates a matcher matching attributes based on their name or value. Either - * a complete name (which will have to match completely but case-independent) - * or an extended POSIX regular expression may be specified. + * Creates a matcher matching attributes based on their value. If 're' is + * true, the specified name is treated as a POSIX extended regular expression. + * Else, the exact name has to match (case-insensitive). + */ +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_attr_matcher(const char *attr_name, const char *attr_name_re, - const char *attr_value, const char *attr_value_re); +sdb_store_isnull_matcher(const char *attr_name); /* - * sdb_store_host_matcher: - * Creates a matcher matching hosts based on their name or its attributes. + * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher, + * sdb_store_ge_matcher, sdb_store_gt_matcher: + * Creates a matcher based on a conditional. The matcher matches objects for + * which the conditional evaluates the object to compare less than, less or + * equal, equal, greater or equal, or greater than the conditional's value + * repsectively. */ sdb_store_matcher_t * -sdb_store_host_matcher(const char *host_name, const char *host_name_re, - sdb_store_matcher_t *attr_matcher); +sdb_store_lt_matcher(sdb_store_cond_t *cond); +sdb_store_matcher_t * +sdb_store_le_matcher(sdb_store_cond_t *cond); +sdb_store_matcher_t * +sdb_store_eq_matcher(sdb_store_cond_t *cond); +sdb_store_matcher_t * +sdb_store_ge_matcher(sdb_store_cond_t *cond); +sdb_store_matcher_t * +sdb_store_gt_matcher(sdb_store_cond_t *cond); /* * sdb_store_matcher_parse_cmp: - * Parse a simple compare expression (. ). + * Parse a simple compare expression (. ). * * Returns: * - a matcher object on success @@ -193,7 +315,7 @@ sdb_store_host_matcher(const char *host_name, const char *host_name_re, */ sdb_store_matcher_t * sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr, - const char *op, const char *value); + const char *op, sdb_store_expr_t *expr); /* * sdb_store_dis_matcher: @@ -218,14 +340,22 @@ sdb_store_inv_matcher(sdb_store_matcher_t *m); /* * 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_base_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: @@ -240,20 +370,23 @@ sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen); * Lookup callback. It is called for each matching object when looking up data * in the store. The lookup aborts if the callback returns non-zero. */ -typedef int (*sdb_store_lookup_cb)(sdb_store_base_t *obj, void *user_data); +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. @@ -272,32 +405,37 @@ enum { /* * 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_base_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: * Store iterator callback. Iteration stops if the callback returns non-zero. */ -typedef int (*sdb_store_iter_cb)(sdb_store_base_t *obj, void *user_data); +typedef int (*sdb_store_iter_cb)(sdb_store_obj_t *obj, void *user_data); /* * sdb_store_iterate: