X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Finclude%2Fcore%2Fstore.h;h=169d1128ac03d1fcef4c809f47984ef57f61317b;hb=a4f738ce48a21a8a1f498d0d968c10dc14721ef4;hp=574b01ed262adcfd88d2a6be63afdff7285300a9;hpb=a077fb06b0cf27ca51477c76d5520d0c814af8df;p=sysdb.git diff --git a/src/include/core/store.h b/src/include/core/store.h index 574b01e..169d112 100644 --- a/src/include/core/store.h +++ b/src/include/core/store.h @@ -46,14 +46,15 @@ extern "C" { enum { SDB_HOST = 1, SDB_SERVICE, + SDB_METRIC, SDB_ATTRIBUTE, }; #define SDB_STORE_TYPE_TO_NAME(t) \ (((t) == SDB_HOST) ? "host" \ : ((t) == SDB_SERVICE) ? "service" \ + : ((t) == SDB_METRIC) ? "metric" \ : ((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 @@ -62,6 +63,22 @@ enum { 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. @@ -127,8 +144,7 @@ sdb_store_attribute(const char *hostname, * 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 * memory required for storing the entry will be allocated an managed by the - * store itself. The specified service-object will not be referenced or - * further accessed. + * store itself. * * Returns: * - 0 on success @@ -158,6 +174,58 @@ int sdb_store_service_attr(const char *hostname, const char *service, const char *key, const sdb_data_t *value, sdb_time_t last_update); +/* + * sdb_store_metric: + * Add/update a metric in the store. If the metric, identified by its name, + * already exists for the specified host, it will be updated according to the + * specified 'metric' object. If the referenced host does not exist, an error + * will be reported. Else, a new entry will be created in the store. Any + * memory required for storing the entry will be allocated an 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_metric(const char *hostname, const char *name, + sdb_time_t last_update); + +/* + * sdb_store_metric_attr: + * Add/update a metric's attribute in the store. If the attribute, identified + * by its key, already exists for the specified metric, it will be updated to + * the specified value. If the references metric (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_metric_attr(const char *hostname, const char *metric, + const char *key, const sdb_data_t *value, sdb_time_t last_update); + +/* + * sdb_store_get_field: + * Get the value of a stored object's queryable field. The caller is + * responsible for freeing any dynamically allocated memory possibly stored in + * the returned value. + * + * Note: Retrieving the backend this way is not currently supported. + * + * Returns: + * - 0 on success + * - a negative value else + */ +int +sdb_store_get_field(sdb_store_obj_t *obj, int field, sdb_data_t *res); + /* * Expressions specify arithmetic expressions. * @@ -180,6 +248,18 @@ typedef struct sdb_store_expr sdb_store_expr_t; sdb_store_expr_t * sdb_store_expr_create(int op, sdb_store_expr_t *left, sdb_store_expr_t *right); +/* + * sdb_store_expr_fieldvalue: + * Creates an expression which evaluates to the value of the specified + * queryable field of a stored object. + * + * Returns: + * - an expression object on success + * - NULL else + */ +sdb_store_expr_t * +sdb_store_expr_fieldvalue(int field); + /* * sdb_store_expr_constvalue: * Creates an expression which evaluates to the specified constant value. @@ -193,16 +273,19 @@ 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); + * Evaluate an expression for the specified stored object 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). The object may be NULL, in which case the expression + * needs to evaluate to a constant value. * * Returns: * - 0 on success * - a negative value else */ int -sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_data_t *res); +sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj, + sdb_data_t *res); /* * Conditionals may be used to lookup hosts from the store based on a @@ -224,6 +307,15 @@ typedef struct sdb_store_cond sdb_store_cond_t; 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 @@ -281,6 +373,17 @@ sdb_store_ge_matcher(sdb_store_cond_t *cond); sdb_store_matcher_t * sdb_store_gt_matcher(sdb_store_cond_t *cond); +/* + * sdb_store_parse_field_name: + * Parse the name of a stored object's queryable field. + * + * Returns: + * - the field id on success + * - a negative value else + */ +int +sdb_store_parse_field_name(const char *name); + /* * sdb_store_matcher_parse_cmp: * Parse a simple compare expression (. ). @@ -293,6 +396,19 @@ sdb_store_matcher_t * sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr, const char *op, sdb_store_expr_t *expr); +/* + * sdb_store_matcher_parse_field_cmp: + * Parse a simple compare expression for queryable object fields ( + * ). + * + * Returns: + * - a matcher object on success + * - NULL else + */ +sdb_store_matcher_t * +sdb_store_matcher_parse_field_cmp(const char *name, const char *op, + sdb_store_expr_t *expr); + /* * sdb_store_dis_matcher: * Creates a matcher matching the disjunction (logical OR) of two matchers. @@ -316,14 +432,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, + * metric, 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: @@ -344,15 +468,17 @@ typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj, void *user_data); * sdb_store_scan: * Look up objects in the store. The specified callback function is called for * each object in the store matching 'm'. The function performs a full scan of - * all hosts stored in the database. + * 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_scan(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. @@ -363,7 +489,8 @@ sdb_store_scan(sdb_store_matcher_t *m, sdb_store_lookup_cb cb, enum { SDB_SKIP_ATTRIBUTES = 1 << 0, SDB_SKIP_SERVICES = 1 << 1, - SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2, + SDB_SKIP_METRICS = 1 << 2, + SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 3, SDB_SKIP_ALL = 0xffff, }; @@ -371,26 +498,32 @@ 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. The filter is never applied + * to the specified host object; the caller is responsible for this and for + * correctly handling skipped hosts. * * 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: