1 /*
2 * SysDB - src/core/store.c
3 * Copyright (C) 2012-2013 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 #if HAVE_CONFIG_H
29 # include "config.h"
30 #endif /* HAVE_CONFIG_H */
32 #include "sysdb.h"
33 #include "core/store-private.h"
34 #include "core/plugin.h"
35 #include "utils/error.h"
36 #include "utils/llist.h"
38 #include <assert.h>
40 #include <errno.h>
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <string.h>
46 #include <pthread.h>
48 /*
49 * private variables
50 */
52 static sdb_llist_t *host_list = NULL;
53 static pthread_rwlock_t host_lock = PTHREAD_RWLOCK_INITIALIZER;
55 /*
56 * private types
57 */
59 static sdb_type_t sdb_host_type;
60 static sdb_type_t sdb_service_type;
61 static sdb_type_t sdb_attribute_type;
63 static int
64 store_obj_init(sdb_object_t *obj, va_list ap)
65 {
66 sdb_store_obj_t *sobj = STORE_OBJ(obj);
68 sobj->type = va_arg(ap, int);
70 sobj->last_update = va_arg(ap, sdb_time_t);
71 sobj->interval = 0;
72 sobj->backends = NULL;
73 sobj->backends_num = 0;
74 sobj->parent = NULL;
75 return 0;
76 } /* store_obj_init */
78 static void
79 store_obj_destroy(sdb_object_t *obj)
80 {
81 sdb_store_obj_t *sobj = STORE_OBJ(obj);
82 size_t i;
84 for (i = 0; i < sobj->backends_num; ++i)
85 free(sobj->backends[i]);
86 free(sobj->backends);
87 sobj->backends = NULL;
88 sobj->backends_num = 0;
90 if (sobj->parent)
91 sdb_object_deref(SDB_OBJ(sobj->parent));
92 } /* store_obj_destroy */
94 static int
95 sdb_host_init(sdb_object_t *obj, va_list ap)
96 {
97 sdb_host_t *sobj = HOST(obj);
98 int ret;
100 /* this will consume the first argument (type) of ap */
101 ret = store_obj_init(obj, ap);
102 if (ret)
103 return ret;
105 sobj->services = sdb_llist_create();
106 if (! sobj->services)
107 return -1;
108 sobj->attributes = sdb_llist_create();
109 if (! sobj->attributes)
110 return -1;
111 return 0;
112 } /* sdb_host_init */
114 static void
115 sdb_host_destroy(sdb_object_t *obj)
116 {
117 sdb_host_t *sobj = HOST(obj);
118 assert(obj);
120 store_obj_destroy(obj);
122 if (sobj->services)
123 sdb_llist_destroy(sobj->services);
124 if (sobj->attributes)
125 sdb_llist_destroy(sobj->attributes);
126 } /* sdb_host_destroy */
128 static int
129 sdb_service_init(sdb_object_t *obj, va_list ap)
130 {
131 sdb_service_t *sobj = SVC(obj);
132 int ret;
134 /* this will consume the first argument (type) of ap */
135 ret = store_obj_init(obj, ap);
136 if (ret)
137 return ret;
139 sobj->attributes = sdb_llist_create();
140 if (! sobj->attributes)
141 return -1;
142 return 0;
143 } /* sdb_service_init */
145 static void
146 sdb_service_destroy(sdb_object_t *obj)
147 {
148 sdb_service_t *sobj = SVC(obj);
149 assert(obj);
151 store_obj_destroy(obj);
153 if (sobj->attributes)
154 sdb_llist_destroy(sobj->attributes);
155 } /* sdb_service_destroy */
157 static int
158 sdb_attr_init(sdb_object_t *obj, va_list ap)
159 {
160 const sdb_data_t *value;
161 int ret;
163 /* this will consume the first two arguments
164 * (type and last_update) of ap */
165 ret = store_obj_init(obj, ap);
166 if (ret)
167 return ret;
168 value = va_arg(ap, const sdb_data_t *);
170 if (value)
171 if (sdb_data_copy(&ATTR(obj)->value, value))
172 return -1;
173 return 0;
174 } /* sdb_attr_init */
176 static void
177 sdb_attr_destroy(sdb_object_t *obj)
178 {
179 assert(obj);
181 store_obj_destroy(obj);
182 sdb_data_free_datum(&ATTR(obj)->value);
183 } /* sdb_attr_destroy */
185 static sdb_type_t sdb_host_type = {
186 sizeof(sdb_host_t),
187 sdb_host_init,
188 sdb_host_destroy
189 };
191 static sdb_type_t sdb_service_type = {
192 sizeof(sdb_service_t),
193 sdb_service_init,
194 sdb_service_destroy
195 };
197 static sdb_type_t sdb_attribute_type = {
198 sizeof(sdb_attribute_t),
199 sdb_attr_init,
200 sdb_attr_destroy
201 };
203 /*
204 * private helper functions
205 */
207 static sdb_host_t *
208 lookup_host(const char *name)
209 {
210 return HOST(sdb_llist_search_by_name(host_list, name));
211 } /* lookup_host */
213 static int
214 record_backend(sdb_store_obj_t *obj)
215 {
216 const sdb_plugin_info_t *info;
217 char **tmp;
218 size_t i;
220 info = sdb_plugin_current();
221 if (! info)
222 return 0;
224 for (i = 0; i < obj->backends_num; ++i)
225 if (!strcasecmp(obj->backends[i], info->plugin_name))
226 return 0;
228 tmp = realloc(obj->backends,
229 (obj->backends_num + 1) * sizeof(*obj->backends));
230 if (! tmp)
231 return -1;
233 obj->backends = tmp;
234 obj->backends[obj->backends_num] = strdup(info->plugin_name);
235 if (! obj->backends[obj->backends_num])
236 return -1;
238 ++obj->backends_num;
239 return 0;
240 } /* record_backend */
242 static int
243 store_obj(sdb_llist_t *parent_list, int type, const char *name,
244 sdb_time_t last_update, sdb_store_obj_t **updated_obj)
245 {
246 sdb_store_obj_t *old, *new;
247 int status = 0;
249 assert(parent_list);
251 if (last_update <= 0)
252 last_update = sdb_gettime();
254 old = STORE_OBJ(sdb_llist_search_by_name(parent_list, name));
255 if (old) {
256 if (old->last_update > last_update) {
257 sdb_log(SDB_LOG_DEBUG, "store: Cannot update %s '%s' - "
258 "value too old (%"PRIscTIME" < %"PRIscTIME")",
259 SDB_STORE_TYPE_TO_NAME(type), name,
260 last_update, old->last_update);
261 /* don't report an error; the object may be updated by multiple
262 * backends */
263 status = 1;
264 }
265 else if (old->last_update == last_update) {
266 /* don't report an error and also don't even log this to avoid
267 * excessive noise on high sampling frequencies */
268 status = 1;
269 }
270 else {
271 sdb_time_t interval = last_update - old->last_update;
272 old->last_update = last_update;
273 if (interval) {
274 if (old->interval)
275 old->interval = (sdb_time_t)((0.9 * (double)old->interval)
276 + (0.1 * (double)interval));
277 else
278 old->interval = interval;
279 }
280 }
282 new = old;
283 }
284 else {
285 if (type == SDB_ATTRIBUTE) {
286 /* the value will be updated by the caller */
287 new = STORE_OBJ(sdb_object_create(name, sdb_attribute_type,
288 type, last_update, NULL));
289 }
290 else {
291 sdb_type_t t;
292 t = type == SDB_HOST ? sdb_host_type : sdb_service_type;
293 new = STORE_OBJ(sdb_object_create(name, t, type, last_update));
294 }
296 if (new) {
297 status = sdb_llist_insert_sorted(parent_list, SDB_OBJ(new),
298 sdb_object_cmp_by_name);
300 /* pass control to the list or destroy in case of an error */
301 sdb_object_deref(SDB_OBJ(new));
302 }
303 else {
304 char errbuf[1024];
305 sdb_log(SDB_LOG_ERR, "store: Failed to create %s '%s': %s",
306 SDB_STORE_TYPE_TO_NAME(type), name,
307 sdb_strerror(errno, errbuf, sizeof(errbuf)));
308 status = -1;
309 }
310 }
312 if (status < 0)
313 return status;
314 assert(new);
316 if (updated_obj)
317 *updated_obj = new;
319 if (record_backend(new))
320 return -1;
321 return status;
322 } /* store_obj */
324 static int
325 store_attr(sdb_llist_t *attributes, const char *key, const sdb_data_t *value,
326 sdb_time_t last_update)
327 {
328 sdb_store_obj_t *attr = NULL;
329 int status;
331 status = store_obj(attributes, SDB_ATTRIBUTE, key, last_update, &attr);
332 if (status)
333 return status;
335 /* don't update unchanged values */
336 if (! sdb_data_cmp(&ATTR(attr)->value, value))
337 return status;
339 assert(attr);
340 if (sdb_data_copy(&ATTR(attr)->value, value))
341 return -1;
342 return status;
343 } /* store_attr */
345 /* The host_lock has to be acquired before calling this function. */
346 static sdb_llist_t *
347 get_host_children(const char *hostname, int type)
348 {
349 char *cname = NULL;
350 sdb_host_t *host;
352 assert(hostname);
353 assert((type == SDB_SERVICE) || (type == SDB_ATTRIBUTE));
355 if (! host_list)
356 return NULL;
358 cname = sdb_plugin_cname(strdup(hostname));
359 if (! cname) {
360 sdb_log(SDB_LOG_ERR, "store: strdup failed");
361 return NULL;
362 }
364 host = lookup_host(cname);
365 free(cname);
366 if (! host)
367 return NULL;
369 if (type == SDB_ATTRIBUTE)
370 return host->attributes;
371 else
372 return host->services;
373 } /* get_host_children */
375 /*
376 * store_common_tojson serializes common object attributes to JSON.
377 *
378 * The function never returns an error. Rather, an error message will be part
379 * of the serialized data.
380 */
381 static void
382 store_common_tojson(sdb_store_obj_t *obj, sdb_strbuf_t *buf)
383 {
384 char time_str[64];
385 char interval_str[64];
386 size_t i;
388 if (! sdb_strftime(time_str, sizeof(time_str),
389 "%F %T %z", obj->last_update))
390 snprintf(time_str, sizeof(time_str), "<error>");
391 time_str[sizeof(time_str) - 1] = '\0';
393 if (! sdb_strfinterval(interval_str, sizeof(interval_str),
394 obj->interval))
395 snprintf(interval_str, sizeof(interval_str), "<error>");
396 interval_str[sizeof(interval_str) - 1] = '\0';
398 sdb_strbuf_append(buf, "\"last_update\": \"%s\", "
399 "\"update_interval\": \"%s\", \"backends\": [",
400 time_str, interval_str);
402 for (i = 0; i < obj->backends_num; ++i) {
403 sdb_strbuf_append(buf, "\"%s\"", obj->backends[i]);
404 if (i < obj->backends_num - 1)
405 sdb_strbuf_append(buf, ",");
406 }
407 sdb_strbuf_append(buf, "]");
408 } /* store_common_tojson */
410 /*
411 * store_obj_tojson serializes attribute / service objects to JSON.
412 *
413 * The function never returns an error. Rather, an error message will be part
414 * of the serialized data.
415 */
416 static void
417 store_obj_tojson(sdb_llist_t *list, int type, sdb_strbuf_t *buf, int flags)
418 {
419 sdb_llist_iter_t *iter;
421 assert((type == SDB_ATTRIBUTE) || (type == SDB_SERVICE));
423 sdb_strbuf_append(buf, "[");
424 iter = sdb_llist_get_iter(list);
425 if (! iter) {
426 char errbuf[1024];
427 sdb_log(SDB_LOG_ERR, "store: Failed to retrieve %ss: %s\n",
428 SDB_STORE_TYPE_TO_NAME(type),
429 sdb_strerror(errno, errbuf, sizeof(errbuf)));
430 sdb_strbuf_append(buf, "{\"error\": \"failed to retrieve %ss: %s\"}",
431 SDB_STORE_TYPE_TO_NAME(type), errbuf);
432 }
434 /* has_next returns false if the iterator is NULL */
435 while (sdb_llist_iter_has_next(iter)) {
436 sdb_store_obj_t *sobj = STORE_OBJ(sdb_llist_iter_get_next(iter));
437 assert(sobj);
438 assert(sobj->type == type);
440 sdb_strbuf_append(buf, "{\"name\": \"%s\", ", SDB_OBJ(sobj)->name);
441 if (sobj->type == SDB_ATTRIBUTE) {
442 char tmp[sdb_data_strlen(&ATTR(sobj)->value) + 1];
443 sdb_data_format(&ATTR(sobj)->value, tmp, sizeof(tmp),
444 SDB_DOUBLE_QUOTED);
445 sdb_strbuf_append(buf, "\"value\": %s, ", tmp);
446 }
447 store_common_tojson(sobj, buf);
449 if ((sobj->type == SDB_SERVICE)
450 && (! (flags & SDB_SKIP_ATTRIBUTES))) {
451 sdb_strbuf_append(buf, ", \"attributes\": ");
452 store_obj_tojson(SVC(sobj)->attributes, SDB_ATTRIBUTE,
453 buf, flags);
454 }
455 sdb_strbuf_append(buf, "}");
457 if (sdb_llist_iter_has_next(iter))
458 sdb_strbuf_append(buf, ",");
459 }
461 sdb_llist_iter_destroy(iter);
462 sdb_strbuf_append(buf, "]");
463 } /* store_obj_tojson */
465 /*
466 * public API
467 */
469 void
470 sdb_store_clear(void)
471 {
472 sdb_llist_destroy(host_list);
473 host_list = NULL;
474 } /* sdb_store_clear */
476 int
477 sdb_store_host(const char *name, sdb_time_t last_update)
478 {
479 char *cname = NULL;
480 int status = 0;
482 if (! name)
483 return -1;
485 cname = sdb_plugin_cname(strdup(name));
486 if (! cname) {
487 sdb_log(SDB_LOG_ERR, "store: strdup failed");
488 return -1;
489 }
491 pthread_rwlock_wrlock(&host_lock);
492 if (! host_list)
493 if (! (host_list = sdb_llist_create()))
494 status = -1;
496 if (! status)
497 status = store_obj(host_list, SDB_HOST, cname, last_update, NULL);
498 pthread_rwlock_unlock(&host_lock);
500 free(cname);
501 return status;
502 } /* sdb_store_host */
504 _Bool
505 sdb_store_has_host(const char *name)
506 {
507 sdb_host_t *host;
509 if (! name)
510 return NULL;
512 host = lookup_host(name);
513 return host != NULL;
514 } /* sdb_store_has_host */
516 sdb_store_obj_t *
517 sdb_store_get_host(const char *name)
518 {
519 sdb_host_t *host;
521 if (! name)
522 return NULL;
524 host = lookup_host(name);
525 if (! host)
526 return NULL;
528 sdb_object_ref(SDB_OBJ(host));
529 return STORE_OBJ(host);
530 } /* sdb_store_get_host */
532 int
533 sdb_store_attribute(const char *hostname,
534 const char *key, const sdb_data_t *value,
535 sdb_time_t last_update)
536 {
537 sdb_llist_t *attrs;
538 int status = 0;
540 if ((! hostname) || (! key))
541 return -1;
543 pthread_rwlock_wrlock(&host_lock);
544 attrs = get_host_children(hostname, SDB_ATTRIBUTE);
545 if (! attrs) {
546 sdb_log(SDB_LOG_ERR, "store: Failed to store attribute '%s' - "
547 "host '%s' not found", key, hostname);
548 status = -1;
549 }
551 if (! status)
552 status = store_attr(attrs, key, value, last_update);
554 pthread_rwlock_unlock(&host_lock);
555 return status;
556 } /* sdb_store_attribute */
558 int
559 sdb_store_service(const char *hostname, const char *name,
560 sdb_time_t last_update)
561 {
562 sdb_llist_t *services;
564 int status = 0;
566 if ((! hostname) || (! name))
567 return -1;
569 pthread_rwlock_wrlock(&host_lock);
570 services = get_host_children(hostname, SDB_SERVICE);
571 if (! services) {
572 sdb_log(SDB_LOG_ERR, "store: Failed to store service '%s' - "
573 "host '%s' not found", name, hostname);
574 status = -1;
575 }
577 if (! status)
578 status = store_obj(services, SDB_SERVICE, name, last_update, NULL);
579 pthread_rwlock_unlock(&host_lock);
580 return status;
581 } /* sdb_store_service */
583 int
584 sdb_store_service_attr(const char *hostname, const char *service,
585 const char *key, const sdb_data_t *value, sdb_time_t last_update)
586 {
587 sdb_llist_t *services;
588 sdb_service_t *svc;
589 int status = 0;
591 if ((! hostname) || (! service) || (! key))
592 return -1;
594 pthread_rwlock_wrlock(&host_lock);
595 services = get_host_children(hostname, SDB_SERVICE);
596 if (! services) {
597 sdb_log(SDB_LOG_ERR, "store: Failed to store attribute '%s' "
598 "for service '%s' - host '%ss' not found",
599 key, service, hostname);
600 pthread_rwlock_unlock(&host_lock);
601 return -1;
602 }
604 svc = SVC(sdb_llist_search_by_name(services, service));
605 if (! svc) {
606 sdb_log(SDB_LOG_ERR, "store: Failed to store attribute '%s' - "
607 "service '%s/%s' not found", key, hostname, service);
608 status = -1;
609 }
611 if (! status)
612 status = store_attr(svc->attributes, key, value, last_update);
614 pthread_rwlock_unlock(&host_lock);
615 return status;
616 } /* sdb_store_service_attr */
618 int
619 sdb_store_host_tojson(sdb_store_obj_t *h, sdb_strbuf_t *buf, int flags)
620 {
621 sdb_host_t *host;
623 if ((! h) || (h->type != SDB_HOST) || (! buf))
624 return -1;
626 host = HOST(h);
628 sdb_strbuf_append(buf, "{\"name\": \"%s\", ", SDB_OBJ(host)->name);
629 store_common_tojson(h, buf);
631 if (! (flags & SDB_SKIP_ATTRIBUTES)) {
632 sdb_strbuf_append(buf, ", \"attributes\": ");
633 store_obj_tojson(host->attributes, SDB_ATTRIBUTE, buf, flags);
634 }
636 if (! (flags & SDB_SKIP_SERVICES)) {
637 sdb_strbuf_append(buf, ", \"services\": ");
638 store_obj_tojson(host->services, SDB_SERVICE, buf, flags);
639 }
641 sdb_strbuf_append(buf, "}");
642 return 0;
643 } /* sdb_store_host_tojson */
645 int
646 sdb_store_tojson(sdb_strbuf_t *buf, int flags)
647 {
648 sdb_llist_iter_t *host_iter;
650 if (! buf)
651 return -1;
653 pthread_rwlock_rdlock(&host_lock);
655 host_iter = sdb_llist_get_iter(host_list);
656 if (! host_iter) {
657 pthread_rwlock_unlock(&host_lock);
658 return -1;
659 }
661 sdb_strbuf_append(buf, "{\"hosts\":[");
663 while (sdb_llist_iter_has_next(host_iter)) {
664 sdb_store_obj_t *host = STORE_OBJ(sdb_llist_iter_get_next(host_iter));
665 assert(host);
667 if (sdb_store_host_tojson(host, buf, flags))
668 return -1;
670 if (sdb_llist_iter_has_next(host_iter))
671 sdb_strbuf_append(buf, ",");
672 }
674 sdb_strbuf_append(buf, "]}");
676 sdb_llist_iter_destroy(host_iter);
677 pthread_rwlock_unlock(&host_lock);
678 return 0;
679 } /* sdb_store_tojson */
681 /* TODO: actually support hierarchical data */
682 int
683 sdb_store_iterate(sdb_store_iter_cb cb, void *user_data)
684 {
685 sdb_llist_iter_t *host_iter;
686 int status = 0;
688 pthread_rwlock_rdlock(&host_lock);
690 host_iter = sdb_llist_get_iter(host_list);
691 if (! host_iter)
692 status = -1;
694 /* has_next returns false if the iterator is NULL */
695 while (sdb_llist_iter_has_next(host_iter)) {
696 sdb_store_obj_t *host = STORE_OBJ(sdb_llist_iter_get_next(host_iter));
697 assert(host);
699 if (cb(host, user_data)) {
700 status = -1;
701 break;
702 }
703 }
705 sdb_llist_iter_destroy(host_iter);
706 pthread_rwlock_unlock(&host_lock);
707 return status;
708 } /* sdb_store_iterate */
710 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */