4 * Copyright (C) 2009 Red Hat Inc.
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 "qemu/osdep.h"
14 #include "qapi/qmp/qint.h"
15 #include "qapi/qmp/qfloat.h"
16 #include "qapi/qmp/qdict.h"
17 #include "qapi/qmp/qbool.h"
18 #include "qapi/qmp/qstring.h"
19 #include "qapi/qmp/qobject.h"
20 #include "qemu/queue.h"
21 #include "qemu-common.h"
22 #include "qemu/cutils.h"
25 * qdict_new(): Create a new QDict
27 * Return strong reference.
29 QDict
*qdict_new(void)
33 qdict
= g_malloc0(sizeof(*qdict
));
34 qobject_init(QOBJECT(qdict
), QTYPE_QDICT
);
40 * qobject_to_qdict(): Convert a QObject into a QDict
42 QDict
*qobject_to_qdict(const QObject
*obj
)
44 if (!obj
|| qobject_type(obj
) != QTYPE_QDICT
) {
47 return container_of(obj
, QDict
, base
);
51 * tdb_hash(): based on the hash agorithm from gdbm, via tdb
52 * (from module-init-tools)
54 static unsigned int tdb_hash(const char *name
)
56 unsigned value
; /* Used to compute the hash value. */
57 unsigned i
; /* Used to cycle through random values. */
59 /* Set the initial value from the key size. */
60 for (value
= 0x238F13AF * strlen(name
), i
=0; name
[i
]; i
++)
61 value
= (value
+ (((const unsigned char *)name
)[i
] << (i
*5 % 24)));
63 return (1103515243 * value
+ 12345);
67 * alloc_entry(): allocate a new QDictEntry
69 static QDictEntry
*alloc_entry(const char *key
, QObject
*value
)
73 entry
= g_malloc0(sizeof(*entry
));
74 entry
->key
= g_strdup(key
);
81 * qdict_entry_value(): Return qdict entry value
83 * Return weak reference.
85 QObject
*qdict_entry_value(const QDictEntry
*entry
)
91 * qdict_entry_key(): Return qdict entry key
93 * Return a *pointer* to the string, it has to be duplicated before being
96 const char *qdict_entry_key(const QDictEntry
*entry
)
102 * qdict_find(): List lookup function
104 static QDictEntry
*qdict_find(const QDict
*qdict
,
105 const char *key
, unsigned int bucket
)
109 QLIST_FOREACH(entry
, &qdict
->table
[bucket
], next
)
110 if (!strcmp(entry
->key
, key
))
117 * qdict_put_obj(): Put a new QObject into the dictionary
119 * Insert the pair 'key:value' into 'qdict', if 'key' already exists
120 * its 'value' will be replaced.
122 * This is done by freeing the reference to the stored QObject and
123 * storing the new one in the same entry.
125 * NOTE: ownership of 'value' is transferred to the QDict
127 void qdict_put_obj(QDict
*qdict
, const char *key
, QObject
*value
)
132 bucket
= tdb_hash(key
) % QDICT_BUCKET_MAX
;
133 entry
= qdict_find(qdict
, key
, bucket
);
135 /* replace key's value */
136 qobject_decref(entry
->value
);
137 entry
->value
= value
;
139 /* allocate a new entry */
140 entry
= alloc_entry(key
, value
);
141 QLIST_INSERT_HEAD(&qdict
->table
[bucket
], entry
, next
);
147 * qdict_get(): Lookup for a given 'key'
149 * Return a weak reference to the QObject associated with 'key' if
150 * 'key' is present in the dictionary, NULL otherwise.
152 QObject
*qdict_get(const QDict
*qdict
, const char *key
)
156 entry
= qdict_find(qdict
, key
, tdb_hash(key
) % QDICT_BUCKET_MAX
);
157 return (entry
== NULL
? NULL
: entry
->value
);
161 * qdict_haskey(): Check if 'key' exists
163 * Return 1 if 'key' exists in the dict, 0 otherwise
165 int qdict_haskey(const QDict
*qdict
, const char *key
)
167 unsigned int bucket
= tdb_hash(key
) % QDICT_BUCKET_MAX
;
168 return (qdict_find(qdict
, key
, bucket
) == NULL
? 0 : 1);
172 * qdict_size(): Return the size of the dictionary
174 size_t qdict_size(const QDict
*qdict
)
180 * qdict_get_obj(): Get a QObject of a specific type
182 static QObject
*qdict_get_obj(const QDict
*qdict
, const char *key
, QType type
)
186 obj
= qdict_get(qdict
, key
);
188 assert(qobject_type(obj
) == type
);
194 * qdict_get_double(): Get an number mapped by 'key'
196 * This function assumes that 'key' exists and it stores a
197 * QFloat or QInt object.
199 * Return number mapped by 'key'.
201 double qdict_get_double(const QDict
*qdict
, const char *key
)
203 QObject
*obj
= qdict_get(qdict
, key
);
206 switch (qobject_type(obj
)) {
208 return qfloat_get_double(qobject_to_qfloat(obj
));
210 return qint_get_int(qobject_to_qint(obj
));
217 * qdict_get_int(): Get an integer mapped by 'key'
219 * This function assumes that 'key' exists and it stores a
222 * Return integer mapped by 'key'.
224 int64_t qdict_get_int(const QDict
*qdict
, const char *key
)
226 return qint_get_int(qobject_to_qint(qdict_get(qdict
, key
)));
230 * qdict_get_bool(): Get a bool mapped by 'key'
232 * This function assumes that 'key' exists and it stores a
235 * Return bool mapped by 'key'.
237 bool qdict_get_bool(const QDict
*qdict
, const char *key
)
239 return qbool_get_bool(qobject_to_qbool(qdict_get(qdict
, key
)));
243 * qdict_get_qlist(): Get the QList mapped by 'key'
245 * This function assumes that 'key' exists and it stores a
248 * Return QList mapped by 'key'.
250 QList
*qdict_get_qlist(const QDict
*qdict
, const char *key
)
252 return qobject_to_qlist(qdict_get_obj(qdict
, key
, QTYPE_QLIST
));
256 * qdict_get_qdict(): Get the QDict mapped by 'key'
258 * This function assumes that 'key' exists and it stores a
261 * Return QDict mapped by 'key'.
263 QDict
*qdict_get_qdict(const QDict
*qdict
, const char *key
)
265 return qobject_to_qdict(qdict_get(qdict
, key
));
269 * qdict_get_str(): Get a pointer to the stored string mapped
272 * This function assumes that 'key' exists and it stores a
275 * Return pointer to the string mapped by 'key'.
277 const char *qdict_get_str(const QDict
*qdict
, const char *key
)
279 return qstring_get_str(qobject_to_qstring(qdict_get(qdict
, key
)));
283 * qdict_get_try_int(): Try to get integer mapped by 'key'
285 * Return integer mapped by 'key', if it is not present in
286 * the dictionary or if the stored object is not of QInt type
287 * 'def_value' will be returned.
289 int64_t qdict_get_try_int(const QDict
*qdict
, const char *key
,
292 QInt
*qint
= qobject_to_qint(qdict_get(qdict
, key
));
294 return qint
? qint_get_int(qint
) : def_value
;
298 * qdict_get_try_bool(): Try to get a bool mapped by 'key'
300 * Return bool mapped by 'key', if it is not present in the
301 * dictionary or if the stored object is not of QBool type
302 * 'def_value' will be returned.
304 bool qdict_get_try_bool(const QDict
*qdict
, const char *key
, bool def_value
)
306 QBool
*qbool
= qobject_to_qbool(qdict_get(qdict
, key
));
308 return qbool
? qbool_get_bool(qbool
) : def_value
;
312 * qdict_get_try_str(): Try to get a pointer to the stored string
315 * Return a pointer to the string mapped by 'key', if it is not present
316 * in the dictionary or if the stored object is not of QString type
317 * NULL will be returned.
319 const char *qdict_get_try_str(const QDict
*qdict
, const char *key
)
321 QString
*qstr
= qobject_to_qstring(qdict_get(qdict
, key
));
323 return qstr
? qstring_get_str(qstr
) : NULL
;
327 * qdict_iter(): Iterate over all the dictionary's stored values.
329 * This function allows the user to provide an iterator, which will be
330 * called for each stored value in the dictionary.
332 void qdict_iter(const QDict
*qdict
,
333 void (*iter
)(const char *key
, QObject
*obj
, void *opaque
),
339 for (i
= 0; i
< QDICT_BUCKET_MAX
; i
++) {
340 QLIST_FOREACH(entry
, &qdict
->table
[i
], next
)
341 iter(entry
->key
, entry
->value
, opaque
);
345 static QDictEntry
*qdict_next_entry(const QDict
*qdict
, int first_bucket
)
349 for (i
= first_bucket
; i
< QDICT_BUCKET_MAX
; i
++) {
350 if (!QLIST_EMPTY(&qdict
->table
[i
])) {
351 return QLIST_FIRST(&qdict
->table
[i
]);
359 * qdict_first(): Return first qdict entry for iteration.
361 const QDictEntry
*qdict_first(const QDict
*qdict
)
363 return qdict_next_entry(qdict
, 0);
367 * qdict_next(): Return next qdict entry in an iteration.
369 const QDictEntry
*qdict_next(const QDict
*qdict
, const QDictEntry
*entry
)
373 ret
= QLIST_NEXT(entry
, next
);
375 unsigned int bucket
= tdb_hash(entry
->key
) % QDICT_BUCKET_MAX
;
376 ret
= qdict_next_entry(qdict
, bucket
+ 1);
383 * qdict_clone_shallow(): Clones a given QDict. Its entries are not copied, but
384 * another reference is added.
386 QDict
*qdict_clone_shallow(const QDict
*src
)
394 for (i
= 0; i
< QDICT_BUCKET_MAX
; i
++) {
395 QLIST_FOREACH(entry
, &src
->table
[i
], next
) {
396 qobject_incref(entry
->value
);
397 qdict_put_obj(dest
, entry
->key
, entry
->value
);
405 * qentry_destroy(): Free all the memory allocated by a QDictEntry
407 static void qentry_destroy(QDictEntry
*e
)
410 assert(e
->key
!= NULL
);
411 assert(e
->value
!= NULL
);
413 qobject_decref(e
->value
);
419 * qdict_del(): Delete a 'key:value' pair from the dictionary
421 * This will destroy all data allocated by this entry.
423 void qdict_del(QDict
*qdict
, const char *key
)
427 entry
= qdict_find(qdict
, key
, tdb_hash(key
) % QDICT_BUCKET_MAX
);
429 QLIST_REMOVE(entry
, next
);
430 qentry_destroy(entry
);
436 * qdict_destroy_obj(): Free all the memory allocated by a QDict
438 void qdict_destroy_obj(QObject
*obj
)
444 qdict
= qobject_to_qdict(obj
);
446 for (i
= 0; i
< QDICT_BUCKET_MAX
; i
++) {
447 QDictEntry
*entry
= QLIST_FIRST(&qdict
->table
[i
]);
449 QDictEntry
*tmp
= QLIST_NEXT(entry
, next
);
450 QLIST_REMOVE(entry
, next
);
451 qentry_destroy(entry
);
460 * qdict_copy_default(): If no entry mapped by 'key' exists in 'dst' yet, the
461 * value of 'key' in 'src' is copied there (and the refcount increased
464 void qdict_copy_default(QDict
*dst
, QDict
*src
, const char *key
)
468 if (qdict_haskey(dst
, key
)) {
472 val
= qdict_get(src
, key
);
475 qdict_put_obj(dst
, key
, val
);
480 * qdict_set_default_str(): If no entry mapped by 'key' exists in 'dst' yet, a
481 * new QString initialised by 'val' is put there.
483 void qdict_set_default_str(QDict
*dst
, const char *key
, const char *val
)
485 if (qdict_haskey(dst
, key
)) {
489 qdict_put(dst
, key
, qstring_from_str(val
));
492 static void qdict_flatten_qdict(QDict
*qdict
, QDict
*target
,
495 static void qdict_flatten_qlist(QList
*qlist
, QDict
*target
, const char *prefix
)
498 const QListEntry
*entry
;
502 /* This function is never called with prefix == NULL, i.e., it is always
503 * called from within qdict_flatten_q(list|dict)(). Therefore, it does not
504 * need to remove list entries during the iteration (the whole list will be
505 * deleted eventually anyway from qdict_flatten_qdict()). */
508 entry
= qlist_first(qlist
);
510 for (i
= 0; entry
; entry
= qlist_next(entry
), i
++) {
511 value
= qlist_entry_obj(entry
);
512 new_key
= g_strdup_printf("%s.%i", prefix
, i
);
514 if (qobject_type(value
) == QTYPE_QDICT
) {
515 qdict_flatten_qdict(qobject_to_qdict(value
), target
, new_key
);
516 } else if (qobject_type(value
) == QTYPE_QLIST
) {
517 qdict_flatten_qlist(qobject_to_qlist(value
), target
, new_key
);
519 /* All other types are moved to the target unchanged. */
520 qobject_incref(value
);
521 qdict_put_obj(target
, new_key
, value
);
528 static void qdict_flatten_qdict(QDict
*qdict
, QDict
*target
, const char *prefix
)
531 const QDictEntry
*entry
, *next
;
535 entry
= qdict_first(qdict
);
537 while (entry
!= NULL
) {
539 next
= qdict_next(qdict
, entry
);
540 value
= qdict_entry_value(entry
);
545 new_key
= g_strdup_printf("%s.%s", prefix
, entry
->key
);
548 if (qobject_type(value
) == QTYPE_QDICT
) {
549 /* Entries of QDicts are processed recursively, the QDict object
550 * itself disappears. */
551 qdict_flatten_qdict(qobject_to_qdict(value
), target
,
552 new_key
? new_key
: entry
->key
);
554 } else if (qobject_type(value
) == QTYPE_QLIST
) {
555 qdict_flatten_qlist(qobject_to_qlist(value
), target
,
556 new_key
? new_key
: entry
->key
);
559 /* All other objects are moved to the target unchanged. */
560 qobject_incref(value
);
561 qdict_put_obj(target
, new_key
, value
);
568 qdict_del(qdict
, entry
->key
);
570 /* Restart loop after modifying the iterated QDict */
571 entry
= qdict_first(qdict
);
580 * qdict_flatten(): For each nested QDict with key x, all fields with key y
581 * are moved to this QDict and their key is renamed to "x.y". For each nested
582 * QList with key x, the field at index y is moved to this QDict with the key
583 * "x.y" (i.e., the reverse of what qdict_array_split() does).
584 * This operation is applied recursively for nested QDicts and QLists.
586 void qdict_flatten(QDict
*qdict
)
588 qdict_flatten_qdict(qdict
, qdict
, NULL
);
591 /* extract all the src QDict entries starting by start into dst */
592 void qdict_extract_subqdict(QDict
*src
, QDict
**dst
, const char *start
)
595 const QDictEntry
*entry
, *next
;
599 entry
= qdict_first(src
);
601 while (entry
!= NULL
) {
602 next
= qdict_next(src
, entry
);
603 if (strstart(entry
->key
, start
, &p
)) {
604 qobject_incref(entry
->value
);
605 qdict_put_obj(*dst
, p
, entry
->value
);
606 qdict_del(src
, entry
->key
);
612 static int qdict_count_prefixed_entries(const QDict
*src
, const char *start
)
614 const QDictEntry
*entry
;
617 for (entry
= qdict_first(src
); entry
; entry
= qdict_next(src
, entry
)) {
618 if (strstart(entry
->key
, start
, NULL
)) {
619 if (count
== INT_MAX
) {
630 * qdict_array_split(): This function moves array-like elements of a QDict into
631 * a new QList. Every entry in the original QDict with a key "%u" or one
632 * prefixed "%u.", where %u designates an unsigned integer starting at 0 and
633 * incrementally counting up, will be moved to a new QDict at index %u in the
634 * output QList with the key prefix removed, if that prefix is "%u.". If the
635 * whole key is just "%u", the whole QObject will be moved unchanged without
636 * creating a new QDict. The function terminates when there is no entry in the
637 * QDict with a prefix directly (incrementally) following the last one; it also
638 * returns if there are both entries with "%u" and "%u." for the same index %u.
639 * Example: {"0.a": 42, "0.b": 23, "1.x": 0, "4.y": 1, "o.o": 7, "2": 66}
640 * (or {"1.x": 0, "4.y": 1, "0.a": 42, "o.o": 7, "0.b": 23, "2": 66})
641 * => [{"a": 42, "b": 23}, {"x": 0}, 66]
642 * and {"4.y": 1, "o.o": 7} (remainder of the old QDict)
644 void qdict_array_split(QDict
*src
, QList
**dst
)
650 for (i
= 0; i
< UINT_MAX
; i
++) {
654 char indexstr
[32], prefix
[32];
657 snprintf_ret
= snprintf(indexstr
, 32, "%u", i
);
658 assert(snprintf_ret
< 32);
660 subqobj
= qdict_get(src
, indexstr
);
662 snprintf_ret
= snprintf(prefix
, 32, "%u.", i
);
663 assert(snprintf_ret
< 32);
665 /* Overflow is the same as positive non-zero results */
666 is_subqdict
= qdict_count_prefixed_entries(src
, prefix
);
668 // There may be either a single subordinate object (named "%u") or
669 // multiple objects (each with a key prefixed "%u."), but not both.
670 if (!subqobj
== !is_subqdict
) {
675 qdict_extract_subqdict(src
, &subqdict
, prefix
);
676 assert(qdict_size(subqdict
) > 0);
678 qobject_incref(subqobj
);
679 qdict_del(src
, indexstr
);
682 qlist_append_obj(*dst
, subqobj
?: QOBJECT(subqdict
));
687 * qdict_array_entries(): Returns the number of direct array entries if the
688 * sub-QDict of src specified by the prefix in subqdict (or src itself for
689 * prefix == "") is valid as an array, i.e. the length of the created list if
690 * the sub-QDict would become empty after calling qdict_array_split() on it. If
691 * the array is not valid, -EINVAL is returned.
693 int qdict_array_entries(QDict
*src
, const char *subqdict
)
695 const QDictEntry
*entry
;
697 unsigned entries
= 0;
698 size_t subqdict_len
= strlen(subqdict
);
700 assert(!subqdict_len
|| subqdict
[subqdict_len
- 1] == '.');
702 /* qdict_array_split() loops until UINT_MAX, but as we want to return
703 * negative errors, we only have a signed return value here. Any additional
704 * entries will lead to -EINVAL. */
705 for (i
= 0; i
< INT_MAX
; i
++) {
707 int subqdict_entries
;
708 char *prefix
= g_strdup_printf("%s%u.", subqdict
, i
);
710 subqdict_entries
= qdict_count_prefixed_entries(src
, prefix
);
712 /* Remove ending "." */
713 prefix
[strlen(prefix
) - 1] = 0;
714 subqobj
= qdict_get(src
, prefix
);
718 if (subqdict_entries
< 0) {
719 return subqdict_entries
;
722 /* There may be either a single subordinate object (named "%u") or
723 * multiple objects (each with a key prefixed "%u."), but not both. */
724 if (subqobj
&& subqdict_entries
) {
726 } else if (!subqobj
&& !subqdict_entries
) {
730 entries
+= subqdict_entries
? subqdict_entries
: 1;
733 /* Consider everything handled that isn't part of the given sub-QDict */
734 for (entry
= qdict_first(src
); entry
; entry
= qdict_next(src
, entry
)) {
735 if (!strstart(qdict_entry_key(entry
), subqdict
, NULL
)) {
740 /* Anything left in the sub-QDict that wasn't handled? */
741 if (qdict_size(src
) != entries
) {
749 * qdict_join(): Absorb the src QDict into the dest QDict, that is, move all
750 * elements from src to dest.
752 * If an element from src has a key already present in dest, it will not be
753 * moved unless overwrite is true.
755 * If overwrite is true, the conflicting values in dest will be discarded and
756 * replaced by the corresponding values from src.
758 * Therefore, with overwrite being true, the src QDict will always be empty when
759 * this function returns. If overwrite is false, the src QDict will be empty
760 * iff there were no conflicts.
762 void qdict_join(QDict
*dest
, QDict
*src
, bool overwrite
)
764 const QDictEntry
*entry
, *next
;
766 entry
= qdict_first(src
);
768 next
= qdict_next(src
, entry
);
770 if (overwrite
|| !qdict_haskey(dest
, entry
->key
)) {
771 qobject_incref(entry
->value
);
772 qdict_put_obj(dest
, entry
->key
, entry
->value
);
773 qdict_del(src
, entry
->key
);