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  * sdb_store_base_t represents the super-class of any object stored in the
  46  * database. It inherits from sdb_object_t and may safely be cast to a generic
  47  * object to access its name.
  48  */
  49 struct sdb_store_base;
  50 typedef struct sdb_store_base sdb_store_base_t;
  51
  52 /*
  53  * sdb_store_clear:
  54  * Clear the entire store and remove all stored objects.
  55  */
  56 void
  57 sdb_store_clear(void);
  58
  59 /*
  60  * sdb_store_host:
  61  * Add/update a host in the store. If the host, identified by its
  62  * canonicalized name, already exists, it will be updated according to the
  63  * specified name and timestamp. Else, a new entry will be created in the
  64  * store. Any memory required for storing the entry will be allocated an
  65  * managed by the store itself.
  66  *
  67  * Returns:
  68  *  - 0 on success
  69  *  - a positive value if the new entry is older than the currently stored
  70  *    entry (in this case, no update will happen)
  71  *  - a negative value on error
  72  */
  73 int
  74 sdb_store_host(const char *name, sdb_time_t last_update);
  75
  76 /*
  77  * sdb_store_has_host:
  78  * sdb_store_get_host:
  79  * Query the store for a host by its (canonicalized) name.
  80  *
  81  * sdb_store_get_host increments the ref count of the host object. The caller
  82  * needs to deref it when no longer using it.
  83  */
  84 _Bool
  85 sdb_store_has_host(const char *name);
  86
  87 sdb_store_base_t *
  88 sdb_store_get_host(const char *name);
  89
  90 /*
  91  * sdb_store_attribute:
  92  * Add/update a host's attribute in the store. If the attribute, identified by
  93  * its key, already exists for the specified host, it will be updated to the
  94  * specified values. If the referenced host does not exist, an error will be
  95  * reported. Else, a new entry will be created in the store. Any memory
  96  * required for storing the entry will be allocated and managed by the store
  97  * itself.
  98  *
  99  * Returns:
 100  *  - 0 on success
 101  *  - a positive value if the new entry is older than the currently stored
 102  *    entry (in this case, no update will happen)
 103  *  - a negative value on error
 104  */
 105 int
 106 sdb_store_attribute(const char *hostname,
 107                 const char *key, const sdb_data_t *value,
 108                 sdb_time_t last_update);
 109
 110 /*
 111  * sdb_store_service:
 112  * Add/update a store in the store. If the service, identified by its name,
 113  * already exists for the specified host, it will be updated according to the
 114  * specified 'service' object. If the referenced host does not exist, an error
 115  * will be reported. Else, a new entry will be created in the store. Any
 116  * memory required for storing the entry will be allocated an managed by the
 117  * store itself. The specified service-object will not be referenced or
 118  * further accessed.
 119  *
 120  * Returns:
 121  *  - 0 on success
 122  *  - a positive value if the new entry is older than the currently stored
 123  *    entry (in this case, no update will happen)
 124  *  - a negative value on error
 125  */
 126 int
 127 sdb_store_service(const char *hostname, const char *name,
 128                 sdb_time_t last_update);
 129
 130 /*
 131  * Store matchers may be used to lookup objects from the host based on their
 132  * various attributes. Each type of matcher evaluates attributes of the
 133  * respective object type.
 134  *
 135  * For each matcher object, *all* specified attributes have to match.
 136  *
 137  * A store matcher object inherits from sdb_object_t and, thus, may safely be
 138  * cast to a generic object.
 139  */
 140 struct sdb_store_matcher;
 141 typedef struct sdb_store_matcher sdb_store_matcher_t;
 142 #define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
 143
 144 /*
 145  * sdb_store_attr_matcher:
 146  * Creates a matcher matching attributes based on their name or value. Either
 147  * a complete name (which will have to match completely but case-independent)
 148  * or an extended POSIX regular expression may be specified.
 149  */
 150 sdb_store_matcher_t *
 151 sdb_store_attr_matcher(const char *attr_name, const char *attr_name_re,
 152                 const char *attr_value, const char *attr_value_re);
 153
 154 /*
 155  * sdb_store_service_matcher:
 156  * Creates a matcher matching services based on their name or attributes.
 157  */
 158 sdb_store_matcher_t *
 159 sdb_store_service_matcher(const char *service_name, const char *service_name_re,
 160                 sdb_store_matcher_t *attr_matcher);
 161
 162 /*
 163  * sdb_store_host_matcher:
 164  * Creates a matcher matching hosts based on their name, services assigned to
 165  * the host, or its attributes.
 166  */
 167 sdb_store_matcher_t *
 168 sdb_store_host_matcher(const char *host_name, const char *host_name_re,
 169                 sdb_store_matcher_t *service_matcher,
 170                 sdb_store_matcher_t *attr_matcher);
 171
 172 /*
 173  * sdb_store_matcher_parse_cmp:
 174  * Parse a simple compare expression (<obj_type>.<attr> <op> <value>).
 175  *
 176  * Returns:
 177  *  - a matcher object on success
 178  *  - NULL else
 179  */
 180 sdb_store_matcher_t *
 181 sdb_store_matcher_parse_cmp(const char *obj_type, const char *attr,
 182                 const char *op, const char *value);
 183
 184 /*
 185  * sdb_store_dis_matcher:
 186  * Creates a matcher matching the disjunction (logical OR) of two matchers.
 187  */
 188 sdb_store_matcher_t *
 189 sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
 190
 191 /*
 192  * sdb_store_con_matcher:
 193  * Creates a matcher matching the conjunction (logical AND) of two matchers.
 194  */
 195 sdb_store_matcher_t *
 196 sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
 197
 198 /*
 199  * sdb_store_con_matcher::
 200  * Creates a matcher matching the inverse (logical NOT) of a matcher.
 201  */
 202 sdb_store_matcher_t *
 203 sdb_store_inv_matcher(sdb_store_matcher_t *m);
 204
 205 /*
 206  * sdb_store_matcher_matches:
 207  * Check whether the specified matcher matches the specified store object.
 208  *
 209  * Returns:
 210  *  - 1 if the object matches
 211  *  - 0 else
 212  */
 213 int
 214 sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_base_t *obj);
 215
 216 /*
 217  * sdb_store_matcher_tostring:
 218  * Format a matcher object as string. This is meant for logging or debugging
 219  * purposes.
 220  */
 221 char *
 222 sdb_store_matcher_tostring(sdb_store_matcher_t *m, char *buf, size_t buflen);
 223
 224 /*
 225  * sdb_store_lookup_cb:
 226  * Lookup callback. It is called for each matching object when looking up data
 227  * in the store. The lookup aborts if the callback returns non-zero.
 228  */
 229 typedef int (*sdb_store_lookup_cb)(sdb_store_base_t *obj, void *user_data);
 230
 231 /*
 232  * sdb_store_lookup:
 233  * Look up objects in the store. The specified callback function is called for
 234  * each object in the store matching 'm'.
 235  *
 236  * Returns:
 237  *  - 0 on success
 238  *  - a negative value else
 239  */
 240 int
 241 sdb_store_lookup(sdb_store_matcher_t *m, sdb_store_lookup_cb cb,
 242                 void *user_data);
 243
 244 /*
 245  * Flags for serialization functions.
 246  *
 247  * By default, the full object will be included in the serialized output. When
 248  * specifying any of the flags, the respective information will be left out.
 249  */
 250 enum {
 251         SDB_SKIP_ATTRIBUTES         = 1 << 0,
 252         SDB_SKIP_SERVICES           = 1 << 1,
 253         SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2,
 254
 255         SDB_SKIP_ALL                = 0xffff,
 256 };
 257
 258 /*
 259  * sdb_store_tojson:
 260  * Serialize the entire store to JSON and append the result to the specified
 261  * buffer.
 262  *
 263  * Returns:
 264  *  - 0 on success
 265  *  - a negative value on error
 266  */
 267 int
 268 sdb_store_tojson(sdb_strbuf_t *buf, int flags);
 269
 270 /*
 271  * sdb_store_host_tojson:
 272  * Serialize a host object to JSON and append the result to the specified
 273  * buffer.
 274  *
 275  * Returns:
 276  *  - 0 on success
 277  *  - a negative value on error
 278  */
 279 int
 280 sdb_store_host_tojson(sdb_store_base_t *host, sdb_strbuf_t *buf, int flags);
 281
 282 /*
 283  * sdb_store_iter_cb:
 284  * Store iterator callback. Iteration stops if the callback returns non-zero.
 285  */
 286 typedef int (*sdb_store_iter_cb)(sdb_store_base_t *obj, void *user_data);
 287
 288 /*
 289  * sdb_store_iterate:
 290  * Iterate the entire store, calling the specified callback for each object.
 291  * The user_data pointer is passed on to each call of the callback.
 292  *
 293  * Returns:
 294  *  - 0 on success
 295  *  - a negative value else
 296  */
 297 int
 298 sdb_store_iterate(sdb_store_iter_cb cb, void *user_data);
 299
 300 #ifdef __cplusplus
 301 } /* extern "C" */
 302 #endif
 303
 304 #endif /* ! SDB_CORE_STORE_H */
 305
 306 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 307