X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Finclude%2Fcore%2Fstore.h;h=856e19c5220894e558e5e0f1d03afb68ac7dda23;hb=b0af45ebf920955095b9fdeaddbde0107c6e519f;hp=ab11a21776a193a460da5e3a8e100b4d1f25cff7;hpb=bc9f267e9066b70b8e379d11da80cb6b2749d49e;p=sysdb.git diff --git a/src/include/core/store.h b/src/include/core/store.h index ab11a21..856e19c 100644 --- a/src/include/core/store.h +++ b/src/include/core/store.h @@ -30,6 +30,7 @@ #include "sysdb.h" #include "core/object.h" +#include "core/data.h" #include "core/time.h" #include "utils/llist.h" #include "utils/strbuf.h" @@ -40,6 +41,20 @@ extern "C" { #endif +/* + * 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_base_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 @@ -48,6 +63,13 @@ extern "C" { struct sdb_store_base; typedef struct sdb_store_base sdb_store_base_t; +/* + * sdb_store_clear: + * Clear the entire store and remove all stored objects. + */ +void +sdb_store_clear(void); + /* * sdb_store_host: * Add/update a host in the store. If the host, identified by its @@ -95,7 +117,8 @@ sdb_store_get_host(const char *name); * - a negative value on error */ int -sdb_store_attribute(const char *hostname, const char *key, const char *value, +sdb_store_attribute(const char *hostname, + const char *key, const sdb_data_t *value, sdb_time_t last_update); /* @@ -118,6 +141,120 @@ int sdb_store_service(const char *hostname, const char *name, sdb_time_t last_update); +/* + * 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. + */ +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. + */ +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. + */ +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_host_matcher: + * Creates a matcher matching hosts based on their name or its attributes. + */ +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_matcher_parse_cmp: + * Parse a simple compare expression (. ). + * + * Returns: + * - a matcher object on success + * - NULL else + */ +sdb_store_matcher_t * +sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr, + const char *op, const char *value); + +/* + * sdb_store_dis_matcher: + * Creates a matcher matching the disjunction (logical OR) of two matchers. + */ +sdb_store_matcher_t * +sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right); + +/* + * sdb_store_con_matcher: + * Creates a matcher matching the conjunction (logical AND) of two matchers. + */ +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. + * + * 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_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); + +/* + * sdb_store_lookup: + * Look up objects in the store. The specified callback function is called for + * each object in the store matching 'm'. + * + * 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); + /* * Flags for serialization functions. * @@ -128,6 +265,8 @@ enum { SDB_SKIP_ATTRIBUTES = 1 << 0, SDB_SKIP_SERVICES = 1 << 1, SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2, + + SDB_SKIP_ALL = 0xffff, }; /* @@ -154,6 +293,24 @@ sdb_store_tojson(sdb_strbuf_t *buf, int flags); int sdb_store_host_tojson(sdb_store_base_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); + +/* + * sdb_store_iterate: + * Iterate the entire store, calling the specified callback for each object. + * The user_data pointer is passed on to each call of the callback. + * + * Returns: + * - 0 on success + * - a negative value else + */ +int +sdb_store_iterate(sdb_store_iter_cb cb, void *user_data); + #ifdef __cplusplus } /* extern "C" */ #endif