X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fstore.h;h=4e8d468c4263f0e57cd2f26d301aedf0006102a7;hp=9f232758b6e1a99b337c959b4174206fbb1080ed;hb=2ced8af7848867b7589a7c068f5f51c47dc7ea01;hpb=90ede04df3cf5701ec929709323fea0fee3ca941 diff --git a/src/include/core/store.h b/src/include/core/store.h index 9f23275..4e8d468 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 @@ -42,12 +41,26 @@ extern "C" { #endif /* - * sdb_store_base_t represents the super-class of any object stored in the + * Store object types. + */ +enum { + SDB_HOST = 1, + SDB_SERVICE, + SDB_ATTRIBUTE, +}; +#define SDB_STORE_TYPE_TO_NAME(t) \ + (((t) == SDB_HOST) ? "host" \ + : ((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 * 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; /* * sdb_store_clear: @@ -84,7 +97,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); /* @@ -109,7 +122,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 @@ -128,11 +141,48 @@ sdb_store_service(const char *hostname, const char *name, sdb_time_t last_update); /* - * Store matchers may be used to lookup objects from the host based on their - * various attributes. Each type of matcher evaluates attributes of the - * respective object type. + * 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. * - * For each matcher object, *all* specified attributes have to match. + * 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); + +/* + * 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 specified value. See sdb_data_cmp for + * details about the comparison. + */ +sdb_store_cond_t * +sdb_store_attr_cond(const char *name, const sdb_data_t *value); + +/* + * 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. * * A store matcher object inherits from sdb_object_t and, thus, may safely be * cast to a generic object. @@ -141,33 +191,49 @@ struct sdb_store_matcher; typedef struct sdb_store_matcher sdb_store_matcher_t; #define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj)) +/* + * 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 (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 *attr_name, const char *attr_name_re, - const char *attr_value, const char *attr_value_re); +sdb_store_attr_matcher(const char *name, const char *value, _Bool re); /* - * sdb_store_service_matcher: - * Creates a matcher matching services based on their name or attributes. + * sdb_store_isnull_matcher: + * Creates a matcher matching "missing" attributes. */ sdb_store_matcher_t * -sdb_store_service_matcher(const char *service_name, const char *service_name_re, - sdb_store_matcher_t *attr_matcher); +sdb_store_isnull_matcher(const char *attr_name); /* - * sdb_store_host_matcher: - * Creates a matcher matching hosts based on their name, services assigned to - * the host, 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 *service_matcher, - 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: @@ -179,7 +245,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, const sdb_data_t *value); /* * sdb_store_dis_matcher: @@ -195,6 +261,13 @@ sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right); sdb_store_matcher_t * sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right); +/* + * sdb_store_con_matcher:: + * Creates a matcher matching the inverse (logical NOT) of a matcher. + */ +sdb_store_matcher_t * +sdb_store_inv_matcher(sdb_store_matcher_t *m); + /* * sdb_store_matcher_matches: * Check whether the specified matcher matches the specified store object. @@ -204,26 +277,35 @@ sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right); * - 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_tostring: + * Format a matcher object as string. This is meant for logging or debugging + * purposes. + */ +char * +sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen); /* * sdb_store_lookup_cb: * 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. * * Returns: * - 0 on success * - a negative value else */ int -sdb_store_lookup(sdb_store_matcher_t *m, sdb_store_lookup_cb cb, +sdb_store_scan(sdb_store_matcher_t *m, sdb_store_lookup_cb cb, void *user_data); /* @@ -262,13 +344,13 @@ sdb_store_tojson(sdb_strbuf_t *buf, int flags); * - 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, 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: