From 0bcc8e5bd8d6fd6e5cb6462054f7cfa45b282f9a Mon Sep 17 00:00:00 2001 From: Markus Armbruster Date: Thu, 14 Jun 2018 21:14:29 +0200 Subject: [PATCH] qobject: Move block-specific qdict code to block-qdict.c Pure code motion, except for two brace placements and a comment tweaked to appease checkpatch. Signed-off-by: Markus Armbruster Reviewed-by: Kevin Wolf Signed-off-by: Kevin Wolf --- MAINTAINERS | 2 + qobject/Makefile.objs | 1 + qobject/{qdict.c => block-qdict.c} | 465 +------- qobject/qdict.c | 1549 ++++++++------------------ tests/Makefile.include | 4 + tests/{check-qdict.c => check-block-qdict.c} | 372 +------ tests/check-qdict.c | 1396 +++++++---------------- 7 files changed, 856 insertions(+), 2933 deletions(-) copy qobject/{qdict.c => block-qdict.c} (63%) rewrite qobject/qdict.c (63%) copy tests/{check-qdict.c => check-block-qdict.c} (67%) rewrite tests/check-qdict.c (67%) diff --git a/MAINTAINERS b/MAINTAINERS index 8a94517e9e..0fb5f38f9f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1369,6 +1369,8 @@ F: qemu-img* F: qemu-io* F: tests/qemu-iotests/ F: util/qemu-progress.c +F: qobject/block-qdict.c +F: test/check-block-qdict.c T: git git://repo.or.cz/qemu/kevin.git block Block I/O path diff --git a/qobject/Makefile.objs b/qobject/Makefile.objs index 002d25873a..7b12c9cacf 100644 --- a/qobject/Makefile.objs +++ b/qobject/Makefile.objs @@ -1,2 +1,3 @@ util-obj-y = qnull.o qnum.o qstring.o qdict.o qlist.o qbool.o qlit.o util-obj-y += qjson.o qobject.o json-lexer.o json-streamer.o json-parser.o +util-obj-y += block-qdict.o diff --git a/qobject/qdict.c b/qobject/block-qdict.c similarity index 63% copy from qobject/qdict.c copy to qobject/block-qdict.c index 0554c64553..fb92010dc5 100644 --- a/qobject/qdict.c +++ b/qobject/block-qdict.c @@ -1,10 +1,7 @@ /* - * QDict Module + * Special QDict functions used by the block layer * - * Copyright (C) 2009 Red Hat Inc. - * - * Authors: - * Luiz Capitulino + * Copyright (c) 2013-2018 Red Hat, Inc. * * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. * See the COPYING.LIB file in the top-level directory. @@ -12,458 +9,9 @@ #include "qemu/osdep.h" #include "block/qdict.h" -#include "qapi/qmp/qnum.h" -#include "qapi/qmp/qdict.h" -#include "qapi/qmp/qbool.h" #include "qapi/qmp/qlist.h" -#include "qapi/qmp/qnull.h" -#include "qapi/qmp/qstring.h" -#include "qapi/error.h" -#include "qemu/queue.h" -#include "qemu-common.h" #include "qemu/cutils.h" - -/** - * qdict_new(): Create a new QDict - * - * Return strong reference. - */ -QDict *qdict_new(void) -{ - QDict *qdict; - - qdict = g_malloc0(sizeof(*qdict)); - qobject_init(QOBJECT(qdict), QTYPE_QDICT); - - return qdict; -} - -/** - * tdb_hash(): based on the hash agorithm from gdbm, via tdb - * (from module-init-tools) - */ -static unsigned int tdb_hash(const char *name) -{ - unsigned value; /* Used to compute the hash value. */ - unsigned i; /* Used to cycle through random values. */ - - /* Set the initial value from the key size. */ - for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++) - value = (value + (((const unsigned char *)name)[i] << (i*5 % 24))); - - return (1103515243 * value + 12345); -} - -/** - * alloc_entry(): allocate a new QDictEntry - */ -static QDictEntry *alloc_entry(const char *key, QObject *value) -{ - QDictEntry *entry; - - entry = g_malloc0(sizeof(*entry)); - entry->key = g_strdup(key); - entry->value = value; - - return entry; -} - -/** - * qdict_entry_value(): Return qdict entry value - * - * Return weak reference. - */ -QObject *qdict_entry_value(const QDictEntry *entry) -{ - return entry->value; -} - -/** - * qdict_entry_key(): Return qdict entry key - * - * Return a *pointer* to the string, it has to be duplicated before being - * stored. - */ -const char *qdict_entry_key(const QDictEntry *entry) -{ - return entry->key; -} - -/** - * qdict_find(): List lookup function - */ -static QDictEntry *qdict_find(const QDict *qdict, - const char *key, unsigned int bucket) -{ - QDictEntry *entry; - - QLIST_FOREACH(entry, &qdict->table[bucket], next) - if (!strcmp(entry->key, key)) - return entry; - - return NULL; -} - -/** - * qdict_put_obj(): Put a new QObject into the dictionary - * - * Insert the pair 'key:value' into 'qdict', if 'key' already exists - * its 'value' will be replaced. - * - * This is done by freeing the reference to the stored QObject and - * storing the new one in the same entry. - * - * NOTE: ownership of 'value' is transferred to the QDict - */ -void qdict_put_obj(QDict *qdict, const char *key, QObject *value) -{ - unsigned int bucket; - QDictEntry *entry; - - bucket = tdb_hash(key) % QDICT_BUCKET_MAX; - entry = qdict_find(qdict, key, bucket); - if (entry) { - /* replace key's value */ - qobject_unref(entry->value); - entry->value = value; - } else { - /* allocate a new entry */ - entry = alloc_entry(key, value); - QLIST_INSERT_HEAD(&qdict->table[bucket], entry, next); - qdict->size++; - } -} - -void qdict_put_int(QDict *qdict, const char *key, int64_t value) -{ - qdict_put(qdict, key, qnum_from_int(value)); -} - -void qdict_put_bool(QDict *qdict, const char *key, bool value) -{ - qdict_put(qdict, key, qbool_from_bool(value)); -} - -void qdict_put_str(QDict *qdict, const char *key, const char *value) -{ - qdict_put(qdict, key, qstring_from_str(value)); -} - -void qdict_put_null(QDict *qdict, const char *key) -{ - qdict_put(qdict, key, qnull()); -} - -/** - * qdict_get(): Lookup for a given 'key' - * - * Return a weak reference to the QObject associated with 'key' if - * 'key' is present in the dictionary, NULL otherwise. - */ -QObject *qdict_get(const QDict *qdict, const char *key) -{ - QDictEntry *entry; - - entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX); - return (entry == NULL ? NULL : entry->value); -} - -/** - * qdict_haskey(): Check if 'key' exists - * - * Return 1 if 'key' exists in the dict, 0 otherwise - */ -int qdict_haskey(const QDict *qdict, const char *key) -{ - unsigned int bucket = tdb_hash(key) % QDICT_BUCKET_MAX; - return (qdict_find(qdict, key, bucket) == NULL ? 0 : 1); -} - -/** - * qdict_size(): Return the size of the dictionary - */ -size_t qdict_size(const QDict *qdict) -{ - return qdict->size; -} - -/** - * qdict_get_double(): Get an number mapped by 'key' - * - * This function assumes that 'key' exists and it stores a QNum. - * - * Return number mapped by 'key'. - */ -double qdict_get_double(const QDict *qdict, const char *key) -{ - return qnum_get_double(qobject_to(QNum, qdict_get(qdict, key))); -} - -/** - * qdict_get_int(): Get an integer mapped by 'key' - * - * This function assumes that 'key' exists and it stores a - * QNum representable as int. - * - * Return integer mapped by 'key'. - */ -int64_t qdict_get_int(const QDict *qdict, const char *key) -{ - return qnum_get_int(qobject_to(QNum, qdict_get(qdict, key))); -} - -/** - * qdict_get_bool(): Get a bool mapped by 'key' - * - * This function assumes that 'key' exists and it stores a - * QBool object. - * - * Return bool mapped by 'key'. - */ -bool qdict_get_bool(const QDict *qdict, const char *key) -{ - return qbool_get_bool(qobject_to(QBool, qdict_get(qdict, key))); -} - -/** - * qdict_get_qlist(): If @qdict maps @key to a QList, return it, else NULL. - */ -QList *qdict_get_qlist(const QDict *qdict, const char *key) -{ - return qobject_to(QList, qdict_get(qdict, key)); -} - -/** - * qdict_get_qdict(): If @qdict maps @key to a QDict, return it, else NULL. - */ -QDict *qdict_get_qdict(const QDict *qdict, const char *key) -{ - return qobject_to(QDict, qdict_get(qdict, key)); -} - -/** - * qdict_get_str(): Get a pointer to the stored string mapped - * by 'key' - * - * This function assumes that 'key' exists and it stores a - * QString object. - * - * Return pointer to the string mapped by 'key'. - */ -const char *qdict_get_str(const QDict *qdict, const char *key) -{ - return qstring_get_str(qobject_to(QString, qdict_get(qdict, key))); -} - -/** - * qdict_get_try_int(): Try to get integer mapped by 'key' - * - * Return integer mapped by 'key', if it is not present in the - * dictionary or if the stored object is not a QNum representing an - * integer, 'def_value' will be returned. - */ -int64_t qdict_get_try_int(const QDict *qdict, const char *key, - int64_t def_value) -{ - QNum *qnum = qobject_to(QNum, qdict_get(qdict, key)); - int64_t val; - - if (!qnum || !qnum_get_try_int(qnum, &val)) { - return def_value; - } - - return val; -} - -/** - * qdict_get_try_bool(): Try to get a bool mapped by 'key' - * - * Return bool mapped by 'key', if it is not present in the - * dictionary or if the stored object is not of QBool type - * 'def_value' will be returned. - */ -bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value) -{ - QBool *qbool = qobject_to(QBool, qdict_get(qdict, key)); - - return qbool ? qbool_get_bool(qbool) : def_value; -} - -/** - * qdict_get_try_str(): Try to get a pointer to the stored string - * mapped by 'key' - * - * Return a pointer to the string mapped by 'key', if it is not present - * in the dictionary or if the stored object is not of QString type - * NULL will be returned. - */ -const char *qdict_get_try_str(const QDict *qdict, const char *key) -{ - QString *qstr = qobject_to(QString, qdict_get(qdict, key)); - - return qstr ? qstring_get_str(qstr) : NULL; -} - -/** - * qdict_iter(): Iterate over all the dictionary's stored values. - * - * This function allows the user to provide an iterator, which will be - * called for each stored value in the dictionary. - */ -void qdict_iter(const QDict *qdict, - void (*iter)(const char *key, QObject *obj, void *opaque), - void *opaque) -{ - int i; - QDictEntry *entry; - - for (i = 0; i < QDICT_BUCKET_MAX; i++) { - QLIST_FOREACH(entry, &qdict->table[i], next) - iter(entry->key, entry->value, opaque); - } -} - -static QDictEntry *qdict_next_entry(const QDict *qdict, int first_bucket) -{ - int i; - - for (i = first_bucket; i < QDICT_BUCKET_MAX; i++) { - if (!QLIST_EMPTY(&qdict->table[i])) { - return QLIST_FIRST(&qdict->table[i]); - } - } - - return NULL; -} - -/** - * qdict_first(): Return first qdict entry for iteration. - */ -const QDictEntry *qdict_first(const QDict *qdict) -{ - return qdict_next_entry(qdict, 0); -} - -/** - * qdict_next(): Return next qdict entry in an iteration. - */ -const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry) -{ - QDictEntry *ret; - - ret = QLIST_NEXT(entry, next); - if (!ret) { - unsigned int bucket = tdb_hash(entry->key) % QDICT_BUCKET_MAX; - ret = qdict_next_entry(qdict, bucket + 1); - } - - return ret; -} - -/** - * qdict_clone_shallow(): Clones a given QDict. Its entries are not copied, but - * another reference is added. - */ -QDict *qdict_clone_shallow(const QDict *src) -{ - QDict *dest; - QDictEntry *entry; - int i; - - dest = qdict_new(); - - for (i = 0; i < QDICT_BUCKET_MAX; i++) { - QLIST_FOREACH(entry, &src->table[i], next) { - qdict_put_obj(dest, entry->key, qobject_ref(entry->value)); - } - } - - return dest; -} - -/** - * qentry_destroy(): Free all the memory allocated by a QDictEntry - */ -static void qentry_destroy(QDictEntry *e) -{ - assert(e != NULL); - assert(e->key != NULL); - assert(e->value != NULL); - - qobject_unref(e->value); - g_free(e->key); - g_free(e); -} - -/** - * qdict_del(): Delete a 'key:value' pair from the dictionary - * - * This will destroy all data allocated by this entry. - */ -void qdict_del(QDict *qdict, const char *key) -{ - QDictEntry *entry; - - entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX); - if (entry) { - QLIST_REMOVE(entry, next); - qentry_destroy(entry); - qdict->size--; - } -} - -/** - * qdict_is_equal(): Test whether the two QDicts are equal - * - * Here, equality means whether they contain the same keys and whether - * the respective values are in turn equal (i.e. invoking - * qobject_is_equal() on them yields true). - */ -bool qdict_is_equal(const QObject *x, const QObject *y) -{ - const QDict *dict_x = qobject_to(QDict, x); - const QDict *dict_y = qobject_to(QDict, y); - const QDictEntry *e; - - if (qdict_size(dict_x) != qdict_size(dict_y)) { - return false; - } - - for (e = qdict_first(dict_x); e; e = qdict_next(dict_x, e)) { - const QObject *obj_x = qdict_entry_value(e); - const QObject *obj_y = qdict_get(dict_y, qdict_entry_key(e)); - - if (!qobject_is_equal(obj_x, obj_y)) { - return false; - } - } - - return true; -} - -/** - * qdict_destroy_obj(): Free all the memory allocated by a QDict - */ -void qdict_destroy_obj(QObject *obj) -{ - int i; - QDict *qdict; - - assert(obj != NULL); - qdict = qobject_to(QDict, obj); - - for (i = 0; i < QDICT_BUCKET_MAX; i++) { - QDictEntry *entry = QLIST_FIRST(&qdict->table[i]); - while (entry) { - QDictEntry *tmp = QLIST_NEXT(entry, next); - QLIST_REMOVE(entry, next); - qentry_destroy(entry); - entry = tmp; - } - } - - g_free(qdict); -} +#include "qapi/error.h" /** * qdict_copy_default(): If no entry mapped by 'key' exists in 'dst' yet, the @@ -670,8 +218,11 @@ void qdict_array_split(QDict *src, QList **dst) /* Overflow is the same as positive non-zero results */ is_subqdict = qdict_count_prefixed_entries(src, prefix); - // There may be either a single subordinate object (named "%u") or - // multiple objects (each with a key prefixed "%u."), but not both. + /* + * There may be either a single subordinate object (named + * "%u") or multiple objects (each with a key prefixed "%u."), + * but not both. + */ if (!subqobj == !is_subqdict) { break; } diff --git a/qobject/qdict.c b/qobject/qdict.c dissimilarity index 63% index 0554c64553..3d8c2f7bbc 100644 --- a/qobject/qdict.c +++ b/qobject/qdict.c @@ -1,1089 +1,460 @@ -/* - * QDict Module - * - * Copyright (C) 2009 Red Hat Inc. - * - * Authors: - * Luiz Capitulino - * - * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. - * See the COPYING.LIB file in the top-level directory. - */ - -#include "qemu/osdep.h" -#include "block/qdict.h" -#include "qapi/qmp/qnum.h" -#include "qapi/qmp/qdict.h" -#include "qapi/qmp/qbool.h" -#include "qapi/qmp/qlist.h" -#include "qapi/qmp/qnull.h" -#include "qapi/qmp/qstring.h" -#include "qapi/error.h" -#include "qemu/queue.h" -#include "qemu-common.h" -#include "qemu/cutils.h" - -/** - * qdict_new(): Create a new QDict - * - * Return strong reference. - */ -QDict *qdict_new(void) -{ - QDict *qdict; - - qdict = g_malloc0(sizeof(*qdict)); - qobject_init(QOBJECT(qdict), QTYPE_QDICT); - - return qdict; -} - -/** - * tdb_hash(): based on the hash agorithm from gdbm, via tdb - * (from module-init-tools) - */ -static unsigned int tdb_hash(const char *name) -{ - unsigned value; /* Used to compute the hash value. */ - unsigned i; /* Used to cycle through random values. */ - - /* Set the initial value from the key size. */ - for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++) - value = (value + (((const unsigned char *)name)[i] << (i*5 % 24))); - - return (1103515243 * value + 12345); -} - -/** - * alloc_entry(): allocate a new QDictEntry - */ -static QDictEntry *alloc_entry(const char *key, QObject *value) -{ - QDictEntry *entry; - - entry = g_malloc0(sizeof(*entry)); - entry->key = g_strdup(key); - entry->value = value; - - return entry; -} - -/** - * qdict_entry_value(): Return qdict entry value - * - * Return weak reference. - */ -QObject *qdict_entry_value(const QDictEntry *entry) -{ - return entry->value; -} - -/** - * qdict_entry_key(): Return qdict entry key - * - * Return a *pointer* to the string, it has to be duplicated before being - * stored. - */ -const char *qdict_entry_key(const QDictEntry *entry) -{ - return entry->key; -} - -/** - * qdict_find(): List lookup function - */ -static QDictEntry *qdict_find(const QDict *qdict, - const char *key, unsigned int bucket) -{ - QDictEntry *entry; - - QLIST_FOREACH(entry, &qdict->table[bucket], next) - if (!strcmp(entry->key, key)) - return entry; - - return NULL; -} - -/** - * qdict_put_obj(): Put a new QObject into the dictionary - * - * Insert the pair 'key:value' into 'qdict', if 'key' already exists - * its 'value' will be replaced. - * - * This is done by freeing the reference to the stored QObject and - * storing the new one in the same entry. - * - * NOTE: ownership of 'value' is transferred to the QDict - */ -void qdict_put_obj(QDict *qdict, const char *key, QObject *value) -{ - unsigned int bucket; - QDictEntry *entry; - - bucket = tdb_hash(key) % QDICT_BUCKET_MAX; - entry = qdict_find(qdict, key, bucket); - if (entry) { - /* replace key's value */ - qobject_unref(entry->value); - entry->value = value; - } else { - /* allocate a new entry */ - entry = alloc_entry(key, value); - QLIST_INSERT_HEAD(&qdict->table[bucket], entry, next); - qdict->size++; - } -} - -void qdict_put_int(QDict *qdict, const char *key, int64_t value) -{ - qdict_put(qdict, key, qnum_from_int(value)); -} - -void qdict_put_bool(QDict *qdict, const char *key, bool value) -{ - qdict_put(qdict, key, qbool_from_bool(value)); -} - -void qdict_put_str(QDict *qdict, const char *key, const char *value) -{ - qdict_put(qdict, key, qstring_from_str(value)); -} - -void qdict_put_null(QDict *qdict, const char *key) -{ - qdict_put(qdict, key, qnull()); -} - -/** - * qdict_get(): Lookup for a given 'key' - * - * Return a weak reference to the QObject associated with 'key' if - * 'key' is present in the dictionary, NULL otherwise. - */ -QObject *qdict_get(const QDict *qdict, const char *key) -{ - QDictEntry *entry; - - entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX); - return (entry == NULL ? NULL : entry->value); -} - -/** - * qdict_haskey(): Check if 'key' exists - * - * Return 1 if 'key' exists in the dict, 0 otherwise - */ -int qdict_haskey(const QDict *qdict, const char *key) -{ - unsigned int bucket = tdb_hash(key) % QDICT_BUCKET_MAX; - return (qdict_find(qdict, key, bucket) == NULL ? 0 : 1); -} - -/** - * qdict_size(): Return the size of the dictionary - */ -size_t qdict_size(const QDict *qdict) -{ - return qdict->size; -} - -/** - * qdict_get_double(): Get an number mapped by 'key' - * - * This function assumes that 'key' exists and it stores a QNum. - * - * Return number mapped by 'key'. - */ -double qdict_get_double(const QDict *qdict, const char *key) -{ - return qnum_get_double(qobject_to(QNum, qdict_get(qdict, key))); -} - -/** - * qdict_get_int(): Get an integer mapped by 'key' - * - * This function assumes that 'key' exists and it stores a - * QNum representable as int. - * - * Return integer mapped by 'key'. - */ -int64_t qdict_get_int(const QDict *qdict, const char *key) -{ - return qnum_get_int(qobject_to(QNum, qdict_get(qdict, key))); -} - -/** - * qdict_get_bool(): Get a bool mapped by 'key' - * - * This function assumes that 'key' exists and it stores a - * QBool object. - * - * Return bool mapped by 'key'. - */ -bool qdict_get_bool(const QDict *qdict, const char *key) -{ - return qbool_get_bool(qobject_to(QBool, qdict_get(qdict, key))); -} - -/** - * qdict_get_qlist(): If @qdict maps @key to a QList, return it, else NULL. - */ -QList *qdict_get_qlist(const QDict *qdict, const char *key) -{ - return qobject_to(QList, qdict_get(qdict, key)); -} - -/** - * qdict_get_qdict(): If @qdict maps @key to a QDict, return it, else NULL. - */ -QDict *qdict_get_qdict(const QDict *qdict, const char *key) -{ - return qobject_to(QDict, qdict_get(qdict, key)); -} - -/** - * qdict_get_str(): Get a pointer to the stored string mapped - * by 'key' - * - * This function assumes that 'key' exists and it stores a - * QString object. - * - * Return pointer to the string mapped by 'key'. - */ -const char *qdict_get_str(const QDict *qdict, const char *key) -{ - return qstring_get_str(qobject_to(QString, qdict_get(qdict, key))); -} - -/** - * qdict_get_try_int(): Try to get integer mapped by 'key' - * - * Return integer mapped by 'key', if it is not present in the - * dictionary or if the stored object is not a QNum representing an - * integer, 'def_value' will be returned. - */ -int64_t qdict_get_try_int(const QDict *qdict, const char *key, - int64_t def_value) -{ - QNum *qnum = qobject_to(QNum, qdict_get(qdict, key)); - int64_t val; - - if (!qnum || !qnum_get_try_int(qnum, &val)) { - return def_value; - } - - return val; -} - -/** - * qdict_get_try_bool(): Try to get a bool mapped by 'key' - * - * Return bool mapped by 'key', if it is not present in the - * dictionary or if the stored object is not of QBool type - * 'def_value' will be returned. - */ -bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value) -{ - QBool *qbool = qobject_to(QBool, qdict_get(qdict, key)); - - return qbool ? qbool_get_bool(qbool) : def_value; -} - -/** - * qdict_get_try_str(): Try to get a pointer to the stored string - * mapped by 'key' - * - * Return a pointer to the string mapped by 'key', if it is not present - * in the dictionary or if the stored object is not of QString type - * NULL will be returned. - */ -const char *qdict_get_try_str(const QDict *qdict, const char *key) -{ - QString *qstr = qobject_to(QString, qdict_get(qdict, key)); - - return qstr ? qstring_get_str(qstr) : NULL; -} - -/** - * qdict_iter(): Iterate over all the dictionary's stored values. - * - * This function allows the user to provide an iterator, which will be - * called for each stored value in the dictionary. - */ -void qdict_iter(const QDict *qdict, - void (*iter)(const char *key, QObject *obj, void *opaque), - void *opaque) -{ - int i; - QDictEntry *entry; - - for (i = 0; i < QDICT_BUCKET_MAX; i++) { - QLIST_FOREACH(entry, &qdict->table[i], next) - iter(entry->key, entry->value, opaque); - } -} - -static QDictEntry *qdict_next_entry(const QDict *qdict, int first_bucket) -{ - int i; - - for (i = first_bucket; i < QDICT_BUCKET_MAX; i++) { - if (!QLIST_EMPTY(&qdict->table[i])) { - return QLIST_FIRST(&qdict->table[i]); - } - } - - return NULL; -} - -/** - * qdict_first(): Return first qdict entry for iteration. - */ -const QDictEntry *qdict_first(const QDict *qdict) -{ - return qdict_next_entry(qdict, 0); -} - -/** - * qdict_next(): Return next qdict entry in an iteration. - */ -const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry) -{ - QDictEntry *ret; - - ret = QLIST_NEXT(entry, next); - if (!ret) { - unsigned int bucket = tdb_hash(entry->key) % QDICT_BUCKET_MAX; - ret = qdict_next_entry(qdict, bucket + 1); - } - - return ret; -} - -/** - * qdict_clone_shallow(): Clones a given QDict. Its entries are not copied, but - * another reference is added. - */ -QDict *qdict_clone_shallow(const QDict *src) -{ - QDict *dest; - QDictEntry *entry; - int i; - - dest = qdict_new(); - - for (i = 0; i < QDICT_BUCKET_MAX; i++) { - QLIST_FOREACH(entry, &src->table[i], next) { - qdict_put_obj(dest, entry->key, qobject_ref(entry->value)); - } - } - - return dest; -} - -/** - * qentry_destroy(): Free all the memory allocated by a QDictEntry - */ -static void qentry_destroy(QDictEntry *e) -{ - assert(e != NULL); - assert(e->key != NULL); - assert(e->value != NULL); - - qobject_unref(e->value); - g_free(e->key); - g_free(e); -} - -/** - * qdict_del(): Delete a 'key:value' pair from the dictionary - * - * This will destroy all data allocated by this entry. - */ -void qdict_del(QDict *qdict, const char *key) -{ - QDictEntry *entry; - - entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX); - if (entry) { - QLIST_REMOVE(entry, next); - qentry_destroy(entry); - qdict->size--; - } -} - -/** - * qdict_is_equal(): Test whether the two QDicts are equal - * - * Here, equality means whether they contain the same keys and whether - * the respective values are in turn equal (i.e. invoking - * qobject_is_equal() on them yields true). - */ -bool qdict_is_equal(const QObject *x, const QObject *y) -{ - const QDict *dict_x = qobject_to(QDict, x); - const QDict *dict_y = qobject_to(QDict, y); - const QDictEntry *e; - - if (qdict_size(dict_x) != qdict_size(dict_y)) { - return false; - } - - for (e = qdict_first(dict_x); e; e = qdict_next(dict_x, e)) { - const QObject *obj_x = qdict_entry_value(e); - const QObject *obj_y = qdict_get(dict_y, qdict_entry_key(e)); - - if (!qobject_is_equal(obj_x, obj_y)) { - return false; - } - } - - return true; -} - -/** - * qdict_destroy_obj(): Free all the memory allocated by a QDict - */ -void qdict_destroy_obj(QObject *obj) -{ - int i; - QDict *qdict; - - assert(obj != NULL); - qdict = qobject_to(QDict, obj); - - for (i = 0; i < QDICT_BUCKET_MAX; i++) { - QDictEntry *entry = QLIST_FIRST(&qdict->table[i]); - while (entry) { - QDictEntry *tmp = QLIST_NEXT(entry, next); - QLIST_REMOVE(entry, next); - qentry_destroy(entry); - entry = tmp; - } - } - - g_free(qdict); -} - -/** - * qdict_copy_default(): If no entry mapped by 'key' exists in 'dst' yet, the - * value of 'key' in 'src' is copied there (and the refcount increased - * accordingly). - */ -void qdict_copy_default(QDict *dst, QDict *src, const char *key) -{ - QObject *val; - - if (qdict_haskey(dst, key)) { - return; - } - - val = qdict_get(src, key); - if (val) { - qdict_put_obj(dst, key, qobject_ref(val)); - } -} - -/** - * qdict_set_default_str(): If no entry mapped by 'key' exists in 'dst' yet, a - * new QString initialised by 'val' is put there. - */ -void qdict_set_default_str(QDict *dst, const char *key, const char *val) -{ - if (qdict_haskey(dst, key)) { - return; - } - - qdict_put_str(dst, key, val); -} - -static void qdict_flatten_qdict(QDict *qdict, QDict *target, - const char *prefix); - -static void qdict_flatten_qlist(QList *qlist, QDict *target, const char *prefix) -{ - QObject *value; - const QListEntry *entry; - char *new_key; - int i; - - /* This function is never called with prefix == NULL, i.e., it is always - * called from within qdict_flatten_q(list|dict)(). Therefore, it does not - * need to remove list entries during the iteration (the whole list will be - * deleted eventually anyway from qdict_flatten_qdict()). */ - assert(prefix); - - entry = qlist_first(qlist); - - for (i = 0; entry; entry = qlist_next(entry), i++) { - value = qlist_entry_obj(entry); - new_key = g_strdup_printf("%s.%i", prefix, i); - - if (qobject_type(value) == QTYPE_QDICT) { - qdict_flatten_qdict(qobject_to(QDict, value), target, new_key); - } else if (qobject_type(value) == QTYPE_QLIST) { - qdict_flatten_qlist(qobject_to(QList, value), target, new_key); - } else { - /* All other types are moved to the target unchanged. */ - qdict_put_obj(target, new_key, qobject_ref(value)); - } - - g_free(new_key); - } -} - -static void qdict_flatten_qdict(QDict *qdict, QDict *target, const char *prefix) -{ - QObject *value; - const QDictEntry *entry, *next; - char *new_key; - bool delete; - - entry = qdict_first(qdict); - - while (entry != NULL) { - - next = qdict_next(qdict, entry); - value = qdict_entry_value(entry); - new_key = NULL; - delete = false; - - if (prefix) { - new_key = g_strdup_printf("%s.%s", prefix, entry->key); - } - - if (qobject_type(value) == QTYPE_QDICT) { - /* Entries of QDicts are processed recursively, the QDict object - * itself disappears. */ - qdict_flatten_qdict(qobject_to(QDict, value), target, - new_key ? new_key : entry->key); - delete = true; - } else if (qobject_type(value) == QTYPE_QLIST) { - qdict_flatten_qlist(qobject_to(QList, value), target, - new_key ? new_key : entry->key); - delete = true; - } else if (prefix) { - /* All other objects are moved to the target unchanged. */ - qdict_put_obj(target, new_key, qobject_ref(value)); - delete = true; - } - - g_free(new_key); - - if (delete) { - qdict_del(qdict, entry->key); - - /* Restart loop after modifying the iterated QDict */ - entry = qdict_first(qdict); - continue; - } - - entry = next; - } -} - -/** - * qdict_flatten(): For each nested QDict with key x, all fields with key y - * are moved to this QDict and their key is renamed to "x.y". For each nested - * QList with key x, the field at index y is moved to this QDict with the key - * "x.y" (i.e., the reverse of what qdict_array_split() does). - * This operation is applied recursively for nested QDicts and QLists. - */ -void qdict_flatten(QDict *qdict) -{ - qdict_flatten_qdict(qdict, qdict, NULL); -} - -/* extract all the src QDict entries starting by start into dst */ -void qdict_extract_subqdict(QDict *src, QDict **dst, const char *start) - -{ - const QDictEntry *entry, *next; - const char *p; - - *dst = qdict_new(); - entry = qdict_first(src); - - while (entry != NULL) { - next = qdict_next(src, entry); - if (strstart(entry->key, start, &p)) { - qdict_put_obj(*dst, p, qobject_ref(entry->value)); - qdict_del(src, entry->key); - } - entry = next; - } -} - -static int qdict_count_prefixed_entries(const QDict *src, const char *start) -{ - const QDictEntry *entry; - int count = 0; - - for (entry = qdict_first(src); entry; entry = qdict_next(src, entry)) { - if (strstart(entry->key, start, NULL)) { - if (count == INT_MAX) { - return -ERANGE; - } - count++; - } - } - - return count; -} - -/** - * qdict_array_split(): This function moves array-like elements of a QDict into - * a new QList. Every entry in the original QDict with a key "%u" or one - * prefixed "%u.", where %u designates an unsigned integer starting at 0 and - * incrementally counting up, will be moved to a new QDict at index %u in the - * output QList with the key prefix removed, if that prefix is "%u.". If the - * whole key is just "%u", the whole QObject will be moved unchanged without - * creating a new QDict. The function terminates when there is no entry in the - * QDict with a prefix directly (incrementally) following the last one; it also - * returns if there are both entries with "%u" and "%u." for the same index %u. - * Example: {"0.a": 42, "0.b": 23, "1.x": 0, "4.y": 1, "o.o": 7, "2": 66} - * (or {"1.x": 0, "4.y": 1, "0.a": 42, "o.o": 7, "0.b": 23, "2": 66}) - * => [{"a": 42, "b": 23}, {"x": 0}, 66] - * and {"4.y": 1, "o.o": 7} (remainder of the old QDict) - */ -void qdict_array_split(QDict *src, QList **dst) -{ - unsigned i; - - *dst = qlist_new(); - - for (i = 0; i < UINT_MAX; i++) { - QObject *subqobj; - bool is_subqdict; - QDict *subqdict; - char indexstr[32], prefix[32]; - size_t snprintf_ret; - - snprintf_ret = snprintf(indexstr, 32, "%u", i); - assert(snprintf_ret < 32); - - subqobj = qdict_get(src, indexstr); - - snprintf_ret = snprintf(prefix, 32, "%u.", i); - assert(snprintf_ret < 32); - - /* Overflow is the same as positive non-zero results */ - is_subqdict = qdict_count_prefixed_entries(src, prefix); - - // There may be either a single subordinate object (named "%u") or - // multiple objects (each with a key prefixed "%u."), but not both. - if (!subqobj == !is_subqdict) { - break; - } - - if (is_subqdict) { - qdict_extract_subqdict(src, &subqdict, prefix); - assert(qdict_size(subqdict) > 0); - } else { - qobject_ref(subqobj); - qdict_del(src, indexstr); - } - - qlist_append_obj(*dst, subqobj ?: QOBJECT(subqdict)); - } -} - -/** - * qdict_split_flat_key: - * @key: the key string to split - * @prefix: non-NULL pointer to hold extracted prefix - * @suffix: non-NULL pointer to remaining suffix - * - * Given a flattened key such as 'foo.0.bar', split it into two parts - * at the first '.' separator. Allows double dot ('..') to escape the - * normal separator. - * - * e.g. - * 'foo.0.bar' -> prefix='foo' and suffix='0.bar' - * 'foo..0.bar' -> prefix='foo.0' and suffix='bar' - * - * The '..' sequence will be unescaped in the returned 'prefix' - * string. The 'suffix' string will be left in escaped format, so it - * can be fed back into the qdict_split_flat_key() key as the input - * later. - * - * The caller is responsible for freeing the string returned in @prefix - * using g_free(). - */ -static void qdict_split_flat_key(const char *key, char **prefix, - const char **suffix) -{ - const char *separator; - size_t i, j; - - /* Find first '.' separator, but if there is a pair '..' - * that acts as an escape, so skip over '..' */ - separator = NULL; - do { - if (separator) { - separator += 2; - } else { - separator = key; - } - separator = strchr(separator, '.'); - } while (separator && separator[1] == '.'); - - if (separator) { - *prefix = g_strndup(key, separator - key); - *suffix = separator + 1; - } else { - *prefix = g_strdup(key); - *suffix = NULL; - } - - /* Unescape the '..' sequence into '.' */ - for (i = 0, j = 0; (*prefix)[i] != '\0'; i++, j++) { - if ((*prefix)[i] == '.') { - assert((*prefix)[i + 1] == '.'); - i++; - } - (*prefix)[j] = (*prefix)[i]; - } - (*prefix)[j] = '\0'; -} - -/** - * qdict_is_list: - * @maybe_list: dict to check if keys represent list elements. - * - * Determine whether all keys in @maybe_list are valid list elements. - * If @maybe_list is non-zero in length and all the keys look like - * valid list indexes, this will return 1. If @maybe_list is zero - * length or all keys are non-numeric then it will return 0 to indicate - * it is a normal qdict. If there is a mix of numeric and non-numeric - * keys, or the list indexes are non-contiguous, an error is reported. - * - * Returns: 1 if a valid list, 0 if a dict, -1 on error - */ -static int qdict_is_list(QDict *maybe_list, Error **errp) -{ - const QDictEntry *ent; - ssize_t len = 0; - ssize_t max = -1; - int is_list = -1; - int64_t val; - - for (ent = qdict_first(maybe_list); ent != NULL; - ent = qdict_next(maybe_list, ent)) { - - if (qemu_strtoi64(ent->key, NULL, 10, &val) == 0) { - if (is_list == -1) { - is_list = 1; - } else if (!is_list) { - error_setg(errp, - "Cannot mix list and non-list keys"); - return -1; - } - len++; - if (val > max) { - max = val; - } - } else { - if (is_list == -1) { - is_list = 0; - } else if (is_list) { - error_setg(errp, - "Cannot mix list and non-list keys"); - return -1; - } - } - } - - if (is_list == -1) { - assert(!qdict_size(maybe_list)); - is_list = 0; - } - - /* NB this isn't a perfect check - e.g. it won't catch - * a list containing '1', '+1', '01', '3', but that - * does not matter - we've still proved that the - * input is a list. It is up the caller to do a - * stricter check if desired */ - if (len != (max + 1)) { - error_setg(errp, "List indices are not contiguous, " - "saw %zd elements but %zd largest index", - len, max); - return -1; - } - - return is_list; -} - -/** - * qdict_crumple: - * @src: the original flat dictionary (only scalar values) to crumple - * - * Takes a flat dictionary whose keys use '.' separator to indicate - * nesting, and values are scalars, and crumples it into a nested - * structure. - * - * To include a literal '.' in a key name, it must be escaped as '..' - * - * For example, an input of: - * - * { 'foo.0.bar': 'one', 'foo.0.wizz': '1', - * 'foo.1.bar': 'two', 'foo.1.wizz': '2' } - * - * will result in an output of: - * - * { - * 'foo': [ - * { 'bar': 'one', 'wizz': '1' }, - * { 'bar': 'two', 'wizz': '2' } - * ], - * } - * - * The following scenarios in the input dict will result in an - * error being returned: - * - * - Any values in @src are non-scalar types - * - If keys in @src imply that a particular level is both a - * list and a dict. e.g., "foo.0.bar" and "foo.eek.bar". - * - If keys in @src imply that a particular level is a list, - * but the indices are non-contiguous. e.g. "foo.0.bar" and - * "foo.2.bar" without any "foo.1.bar" present. - * - If keys in @src represent list indexes, but are not in - * the "%zu" format. e.g. "foo.+0.bar" - * - * Returns: either a QDict or QList for the nested data structure, or NULL - * on error - */ -QObject *qdict_crumple(const QDict *src, Error **errp) -{ - const QDictEntry *ent; - QDict *two_level, *multi_level = NULL; - QObject *dst = NULL, *child; - size_t i; - char *prefix = NULL; - const char *suffix = NULL; - int is_list; - - two_level = qdict_new(); - - /* Step 1: split our totally flat dict into a two level dict */ - for (ent = qdict_first(src); ent != NULL; ent = qdict_next(src, ent)) { - if (qobject_type(ent->value) == QTYPE_QDICT || - qobject_type(ent->value) == QTYPE_QLIST) { - error_setg(errp, "Value %s is not a scalar", - ent->key); - goto error; - } - - qdict_split_flat_key(ent->key, &prefix, &suffix); - - child = qdict_get(two_level, prefix); - if (suffix) { - QDict *child_dict = qobject_to(QDict, child); - if (!child_dict) { - if (child) { - error_setg(errp, "Key %s prefix is already set as a scalar", - prefix); - goto error; - } - - child_dict = qdict_new(); - qdict_put_obj(two_level, prefix, QOBJECT(child_dict)); - } - - qdict_put_obj(child_dict, suffix, qobject_ref(ent->value)); - } else { - if (child) { - error_setg(errp, "Key %s prefix is already set as a dict", - prefix); - goto error; - } - qdict_put_obj(two_level, prefix, qobject_ref(ent->value)); - } - - g_free(prefix); - prefix = NULL; - } - - /* Step 2: optionally process the two level dict recursively - * into a multi-level dict */ - multi_level = qdict_new(); - for (ent = qdict_first(two_level); ent != NULL; - ent = qdict_next(two_level, ent)) { - QDict *dict = qobject_to(QDict, ent->value); - if (dict) { - child = qdict_crumple(dict, errp); - if (!child) { - goto error; - } - - qdict_put_obj(multi_level, ent->key, child); - } else { - qdict_put_obj(multi_level, ent->key, qobject_ref(ent->value)); - } - } - qobject_unref(two_level); - two_level = NULL; - - /* Step 3: detect if we need to turn our dict into list */ - is_list = qdict_is_list(multi_level, errp); - if (is_list < 0) { - goto error; - } - - if (is_list) { - dst = QOBJECT(qlist_new()); - - for (i = 0; i < qdict_size(multi_level); i++) { - char *key = g_strdup_printf("%zu", i); - - child = qdict_get(multi_level, key); - g_free(key); - - if (!child) { - error_setg(errp, "Missing list index %zu", i); - goto error; - } - - qlist_append_obj(qobject_to(QList, dst), qobject_ref(child)); - } - qobject_unref(multi_level); - multi_level = NULL; - } else { - dst = QOBJECT(multi_level); - } - - return dst; - - error: - g_free(prefix); - qobject_unref(multi_level); - qobject_unref(two_level); - qobject_unref(dst); - return NULL; -} - -/** - * qdict_array_entries(): Returns the number of direct array entries if the - * sub-QDict of src specified by the prefix in subqdict (or src itself for - * prefix == "") is valid as an array, i.e. the length of the created list if - * the sub-QDict would become empty after calling qdict_array_split() on it. If - * the array is not valid, -EINVAL is returned. - */ -int qdict_array_entries(QDict *src, const char *subqdict) -{ - const QDictEntry *entry; - unsigned i; - unsigned entries = 0; - size_t subqdict_len = strlen(subqdict); - - assert(!subqdict_len || subqdict[subqdict_len - 1] == '.'); - - /* qdict_array_split() loops until UINT_MAX, but as we want to return - * negative errors, we only have a signed return value here. Any additional - * entries will lead to -EINVAL. */ - for (i = 0; i < INT_MAX; i++) { - QObject *subqobj; - int subqdict_entries; - char *prefix = g_strdup_printf("%s%u.", subqdict, i); - - subqdict_entries = qdict_count_prefixed_entries(src, prefix); - - /* Remove ending "." */ - prefix[strlen(prefix) - 1] = 0; - subqobj = qdict_get(src, prefix); - - g_free(prefix); - - if (subqdict_entries < 0) { - return subqdict_entries; - } - - /* There may be either a single subordinate object (named "%u") or - * multiple objects (each with a key prefixed "%u."), but not both. */ - if (subqobj && subqdict_entries) { - return -EINVAL; - } else if (!subqobj && !subqdict_entries) { - break; - } - - entries += subqdict_entries ? subqdict_entries : 1; - } - - /* Consider everything handled that isn't part of the given sub-QDict */ - for (entry = qdict_first(src); entry; entry = qdict_next(src, entry)) { - if (!strstart(qdict_entry_key(entry), subqdict, NULL)) { - entries++; - } - } - - /* Anything left in the sub-QDict that wasn't handled? */ - if (qdict_size(src) != entries) { - return -EINVAL; - } - - return i; -} - -/** - * qdict_join(): Absorb the src QDict into the dest QDict, that is, move all - * elements from src to dest. - * - * If an element from src has a key already present in dest, it will not be - * moved unless overwrite is true. - * - * If overwrite is true, the conflicting values in dest will be discarded and - * replaced by the corresponding values from src. - * - * Therefore, with overwrite being true, the src QDict will always be empty when - * this function returns. If overwrite is false, the src QDict will be empty - * iff there were no conflicts. - */ -void qdict_join(QDict *dest, QDict *src, bool overwrite) -{ - const QDictEntry *entry, *next; - - entry = qdict_first(src); - while (entry) { - next = qdict_next(src, entry); - - if (overwrite || !qdict_haskey(dest, entry->key)) { - qdict_put_obj(dest, entry->key, qobject_ref(entry->value)); - qdict_del(src, entry->key); - } - - entry = next; - } -} - -/** - * qdict_rename_keys(): Rename keys in qdict according to the replacements - * specified in the array renames. The array must be terminated by an entry - * with from = NULL. - * - * The renames are performed individually in the order of the array, so entries - * may be renamed multiple times and may or may not conflict depending on the - * order of the renames array. - * - * Returns true for success, false in error cases. - */ -bool qdict_rename_keys(QDict *qdict, const QDictRenames *renames, Error **errp) -{ - QObject *qobj; - - while (renames->from) { - if (qdict_haskey(qdict, renames->from)) { - if (qdict_haskey(qdict, renames->to)) { - error_setg(errp, "'%s' and its alias '%s' can't be used at the " - "same time", renames->to, renames->from); - return false; - } - - qobj = qdict_get(qdict, renames->from); - qdict_put_obj(qdict, renames->to, qobject_ref(qobj)); - qdict_del(qdict, renames->from); - } - - renames++; - } - return true; -} +/* + * QDict Module + * + * Copyright (C) 2009 Red Hat Inc. + * + * Authors: + * Luiz Capitulino + * + * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. + * See the COPYING.LIB file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include "qapi/qmp/qnum.h" +#include "qapi/qmp/qdict.h" +#include "qapi/qmp/qbool.h" +#include "qapi/qmp/qnull.h" +#include "qapi/qmp/qstring.h" + +/** + * qdict_new(): Create a new QDict + * + * Return strong reference. + */ +QDict *qdict_new(void) +{ + QDict *qdict; + + qdict = g_malloc0(sizeof(*qdict)); + qobject_init(QOBJECT(qdict), QTYPE_QDICT); + + return qdict; +} + +/** + * tdb_hash(): based on the hash agorithm from gdbm, via tdb + * (from module-init-tools) + */ +static unsigned int tdb_hash(const char *name) +{ + unsigned value; /* Used to compute the hash value. */ + unsigned i; /* Used to cycle through random values. */ + + /* Set the initial value from the key size. */ + for (value = 0x238F13AF * strlen(name), i=0; name[i]; i++) + value = (value + (((const unsigned char *)name)[i] << (i*5 % 24))); + + return (1103515243 * value + 12345); +} + +/** + * alloc_entry(): allocate a new QDictEntry + */ +static QDictEntry *alloc_entry(const char *key, QObject *value) +{ + QDictEntry *entry; + + entry = g_malloc0(sizeof(*entry)); + entry->key = g_strdup(key); + entry->value = value; + + return entry; +} + +/** + * qdict_entry_value(): Return qdict entry value + * + * Return weak reference. + */ +QObject *qdict_entry_value(const QDictEntry *entry) +{ + return entry->value; +} + +/** + * qdict_entry_key(): Return qdict entry key + * + * Return a *pointer* to the string, it has to be duplicated before being + * stored. + */ +const char *qdict_entry_key(const QDictEntry *entry) +{ + return entry->key; +} + +/** + * qdict_find(): List lookup function + */ +static QDictEntry *qdict_find(const QDict *qdict, + const char *key, unsigned int bucket) +{ + QDictEntry *entry; + + QLIST_FOREACH(entry, &qdict->table[bucket], next) + if (!strcmp(entry->key, key)) + return entry; + + return NULL; +} + +/** + * qdict_put_obj(): Put a new QObject into the dictionary + * + * Insert the pair 'key:value' into 'qdict', if 'key' already exists + * its 'value' will be replaced. + * + * This is done by freeing the reference to the stored QObject and + * storing the new one in the same entry. + * + * NOTE: ownership of 'value' is transferred to the QDict + */ +void qdict_put_obj(QDict *qdict, const char *key, QObject *value) +{ + unsigned int bucket; + QDictEntry *entry; + + bucket = tdb_hash(key) % QDICT_BUCKET_MAX; + entry = qdict_find(qdict, key, bucket); + if (entry) { + /* replace key's value */ + qobject_unref(entry->value); + entry->value = value; + } else { + /* allocate a new entry */ + entry = alloc_entry(key, value); + QLIST_INSERT_HEAD(&qdict->table[bucket], entry, next); + qdict->size++; + } +} + +void qdict_put_int(QDict *qdict, const char *key, int64_t value) +{ + qdict_put(qdict, key, qnum_from_int(value)); +} + +void qdict_put_bool(QDict *qdict, const char *key, bool value) +{ + qdict_put(qdict, key, qbool_from_bool(value)); +} + +void qdict_put_str(QDict *qdict, const char *key, const char *value) +{ + qdict_put(qdict, key, qstring_from_str(value)); +} + +void qdict_put_null(QDict *qdict, const char *key) +{ + qdict_put(qdict, key, qnull()); +} + +/** + * qdict_get(): Lookup for a given 'key' + * + * Return a weak reference to the QObject associated with 'key' if + * 'key' is present in the dictionary, NULL otherwise. + */ +QObject *qdict_get(const QDict *qdict, const char *key) +{ + QDictEntry *entry; + + entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX); + return (entry == NULL ? NULL : entry->value); +} + +/** + * qdict_haskey(): Check if 'key' exists + * + * Return 1 if 'key' exists in the dict, 0 otherwise + */ +int qdict_haskey(const QDict *qdict, const char *key) +{ + unsigned int bucket = tdb_hash(key) % QDICT_BUCKET_MAX; + return (qdict_find(qdict, key, bucket) == NULL ? 0 : 1); +} + +/** + * qdict_size(): Return the size of the dictionary + */ +size_t qdict_size(const QDict *qdict) +{ + return qdict->size; +} + +/** + * qdict_get_double(): Get an number mapped by 'key' + * + * This function assumes that 'key' exists and it stores a QNum. + * + * Return number mapped by 'key'. + */ +double qdict_get_double(const QDict *qdict, const char *key) +{ + return qnum_get_double(qobject_to(QNum, qdict_get(qdict, key))); +} + +/** + * qdict_get_int(): Get an integer mapped by 'key' + * + * This function assumes that 'key' exists and it stores a + * QNum representable as int. + * + * Return integer mapped by 'key'. + */ +int64_t qdict_get_int(const QDict *qdict, const char *key) +{ + return qnum_get_int(qobject_to(QNum, qdict_get(qdict, key))); +} + +/** + * qdict_get_bool(): Get a bool mapped by 'key' + * + * This function assumes that 'key' exists and it stores a + * QBool object. + * + * Return bool mapped by 'key'. + */ +bool qdict_get_bool(const QDict *qdict, const char *key) +{ + return qbool_get_bool(qobject_to(QBool, qdict_get(qdict, key))); +} + +/** + * qdict_get_qlist(): If @qdict maps @key to a QList, return it, else NULL. + */ +QList *qdict_get_qlist(const QDict *qdict, const char *key) +{ + return qobject_to(QList, qdict_get(qdict, key)); +} + +/** + * qdict_get_qdict(): If @qdict maps @key to a QDict, return it, else NULL. + */ +QDict *qdict_get_qdict(const QDict *qdict, const char *key) +{ + return qobject_to(QDict, qdict_get(qdict, key)); +} + +/** + * qdict_get_str(): Get a pointer to the stored string mapped + * by 'key' + * + * This function assumes that 'key' exists and it stores a + * QString object. + * + * Return pointer to the string mapped by 'key'. + */ +const char *qdict_get_str(const QDict *qdict, const char *key) +{ + return qstring_get_str(qobject_to(QString, qdict_get(qdict, key))); +} + +/** + * qdict_get_try_int(): Try to get integer mapped by 'key' + * + * Return integer mapped by 'key', if it is not present in the + * dictionary or if the stored object is not a QNum representing an + * integer, 'def_value' will be returned. + */ +int64_t qdict_get_try_int(const QDict *qdict, const char *key, + int64_t def_value) +{ + QNum *qnum = qobject_to(QNum, qdict_get(qdict, key)); + int64_t val; + + if (!qnum || !qnum_get_try_int(qnum, &val)) { + return def_value; + } + + return val; +} + +/** + * qdict_get_try_bool(): Try to get a bool mapped by 'key' + * + * Return bool mapped by 'key', if it is not present in the + * dictionary or if the stored object is not of QBool type + * 'def_value' will be returned. + */ +bool qdict_get_try_bool(const QDict *qdict, const char *key, bool def_value) +{ + QBool *qbool = qobject_to(QBool, qdict_get(qdict, key)); + + return qbool ? qbool_get_bool(qbool) : def_value; +} + +/** + * qdict_get_try_str(): Try to get a pointer to the stored string + * mapped by 'key' + * + * Return a pointer to the string mapped by 'key', if it is not present + * in the dictionary or if the stored object is not of QString type + * NULL will be returned. + */ +const char *qdict_get_try_str(const QDict *qdict, const char *key) +{ + QString *qstr = qobject_to(QString, qdict_get(qdict, key)); + + return qstr ? qstring_get_str(qstr) : NULL; +} + +/** + * qdict_iter(): Iterate over all the dictionary's stored values. + * + * This function allows the user to provide an iterator, which will be + * called for each stored value in the dictionary. + */ +void qdict_iter(const QDict *qdict, + void (*iter)(const char *key, QObject *obj, void *opaque), + void *opaque) +{ + int i; + QDictEntry *entry; + + for (i = 0; i < QDICT_BUCKET_MAX; i++) { + QLIST_FOREACH(entry, &qdict->table[i], next) + iter(entry->key, entry->value, opaque); + } +} + +static QDictEntry *qdict_next_entry(const QDict *qdict, int first_bucket) +{ + int i; + + for (i = first_bucket; i < QDICT_BUCKET_MAX; i++) { + if (!QLIST_EMPTY(&qdict->table[i])) { + return QLIST_FIRST(&qdict->table[i]); + } + } + + return NULL; +} + +/** + * qdict_first(): Return first qdict entry for iteration. + */ +const QDictEntry *qdict_first(const QDict *qdict) +{ + return qdict_next_entry(qdict, 0); +} + +/** + * qdict_next(): Return next qdict entry in an iteration. + */ +const QDictEntry *qdict_next(const QDict *qdict, const QDictEntry *entry) +{ + QDictEntry *ret; + + ret = QLIST_NEXT(entry, next); + if (!ret) { + unsigned int bucket = tdb_hash(entry->key) % QDICT_BUCKET_MAX; + ret = qdict_next_entry(qdict, bucket + 1); + } + + return ret; +} + +/** + * qdict_clone_shallow(): Clones a given QDict. Its entries are not copied, but + * another reference is added. + */ +QDict *qdict_clone_shallow(const QDict *src) +{ + QDict *dest; + QDictEntry *entry; + int i; + + dest = qdict_new(); + + for (i = 0; i < QDICT_BUCKET_MAX; i++) { + QLIST_FOREACH(entry, &src->table[i], next) { + qdict_put_obj(dest, entry->key, qobject_ref(entry->value)); + } + } + + return dest; +} + +/** + * qentry_destroy(): Free all the memory allocated by a QDictEntry + */ +static void qentry_destroy(QDictEntry *e) +{ + assert(e != NULL); + assert(e->key != NULL); + assert(e->value != NULL); + + qobject_unref(e->value); + g_free(e->key); + g_free(e); +} + +/** + * qdict_del(): Delete a 'key:value' pair from the dictionary + * + * This will destroy all data allocated by this entry. + */ +void qdict_del(QDict *qdict, const char *key) +{ + QDictEntry *entry; + + entry = qdict_find(qdict, key, tdb_hash(key) % QDICT_BUCKET_MAX); + if (entry) { + QLIST_REMOVE(entry, next); + qentry_destroy(entry); + qdict->size--; + } +} + +/** + * qdict_is_equal(): Test whether the two QDicts are equal + * + * Here, equality means whether they contain the same keys and whether + * the respective values are in turn equal (i.e. invoking + * qobject_is_equal() on them yields true). + */ +bool qdict_is_equal(const QObject *x, const QObject *y) +{ + const QDict *dict_x = qobject_to(QDict, x); + const QDict *dict_y = qobject_to(QDict, y); + const QDictEntry *e; + + if (qdict_size(dict_x) != qdict_size(dict_y)) { + return false; + } + + for (e = qdict_first(dict_x); e; e = qdict_next(dict_x, e)) { + const QObject *obj_x = qdict_entry_value(e); + const QObject *obj_y = qdict_get(dict_y, qdict_entry_key(e)); + + if (!qobject_is_equal(obj_x, obj_y)) { + return false; + } + } + + return true; +} + +/** + * qdict_destroy_obj(): Free all the memory allocated by a QDict + */ +void qdict_destroy_obj(QObject *obj) +{ + int i; + QDict *qdict; + + assert(obj != NULL); + qdict = qobject_to(QDict, obj); + + for (i = 0; i < QDICT_BUCKET_MAX; i++) { + QDictEntry *entry = QLIST_FIRST(&qdict->table[i]); + while (entry) { + QDictEntry *tmp = QLIST_NEXT(entry, next); + QLIST_REMOVE(entry, next); + qentry_destroy(entry); + entry = tmp; + } + } + + g_free(qdict); +} diff --git a/tests/Makefile.include b/tests/Makefile.include index 607afe5bed..ca91da26cb 100644 --- a/tests/Makefile.include +++ b/tests/Makefile.include @@ -39,6 +39,8 @@ SYSEMU_TARGET_LIST := $(subst -softmmu.mak,,$(notdir \ check-unit-y = tests/check-qdict$(EXESUF) gcov-files-check-qdict-y = qobject/qdict.c +check-unit-y = tests/check-block-qdict$(EXESUF) +gcov-files-check-block-qdict-y = qobject/block-qdict.c check-unit-y += tests/test-char$(EXESUF) gcov-files-check-qdict-y = chardev/char.c check-unit-y += tests/check-qnum$(EXESUF) @@ -584,6 +586,7 @@ GENERATED_FILES += tests/test-qapi-types.h tests/test-qapi-visit.h \ test-obj-y = tests/check-qnum.o tests/check-qstring.o tests/check-qdict.o \ tests/check-qlist.o tests/check-qnull.o tests/check-qobject.o \ tests/check-qjson.o tests/check-qlit.o \ + tests/check-block-qtest.o \ tests/test-coroutine.o tests/test-string-output-visitor.o \ tests/test-string-input-visitor.o tests/test-qobject-output-visitor.o \ tests/test-clone-visitor.o \ @@ -614,6 +617,7 @@ test-block-obj-y = $(block-obj-y) $(test-io-obj-y) tests/iothread.o tests/check-qnum$(EXESUF): tests/check-qnum.o $(test-util-obj-y) tests/check-qstring$(EXESUF): tests/check-qstring.o $(test-util-obj-y) tests/check-qdict$(EXESUF): tests/check-qdict.o $(test-util-obj-y) +tests/check-block-qdict$(EXESUF): tests/check-block-qdict.o $(test-util-obj-y) tests/check-qlist$(EXESUF): tests/check-qlist.o $(test-util-obj-y) tests/check-qnull$(EXESUF): tests/check-qnull.o $(test-util-obj-y) tests/check-qobject$(EXESUF): tests/check-qobject.o $(test-util-obj-y) diff --git a/tests/check-qdict.c b/tests/check-block-qdict.c similarity index 67% copy from tests/check-qdict.c copy to tests/check-block-qdict.c index 93e2112b6d..5b9f4d506e 100644 --- a/tests/check-qdict.c +++ b/tests/check-block-qdict.c @@ -1,10 +1,7 @@ /* - * QDict unit-tests. + * Unit-tests for Block layer QDict extras * - * Copyright (C) 2009 Red Hat Inc. - * - * Authors: - * Luiz Capitulino + * Copyright (c) 2013-2018 Red Hat, Inc. * * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. * See the COPYING.LIB file in the top-level directory. @@ -12,150 +9,9 @@ #include "qemu/osdep.h" #include "block/qdict.h" -#include "qapi/qmp/qdict.h" #include "qapi/qmp/qlist.h" #include "qapi/qmp/qnum.h" -#include "qapi/qmp/qstring.h" #include "qapi/error.h" -#include "qemu-common.h" - -/* - * Public Interface test-cases - * - * (with some violations to access 'private' data) - */ - -static void qdict_new_test(void) -{ - QDict *qdict; - - qdict = qdict_new(); - g_assert(qdict != NULL); - g_assert(qdict_size(qdict) == 0); - g_assert(qdict->base.refcnt == 1); - g_assert(qobject_type(QOBJECT(qdict)) == QTYPE_QDICT); - - qobject_unref(qdict); -} - -static void qdict_put_obj_test(void) -{ - QNum *qn; - QDict *qdict; - QDictEntry *ent; - const int num = 42; - - qdict = qdict_new(); - - // key "" will have tdb hash 12345 - qdict_put_int(qdict, "", num); - - g_assert(qdict_size(qdict) == 1); - ent = QLIST_FIRST(&qdict->table[12345 % QDICT_BUCKET_MAX]); - qn = qobject_to(QNum, ent->value); - g_assert_cmpint(qnum_get_int(qn), ==, num); - - qobject_unref(qdict); -} - -static void qdict_destroy_simple_test(void) -{ - QDict *qdict; - - qdict = qdict_new(); - qdict_put_int(qdict, "num", 0); - qdict_put_str(qdict, "str", "foo"); - - qobject_unref(qdict); -} - -static void qdict_get_test(void) -{ - QNum *qn; - QObject *obj; - const int value = -42; - const char *key = "test"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, value); - - obj = qdict_get(tests_dict, key); - g_assert(obj != NULL); - - qn = qobject_to(QNum, obj); - g_assert_cmpint(qnum_get_int(qn), ==, value); - - qobject_unref(tests_dict); -} - -static void qdict_get_int_test(void) -{ - int ret; - const int value = 100; - const char *key = "int"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, value); - - ret = qdict_get_int(tests_dict, key); - g_assert(ret == value); - - qobject_unref(tests_dict); -} - -static void qdict_get_try_int_test(void) -{ - int ret; - const int value = 100; - const char *key = "int"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, value); - qdict_put_str(tests_dict, "string", "test"); - - ret = qdict_get_try_int(tests_dict, key, 0); - g_assert(ret == value); - - ret = qdict_get_try_int(tests_dict, "missing", -42); - g_assert_cmpuint(ret, ==, -42); - - ret = qdict_get_try_int(tests_dict, "string", -42); - g_assert_cmpuint(ret, ==, -42); - - qobject_unref(tests_dict); -} - -static void qdict_get_str_test(void) -{ - const char *p; - const char *key = "key"; - const char *str = "string"; - QDict *tests_dict = qdict_new(); - - qdict_put_str(tests_dict, key, str); - - p = qdict_get_str(tests_dict, key); - g_assert(p != NULL); - g_assert(strcmp(p, str) == 0); - - qobject_unref(tests_dict); -} - -static void qdict_get_try_str_test(void) -{ - const char *p; - const char *key = "key"; - const char *str = "string"; - QDict *tests_dict = qdict_new(); - - qdict_put_str(tests_dict, key, str); - - p = qdict_get_try_str(tests_dict, key); - g_assert(p != NULL); - g_assert(strcmp(p, str) == 0); - - qobject_unref(tests_dict); -} static void qdict_defaults_test(void) { @@ -179,81 +35,6 @@ static void qdict_defaults_test(void) qobject_unref(dict); } -static void qdict_haskey_not_test(void) -{ - QDict *tests_dict = qdict_new(); - g_assert(qdict_haskey(tests_dict, "test") == 0); - - qobject_unref(tests_dict); -} - -static void qdict_haskey_test(void) -{ - const char *key = "test"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, 0); - g_assert(qdict_haskey(tests_dict, key) == 1); - - qobject_unref(tests_dict); -} - -static void qdict_del_test(void) -{ - const char *key = "key test"; - QDict *tests_dict = qdict_new(); - - qdict_put_str(tests_dict, key, "foo"); - g_assert(qdict_size(tests_dict) == 1); - - qdict_del(tests_dict, key); - - g_assert(qdict_size(tests_dict) == 0); - g_assert(qdict_haskey(tests_dict, key) == 0); - - qobject_unref(tests_dict); -} - -static void qobject_to_qdict_test(void) -{ - QDict *tests_dict = qdict_new(); - g_assert(qobject_to(QDict, QOBJECT(tests_dict)) == tests_dict); - - qobject_unref(tests_dict); -} - -static void qdict_iterapi_test(void) -{ - int count; - const QDictEntry *ent; - QDict *tests_dict = qdict_new(); - - g_assert(qdict_first(tests_dict) == NULL); - - qdict_put_int(tests_dict, "key1", 1); - qdict_put_int(tests_dict, "key2", 2); - qdict_put_int(tests_dict, "key3", 3); - - count = 0; - for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){ - g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1); - count++; - } - - g_assert(count == qdict_size(tests_dict)); - - /* Do it again to test restarting */ - count = 0; - for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){ - g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1); - count++; - } - - g_assert(count == qdict_size(tests_dict)); - - qobject_unref(tests_dict); -} - static void qdict_flatten_test(void) { QList *list1 = qlist_new(); @@ -523,8 +304,7 @@ static void qdict_join_test(void) dict2 = qdict_new(); /* Test everything once without overwrite and once with */ - do - { + do { /* Test empty dicts */ qdict_join(dict1, dict2, overwrite); @@ -585,8 +365,7 @@ static void qdict_join_test(void) if (!overwrite) { qdict_del(dict2, "foo"); } - } - while (overwrite ^= true); + } while (overwrite ^= true); qobject_unref(dict1); qobject_unref(dict2); @@ -854,153 +633,15 @@ static void qdict_crumple_test_bad_inputs(void) qobject_unref(src); } -/* - * Errors test-cases - */ - -static void qdict_put_exists_test(void) -{ - int value; - const char *key = "exists"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, 1); - qdict_put_int(tests_dict, key, 2); - - value = qdict_get_int(tests_dict, key); - g_assert(value == 2); - - g_assert(qdict_size(tests_dict) == 1); - - qobject_unref(tests_dict); -} - -static void qdict_get_not_exists_test(void) -{ - QDict *tests_dict = qdict_new(); - g_assert(qdict_get(tests_dict, "foo") == NULL); - - qobject_unref(tests_dict); -} - -/* - * Stress test-case - * - * This is a lot big for a unit-test, but there is no other place - * to have it. - */ - -static void remove_dots(char *string) -{ - char *p = strchr(string, ':'); - if (p) - *p = '\0'; -} - -static QString *read_line(FILE *file, char *key) -{ - char value[128]; - - if (fscanf(file, "%127s%127s", key, value) == EOF) { - return NULL; - } - remove_dots(key); - return qstring_from_str(value); -} - -#define reset_file(file) fseek(file, 0L, SEEK_SET) - -static void qdict_stress_test(void) -{ - size_t lines; - char key[128]; - FILE *test_file; - QDict *qdict; - QString *value; - const char *test_file_path = "qdict-test-data.txt"; - - test_file = fopen(test_file_path, "r"); - g_assert(test_file != NULL); - - // Create the dict - qdict = qdict_new(); - g_assert(qdict != NULL); - - // Add everything from the test file - for (lines = 0;; lines++) { - value = read_line(test_file, key); - if (!value) - break; - - qdict_put(qdict, key, value); - } - g_assert(qdict_size(qdict) == lines); - - // Check if everything is really in there - reset_file(test_file); - for (;;) { - const char *str1, *str2; - - value = read_line(test_file, key); - if (!value) - break; - - str1 = qstring_get_str(value); - - str2 = qdict_get_str(qdict, key); - g_assert(str2 != NULL); - - g_assert(strcmp(str1, str2) == 0); - - qobject_unref(value); - } - - // Delete everything - reset_file(test_file); - for (;;) { - value = read_line(test_file, key); - if (!value) - break; - - qdict_del(qdict, key); - qobject_unref(value); - - g_assert(qdict_haskey(qdict, key) == 0); - } - fclose(test_file); - - g_assert(qdict_size(qdict) == 0); - qobject_unref(qdict); -} - int main(int argc, char **argv) { g_test_init(&argc, &argv, NULL); - g_test_add_func("/public/new", qdict_new_test); - g_test_add_func("/public/put_obj", qdict_put_obj_test); - g_test_add_func("/public/destroy_simple", qdict_destroy_simple_test); - - /* Continue, but now with fixtures */ - g_test_add_func("/public/get", qdict_get_test); - g_test_add_func("/public/get_int", qdict_get_int_test); - g_test_add_func("/public/get_try_int", qdict_get_try_int_test); - g_test_add_func("/public/get_str", qdict_get_str_test); - g_test_add_func("/public/get_try_str", qdict_get_try_str_test); g_test_add_func("/public/defaults", qdict_defaults_test); - g_test_add_func("/public/haskey_not", qdict_haskey_not_test); - g_test_add_func("/public/haskey", qdict_haskey_test); - g_test_add_func("/public/del", qdict_del_test); - g_test_add_func("/public/to_qdict", qobject_to_qdict_test); - g_test_add_func("/public/iterapi", qdict_iterapi_test); g_test_add_func("/public/flatten", qdict_flatten_test); g_test_add_func("/public/array_split", qdict_array_split_test); g_test_add_func("/public/array_entries", qdict_array_entries_test); g_test_add_func("/public/join", qdict_join_test); - - g_test_add_func("/errors/put_exists", qdict_put_exists_test); - g_test_add_func("/errors/get_not_exists", qdict_get_not_exists_test); - g_test_add_func("/public/crumple/recursive", qdict_crumple_test_recursive); g_test_add_func("/public/crumple/empty", @@ -1010,10 +651,5 @@ int main(int argc, char **argv) g_test_add_func("/public/rename_keys", qdict_rename_keys_test); - /* The Big one */ - if (g_test_slow()) { - g_test_add_func("/stress/test", qdict_stress_test); - } - return g_test_run(); } diff --git a/tests/check-qdict.c b/tests/check-qdict.c dissimilarity index 67% index 93e2112b6d..86e9fe7dc4 100644 --- a/tests/check-qdict.c +++ b/tests/check-qdict.c @@ -1,1019 +1,377 @@ -/* - * QDict unit-tests. - * - * Copyright (C) 2009 Red Hat Inc. - * - * Authors: - * Luiz Capitulino - * - * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. - * See the COPYING.LIB file in the top-level directory. - */ - -#include "qemu/osdep.h" -#include "block/qdict.h" -#include "qapi/qmp/qdict.h" -#include "qapi/qmp/qlist.h" -#include "qapi/qmp/qnum.h" -#include "qapi/qmp/qstring.h" -#include "qapi/error.h" -#include "qemu-common.h" - -/* - * Public Interface test-cases - * - * (with some violations to access 'private' data) - */ - -static void qdict_new_test(void) -{ - QDict *qdict; - - qdict = qdict_new(); - g_assert(qdict != NULL); - g_assert(qdict_size(qdict) == 0); - g_assert(qdict->base.refcnt == 1); - g_assert(qobject_type(QOBJECT(qdict)) == QTYPE_QDICT); - - qobject_unref(qdict); -} - -static void qdict_put_obj_test(void) -{ - QNum *qn; - QDict *qdict; - QDictEntry *ent; - const int num = 42; - - qdict = qdict_new(); - - // key "" will have tdb hash 12345 - qdict_put_int(qdict, "", num); - - g_assert(qdict_size(qdict) == 1); - ent = QLIST_FIRST(&qdict->table[12345 % QDICT_BUCKET_MAX]); - qn = qobject_to(QNum, ent->value); - g_assert_cmpint(qnum_get_int(qn), ==, num); - - qobject_unref(qdict); -} - -static void qdict_destroy_simple_test(void) -{ - QDict *qdict; - - qdict = qdict_new(); - qdict_put_int(qdict, "num", 0); - qdict_put_str(qdict, "str", "foo"); - - qobject_unref(qdict); -} - -static void qdict_get_test(void) -{ - QNum *qn; - QObject *obj; - const int value = -42; - const char *key = "test"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, value); - - obj = qdict_get(tests_dict, key); - g_assert(obj != NULL); - - qn = qobject_to(QNum, obj); - g_assert_cmpint(qnum_get_int(qn), ==, value); - - qobject_unref(tests_dict); -} - -static void qdict_get_int_test(void) -{ - int ret; - const int value = 100; - const char *key = "int"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, value); - - ret = qdict_get_int(tests_dict, key); - g_assert(ret == value); - - qobject_unref(tests_dict); -} - -static void qdict_get_try_int_test(void) -{ - int ret; - const int value = 100; - const char *key = "int"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, value); - qdict_put_str(tests_dict, "string", "test"); - - ret = qdict_get_try_int(tests_dict, key, 0); - g_assert(ret == value); - - ret = qdict_get_try_int(tests_dict, "missing", -42); - g_assert_cmpuint(ret, ==, -42); - - ret = qdict_get_try_int(tests_dict, "string", -42); - g_assert_cmpuint(ret, ==, -42); - - qobject_unref(tests_dict); -} - -static void qdict_get_str_test(void) -{ - const char *p; - const char *key = "key"; - const char *str = "string"; - QDict *tests_dict = qdict_new(); - - qdict_put_str(tests_dict, key, str); - - p = qdict_get_str(tests_dict, key); - g_assert(p != NULL); - g_assert(strcmp(p, str) == 0); - - qobject_unref(tests_dict); -} - -static void qdict_get_try_str_test(void) -{ - const char *p; - const char *key = "key"; - const char *str = "string"; - QDict *tests_dict = qdict_new(); - - qdict_put_str(tests_dict, key, str); - - p = qdict_get_try_str(tests_dict, key); - g_assert(p != NULL); - g_assert(strcmp(p, str) == 0); - - qobject_unref(tests_dict); -} - -static void qdict_defaults_test(void) -{ - QDict *dict, *copy; - - dict = qdict_new(); - copy = qdict_new(); - - qdict_set_default_str(dict, "foo", "abc"); - qdict_set_default_str(dict, "foo", "def"); - g_assert_cmpstr(qdict_get_str(dict, "foo"), ==, "abc"); - qdict_set_default_str(dict, "bar", "ghi"); - - qdict_copy_default(copy, dict, "foo"); - g_assert_cmpstr(qdict_get_str(copy, "foo"), ==, "abc"); - qdict_set_default_str(copy, "bar", "xyz"); - qdict_copy_default(copy, dict, "bar"); - g_assert_cmpstr(qdict_get_str(copy, "bar"), ==, "xyz"); - - qobject_unref(copy); - qobject_unref(dict); -} - -static void qdict_haskey_not_test(void) -{ - QDict *tests_dict = qdict_new(); - g_assert(qdict_haskey(tests_dict, "test") == 0); - - qobject_unref(tests_dict); -} - -static void qdict_haskey_test(void) -{ - const char *key = "test"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, 0); - g_assert(qdict_haskey(tests_dict, key) == 1); - - qobject_unref(tests_dict); -} - -static void qdict_del_test(void) -{ - const char *key = "key test"; - QDict *tests_dict = qdict_new(); - - qdict_put_str(tests_dict, key, "foo"); - g_assert(qdict_size(tests_dict) == 1); - - qdict_del(tests_dict, key); - - g_assert(qdict_size(tests_dict) == 0); - g_assert(qdict_haskey(tests_dict, key) == 0); - - qobject_unref(tests_dict); -} - -static void qobject_to_qdict_test(void) -{ - QDict *tests_dict = qdict_new(); - g_assert(qobject_to(QDict, QOBJECT(tests_dict)) == tests_dict); - - qobject_unref(tests_dict); -} - -static void qdict_iterapi_test(void) -{ - int count; - const QDictEntry *ent; - QDict *tests_dict = qdict_new(); - - g_assert(qdict_first(tests_dict) == NULL); - - qdict_put_int(tests_dict, "key1", 1); - qdict_put_int(tests_dict, "key2", 2); - qdict_put_int(tests_dict, "key3", 3); - - count = 0; - for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){ - g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1); - count++; - } - - g_assert(count == qdict_size(tests_dict)); - - /* Do it again to test restarting */ - count = 0; - for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){ - g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1); - count++; - } - - g_assert(count == qdict_size(tests_dict)); - - qobject_unref(tests_dict); -} - -static void qdict_flatten_test(void) -{ - QList *list1 = qlist_new(); - QList *list2 = qlist_new(); - QDict *dict1 = qdict_new(); - QDict *dict2 = qdict_new(); - QDict *dict3 = qdict_new(); - - /* - * Test the flattening of - * - * { - * "e": [ - * 42, - * [ - * 23, - * 66, - * { - * "a": 0, - * "b": 1 - * } - * ] - * ], - * "f": { - * "c": 2, - * "d": 3, - * }, - * "g": 4 - * } - * - * to - * - * { - * "e.0": 42, - * "e.1.0": 23, - * "e.1.1": 66, - * "e.1.2.a": 0, - * "e.1.2.b": 1, - * "f.c": 2, - * "f.d": 3, - * "g": 4 - * } - */ - - qdict_put_int(dict1, "a", 0); - qdict_put_int(dict1, "b", 1); - - qlist_append_int(list1, 23); - qlist_append_int(list1, 66); - qlist_append(list1, dict1); - qlist_append_int(list2, 42); - qlist_append(list2, list1); - - qdict_put_int(dict2, "c", 2); - qdict_put_int(dict2, "d", 3); - qdict_put(dict3, "e", list2); - qdict_put(dict3, "f", dict2); - qdict_put_int(dict3, "g", 4); - - qdict_flatten(dict3); - - g_assert(qdict_get_int(dict3, "e.0") == 42); - g_assert(qdict_get_int(dict3, "e.1.0") == 23); - g_assert(qdict_get_int(dict3, "e.1.1") == 66); - g_assert(qdict_get_int(dict3, "e.1.2.a") == 0); - g_assert(qdict_get_int(dict3, "e.1.2.b") == 1); - g_assert(qdict_get_int(dict3, "f.c") == 2); - g_assert(qdict_get_int(dict3, "f.d") == 3); - g_assert(qdict_get_int(dict3, "g") == 4); - - g_assert(qdict_size(dict3) == 8); - - qobject_unref(dict3); -} - -static void qdict_array_split_test(void) -{ - QDict *test_dict = qdict_new(); - QDict *dict1, *dict2; - QNum *int1; - QList *test_list; - - /* - * Test the split of - * - * { - * "1.x": 0, - * "4.y": 1, - * "0.a": 42, - * "o.o": 7, - * "0.b": 23, - * "2": 66 - * } - * - * to - * - * [ - * { - * "a": 42, - * "b": 23 - * }, - * { - * "x": 0 - * }, - * 66 - * ] - * - * and - * - * { - * "4.y": 1, - * "o.o": 7 - * } - * - * (remaining in the old QDict) - * - * This example is given in the comment of qdict_array_split(). - */ - - qdict_put_int(test_dict, "1.x", 0); - qdict_put_int(test_dict, "4.y", 1); - qdict_put_int(test_dict, "0.a", 42); - qdict_put_int(test_dict, "o.o", 7); - qdict_put_int(test_dict, "0.b", 23); - qdict_put_int(test_dict, "2", 66); - - qdict_array_split(test_dict, &test_list); - - dict1 = qobject_to(QDict, qlist_pop(test_list)); - dict2 = qobject_to(QDict, qlist_pop(test_list)); - int1 = qobject_to(QNum, qlist_pop(test_list)); - - g_assert(dict1); - g_assert(dict2); - g_assert(int1); - g_assert(qlist_empty(test_list)); - - qobject_unref(test_list); - - g_assert(qdict_get_int(dict1, "a") == 42); - g_assert(qdict_get_int(dict1, "b") == 23); - - g_assert(qdict_size(dict1) == 2); - - qobject_unref(dict1); - - g_assert(qdict_get_int(dict2, "x") == 0); - - g_assert(qdict_size(dict2) == 1); - - qobject_unref(dict2); - - g_assert_cmpint(qnum_get_int(int1), ==, 66); - - qobject_unref(int1); - - g_assert(qdict_get_int(test_dict, "4.y") == 1); - g_assert(qdict_get_int(test_dict, "o.o") == 7); - - g_assert(qdict_size(test_dict) == 2); - - qobject_unref(test_dict); - - /* - * Test the split of - * - * { - * "0": 42, - * "1": 23, - * "1.x": 84 - * } - * - * to - * - * [ - * 42 - * ] - * - * and - * - * { - * "1": 23, - * "1.x": 84 - * } - * - * That is, test whether splitting stops if there is both an entry with key - * of "%u" and other entries with keys prefixed "%u." for the same index. - */ - - test_dict = qdict_new(); - - qdict_put_int(test_dict, "0", 42); - qdict_put_int(test_dict, "1", 23); - qdict_put_int(test_dict, "1.x", 84); - - qdict_array_split(test_dict, &test_list); - - int1 = qobject_to(QNum, qlist_pop(test_list)); - - g_assert(int1); - g_assert(qlist_empty(test_list)); - - qobject_unref(test_list); - - g_assert_cmpint(qnum_get_int(int1), ==, 42); - - qobject_unref(int1); - - g_assert(qdict_get_int(test_dict, "1") == 23); - g_assert(qdict_get_int(test_dict, "1.x") == 84); - - g_assert(qdict_size(test_dict) == 2); - - qobject_unref(test_dict); -} - -static void qdict_array_entries_test(void) -{ - QDict *dict = qdict_new(); - - g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 0); - - qdict_put_int(dict, "bar", 0); - qdict_put_int(dict, "baz.0", 0); - g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 0); - - qdict_put_int(dict, "foo.1", 0); - g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, -EINVAL); - qdict_put_int(dict, "foo.0", 0); - g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 2); - qdict_put_int(dict, "foo.bar", 0); - g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, -EINVAL); - qdict_del(dict, "foo.bar"); - - qdict_put_int(dict, "foo.2.a", 0); - qdict_put_int(dict, "foo.2.b", 0); - qdict_put_int(dict, "foo.2.c", 0); - g_assert_cmpint(qdict_array_entries(dict, "foo."), ==, 3); - g_assert_cmpint(qdict_array_entries(dict, ""), ==, -EINVAL); - - qobject_unref(dict); - - dict = qdict_new(); - qdict_put_int(dict, "1", 0); - g_assert_cmpint(qdict_array_entries(dict, ""), ==, -EINVAL); - qdict_put_int(dict, "0", 0); - g_assert_cmpint(qdict_array_entries(dict, ""), ==, 2); - qdict_put_int(dict, "bar", 0); - g_assert_cmpint(qdict_array_entries(dict, ""), ==, -EINVAL); - qdict_del(dict, "bar"); - - qdict_put_int(dict, "2.a", 0); - qdict_put_int(dict, "2.b", 0); - qdict_put_int(dict, "2.c", 0); - g_assert_cmpint(qdict_array_entries(dict, ""), ==, 3); - - qobject_unref(dict); -} - -static void qdict_join_test(void) -{ - QDict *dict1, *dict2; - bool overwrite = false; - int i; - - dict1 = qdict_new(); - dict2 = qdict_new(); - - /* Test everything once without overwrite and once with */ - do - { - /* Test empty dicts */ - qdict_join(dict1, dict2, overwrite); - - g_assert(qdict_size(dict1) == 0); - g_assert(qdict_size(dict2) == 0); - - /* First iteration: Test movement */ - /* Second iteration: Test empty source and non-empty destination */ - qdict_put_int(dict2, "foo", 42); - - for (i = 0; i < 2; i++) { - qdict_join(dict1, dict2, overwrite); - - g_assert(qdict_size(dict1) == 1); - g_assert(qdict_size(dict2) == 0); - - g_assert(qdict_get_int(dict1, "foo") == 42); - } - - /* Test non-empty source and destination without conflict */ - qdict_put_int(dict2, "bar", 23); - - qdict_join(dict1, dict2, overwrite); - - g_assert(qdict_size(dict1) == 2); - g_assert(qdict_size(dict2) == 0); - - g_assert(qdict_get_int(dict1, "foo") == 42); - g_assert(qdict_get_int(dict1, "bar") == 23); - - /* Test conflict */ - qdict_put_int(dict2, "foo", 84); - - qdict_join(dict1, dict2, overwrite); - - g_assert(qdict_size(dict1) == 2); - g_assert(qdict_size(dict2) == !overwrite); - - g_assert(qdict_get_int(dict1, "foo") == (overwrite ? 84 : 42)); - g_assert(qdict_get_int(dict1, "bar") == 23); - - if (!overwrite) { - g_assert(qdict_get_int(dict2, "foo") == 84); - } - - /* Check the references */ - g_assert(qdict_get(dict1, "foo")->base.refcnt == 1); - g_assert(qdict_get(dict1, "bar")->base.refcnt == 1); - - if (!overwrite) { - g_assert(qdict_get(dict2, "foo")->base.refcnt == 1); - } - - /* Clean up */ - qdict_del(dict1, "foo"); - qdict_del(dict1, "bar"); - - if (!overwrite) { - qdict_del(dict2, "foo"); - } - } - while (overwrite ^= true); - - qobject_unref(dict1); - qobject_unref(dict2); -} - -static void qdict_crumple_test_recursive(void) -{ - QDict *src, *dst, *rule, *vnc, *acl, *listen; - QList *rules; - - src = qdict_new(); - qdict_put_str(src, "vnc.listen.addr", "127.0.0.1"); - qdict_put_str(src, "vnc.listen.port", "5901"); - qdict_put_str(src, "vnc.acl.rules.0.match", "fred"); - qdict_put_str(src, "vnc.acl.rules.0.policy", "allow"); - qdict_put_str(src, "vnc.acl.rules.1.match", "bob"); - qdict_put_str(src, "vnc.acl.rules.1.policy", "deny"); - qdict_put_str(src, "vnc.acl.default", "deny"); - qdict_put_str(src, "vnc.acl..name", "acl0"); - qdict_put_str(src, "vnc.acl.rule..name", "acl0"); - - dst = qobject_to(QDict, qdict_crumple(src, &error_abort)); - g_assert(dst); - g_assert_cmpint(qdict_size(dst), ==, 1); - - vnc = qdict_get_qdict(dst, "vnc"); - g_assert(vnc); - g_assert_cmpint(qdict_size(vnc), ==, 3); - - listen = qdict_get_qdict(vnc, "listen"); - g_assert(listen); - g_assert_cmpint(qdict_size(listen), ==, 2); - g_assert_cmpstr("127.0.0.1", ==, qdict_get_str(listen, "addr")); - g_assert_cmpstr("5901", ==, qdict_get_str(listen, "port")); - - acl = qdict_get_qdict(vnc, "acl"); - g_assert(acl); - g_assert_cmpint(qdict_size(acl), ==, 3); - - rules = qdict_get_qlist(acl, "rules"); - g_assert(rules); - g_assert_cmpint(qlist_size(rules), ==, 2); - - rule = qobject_to(QDict, qlist_pop(rules)); - g_assert(rule); - g_assert_cmpint(qdict_size(rule), ==, 2); - g_assert_cmpstr("fred", ==, qdict_get_str(rule, "match")); - g_assert_cmpstr("allow", ==, qdict_get_str(rule, "policy")); - qobject_unref(rule); - - rule = qobject_to(QDict, qlist_pop(rules)); - g_assert(rule); - g_assert_cmpint(qdict_size(rule), ==, 2); - g_assert_cmpstr("bob", ==, qdict_get_str(rule, "match")); - g_assert_cmpstr("deny", ==, qdict_get_str(rule, "policy")); - qobject_unref(rule); - - /* With recursive crumpling, we should see all names unescaped */ - g_assert_cmpstr("acl0", ==, qdict_get_str(vnc, "acl.name")); - g_assert_cmpstr("acl0", ==, qdict_get_str(acl, "rule.name")); - - qobject_unref(src); - qobject_unref(dst); -} - -static void qdict_crumple_test_empty(void) -{ - QDict *src, *dst; - - src = qdict_new(); - - dst = qobject_to(QDict, qdict_crumple(src, &error_abort)); - - g_assert_cmpint(qdict_size(dst), ==, 0); - - qobject_unref(src); - qobject_unref(dst); -} - -static int qdict_count_entries(QDict *dict) -{ - const QDictEntry *e; - int count = 0; - - for (e = qdict_first(dict); e; e = qdict_next(dict, e)) { - count++; - } - - return count; -} - -static void qdict_rename_keys_test(void) -{ - QDict *dict = qdict_new(); - QDict *copy; - QDictRenames *renames; - Error *local_err = NULL; - - qdict_put_str(dict, "abc", "foo"); - qdict_put_str(dict, "abcdef", "bar"); - qdict_put_int(dict, "number", 42); - qdict_put_bool(dict, "flag", true); - qdict_put_null(dict, "nothing"); - - /* Empty rename list */ - renames = (QDictRenames[]) { - { NULL, "this can be anything" } - }; - copy = qdict_clone_shallow(dict); - qdict_rename_keys(copy, renames, &error_abort); - - g_assert_cmpstr(qdict_get_str(copy, "abc"), ==, "foo"); - g_assert_cmpstr(qdict_get_str(copy, "abcdef"), ==, "bar"); - g_assert_cmpint(qdict_get_int(copy, "number"), ==, 42); - g_assert_cmpint(qdict_get_bool(copy, "flag"), ==, true); - g_assert(qobject_type(qdict_get(copy, "nothing")) == QTYPE_QNULL); - g_assert_cmpint(qdict_count_entries(copy), ==, 5); - - qobject_unref(copy); - - /* Simple rename of all entries */ - renames = (QDictRenames[]) { - { "abc", "str1" }, - { "abcdef", "str2" }, - { "number", "int" }, - { "flag", "bool" }, - { "nothing", "null" }, - { NULL , NULL } - }; - copy = qdict_clone_shallow(dict); - qdict_rename_keys(copy, renames, &error_abort); - - g_assert(!qdict_haskey(copy, "abc")); - g_assert(!qdict_haskey(copy, "abcdef")); - g_assert(!qdict_haskey(copy, "number")); - g_assert(!qdict_haskey(copy, "flag")); - g_assert(!qdict_haskey(copy, "nothing")); - - g_assert_cmpstr(qdict_get_str(copy, "str1"), ==, "foo"); - g_assert_cmpstr(qdict_get_str(copy, "str2"), ==, "bar"); - g_assert_cmpint(qdict_get_int(copy, "int"), ==, 42); - g_assert_cmpint(qdict_get_bool(copy, "bool"), ==, true); - g_assert(qobject_type(qdict_get(copy, "null")) == QTYPE_QNULL); - g_assert_cmpint(qdict_count_entries(copy), ==, 5); - - qobject_unref(copy); - - /* Renames are processed top to bottom */ - renames = (QDictRenames[]) { - { "abc", "tmp" }, - { "abcdef", "abc" }, - { "number", "abcdef" }, - { "flag", "number" }, - { "nothing", "flag" }, - { "tmp", "nothing" }, - { NULL , NULL } - }; - copy = qdict_clone_shallow(dict); - qdict_rename_keys(copy, renames, &error_abort); - - g_assert_cmpstr(qdict_get_str(copy, "nothing"), ==, "foo"); - g_assert_cmpstr(qdict_get_str(copy, "abc"), ==, "bar"); - g_assert_cmpint(qdict_get_int(copy, "abcdef"), ==, 42); - g_assert_cmpint(qdict_get_bool(copy, "number"), ==, true); - g_assert(qobject_type(qdict_get(copy, "flag")) == QTYPE_QNULL); - g_assert(!qdict_haskey(copy, "tmp")); - g_assert_cmpint(qdict_count_entries(copy), ==, 5); - - qobject_unref(copy); - - /* Conflicting rename */ - renames = (QDictRenames[]) { - { "abcdef", "abc" }, - { NULL , NULL } - }; - copy = qdict_clone_shallow(dict); - qdict_rename_keys(copy, renames, &local_err); - - g_assert(local_err != NULL); - error_free(local_err); - local_err = NULL; - - g_assert_cmpstr(qdict_get_str(copy, "abc"), ==, "foo"); - g_assert_cmpstr(qdict_get_str(copy, "abcdef"), ==, "bar"); - g_assert_cmpint(qdict_get_int(copy, "number"), ==, 42); - g_assert_cmpint(qdict_get_bool(copy, "flag"), ==, true); - g_assert(qobject_type(qdict_get(copy, "nothing")) == QTYPE_QNULL); - g_assert_cmpint(qdict_count_entries(copy), ==, 5); - - qobject_unref(copy); - - /* Renames in an empty dict */ - renames = (QDictRenames[]) { - { "abcdef", "abc" }, - { NULL , NULL } - }; - - qobject_unref(dict); - dict = qdict_new(); - - qdict_rename_keys(dict, renames, &error_abort); - g_assert(qdict_first(dict) == NULL); - - qobject_unref(dict); -} - -static void qdict_crumple_test_bad_inputs(void) -{ - QDict *src; - Error *error = NULL; - - src = qdict_new(); - /* rule.0 can't be both a string and a dict */ - qdict_put_str(src, "rule.0", "fred"); - qdict_put_str(src, "rule.0.policy", "allow"); - - g_assert(qdict_crumple(src, &error) == NULL); - g_assert(error != NULL); - error_free(error); - error = NULL; - qobject_unref(src); - - src = qdict_new(); - /* rule can't be both a list and a dict */ - qdict_put_str(src, "rule.0", "fred"); - qdict_put_str(src, "rule.a", "allow"); - - g_assert(qdict_crumple(src, &error) == NULL); - g_assert(error != NULL); - error_free(error); - error = NULL; - qobject_unref(src); - - src = qdict_new(); - /* The input should be flat, ie no dicts or lists */ - qdict_put(src, "rule.a", qdict_new()); - qdict_put_str(src, "rule.b", "allow"); - - g_assert(qdict_crumple(src, &error) == NULL); - g_assert(error != NULL); - error_free(error); - error = NULL; - qobject_unref(src); - - src = qdict_new(); - /* List indexes must not have gaps */ - qdict_put_str(src, "rule.0", "deny"); - qdict_put_str(src, "rule.3", "allow"); - - g_assert(qdict_crumple(src, &error) == NULL); - g_assert(error != NULL); - error_free(error); - error = NULL; - qobject_unref(src); - - src = qdict_new(); - /* List indexes must be in %zu format */ - qdict_put_str(src, "rule.0", "deny"); - qdict_put_str(src, "rule.+1", "allow"); - - g_assert(qdict_crumple(src, &error) == NULL); - g_assert(error != NULL); - error_free(error); - error = NULL; - qobject_unref(src); -} - -/* - * Errors test-cases - */ - -static void qdict_put_exists_test(void) -{ - int value; - const char *key = "exists"; - QDict *tests_dict = qdict_new(); - - qdict_put_int(tests_dict, key, 1); - qdict_put_int(tests_dict, key, 2); - - value = qdict_get_int(tests_dict, key); - g_assert(value == 2); - - g_assert(qdict_size(tests_dict) == 1); - - qobject_unref(tests_dict); -} - -static void qdict_get_not_exists_test(void) -{ - QDict *tests_dict = qdict_new(); - g_assert(qdict_get(tests_dict, "foo") == NULL); - - qobject_unref(tests_dict); -} - -/* - * Stress test-case - * - * This is a lot big for a unit-test, but there is no other place - * to have it. - */ - -static void remove_dots(char *string) -{ - char *p = strchr(string, ':'); - if (p) - *p = '\0'; -} - -static QString *read_line(FILE *file, char *key) -{ - char value[128]; - - if (fscanf(file, "%127s%127s", key, value) == EOF) { - return NULL; - } - remove_dots(key); - return qstring_from_str(value); -} - -#define reset_file(file) fseek(file, 0L, SEEK_SET) - -static void qdict_stress_test(void) -{ - size_t lines; - char key[128]; - FILE *test_file; - QDict *qdict; - QString *value; - const char *test_file_path = "qdict-test-data.txt"; - - test_file = fopen(test_file_path, "r"); - g_assert(test_file != NULL); - - // Create the dict - qdict = qdict_new(); - g_assert(qdict != NULL); - - // Add everything from the test file - for (lines = 0;; lines++) { - value = read_line(test_file, key); - if (!value) - break; - - qdict_put(qdict, key, value); - } - g_assert(qdict_size(qdict) == lines); - - // Check if everything is really in there - reset_file(test_file); - for (;;) { - const char *str1, *str2; - - value = read_line(test_file, key); - if (!value) - break; - - str1 = qstring_get_str(value); - - str2 = qdict_get_str(qdict, key); - g_assert(str2 != NULL); - - g_assert(strcmp(str1, str2) == 0); - - qobject_unref(value); - } - - // Delete everything - reset_file(test_file); - for (;;) { - value = read_line(test_file, key); - if (!value) - break; - - qdict_del(qdict, key); - qobject_unref(value); - - g_assert(qdict_haskey(qdict, key) == 0); - } - fclose(test_file); - - g_assert(qdict_size(qdict) == 0); - qobject_unref(qdict); -} - -int main(int argc, char **argv) -{ - g_test_init(&argc, &argv, NULL); - - g_test_add_func("/public/new", qdict_new_test); - g_test_add_func("/public/put_obj", qdict_put_obj_test); - g_test_add_func("/public/destroy_simple", qdict_destroy_simple_test); - - /* Continue, but now with fixtures */ - g_test_add_func("/public/get", qdict_get_test); - g_test_add_func("/public/get_int", qdict_get_int_test); - g_test_add_func("/public/get_try_int", qdict_get_try_int_test); - g_test_add_func("/public/get_str", qdict_get_str_test); - g_test_add_func("/public/get_try_str", qdict_get_try_str_test); - g_test_add_func("/public/defaults", qdict_defaults_test); - g_test_add_func("/public/haskey_not", qdict_haskey_not_test); - g_test_add_func("/public/haskey", qdict_haskey_test); - g_test_add_func("/public/del", qdict_del_test); - g_test_add_func("/public/to_qdict", qobject_to_qdict_test); - g_test_add_func("/public/iterapi", qdict_iterapi_test); - g_test_add_func("/public/flatten", qdict_flatten_test); - g_test_add_func("/public/array_split", qdict_array_split_test); - g_test_add_func("/public/array_entries", qdict_array_entries_test); - g_test_add_func("/public/join", qdict_join_test); - - g_test_add_func("/errors/put_exists", qdict_put_exists_test); - g_test_add_func("/errors/get_not_exists", qdict_get_not_exists_test); - - g_test_add_func("/public/crumple/recursive", - qdict_crumple_test_recursive); - g_test_add_func("/public/crumple/empty", - qdict_crumple_test_empty); - g_test_add_func("/public/crumple/bad_inputs", - qdict_crumple_test_bad_inputs); - - g_test_add_func("/public/rename_keys", qdict_rename_keys_test); - - /* The Big one */ - if (g_test_slow()) { - g_test_add_func("/stress/test", qdict_stress_test); - } - - return g_test_run(); -} +/* + * QDict unit-tests. + * + * Copyright (C) 2009 Red Hat Inc. + * + * Authors: + * Luiz Capitulino + * + * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. + * See the COPYING.LIB file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include "qapi/qmp/qdict.h" + +/* + * Public Interface test-cases + * + * (with some violations to access 'private' data) + */ + +static void qdict_new_test(void) +{ + QDict *qdict; + + qdict = qdict_new(); + g_assert(qdict != NULL); + g_assert(qdict_size(qdict) == 0); + g_assert(qdict->base.refcnt == 1); + g_assert(qobject_type(QOBJECT(qdict)) == QTYPE_QDICT); + + qobject_unref(qdict); +} + +static void qdict_put_obj_test(void) +{ + QNum *qn; + QDict *qdict; + QDictEntry *ent; + const int num = 42; + + qdict = qdict_new(); + + // key "" will have tdb hash 12345 + qdict_put_int(qdict, "", num); + + g_assert(qdict_size(qdict) == 1); + ent = QLIST_FIRST(&qdict->table[12345 % QDICT_BUCKET_MAX]); + qn = qobject_to(QNum, ent->value); + g_assert_cmpint(qnum_get_int(qn), ==, num); + + qobject_unref(qdict); +} + +static void qdict_destroy_simple_test(void) +{ + QDict *qdict; + + qdict = qdict_new(); + qdict_put_int(qdict, "num", 0); + qdict_put_str(qdict, "str", "foo"); + + qobject_unref(qdict); +} + +static void qdict_get_test(void) +{ + QNum *qn; + QObject *obj; + const int value = -42; + const char *key = "test"; + QDict *tests_dict = qdict_new(); + + qdict_put_int(tests_dict, key, value); + + obj = qdict_get(tests_dict, key); + g_assert(obj != NULL); + + qn = qobject_to(QNum, obj); + g_assert_cmpint(qnum_get_int(qn), ==, value); + + qobject_unref(tests_dict); +} + +static void qdict_get_int_test(void) +{ + int ret; + const int value = 100; + const char *key = "int"; + QDict *tests_dict = qdict_new(); + + qdict_put_int(tests_dict, key, value); + + ret = qdict_get_int(tests_dict, key); + g_assert(ret == value); + + qobject_unref(tests_dict); +} + +static void qdict_get_try_int_test(void) +{ + int ret; + const int value = 100; + const char *key = "int"; + QDict *tests_dict = qdict_new(); + + qdict_put_int(tests_dict, key, value); + qdict_put_str(tests_dict, "string", "test"); + + ret = qdict_get_try_int(tests_dict, key, 0); + g_assert(ret == value); + + ret = qdict_get_try_int(tests_dict, "missing", -42); + g_assert_cmpuint(ret, ==, -42); + + ret = qdict_get_try_int(tests_dict, "string", -42); + g_assert_cmpuint(ret, ==, -42); + + qobject_unref(tests_dict); +} + +static void qdict_get_str_test(void) +{ + const char *p; + const char *key = "key"; + const char *str = "string"; + QDict *tests_dict = qdict_new(); + + qdict_put_str(tests_dict, key, str); + + p = qdict_get_str(tests_dict, key); + g_assert(p != NULL); + g_assert(strcmp(p, str) == 0); + + qobject_unref(tests_dict); +} + +static void qdict_get_try_str_test(void) +{ + const char *p; + const char *key = "key"; + const char *str = "string"; + QDict *tests_dict = qdict_new(); + + qdict_put_str(tests_dict, key, str); + + p = qdict_get_try_str(tests_dict, key); + g_assert(p != NULL); + g_assert(strcmp(p, str) == 0); + + qobject_unref(tests_dict); +} + +static void qdict_haskey_not_test(void) +{ + QDict *tests_dict = qdict_new(); + g_assert(qdict_haskey(tests_dict, "test") == 0); + + qobject_unref(tests_dict); +} + +static void qdict_haskey_test(void) +{ + const char *key = "test"; + QDict *tests_dict = qdict_new(); + + qdict_put_int(tests_dict, key, 0); + g_assert(qdict_haskey(tests_dict, key) == 1); + + qobject_unref(tests_dict); +} + +static void qdict_del_test(void) +{ + const char *key = "key test"; + QDict *tests_dict = qdict_new(); + + qdict_put_str(tests_dict, key, "foo"); + g_assert(qdict_size(tests_dict) == 1); + + qdict_del(tests_dict, key); + + g_assert(qdict_size(tests_dict) == 0); + g_assert(qdict_haskey(tests_dict, key) == 0); + + qobject_unref(tests_dict); +} + +static void qobject_to_qdict_test(void) +{ + QDict *tests_dict = qdict_new(); + g_assert(qobject_to(QDict, QOBJECT(tests_dict)) == tests_dict); + + qobject_unref(tests_dict); +} + +static void qdict_iterapi_test(void) +{ + int count; + const QDictEntry *ent; + QDict *tests_dict = qdict_new(); + + g_assert(qdict_first(tests_dict) == NULL); + + qdict_put_int(tests_dict, "key1", 1); + qdict_put_int(tests_dict, "key2", 2); + qdict_put_int(tests_dict, "key3", 3); + + count = 0; + for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){ + g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1); + count++; + } + + g_assert(count == qdict_size(tests_dict)); + + /* Do it again to test restarting */ + count = 0; + for (ent = qdict_first(tests_dict); ent; ent = qdict_next(tests_dict, ent)){ + g_assert(qdict_haskey(tests_dict, qdict_entry_key(ent)) == 1); + count++; + } + + g_assert(count == qdict_size(tests_dict)); + + qobject_unref(tests_dict); +} + +/* + * Errors test-cases + */ + +static void qdict_put_exists_test(void) +{ + int value; + const char *key = "exists"; + QDict *tests_dict = qdict_new(); + + qdict_put_int(tests_dict, key, 1); + qdict_put_int(tests_dict, key, 2); + + value = qdict_get_int(tests_dict, key); + g_assert(value == 2); + + g_assert(qdict_size(tests_dict) == 1); + + qobject_unref(tests_dict); +} + +static void qdict_get_not_exists_test(void) +{ + QDict *tests_dict = qdict_new(); + g_assert(qdict_get(tests_dict, "foo") == NULL); + + qobject_unref(tests_dict); +} + +/* + * Stress test-case + * + * This is a lot big for a unit-test, but there is no other place + * to have it. + */ + +static void remove_dots(char *string) +{ + char *p = strchr(string, ':'); + if (p) + *p = '\0'; +} + +static QString *read_line(FILE *file, char *key) +{ + char value[128]; + + if (fscanf(file, "%127s%127s", key, value) == EOF) { + return NULL; + } + remove_dots(key); + return qstring_from_str(value); +} + +#define reset_file(file) fseek(file, 0L, SEEK_SET) + +static void qdict_stress_test(void) +{ + size_t lines; + char key[128]; + FILE *test_file; + QDict *qdict; + QString *value; + const char *test_file_path = "qdict-test-data.txt"; + + test_file = fopen(test_file_path, "r"); + g_assert(test_file != NULL); + + // Create the dict + qdict = qdict_new(); + g_assert(qdict != NULL); + + // Add everything from the test file + for (lines = 0;; lines++) { + value = read_line(test_file, key); + if (!value) + break; + + qdict_put(qdict, key, value); + } + g_assert(qdict_size(qdict) == lines); + + // Check if everything is really in there + reset_file(test_file); + for (;;) { + const char *str1, *str2; + + value = read_line(test_file, key); + if (!value) + break; + + str1 = qstring_get_str(value); + + str2 = qdict_get_str(qdict, key); + g_assert(str2 != NULL); + + g_assert(strcmp(str1, str2) == 0); + + qobject_unref(value); + } + + // Delete everything + reset_file(test_file); + for (;;) { + value = read_line(test_file, key); + if (!value) + break; + + qdict_del(qdict, key); + qobject_unref(value); + + g_assert(qdict_haskey(qdict, key) == 0); + } + fclose(test_file); + + g_assert(qdict_size(qdict) == 0); + qobject_unref(qdict); +} + +int main(int argc, char **argv) +{ + g_test_init(&argc, &argv, NULL); + + g_test_add_func("/public/new", qdict_new_test); + g_test_add_func("/public/put_obj", qdict_put_obj_test); + g_test_add_func("/public/destroy_simple", qdict_destroy_simple_test); + + /* Continue, but now with fixtures */ + g_test_add_func("/public/get", qdict_get_test); + g_test_add_func("/public/get_int", qdict_get_int_test); + g_test_add_func("/public/get_try_int", qdict_get_try_int_test); + g_test_add_func("/public/get_str", qdict_get_str_test); + g_test_add_func("/public/get_try_str", qdict_get_try_str_test); + g_test_add_func("/public/haskey_not", qdict_haskey_not_test); + g_test_add_func("/public/haskey", qdict_haskey_test); + g_test_add_func("/public/del", qdict_del_test); + g_test_add_func("/public/to_qdict", qobject_to_qdict_test); + g_test_add_func("/public/iterapi", qdict_iterapi_test); + + g_test_add_func("/errors/put_exists", qdict_put_exists_test); + g_test_add_func("/errors/get_not_exists", qdict_get_not_exists_test); + + /* The Big one */ + if (g_test_slow()) { + g_test_add_func("/stress/test", qdict_stress_test); + } + + return g_test_run(); +} -- 2.11.4.GIT