![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 179b5d05a470a9f59e13b73c9826edfed9fa184e..0cee91362998d55c4f329c031572d5096e68400c 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
SDB_FIELD_INTERVAL, /* type: datetime */
SDB_FIELD_BACKEND, /* type: array of strings */
SDB_FIELD_VALUE, /* attributes only; type: type of the value */
+ SDB_FIELD_TIMESERIES, /* metrics only; type: boolean */
};
#define SDB_STORE_TYPE_TO_NAME(t) \
(((t) == SDB_HOST) ? "host" \
: ((f) == SDB_FIELD_INTERVAL) ? "interval" \
: ((f) == SDB_FIELD_BACKEND) ? "backend" \
: ((f) == SDB_FIELD_VALUE) ? "value" \
+ : ((f) == SDB_FIELD_TIMESERIES) ? "timeseries" \
: "unknown")
#define SDB_FIELD_TYPE(f) \
: ((f) == SDB_FIELD_INTERVAL) ? SDB_TYPE_DATETIME \
: ((f) == SDB_FIELD_BACKEND) ? (SDB_TYPE_ARRAY | SDB_TYPE_STRING) \
: ((f) == SDB_FIELD_VALUE) ? -1 /* unknown */ \
+ : ((f) == SDB_FIELD_TIMESERIES) ? SDB_TYPE_BOOLEAN \
: -1)
/*
- * 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.
+ * sdb_store_t represents an in-memory store. It inherits from sdb_object_t
+ * and may safely be case to a generic object.
+ */
+struct sdb_store;
+typedef struct sdb_store sdb_store_t;
+#define SDB_STORE(obj) ((sdb_store_t *)(obj))
+
+/*
+ * sdb_store_obj_t represents the super-class of any stored object. It
+ * inherits from sdb_object_t and may safely be cast to a generic object to
+ * access its name.
*/
struct sdb_store_obj;
typedef struct sdb_store_obj sdb_store_obj_t;
/*
- * A metric store describes how to access a metric's data.
+ * sdb_store_host_t represents the meta-data of a stored host object.
+ */
+typedef struct {
+ const char *name;
+
+ sdb_time_t last_update;
+ sdb_time_t interval;
+ const char * const *backends;
+ size_t backends_num;
+} sdb_store_host_t;
+
+/*
+ * sdb_store_service_t represents the meta-data of a stored service object.
+ */
+typedef struct {
+ const char *hostname;
+ const char *name;
+
+ sdb_time_t last_update;
+ sdb_time_t interval;
+ const char * const *backends;
+ size_t backends_num;
+} sdb_store_service_t;
+
+/*
+ * sdb_metric_store_t specifies how to access a metric's data.
*/
typedef struct {
const char *type;
const char *id;
} sdb_metric_store_t;
+/*
+ * sdb_store_metric_t represents the meta-data of a stored metric object.
+ */
+typedef struct {
+ const char *hostname;
+ const char *name;
+ struct {
+ const char *type;
+ const char *id;
+ } store;
+
+ sdb_time_t last_update;
+ sdb_time_t interval;
+ const char * const *backends;
+ size_t backends_num;
+} sdb_store_metric_t;
+
+/*
+ * sdb_store_attribute_t represents a stored attribute.
+ */
+typedef struct {
+ const char *hostname; /* optional */
+ int parent_type;
+ const char *parent;
+ const char *key;
+ sdb_data_t value;
+
+ sdb_time_t last_update;
+ sdb_time_t interval;
+ const char * const *backends;
+ size_t backends_num;
+} sdb_store_attribute_t;
+
/*
* Expressions represent arithmetic expressions based on stored objects and
* their various attributes.
#define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
/*
- * An expression iterator iterates over the values of an iterable expression
- * (see sdb_store_expr_iterable).
+ * An expression iterator iterates over the values of an iterable expression.
*/
struct sdb_store_expr_iter;
typedef struct sdb_store_expr_iter sdb_store_expr_iter_t;
/*
* A JSON formatter converts stored objects into the JSON format.
* See http://www.ietf.org/rfc/rfc4627.txt
+ *
+ * A JSON formatter object inherits from sdb_object_t and, thus, may safely be
+ * cast to a generic object.
*/
struct sdb_store_json_formatter;
typedef struct sdb_store_json_formatter sdb_store_json_formatter_t;
/*
* A store writer describes the interface for plugins implementing a store.
+ *
+ * Any of the call-back functions shall return:
+ * - 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
*/
typedef struct {
- int (*store_host)(const char *name, sdb_time_t last_update,
- sdb_object_t *user_data);
- int (*store_service)(const char *hostname, const char *name,
- sdb_time_t last_update, sdb_object_t *user_data);
- int (*store_metric)(const char *hostname, const char *name,
- sdb_metric_store_t *store, sdb_time_t last_update,
- sdb_object_t *user_data);
- int (*store_attribute)(const char *hostname,
- const char *key, const sdb_data_t *value, sdb_time_t last_update,
- sdb_object_t *user_data);
- int (*store_service_attr)(const char *hostname, const char *service,
- const char *key, const sdb_data_t *value, sdb_time_t last_update,
- sdb_object_t *user_data);
- int (*store_metric_attr)(const char *hostname, const char *metric,
- const char *key, const sdb_data_t *value, sdb_time_t last_update,
- sdb_object_t *user_data);
+ /*
+ * store_host:
+ * Add/update a host in the store. If the host, identified by its
+ * canonicalized name, already exists, it will be updated according to the
+ * specified name and timestamp. Else, a new entry will be created in the
+ * store.
+ */
+ int (*store_host)(sdb_store_host_t *host, sdb_object_t *user_data);
+
+ /*
+ * store_service:
+ * 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 name and timestamp. If the referenced host
+ * does not exist, an error will be reported. Else, a new entry will be
+ * created in the store.
+ */
+ int (*store_service)(sdb_store_service_t *service, sdb_object_t *user_data);
+
+ /*
+ * 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 attributes. If the referenced host does not
+ * exist, an error will be reported. Else, a new entry will be created in
+ * the store.
+ */
+ int (*store_metric)(sdb_store_metric_t *metric, sdb_object_t *user_data);
+
+ /*
+ * store_attribute:
+ * Add/update a host's attribute in the store. If the attribute,
+ * identified by its key, already exists for the specified host, it will
+ * be updated to the specified values. If the referenced host does not
+ * exist, an error will be reported. Else, a new entry will be created in
+ * the store.
+ */
+ int (*store_attribute)(sdb_store_attribute_t *attr, sdb_object_t *user_data);
} sdb_store_writer_t;
/*
- * sdb_store_clear:
- * Clear the entire store and remove all stored objects.
+ * sdb_store_writer:
+ * A store writer implementation that provides an in-memory object store. It
+ * expects a store object as its user-data argument.
*/
-void
-sdb_store_clear(void);
+extern sdb_store_writer_t sdb_store_writer;
/*
- * sdb_store_host:
- * Add/update a host in the store. If the host, identified by its
- * canonicalized name, already exists, it will be updated according to the
- * specified name and timestamp. 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
+ * A store reader describes the interface to query a store implementation.
*/
-int
-sdb_store_host(const char *name, sdb_time_t last_update);
+typedef struct {
+ /*
+ * prepare_query:
+ * Prepare the query described by 'ast' for execution.
+ */
+ sdb_object_t *(*prepare_query)(sdb_ast_node_t *ast,
+ sdb_strbuf_t *errbuf, sdb_object_t *user_data);
+
+ /*
+ * execute_query:
+ * Execute a previously prepared query. The callback may expect that only
+ * queries prepared by its respective prepare callback will be passed to
+ * this function. The query result will be passed back via the specified
+ * store writer.
+ */
+ int (*execute_query)(sdb_object_t *q,
+ sdb_store_writer_t *w, sdb_object_t *wd,
+ sdb_strbuf_t *errbuf, sdb_object_t *user_data);
+} sdb_store_reader_t;
/*
- * sdb_store_has_host:
- * sdb_store_get_host:
- * Query the store for a host by its (canonicalized) name.
- *
- * sdb_store_get_host increments the ref count of the host object. The caller
- * needs to deref it when no longer using it.
+ * sdb_store_reader:
+ * A store reader implementation that uses an in-memory object store. It
+ * expects a store object as its user-data argument.
*/
-bool
-sdb_store_has_host(const char *name);
-
-sdb_store_obj_t *
-sdb_store_get_host(const char *name);
+extern sdb_store_reader_t sdb_store_reader;
/*
- * sdb_store_attribute:
- * Add/update a host's attribute in the store. If the attribute, identified by
- * its key, already exists for the specified host, it will be updated to the
- * specified values. 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 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
+ * sdb_store_create:
+ * Allocate a new in-memory store.
*/
-int
-sdb_store_attribute(const char *hostname,
- const char *key, const sdb_data_t *value,
- sdb_time_t last_update);
+sdb_store_t *
+sdb_store_create(void);
/*
- * sdb_store_service:
- * 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
- * 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
+ * sdb_store_host, sdb_store_service, sdb_store_metric, sdb_store_attribute,
+ * sdb_store_metric_attr:
+ * Store an object in the specified store. The hostname is expected to be
+ * canonical.
*/
int
-sdb_store_service(const char *hostname, const char *name,
+sdb_store_host(sdb_store_t *store, const char *name, sdb_time_t last_update);
+int
+sdb_store_service(sdb_store_t *store, 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,
+sdb_store_metric(sdb_store_t *store, const char *hostname, const char *name,
+ sdb_metric_store_t *metric_store, sdb_time_t last_update);
+int
+sdb_store_attribute(sdb_store_t *store, const char *hostname,
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.
- *
- * If specified, the metric store describes where to access the metric's data.
- *
- * 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_metric_store_t *store, sdb_time_t last_update);
+sdb_store_service_attr(sdb_store_t *store, const char *hostname,
+ const char *service, const char *key, const sdb_data_t *value,
+ sdb_time_t last_update);
+int
+sdb_store_metric_attr(sdb_store_t *store, const char *hostname,
+ const char *metric, const char *key, const sdb_data_t *value,
+ 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.
+ * sdb_store_get_host:
+ * Query the specified store for a host by its (canonicalized) name.
*
- * 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
+ * The function increments the ref count of the host object. The caller needs
+ * to deref it when no longer using it.
*/
-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_obj_t *
+sdb_store_get_host(sdb_store_t *store, const char *name);
/*
* sdb_store_fetch_timeseries:
* Fetch the time-series described by the specified host's metric and
- * serialize it as JSON into the provided string buffer.
+ * serialize it as JSON into the provided string buffer. The host data is
+ * retrieved from the specified store.
*
* Returns:
* - 0 on success
* - a negative value else
*/
int
-sdb_store_fetch_timeseries(const char *hostname, const char *metric,
+sdb_store_fetch_timeseries(sdb_store_t *store,
+ const char *hostname, const char *metric,
sdb_timeseries_opts_t *opts, sdb_strbuf_t *buf);
/*
* the returned value. If 'res' is NULL, the function will return whether the
* field exists.
*
- * Note: Retrieving the backend this way is not currently supported.
- *
* Returns:
* - 0 on success
* - a negative value else
sdb_store_get_attr(sdb_store_obj_t *obj, const char *name, sdb_data_t *res,
sdb_store_matcher_t *filter);
+/*
+ * Querying a store:
+ *
+ * - Query interface: A query is a formal description of an interaction with
+ * the store. It can be used, both, for read and write access. The query is
+ * described by its abstract syntax tree (AST). The parser package provides
+ * means to parse a string (SysQL) representation of the query into an AST.
+ *
+ * - Matcher / expression interface: This low-level interface provides direct
+ * control over how to access the store. It is used by the query
+ * implementation internally and can only be used for read access.
+ */
+
+/*
+ * sdb_store_query_t:
+ * A parsed query readily prepared for execution.
+ */
+struct sdb_store_query;
+typedef struct sdb_store_query sdb_store_query_t;
+
/*
* sdb_store_query_prepare:
* Prepare the query described by 'ast' for execution in a store.
*
* Returns:
- * - a store matcher on success
+ * - a store query on success
* - NULL else
*/
-sdb_store_matcher_t *
+sdb_store_query_t *
sdb_store_query_prepare(sdb_ast_node_t *ast);
+/*
+ * sdb_store_query_prepare_matcher:
+ * Prepare the logical expression described by 'ast' for execution as a store
+ * matcher.
+ *
+ * Returns:
+ * - a matcher on success
+ * - NULL else
+ */
+sdb_store_matcher_t *
+sdb_store_query_prepare_matcher(sdb_ast_node_t *ast);
+
/*
* sdb_store_query_execute:
- * Execute a previously prepared query. The query result will be written to
- * 'buf' and any errors to 'errbuf'.
+ * Execute a previously prepared query in the specified store. The query
+ * result will be written to 'buf' and any errors to 'errbuf'.
*
* Returns:
* - the result type (to be used by the server reply)
* - a negative value on error
*/
int
-sdb_store_query_execute(sdb_store_matcher_t *m,
- sdb_strbuf_t *buf, sdb_strbuf_t *errbuf);
+sdb_store_query_execute(sdb_store_t *store, sdb_store_query_t *m,
+ sdb_store_writer_t *w, sdb_object_t *wd, sdb_strbuf_t *errbuf);
/*
* sdb_store_expr_create:
sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
sdb_data_t *res, sdb_store_matcher_t *filter);
-/*
- * sdb_store_expr_iterable:
- * Check whether an expression, evaluated in the specified context (HOST,
- * SERVICE, METRIC) is iterable, that is, if it may evaluate to multiple
- * values.
- */
-bool
-sdb_store_expr_iterable(sdb_store_expr_t *expr, int context);
-
/*
* sdb_store_expr_iter:
* Iterate over the elements of an iterable expression. sdb_store_expr_iter
* returns NULL if the expression is not iterable (for the specified object).
- * See also sdb_store_expr_iterable.
*
* sdb_store_expr_iter_get_next returns NULL if there is no next element.
*/
sdb_store_matcher_t *
sdb_store_in_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
-/*
- * sdb_store_nin_matcher:
- * Like sdb_store_in_matcher but matches if the left value is not included in
- * the right value.
- */
-sdb_store_matcher_t *
-sdb_store_nin_matcher(sdb_store_expr_t *left, sdb_store_expr_t *right);
-
/*
* sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
* sdb_store_ge_matcher, sdb_store_gt_matcher:
sdb_store_isnull_matcher(sdb_store_expr_t *expr);
/*
- * sdb_store_isnnull_matcher:
- * Creates a matcher matching non-NULL values.
+ * sdb_store_istrue_matcher, sdb_store_isfalse_matcher:
+ * Creates a matcher matching boolean values.
*/
sdb_store_matcher_t *
-sdb_store_isnnull_matcher(sdb_store_expr_t *expr);
+sdb_store_istrue_matcher(sdb_store_expr_t *expr);
+sdb_store_matcher_t *
+sdb_store_isfalse_matcher(sdb_store_expr_t *expr);
/*
* sdb_store_matcher_matches:
typedef sdb_store_matcher_t *(*sdb_store_matcher_op_cb)
(sdb_store_expr_t *, sdb_store_expr_t *);
-/*
- * sdb_store_parse_matcher_op:
- * Parse a matcher operator and return a constructor for the respective
- * matcher.
- *
- * Returns:
- * - matcher operator constructor on success
- * - NULL else
- */
-sdb_store_matcher_op_cb
-sdb_store_parse_matcher_op(const char *op);
-
-/*
- * sdb_store_parse_object_type:
- * Parse the type name of a stored object.
- *
- * Returns:
- * - the object type on success
- * - a negative value else
- */
-int
-sdb_store_parse_object_type(const char *name);
-
-/*
- * sdb_store_parse_object_type_plural:
- * Parse the type name (plural) of a stored object.
- *
- * Returns:
- * - the object type on success
- * - a negative value else
- */
-int
-sdb_store_parse_object_type_plural(const char *name);
-
-/*
- * 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_lookup_cb:
* Lookup callback. It is called for each matching object when looking up data
/*
* sdb_store_scan:
- * Look up objects of the specified type 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 objects 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.
+ * Look up objects of the specified type in the specified store. The specified
+ * callback function is called for each object in the store matching 'm'. The
+ * function performs a full scan of all stored objects. 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(int type, sdb_store_matcher_t *m, sdb_store_matcher_t *filter,
+sdb_store_scan(sdb_store_t *store, int type,
+ sdb_store_matcher_t *m, sdb_store_matcher_t *filter,
sdb_store_lookup_cb cb, void *user_data);
/*
sdb_store_json_formatter(sdb_strbuf_t *buf, int type, int flags);
/*
- * sdb_store_json_emit:
+ * sdb_store_emit:
* Serialize a single object to JSON adding it to the string buffer associated
* with the formatter object. The serialized object will not include
* attributes or any child objects. Instead, call the function again for each
* of those objects. All attributes have to be emitted before any other
- * children types. Use sdb_store_json_emit_full() to emit a full (filtered)
- * object.
+ * children types. Use sdb_store_emit_full() to emit a full (filtered) object.
*
* Note that the output might not be valid JSON before calling
* sdb_store_json_finish().
* - a negative value else
*/
int
-sdb_store_json_emit(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj);
+sdb_store_emit(sdb_store_obj_t *obj, sdb_store_writer_t *w, sdb_object_t *wd);
/*
- * sdb_store_json_emit_full:
+ * sdb_store_emit_full:
* Serialize a single object including it's attributes and all children to
* JSON, adding it to the string buffer associated with the formatter object.
* The filter, if specified, is applied to each attribute and child object.
* - a negative value else
*/
int
-sdb_store_json_emit_full(sdb_store_json_formatter_t *f, sdb_store_obj_t *obj,
- sdb_store_matcher_t *filter);
+sdb_store_emit_full(sdb_store_obj_t *obj, sdb_store_matcher_t *filter,
+ sdb_store_writer_t *w, sdb_object_t *wd);
/*
* sdb_store_json_finish:
int
sdb_store_json_finish(sdb_store_json_formatter_t *f);
+/*
+ * sdb_store_json_writer:
+ * A store writer implementation that generates JSON output. It expects a
+ * store JSON formatter as its user-data argument.
+ */
+extern sdb_store_writer_t sdb_store_json_writer;
+
#ifdef __cplusplus
} /* extern "C" */
#endif