1 /*
2 * SysDB - src/include/core/store.h
3 * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #ifndef SDB_CORE_STORE_H
29 #define SDB_CORE_STORE_H 1
31 #include "sysdb.h"
32 #include "core/object.h"
33 #include "core/data.h"
34 #include "core/time.h"
35 #include "utils/llist.h"
36 #include "utils/strbuf.h"
38 #include <stdio.h>
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
44 /*
45 * Store object types.
46 */
47 enum {
48 SDB_HOST = 1,
49 SDB_SERVICE,
50 SDB_ATTRIBUTE,
51 };
52 #define SDB_STORE_TYPE_TO_NAME(t) \
53 (((t) == SDB_HOST) ? "host" \
54 : ((t) == SDB_SERVICE) ? "service" \
55 : ((t) == SDB_ATTRIBUTE) ? "attribute" : "unknown")
58 /*
59 * sdb_store_base_t represents the super-class of any object stored in the
60 * database. It inherits from sdb_object_t and may safely be cast to a generic
61 * object to access its name.
62 */
63 struct sdb_store_base;
64 typedef struct sdb_store_base sdb_store_base_t;
66 /*
67 * sdb_store_clear:
68 * Clear the entire store and remove all stored objects.
69 */
70 void
71 sdb_store_clear(void);
73 /*
74 * sdb_store_host:
75 * Add/update a host in the store. If the host, identified by its
76 * canonicalized name, already exists, it will be updated according to the
77 * specified name and timestamp. Else, a new entry will be created in the
78 * store. Any memory required for storing the entry will be allocated an
79 * managed by the store itself.
80 *
81 * Returns:
82 * - 0 on success
83 * - a positive value if the new entry is older than the currently stored
84 * entry (in this case, no update will happen)
85 * - a negative value on error
86 */
87 int
88 sdb_store_host(const char *name, sdb_time_t last_update);
90 /*
91 * sdb_store_has_host:
92 * sdb_store_get_host:
93 * Query the store for a host by its (canonicalized) name.
94 *
95 * sdb_store_get_host increments the ref count of the host object. The caller
96 * needs to deref it when no longer using it.
97 */
98 _Bool
99 sdb_store_has_host(const char *name);
101 sdb_store_base_t *
102 sdb_store_get_host(const char *name);
104 /*
105 * sdb_store_attribute:
106 * Add/update a host's attribute in the store. If the attribute, identified by
107 * its key, already exists for the specified host, it will be updated to the
108 * specified values. If the referenced host does not exist, an error will be
109 * reported. Else, a new entry will be created in the store. Any memory
110 * required for storing the entry will be allocated and managed by the store
111 * itself.
112 *
113 * Returns:
114 * - 0 on success
115 * - a positive value if the new entry is older than the currently stored
116 * entry (in this case, no update will happen)
117 * - a negative value on error
118 */
119 int
120 sdb_store_attribute(const char *hostname,
121 const char *key, const sdb_data_t *value,
122 sdb_time_t last_update);
124 /*
125 * sdb_store_service:
126 * Add/update a store in the store. If the service, identified by its name,
127 * already exists for the specified host, it will be updated according to the
128 * specified 'service' object. If the referenced host does not exist, an error
129 * will be reported. Else, a new entry will be created in the store. Any
130 * memory required for storing the entry will be allocated an managed by the
131 * store itself. The specified service-object will not be referenced or
132 * further accessed.
133 *
134 * Returns:
135 * - 0 on success
136 * - a positive value if the new entry is older than the currently stored
137 * entry (in this case, no update will happen)
138 * - a negative value on error
139 */
140 int
141 sdb_store_service(const char *hostname, const char *name,
142 sdb_time_t last_update);
144 /*
145 * Store matchers may be used to lookup hosts from the store based on their
146 * various attributes. Service and attribute matchers are applied to a host's
147 * services and attributes and evaluate to true if *any* service or attribute
148 * matches.
149 *
150 * For each matcher object, *all* specified attributes have to match.
151 *
152 * A store matcher object inherits from sdb_object_t and, thus, may safely be
153 * cast to a generic object.
154 */
155 struct sdb_store_matcher;
156 typedef struct sdb_store_matcher sdb_store_matcher_t;
157 #define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
159 /*
160 * sdb_store_name_matcher:
161 * Creates a matcher matching by the specified object type's name. If 're' is
162 * true, the specified name is treated as a POSIX extended regular expression.
163 * Else, the exact name has to match.
164 */
165 sdb_store_matcher_t *
166 sdb_store_name_matcher(int type, const char *name, _Bool re);
168 /*
169 * sdb_store_attr_matcher:
170 * Creates a matcher matching attributes based on their name or value. Either
171 * a complete name (which will have to match completely but case-independent)
172 * or an extended POSIX regular expression may be specified.
173 */
174 sdb_store_matcher_t *
175 sdb_store_attr_matcher(const char *attr_name, const char *attr_name_re,
176 const char *attr_value, const char *attr_value_re);
178 /*
179 * sdb_store_service_matcher:
180 * Creates a matcher matching services based on their name or attributes.
181 */
182 sdb_store_matcher_t *
183 sdb_store_service_matcher(const char *service_name, const char *service_name_re,
184 sdb_store_matcher_t *attr_matcher);
186 /*
187 * sdb_store_host_matcher:
188 * Creates a matcher matching hosts based on their name, services assigned to
189 * the host, or its attributes.
190 */
191 sdb_store_matcher_t *
192 sdb_store_host_matcher(const char *host_name, const char *host_name_re,
193 sdb_store_matcher_t *service_matcher,
194 sdb_store_matcher_t *attr_matcher);
196 /*
197 * sdb_store_matcher_parse_cmp:
198 * Parse a simple compare expression (<obj_type>.<attr> <op> <value>).
199 *
200 * Returns:
201 * - a matcher object on success
202 * - NULL else
203 */
204 sdb_store_matcher_t *
205 sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr,
206 const char *op, const char *value);
208 /*
209 * sdb_store_dis_matcher:
210 * Creates a matcher matching the disjunction (logical OR) of two matchers.
211 */
212 sdb_store_matcher_t *
213 sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
215 /*
216 * sdb_store_con_matcher:
217 * Creates a matcher matching the conjunction (logical AND) of two matchers.
218 */
219 sdb_store_matcher_t *
220 sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
222 /*
223 * sdb_store_con_matcher::
224 * Creates a matcher matching the inverse (logical NOT) of a matcher.
225 */
226 sdb_store_matcher_t *
227 sdb_store_inv_matcher(sdb_store_matcher_t *m);
229 /*
230 * sdb_store_matcher_matches:
231 * Check whether the specified matcher matches the specified store object.
232 *
233 * Returns:
234 * - 1 if the object matches
235 * - 0 else
236 */
237 int
238 sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_base_t *obj);
240 /*
241 * sdb_store_matcher_tostring:
242 * Format a matcher object as string. This is meant for logging or debugging
243 * purposes.
244 */
245 char *
246 sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen);
248 /*
249 * sdb_store_lookup_cb:
250 * Lookup callback. It is called for each matching object when looking up data
251 * in the store. The lookup aborts if the callback returns non-zero.
252 */
253 typedef int (*sdb_store_lookup_cb)(sdb_store_base_t *obj, void *user_data);
255 /*
256 * sdb_store_lookup:
257 * Look up objects in the store. The specified callback function is called for
258 * each object in the store matching 'm'.
259 *
260 * Returns:
261 * - 0 on success
262 * - a negative value else
263 */
264 int
265 sdb_store_lookup(sdb_store_matcher_t *m, sdb_store_lookup_cb cb,
266 void *user_data);
268 /*
269 * Flags for serialization functions.
270 *
271 * By default, the full object will be included in the serialized output. When
272 * specifying any of the flags, the respective information will be left out.
273 */
274 enum {
275 SDB_SKIP_ATTRIBUTES = 1 << 0,
276 SDB_SKIP_SERVICES = 1 << 1,
277 SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2,
279 SDB_SKIP_ALL = 0xffff,
280 };
282 /*
283 * sdb_store_tojson:
284 * Serialize the entire store to JSON and append the result to the specified
285 * buffer.
286 *
287 * Returns:
288 * - 0 on success
289 * - a negative value on error
290 */
291 int
292 sdb_store_tojson(sdb_strbuf_t *buf, int flags);
294 /*
295 * sdb_store_host_tojson:
296 * Serialize a host object to JSON and append the result to the specified
297 * buffer.
298 *
299 * Returns:
300 * - 0 on success
301 * - a negative value on error
302 */
303 int
304 sdb_store_host_tojson(sdb_store_base_t *host, sdb_strbuf_t *buf, int flags);
306 /*
307 * sdb_store_iter_cb:
308 * Store iterator callback. Iteration stops if the callback returns non-zero.
309 */
310 typedef int (*sdb_store_iter_cb)(sdb_store_base_t *obj, void *user_data);
312 /*
313 * sdb_store_iterate:
314 * Iterate the entire store, calling the specified callback for each object.
315 * The user_data pointer is passed on to each call of the callback.
316 *
317 * Returns:
318 * - 0 on success
319 * - a negative value else
320 */
321 int
322 sdb_store_iterate(sdb_store_iter_cb cb, void *user_data);
324 #ifdef __cplusplus
325 } /* extern "C" */
326 #endif
328 #endif /* ! SDB_CORE_STORE_H */
330 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */