qapi/qmp-input-visitor.c

   1 /*
   2  * Input Visitor
   3  *
   4  * Copyright (C) 2012-2016 Red Hat, Inc.
   5  * Copyright IBM, Corp. 2011
   6  *
   7  * Authors:
   8  *  Anthony Liguori   <aliguori@us.ibm.com>
   9  *
  10  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
  11  * See the COPYING.LIB file in the top-level directory.
  12  *
  13  */
  14
  15 #include "qemu/osdep.h"
  16 #include "qapi/error.h"
  17 #include "qapi/qmp-input-visitor.h"
  18 #include "qapi/visitor-impl.h"
  19 #include "qemu/queue.h"
  20 #include "qemu-common.h"
  21 #include "qapi/qmp/types.h"
  22 #include "qapi/qmp/qerror.h"
  23
  24 #define QIV_STACK_SIZE 1024
  25
  26 typedef struct StackObject
  27 {
  28     QObject *obj;
  29     const QListEntry *entry;
  30     GHashTable *h;
  31 } StackObject;
  32
  33 struct QmpInputVisitor
  34 {
  35     Visitor visitor;
  36     StackObject stack[QIV_STACK_SIZE];
  37     int nb_stack;
  38     bool strict;
  39 };
  40
  41 static QmpInputVisitor *to_qiv(Visitor *v)
  42 {
  43     return container_of(v, QmpInputVisitor, visitor);
  44 }
  45
  46 static QObject *qmp_input_get_object(QmpInputVisitor *qiv,
  47                                      const char *name,
  48                                      bool consume)
  49 {
  50     QObject *qobj = qiv->stack[qiv->nb_stack - 1].obj;
  51
  52     if (qobj) {
  53         if (name && qobject_type(qobj) == QTYPE_QDICT) {
  54             if (qiv->stack[qiv->nb_stack - 1].h && consume) {
  55                 g_hash_table_remove(qiv->stack[qiv->nb_stack - 1].h, name);
  56             }
  57             return qdict_get(qobject_to_qdict(qobj), name);
  58         } else if (qiv->stack[qiv->nb_stack - 1].entry) {
  59             return qlist_entry_obj(qiv->stack[qiv->nb_stack - 1].entry);
  60         }
  61     }
  62
  63     return qobj;
  64 }
  65
  66 static void qdict_add_key(const char *key, QObject *obj, void *opaque)
  67 {
  68     GHashTable *h = opaque;
  69     g_hash_table_insert(h, (gpointer) key, NULL);
  70 }
  71
  72 static void qmp_input_push(QmpInputVisitor *qiv, QObject *obj, Error **errp)
  73 {
  74     GHashTable *h;
  75
  76     if (qiv->nb_stack >= QIV_STACK_SIZE) {
  77         error_setg(errp, "An internal buffer overran");
  78         return;
  79     }
  80
  81     qiv->stack[qiv->nb_stack].obj = obj;
  82     qiv->stack[qiv->nb_stack].entry = NULL;
  83     qiv->stack[qiv->nb_stack].h = NULL;
  84
  85     if (qiv->strict && qobject_type(obj) == QTYPE_QDICT) {
  86         h = g_hash_table_new(g_str_hash, g_str_equal);
  87         qdict_iter(qobject_to_qdict(obj), qdict_add_key, h);
  88         qiv->stack[qiv->nb_stack].h = h;
  89     }
  90
  91     qiv->nb_stack++;
  92 }
  93
  94
  95 static void qmp_input_pop(QmpInputVisitor *qiv, Error **errp)
  96 {
  97     assert(qiv->nb_stack > 0);
  98
  99     if (qiv->strict) {
 100         GHashTable * const top_ht = qiv->stack[qiv->nb_stack - 1].h;
 101         if (top_ht) {
 102             GHashTableIter iter;
 103             const char *key;
 104
 105             g_hash_table_iter_init(&iter, top_ht);
 106             if (g_hash_table_iter_next(&iter, (void **)&key, NULL)) {
 107                 error_setg(errp, QERR_QMP_EXTRA_MEMBER, key);
 108             }
 109             g_hash_table_unref(top_ht);
 110         }
 111     }
 112
 113     qiv->nb_stack--;
 114 }
 115
 116 static void qmp_input_start_struct(Visitor *v, const char *name, void **obj,
 117                                    size_t size, Error **errp)
 118 {
 119     QmpInputVisitor *qiv = to_qiv(v);
 120     QObject *qobj = qmp_input_get_object(qiv, name, true);
 121     Error *err = NULL;
 122
 123     if (obj) {
 124         *obj = NULL;
 125     }
 126     if (!qobj || qobject_type(qobj) != QTYPE_QDICT) {
 127         error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 128                    "QDict");
 129         return;
 130     }
 131
 132     qmp_input_push(qiv, qobj, &err);
 133     if (err) {
 134         error_propagate(errp, err);
 135         return;
 136     }
 137
 138     if (obj) {
 139         *obj = g_malloc0(size);
 140     }
 141 }
 142
 143 static void qmp_input_end_struct(Visitor *v, Error **errp)
 144 {
 145     QmpInputVisitor *qiv = to_qiv(v);
 146
 147     qmp_input_pop(qiv, errp);
 148 }
 149
 150 static void qmp_input_start_list(Visitor *v, const char *name, Error **errp)
 151 {
 152     QmpInputVisitor *qiv = to_qiv(v);
 153     QObject *qobj = qmp_input_get_object(qiv, name, true);
 154
 155     if (!qobj || qobject_type(qobj) != QTYPE_QLIST) {
 156         error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 157                    "list");
 158         return;
 159     }
 160
 161     qmp_input_push(qiv, qobj, errp);
 162 }
 163
 164 static GenericList *qmp_input_next_list(Visitor *v, GenericList **list,
 165                                         size_t size)
 166 {
 167     QmpInputVisitor *qiv = to_qiv(v);
 168     GenericList *entry;
 169     StackObject *so = &qiv->stack[qiv->nb_stack - 1];
 170     bool first;
 171
 172     if (so->entry == NULL) {
 173         so->entry = qlist_first(qobject_to_qlist(so->obj));
 174         first = true;
 175     } else {
 176         so->entry = qlist_next(so->entry);
 177         first = false;
 178     }
 179
 180     if (so->entry == NULL) {
 181         return NULL;
 182     }
 183
 184     entry = g_malloc0(size);
 185     if (first) {
 186         *list = entry;
 187     } else {
 188         (*list)->next = entry;
 189     }
 190
 191     return entry;
 192 }
 193
 194 static void qmp_input_end_list(Visitor *v)
 195 {
 196     QmpInputVisitor *qiv = to_qiv(v);
 197
 198     qmp_input_pop(qiv, &error_abort);
 199 }
 200
 201 static void qmp_input_start_alternate(Visitor *v, const char *name,
 202                                       GenericAlternate **obj, size_t size,
 203                                       bool promote_int, Error **errp)
 204 {
 205     QmpInputVisitor *qiv = to_qiv(v);
 206     QObject *qobj = qmp_input_get_object(qiv, name, false);
 207
 208     if (!qobj) {
 209         *obj = NULL;
 210         error_setg(errp, QERR_MISSING_PARAMETER, name ? name : "null");
 211         return;
 212     }
 213     *obj = g_malloc0(size);
 214     (*obj)->type = qobject_type(qobj);
 215     if (promote_int && (*obj)->type == QTYPE_QINT) {
 216         (*obj)->type = QTYPE_QFLOAT;
 217     }
 218 }
 219
 220 static void qmp_input_type_int64(Visitor *v, const char *name, int64_t *obj,
 221                                  Error **errp)
 222 {
 223     QmpInputVisitor *qiv = to_qiv(v);
 224     QInt *qint = qobject_to_qint(qmp_input_get_object(qiv, name, true));
 225
 226     if (!qint) {
 227         error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 228                    "integer");
 229         return;
 230     }
 231
 232     *obj = qint_get_int(qint);
 233 }
 234
 235 static void qmp_input_type_uint64(Visitor *v, const char *name, uint64_t *obj,
 236                                   Error **errp)
 237 {
 238     /* FIXME: qobject_to_qint mishandles values over INT64_MAX */
 239     QmpInputVisitor *qiv = to_qiv(v);
 240     QInt *qint = qobject_to_qint(qmp_input_get_object(qiv, name, true));
 241
 242     if (!qint) {
 243         error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 244                    "integer");
 245         return;
 246     }
 247
 248     *obj = qint_get_int(qint);
 249 }
 250
 251 static void qmp_input_type_bool(Visitor *v, const char *name, bool *obj,
 252                                 Error **errp)
 253 {
 254     QmpInputVisitor *qiv = to_qiv(v);
 255     QBool *qbool = qobject_to_qbool(qmp_input_get_object(qiv, name, true));
 256
 257     if (!qbool) {
 258         error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 259                    "boolean");
 260         return;
 261     }
 262
 263     *obj = qbool_get_bool(qbool);
 264 }
 265
 266 static void qmp_input_type_str(Visitor *v, const char *name, char **obj,
 267                                Error **errp)
 268 {
 269     QmpInputVisitor *qiv = to_qiv(v);
 270     QString *qstr = qobject_to_qstring(qmp_input_get_object(qiv, name, true));
 271
 272     if (!qstr) {
 273         *obj = NULL;
 274         error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 275                    "string");
 276         return;
 277     }
 278
 279     *obj = g_strdup(qstring_get_str(qstr));
 280 }
 281
 282 static void qmp_input_type_number(Visitor *v, const char *name, double *obj,
 283                                   Error **errp)
 284 {
 285     QmpInputVisitor *qiv = to_qiv(v);
 286     QObject *qobj = qmp_input_get_object(qiv, name, true);
 287     QInt *qint;
 288     QFloat *qfloat;
 289
 290     qint = qobject_to_qint(qobj);
 291     if (qint) {
 292         *obj = qint_get_int(qobject_to_qint(qobj));
 293         return;
 294     }
 295
 296     qfloat = qobject_to_qfloat(qobj);
 297     if (qfloat) {
 298         *obj = qfloat_get_double(qobject_to_qfloat(qobj));
 299         return;
 300     }
 301
 302     error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 303                "number");
 304 }
 305
 306 static void qmp_input_type_any(Visitor *v, const char *name, QObject **obj,
 307                                Error **errp)
 308 {
 309     QmpInputVisitor *qiv = to_qiv(v);
 310     QObject *qobj = qmp_input_get_object(qiv, name, true);
 311
 312     qobject_incref(qobj);
 313     *obj = qobj;
 314 }
 315
 316 static void qmp_input_optional(Visitor *v, const char *name, bool *present)
 317 {
 318     QmpInputVisitor *qiv = to_qiv(v);
 319     QObject *qobj = qmp_input_get_object(qiv, name, true);
 320
 321     if (!qobj) {
 322         *present = false;
 323         return;
 324     }
 325
 326     *present = true;
 327 }
 328
 329 Visitor *qmp_input_get_visitor(QmpInputVisitor *v)
 330 {
 331     return &v->visitor;
 332 }
 333
 334 void qmp_input_visitor_cleanup(QmpInputVisitor *v)
 335 {
 336     qobject_decref(v->stack[0].obj);
 337     g_free(v);
 338 }
 339
 340 QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
 341 {
 342     QmpInputVisitor *v;
 343
 344     v = g_malloc0(sizeof(*v));
 345
 346     v->visitor.type = VISITOR_INPUT;
 347     v->visitor.start_struct = qmp_input_start_struct;
 348     v->visitor.end_struct = qmp_input_end_struct;
 349     v->visitor.start_list = qmp_input_start_list;
 350     v->visitor.next_list = qmp_input_next_list;
 351     v->visitor.end_list = qmp_input_end_list;
 352     v->visitor.start_alternate = qmp_input_start_alternate;
 353     v->visitor.type_int64 = qmp_input_type_int64;
 354     v->visitor.type_uint64 = qmp_input_type_uint64;
 355     v->visitor.type_bool = qmp_input_type_bool;
 356     v->visitor.type_str = qmp_input_type_str;
 357     v->visitor.type_number = qmp_input_type_number;
 358     v->visitor.type_any = qmp_input_type_any;
 359     v->visitor.optional = qmp_input_optional;
 360
 361     qmp_input_push(v, obj, NULL);
 362     qobject_incref(obj);
 363
 364     return v;
 365 }
 366
 367 QmpInputVisitor *qmp_input_visitor_new_strict(QObject *obj)
 368 {
 369     QmpInputVisitor *v;
 370
 371     v = qmp_input_visitor_new(obj);
 372     v->strict = true;
 373
 374     return v;
 375 }