src/include/core/store.h

   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  */
  27
  28 #ifndef SDB_CORE_STORE_H
  29 #define SDB_CORE_STORE_H 1
  30
  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"
  37
  38 #include <stdio.h>
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  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")
  56
  57
  58 /*
  59  * sdb_store_obj_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_obj;
  64 typedef struct sdb_store_obj sdb_store_obj_t;
  65
  66 /*
  67  * sdb_store_clear:
  68  * Clear the entire store and remove all stored objects.
  69  */
  70 void
  71 sdb_store_clear(void);
  72
  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);
  89
  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);
 100
 101 sdb_store_obj_t *
 102 sdb_store_get_host(const char *name);
 103
 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);
 123
 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);
 143
 144 /*
 145  * Conditionals may be used to lookup hosts from the store based on a
 146  * conditional expression.
 147  *
 148  * A conditional object inherits from sdb_object_t and, thus, may safely be
 149  * cast to a generic object.
 150  */
 151 struct sdb_store_cond;
 152 typedef struct sdb_store_cond sdb_store_cond_t;
 153 #define SDB_STORE_COND(obj) ((sdb_store_cond_t *)(obj))
 154
 155 /*
 156  * sdb_store_attr_cond:
 157  * Creates a conditional based on attribute values. The value of stored
 158  * attributes is compared against the specified value. See sdb_data_cmp for
 159  * details about the comparison.
 160  */
 161 sdb_store_cond_t *
 162 sdb_store_attr_cond(const char *name, const sdb_data_t *value);
 163
 164 /*
 165  * Store matchers may be used to lookup hosts from the store based on their
 166  * various attributes. Service and attribute matchers are applied to a host's
 167  * services and attributes and evaluate to true if *any* service or attribute
 168  * matches.
 169  *
 170  * A store matcher object inherits from sdb_object_t and, thus, may safely be
 171  * cast to a generic object.
 172  */
 173 struct sdb_store_matcher;
 174 typedef struct sdb_store_matcher sdb_store_matcher_t;
 175 #define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
 176
 177 /*
 178  * sdb_store_name_matcher:
 179  * Creates a matcher matching by the specified object type's name. If 're' is
 180  * true, the specified name is treated as a POSIX extended regular expression.
 181  * Else, the exact name has to match (case-insensitive).
 182  */
 183 sdb_store_matcher_t *
 184 sdb_store_name_matcher(int type, const char *name, _Bool re);
 185
 186 /*
 187  * sdb_store_attr_matcher:
 188  * Creates a matcher matching attributes based on their value. If 're' is
 189  * true, the specified name is treated as a POSIX extended regular expression.
 190  * Else, the exact name has to match (case-insensitive).
 191  */
 192 sdb_store_matcher_t *
 193 sdb_store_attr_matcher(const char *name, const char *value, _Bool re);
 194
 195 /*
 196  * sdb_store_lt_matcher, sdb_store_le_matcher, sdb_store_eq_matcher,
 197  * sdb_store_ge_matcher, sdb_store_gt_matcher:
 198  * Creates a matcher based on a conditional. The matcher matches objects for
 199  * which the conditional evaluates the object to compare less than, less or
 200  * equal, equal, greater or equal, or greater than the conditional's value
 201  * repsectively.
 202  */
 203 sdb_store_matcher_t *
 204 sdb_store_lt_matcher(sdb_store_cond_t *cond);
 205 sdb_store_matcher_t *
 206 sdb_store_le_matcher(sdb_store_cond_t *cond);
 207 sdb_store_matcher_t *
 208 sdb_store_eq_matcher(sdb_store_cond_t *cond);
 209 sdb_store_matcher_t *
 210 sdb_store_ge_matcher(sdb_store_cond_t *cond);
 211 sdb_store_matcher_t *
 212 sdb_store_gt_matcher(sdb_store_cond_t *cond);
 213
 214 /*
 215  * sdb_store_matcher_parse_cmp:
 216  * Parse a simple compare expression (<obj_type>.<attr> <op> <value>).
 217  *
 218  * Returns:
 219  *  - a matcher object on success
 220  *  - NULL else
 221  */
 222 sdb_store_matcher_t *
 223 sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr,
 224                 const char *op, const sdb_data_t *value);
 225
 226 /*
 227  * sdb_store_dis_matcher:
 228  * Creates a matcher matching the disjunction (logical OR) of two matchers.
 229  */
 230 sdb_store_matcher_t *
 231 sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
 232
 233 /*
 234  * sdb_store_con_matcher:
 235  * Creates a matcher matching the conjunction (logical AND) of two matchers.
 236  */
 237 sdb_store_matcher_t *
 238 sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
 239
 240 /*
 241  * sdb_store_con_matcher::
 242  * Creates a matcher matching the inverse (logical NOT) of a matcher.
 243  */
 244 sdb_store_matcher_t *
 245 sdb_store_inv_matcher(sdb_store_matcher_t *m);
 246
 247 /*
 248  * sdb_store_matcher_matches:
 249  * Check whether the specified matcher matches the specified store object.
 250  *
 251  * Returns:
 252  *  - 1 if the object matches
 253  *  - 0 else
 254  */
 255 int
 256 sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_obj_t *obj);
 257
 258 /*
 259  * sdb_store_matcher_tostring:
 260  * Format a matcher object as string. This is meant for logging or debugging
 261  * purposes.
 262  */
 263 char *
 264 sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen);
 265
 266 /*
 267  * sdb_store_lookup_cb:
 268  * Lookup callback. It is called for each matching object when looking up data
 269  * in the store. The lookup aborts if the callback returns non-zero.
 270  */
 271 typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj, void *user_data);
 272
 273 /*
 274  * sdb_store_lookup:
 275  * Look up objects in the store. The specified callback function is called for
 276  * each object in the store matching 'm'.
 277  *
 278  * Returns:
 279  *  - 0 on success
 280  *  - a negative value else
 281  */
 282 int
 283 sdb_store_lookup(sdb_store_matcher_t *m, sdb_store_lookup_cb cb,
 284                 void *user_data);
 285
 286 /*
 287  * Flags for serialization functions.
 288  *
 289  * By default, the full object will be included in the serialized output. When
 290  * specifying any of the flags, the respective information will be left out.
 291  */
 292 enum {
 293         SDB_SKIP_ATTRIBUTES         = 1 << 0,
 294         SDB_SKIP_SERVICES           = 1 << 1,
 295         SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2,
 296
 297         SDB_SKIP_ALL                = 0xffff,
 298 };
 299
 300 /*
 301  * sdb_store_tojson:
 302  * Serialize the entire store to JSON and append the result to the specified
 303  * buffer.
 304  *
 305  * Returns:
 306  *  - 0 on success
 307  *  - a negative value on error
 308  */
 309 int
 310 sdb_store_tojson(sdb_strbuf_t *buf, int flags);
 311
 312 /*
 313  * sdb_store_host_tojson:
 314  * Serialize a host object to JSON and append the result to the specified
 315  * buffer.
 316  *
 317  * Returns:
 318  *  - 0 on success
 319  *  - a negative value on error
 320  */
 321 int
 322 sdb_store_host_tojson(sdb_store_obj_t *host, sdb_strbuf_t *buf, int flags);
 323
 324 /*
 325  * sdb_store_iter_cb:
 326  * Store iterator callback. Iteration stops if the callback returns non-zero.
 327  */
 328 typedef int (*sdb_store_iter_cb)(sdb_store_obj_t *obj, void *user_data);
 329
 330 /*
 331  * sdb_store_iterate:
 332  * Iterate the entire store, calling the specified callback for each object.
 333  * The user_data pointer is passed on to each call of the callback.
 334  *
 335  * Returns:
 336  *  - 0 on success
 337  *  - a negative value else
 338  */
 339 int
 340 sdb_store_iterate(sdb_store_iter_cb cb, void *user_data);
 341
 342 #ifdef __cplusplus
 343 } /* extern "C" */
 344 #endif
 345
 346 #endif /* ! SDB_CORE_STORE_H */
 347
 348 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 349