ipmi: add GET_SYS_RESTART_CAUSE chassis command
[qemu/cris-port.git] / qobject / qdict.c
blob19df837c552d0cc668a5f0e51af1907b9896a432
1 /*
2 * QDict Module
4 * Copyright (C) 2009 Red Hat Inc.
6 * Authors:
7 * Luiz Capitulino <lcapitulino@redhat.com>
9 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
10 * See the COPYING.LIB file in the top-level directory.
13 #include "qapi/qmp/qint.h"
14 #include "qapi/qmp/qfloat.h"
15 #include "qapi/qmp/qdict.h"
16 #include "qapi/qmp/qbool.h"
17 #include "qapi/qmp/qstring.h"
18 #include "qapi/qmp/qobject.h"
19 #include "qemu/queue.h"
20 #include "qemu-common.h"
22 /**
23 * qdict_new(): Create a new QDict
25 * Return strong reference.
27 QDict *qdict_new(void)
29 QDict *qdict;
31 qdict = g_malloc0(sizeof(*qdict));
32 qobject_init(QOBJECT(qdict), QTYPE_QDICT);
34 return qdict;
37 /**
38 * qobject_to_qdict(): Convert a QObject into a QDict
40 QDict *qobject_to_qdict(const QObject *obj)
42 if (!obj || qobject_type(obj) != QTYPE_QDICT) {
43 return NULL;
45 return container_of(obj, QDict, base);
48 /**
49 * tdb_hash(): based on the hash agorithm from gdbm, via tdb
50 * (from module-init-tools)
52 static unsigned int tdb_hash(const char *name)
54 unsigned value; /* Used to compute the hash value. */
55 unsigned i; /* Used to cycle through random values. */
57 /* Set the initial value from the key size. */
58 for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++)
59 value = (value + (((const unsigned char *)name)[i] << (i*5 % 24)));
61 return (1103515243 * value + 12345);
64 /**
65 * alloc_entry(): allocate a new QDictEntry
67 static QDictEntry *alloc_entry(const char *key, QObject *value)
69 QDictEntry *entry;
71 entry = g_malloc0(sizeof(*entry));
72 entry->key = g_strdup(key);
73 entry->value = value;
75 return entry;
78 /**
79 * qdict_entry_value(): Return qdict entry value
81 * Return weak reference.
83 QObject *qdict_entry_value(const QDictEntry *entry)
85 return entry->value;
88 /**
89 * qdict_entry_key(): Return qdict entry key
91 * Return a *pointer* to the string, it has to be duplicated before being
92 * stored.
94 const char *qdict_entry_key(const QDictEntry *entry)
96 return entry->key;
99 /**
100 * qdict_find(): List lookup function
102 static QDictEntry *qdict_find(const QDict *qdict,
103 const char *key, unsigned int bucket)
105 QDictEntry *entry;
107 QLIST_FOREACH(entry, &qdict->table[bucket], next)
108 if (!strcmp(entry->key, key))
109 return entry;
111 return NULL;
115 * qdict_put_obj(): Put a new QObject into the dictionary
117 * Insert the pair 'key:value' into 'qdict', if 'key' already exists
118 * its 'value' will be replaced.
120 * This is done by freeing the reference to the stored QObject and
121 * storing the new one in the same entry.
123 * NOTE: ownership of 'value' is transferred to the QDict
125 void qdict_put_obj(QDict *qdict, const char *key, QObject *value)
127 unsigned int bucket;
128 QDictEntry *entry;
130 bucket = tdb_hash(key) % QDICT_BUCKET_MAX;
131 entry = qdict_find(qdict, key, bucket);
132 if (entry) {
133 /* replace key's value */
134 qobject_decref(entry->value);
135 entry->value = value;
136 } else {
137 /* allocate a new entry */
138 entry = alloc_entry(key, value);
139 QLIST_INSERT_HEAD(&qdict->table[bucket], entry, next);
140 qdict->size++;
145 * qdict_get(): Lookup for a given 'key'
147 * Return a weak reference to the QObject associated with 'key' if
148 * 'key' is present in the dictionary, NULL otherwise.
150 QObject *qdict_get(const QDict *qdict, const char *key)
152 QDictEntry *entry;
154 entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX);
155 return (entry == NULL ? NULL : entry->value);
159 * qdict_haskey(): Check if 'key' exists
161 * Return 1 if 'key' exists in the dict, 0 otherwise
163 int qdict_haskey(const QDict *qdict, const char *key)
165 unsigned int bucket = tdb_hash(key) % QDICT_BUCKET_MAX;
166 return (qdict_find(qdict, key, bucket) == NULL ? 0 : 1);
170 * qdict_size(): Return the size of the dictionary
172 size_t qdict_size(const QDict *qdict)
174 return qdict->size;
178 * qdict_get_obj(): Get a QObject of a specific type
180 static QObject *qdict_get_obj(const QDict *qdict, const char *key, QType type)
182 QObject *obj;
184 obj = qdict_get(qdict, key);
185 assert(obj != NULL);
186 assert(qobject_type(obj) == type);
188 return obj;
192 * qdict_get_double(): Get an number mapped by 'key'
194 * This function assumes that 'key' exists and it stores a
195 * QFloat or QInt object.
197 * Return number mapped by 'key'.
199 double qdict_get_double(const QDict *qdict, const char *key)
201 QObject *obj = qdict_get(qdict, key);
203 assert(obj);
204 switch (qobject_type(obj)) {
205 case QTYPE_QFLOAT:
206 return qfloat_get_double(qobject_to_qfloat(obj));
207 case QTYPE_QINT:
208 return qint_get_int(qobject_to_qint(obj));
209 default:
210 abort();
215 * qdict_get_int(): Get an integer mapped by 'key'
217 * This function assumes that 'key' exists and it stores a
218 * QInt object.
220 * Return integer mapped by 'key'.
222 int64_t qdict_get_int(const QDict *qdict, const char *key)
224 return qint_get_int(qobject_to_qint(qdict_get(qdict, key)));
228 * qdict_get_bool(): Get a bool mapped by 'key'
230 * This function assumes that 'key' exists and it stores a
231 * QBool object.
233 * Return bool mapped by 'key'.
235 bool qdict_get_bool(const QDict *qdict, const char *key)
237 return qbool_get_bool(qobject_to_qbool(qdict_get(qdict, key)));
241 * qdict_get_qlist(): Get the QList mapped by 'key'
243 * This function assumes that 'key' exists and it stores a
244 * QList object.
246 * Return QList mapped by 'key'.
248 QList *qdict_get_qlist(const QDict *qdict, const char *key)
250 return qobject_to_qlist(qdict_get_obj(qdict, key, QTYPE_QLIST));
254 * qdict_get_qdict(): Get the QDict mapped by 'key'
256 * This function assumes that 'key' exists and it stores a
257 * QDict object.
259 * Return QDict mapped by 'key'.
261 QDict *qdict_get_qdict(const QDict *qdict, const char *key)
263 return qobject_to_qdict(qdict_get(qdict, key));
267 * qdict_get_str(): Get a pointer to the stored string mapped
268 * by 'key'
270 * This function assumes that 'key' exists and it stores a
271 * QString object.
273 * Return pointer to the string mapped by 'key'.
275 const char *qdict_get_str(const QDict *qdict, const char *key)
277 return qstring_get_str(qobject_to_qstring(qdict_get(qdict, key)));
281 * qdict_get_try_int(): Try to get integer mapped by 'key'
283 * Return integer mapped by 'key', if it is not present in
284 * the dictionary or if the stored object is not of QInt type
285 * 'def_value' will be returned.
287 int64_t qdict_get_try_int(const QDict *qdict, const char *key,
288 int64_t def_value)
290 QInt *qint = qobject_to_qint(qdict_get(qdict, key));
292 return qint ? qint_get_int(qint) : def_value;
296 * qdict_get_try_bool(): Try to get a bool mapped by 'key'
298 * Return bool mapped by 'key', if it is not present in the
299 * dictionary or if the stored object is not of QBool type
300 * 'def_value' will be returned.
302 bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value)
304 QBool *qbool = qobject_to_qbool(qdict_get(qdict, key));
306 return qbool ? qbool_get_bool(qbool) : def_value;
310 * qdict_get_try_str(): Try to get a pointer to the stored string
311 * mapped by 'key'
313 * Return a pointer to the string mapped by 'key', if it is not present
314 * in the dictionary or if the stored object is not of QString type
315 * NULL will be returned.
317 const char *qdict_get_try_str(const QDict *qdict, const char *key)
319 QString *qstr = qobject_to_qstring(qdict_get(qdict, key));
321 return qstr ? qstring_get_str(qstr) : NULL;
325 * qdict_iter(): Iterate over all the dictionary's stored values.
327 * This function allows the user to provide an iterator, which will be
328 * called for each stored value in the dictionary.
330 void qdict_iter(const QDict *qdict,
331 void (*iter)(const char *key, QObject *obj, void *opaque),
332 void *opaque)
334 int i;
335 QDictEntry *entry;
337 for (i = 0; i < QDICT_BUCKET_MAX; i++) {
338 QLIST_FOREACH(entry, &qdict->table[i], next)
339 iter(entry->key, entry->value, opaque);
343 static QDictEntry *qdict_next_entry(const QDict *qdict, int first_bucket)
345 int i;
347 for (i = first_bucket; i < QDICT_BUCKET_MAX; i++) {
348 if (!QLIST_EMPTY(&qdict->table[i])) {
349 return QLIST_FIRST(&qdict->table[i]);
353 return NULL;
357 * qdict_first(): Return first qdict entry for iteration.
359 const QDictEntry *qdict_first(const QDict *qdict)
361 return qdict_next_entry(qdict, 0);
365 * qdict_next(): Return next qdict entry in an iteration.
367 const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry)
369 QDictEntry *ret;
371 ret = QLIST_NEXT(entry, next);
372 if (!ret) {
373 unsigned int bucket = tdb_hash(entry->key) % QDICT_BUCKET_MAX;
374 ret = qdict_next_entry(qdict, bucket + 1);
377 return ret;
381 * qdict_clone_shallow(): Clones a given QDict. Its entries are not copied, but
382 * another reference is added.
384 QDict *qdict_clone_shallow(const QDict *src)
386 QDict *dest;
387 QDictEntry *entry;
388 int i;
390 dest = qdict_new();
392 for (i = 0; i < QDICT_BUCKET_MAX; i++) {
393 QLIST_FOREACH(entry, &src->table[i], next) {
394 qobject_incref(entry->value);
395 qdict_put_obj(dest, entry->key, entry->value);
399 return dest;
403 * qentry_destroy(): Free all the memory allocated by a QDictEntry
405 static void qentry_destroy(QDictEntry *e)
407 assert(e != NULL);
408 assert(e->key != NULL);
409 assert(e->value != NULL);
411 qobject_decref(e->value);
412 g_free(e->key);
413 g_free(e);
417 * qdict_del(): Delete a 'key:value' pair from the dictionary
419 * This will destroy all data allocated by this entry.
421 void qdict_del(QDict *qdict, const char *key)
423 QDictEntry *entry;
425 entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX);
426 if (entry) {
427 QLIST_REMOVE(entry, next);
428 qentry_destroy(entry);
429 qdict->size--;
434 * qdict_destroy_obj(): Free all the memory allocated by a QDict
436 void qdict_destroy_obj(QObject *obj)
438 int i;
439 QDict *qdict;
441 assert(obj != NULL);
442 qdict = qobject_to_qdict(obj);
444 for (i = 0; i < QDICT_BUCKET_MAX; i++) {
445 QDictEntry *entry = QLIST_FIRST(&qdict->table[i]);
446 while (entry) {
447 QDictEntry *tmp = QLIST_NEXT(entry, next);
448 QLIST_REMOVE(entry, next);
449 qentry_destroy(entry);
450 entry = tmp;
454 g_free(qdict);
458 * qdict_copy_default(): If no entry mapped by 'key' exists in 'dst' yet, the
459 * value of 'key' in 'src' is copied there (and the refcount increased
460 * accordingly).
462 void qdict_copy_default(QDict *dst, QDict *src, const char *key)
464 QObject *val;
466 if (qdict_haskey(dst, key)) {
467 return;
470 val = qdict_get(src, key);
471 if (val) {
472 qobject_incref(val);
473 qdict_put_obj(dst, key, val);
478 * qdict_set_default_str(): If no entry mapped by 'key' exists in 'dst' yet, a
479 * new QString initialised by 'val' is put there.
481 void qdict_set_default_str(QDict *dst, const char *key, const char *val)
483 if (qdict_haskey(dst, key)) {
484 return;
487 qdict_put(dst, key, qstring_from_str(val));
490 static void qdict_flatten_qdict(QDict *qdict, QDict *target,
491 const char *prefix);
493 static void qdict_flatten_qlist(QList *qlist, QDict *target, const char *prefix)
495 QObject *value;
496 const QListEntry *entry;
497 char *new_key;
498 int i;
500 /* This function is never called with prefix == NULL, i.e., it is always
501 * called from within qdict_flatten_q(list|dict)(). Therefore, it does not
502 * need to remove list entries during the iteration (the whole list will be
503 * deleted eventually anyway from qdict_flatten_qdict()). */
504 assert(prefix);
506 entry = qlist_first(qlist);
508 for (i = 0; entry; entry = qlist_next(entry), i++) {
509 value = qlist_entry_obj(entry);
510 new_key = g_strdup_printf("%s.%i", prefix, i);
512 if (qobject_type(value) == QTYPE_QDICT) {
513 qdict_flatten_qdict(qobject_to_qdict(value), target, new_key);
514 } else if (qobject_type(value) == QTYPE_QLIST) {
515 qdict_flatten_qlist(qobject_to_qlist(value), target, new_key);
516 } else {
517 /* All other types are moved to the target unchanged. */
518 qobject_incref(value);
519 qdict_put_obj(target, new_key, value);
522 g_free(new_key);
526 static void qdict_flatten_qdict(QDict *qdict, QDict *target, const char *prefix)
528 QObject *value;
529 const QDictEntry *entry, *next;
530 char *new_key;
531 bool delete;
533 entry = qdict_first(qdict);
535 while (entry != NULL) {
537 next = qdict_next(qdict, entry);
538 value = qdict_entry_value(entry);
539 new_key = NULL;
540 delete = false;
542 if (prefix) {
543 new_key = g_strdup_printf("%s.%s", prefix, entry->key);
546 if (qobject_type(value) == QTYPE_QDICT) {
547 /* Entries of QDicts are processed recursively, the QDict object
548 * itself disappears. */
549 qdict_flatten_qdict(qobject_to_qdict(value), target,
550 new_key ? new_key : entry->key);
551 delete = true;
552 } else if (qobject_type(value) == QTYPE_QLIST) {
553 qdict_flatten_qlist(qobject_to_qlist(value), target,
554 new_key ? new_key : entry->key);
555 delete = true;
556 } else if (prefix) {
557 /* All other objects are moved to the target unchanged. */
558 qobject_incref(value);
559 qdict_put_obj(target, new_key, value);
560 delete = true;
563 g_free(new_key);
565 if (delete) {
566 qdict_del(qdict, entry->key);
568 /* Restart loop after modifying the iterated QDict */
569 entry = qdict_first(qdict);
570 continue;
573 entry = next;
578 * qdict_flatten(): For each nested QDict with key x, all fields with key y
579 * are moved to this QDict and their key is renamed to "x.y". For each nested
580 * QList with key x, the field at index y is moved to this QDict with the key
581 * "x.y" (i.e., the reverse of what qdict_array_split() does).
582 * This operation is applied recursively for nested QDicts and QLists.
584 void qdict_flatten(QDict *qdict)
586 qdict_flatten_qdict(qdict, qdict, NULL);
589 /* extract all the src QDict entries starting by start into dst */
590 void qdict_extract_subqdict(QDict *src, QDict **dst, const char *start)
593 const QDictEntry *entry, *next;
594 const char *p;
596 *dst = qdict_new();
597 entry = qdict_first(src);
599 while (entry != NULL) {
600 next = qdict_next(src, entry);
601 if (strstart(entry->key, start, &p)) {
602 qobject_incref(entry->value);
603 qdict_put_obj(*dst, p, entry->value);
604 qdict_del(src, entry->key);
606 entry = next;
610 static int qdict_count_prefixed_entries(const QDict *src, const char *start)
612 const QDictEntry *entry;
613 int count = 0;
615 for (entry = qdict_first(src); entry; entry = qdict_next(src, entry)) {
616 if (strstart(entry->key, start, NULL)) {
617 if (count == INT_MAX) {
618 return -ERANGE;
620 count++;
624 return count;
628 * qdict_array_split(): This function moves array-like elements of a QDict into
629 * a new QList. Every entry in the original QDict with a key "%u" or one
630 * prefixed "%u.", where %u designates an unsigned integer starting at 0 and
631 * incrementally counting up, will be moved to a new QDict at index %u in the
632 * output QList with the key prefix removed, if that prefix is "%u.". If the
633 * whole key is just "%u", the whole QObject will be moved unchanged without
634 * creating a new QDict. The function terminates when there is no entry in the
635 * QDict with a prefix directly (incrementally) following the last one; it also
636 * returns if there are both entries with "%u" and "%u." for the same index %u.
637 * Example: {"0.a": 42, "0.b": 23, "1.x": 0, "4.y": 1, "o.o": 7, "2": 66}
638 * (or {"1.x": 0, "4.y": 1, "0.a": 42, "o.o": 7, "0.b": 23, "2": 66})
639 * => [{"a": 42, "b": 23}, {"x": 0}, 66]
640 * and {"4.y": 1, "o.o": 7} (remainder of the old QDict)
642 void qdict_array_split(QDict *src, QList **dst)
644 unsigned i;
646 *dst = qlist_new();
648 for (i = 0; i < UINT_MAX; i++) {
649 QObject *subqobj;
650 bool is_subqdict;
651 QDict *subqdict;
652 char indexstr[32], prefix[32];
653 size_t snprintf_ret;
655 snprintf_ret = snprintf(indexstr, 32, "%u", i);
656 assert(snprintf_ret < 32);
658 subqobj = qdict_get(src, indexstr);
660 snprintf_ret = snprintf(prefix, 32, "%u.", i);
661 assert(snprintf_ret < 32);
663 /* Overflow is the same as positive non-zero results */
664 is_subqdict = qdict_count_prefixed_entries(src, prefix);
666 // There may be either a single subordinate object (named "%u") or
667 // multiple objects (each with a key prefixed "%u."), but not both.
668 if (!subqobj == !is_subqdict) {
669 break;
672 if (is_subqdict) {
673 qdict_extract_subqdict(src, &subqdict, prefix);
674 assert(qdict_size(subqdict) > 0);
675 } else {
676 qobject_incref(subqobj);
677 qdict_del(src, indexstr);
680 qlist_append_obj(*dst, subqobj ?: QOBJECT(subqdict));
685 * qdict_array_entries(): Returns the number of direct array entries if the
686 * sub-QDict of src specified by the prefix in subqdict (or src itself for
687 * prefix == "") is valid as an array, i.e. the length of the created list if
688 * the sub-QDict would become empty after calling qdict_array_split() on it. If
689 * the array is not valid, -EINVAL is returned.
691 int qdict_array_entries(QDict *src, const char *subqdict)
693 const QDictEntry *entry;
694 unsigned i;
695 unsigned entries = 0;
696 size_t subqdict_len = strlen(subqdict);
698 assert(!subqdict_len || subqdict[subqdict_len - 1] == '.');
700 /* qdict_array_split() loops until UINT_MAX, but as we want to return
701 * negative errors, we only have a signed return value here. Any additional
702 * entries will lead to -EINVAL. */
703 for (i = 0; i < INT_MAX; i++) {
704 QObject *subqobj;
705 int subqdict_entries;
706 size_t slen = 32 + subqdict_len;
707 char indexstr[slen], prefix[slen];
708 size_t snprintf_ret;
710 snprintf_ret = snprintf(indexstr, slen, "%s%u", subqdict, i);
711 assert(snprintf_ret < slen);
713 subqobj = qdict_get(src, indexstr);
715 snprintf_ret = snprintf(prefix, slen, "%s%u.", subqdict, i);
716 assert(snprintf_ret < slen);
718 subqdict_entries = qdict_count_prefixed_entries(src, prefix);
719 if (subqdict_entries < 0) {
720 return subqdict_entries;
723 /* There may be either a single subordinate object (named "%u") or
724 * multiple objects (each with a key prefixed "%u."), but not both. */
725 if (subqobj && subqdict_entries) {
726 return -EINVAL;
727 } else if (!subqobj && !subqdict_entries) {
728 break;
731 entries += subqdict_entries ? subqdict_entries : 1;
734 /* Consider everything handled that isn't part of the given sub-QDict */
735 for (entry = qdict_first(src); entry; entry = qdict_next(src, entry)) {
736 if (!strstart(qdict_entry_key(entry), subqdict, NULL)) {
737 entries++;
741 /* Anything left in the sub-QDict that wasn't handled? */
742 if (qdict_size(src) != entries) {
743 return -EINVAL;
746 return i;
750 * qdict_join(): Absorb the src QDict into the dest QDict, that is, move all
751 * elements from src to dest.
753 * If an element from src has a key already present in dest, it will not be
754 * moved unless overwrite is true.
756 * If overwrite is true, the conflicting values in dest will be discarded and
757 * replaced by the corresponding values from src.
759 * Therefore, with overwrite being true, the src QDict will always be empty when
760 * this function returns. If overwrite is false, the src QDict will be empty
761 * iff there were no conflicts.
763 void qdict_join(QDict *dest, QDict *src, bool overwrite)
765 const QDictEntry *entry, *next;
767 entry = qdict_first(src);
768 while (entry) {
769 next = qdict_next(src, entry);
771 if (overwrite || !qdict_haskey(dest, entry->key)) {
772 qobject_incref(entry->value);
773 qdict_put_obj(dest, entry->key, entry->value);
774 qdict_del(src, entry->key);
777 entry = next;