qapi/qmp-input-visitor.c

   1 /*
   2  * Input Visitor
   3  *
   4  * Copyright IBM, Corp. 2011
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <aliguori@us.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
  10  * See the COPYING.LIB file in the top-level directory.
  11  *
  12  */
  13
  14 #include "qmp-input-visitor.h"
  15 #include "qapi/qapi-visit-impl.h"
  16 #include "qemu-queue.h"
  17 #include "qemu-common.h"
  18 #include "qemu-objects.h"
  19 #include "qerror.h"
  20
  21 #define QIV_STACK_SIZE 1024
  22
  23 typedef struct StackObject
  24 {
  25     const QObject *obj;
  26     const  QListEntry *entry;
  27 } StackObject;
  28
  29 struct QmpInputVisitor
  30 {
  31     Visitor visitor;
  32     QObject *obj;
  33     StackObject stack[QIV_STACK_SIZE];
  34     int nb_stack;
  35 };
  36
  37 static QmpInputVisitor *to_qiv(Visitor *v)
  38 {
  39     return container_of(v, QmpInputVisitor, visitor);
  40 }
  41
  42 static const QObject *qmp_input_get_object(QmpInputVisitor *qiv,
  43                                            const char *name)
  44 {
  45     const QObject *qobj;
  46
  47     if (qiv->nb_stack == 0) {
  48         qobj = qiv->obj;
  49     } else {
  50         qobj = qiv->stack[qiv->nb_stack - 1].obj;
  51     }
  52
  53     if (qobj) {
  54         if (name && qobject_type(qobj) == QTYPE_QDICT) {
  55             return qdict_get(qobject_to_qdict(qobj), name);
  56         } else if (qiv->nb_stack > 0 && qobject_type(qobj) == QTYPE_QLIST) {
  57             return qlist_entry_obj(qiv->stack[qiv->nb_stack - 1].entry);
  58         }
  59     }
  60
  61     return qobj;
  62 }
  63
  64 static void qmp_input_push(QmpInputVisitor *qiv, const QObject *obj, Error **errp)
  65 {
  66     qiv->stack[qiv->nb_stack].obj = obj;
  67     qiv->stack[qiv->nb_stack].entry = NULL;
  68     qiv->nb_stack++;
  69
  70     if (qiv->nb_stack >= QIV_STACK_SIZE) {
  71         error_set(errp, QERR_BUFFER_OVERRUN);
  72         return;
  73     }
  74 }
  75
  76 static void qmp_input_pop(QmpInputVisitor *qiv, Error **errp)
  77 {
  78     assert(qiv->nb_stack > 0);
  79     qiv->nb_stack--;
  80 }
  81
  82 static void qmp_input_start_struct(Visitor *v, void **obj, const char *kind,
  83                                    const char *name, size_t size, Error **errp)
  84 {
  85     QmpInputVisitor *qiv = to_qiv(v);
  86     const QObject *qobj = qmp_input_get_object(qiv, name);
  87     Error *err = NULL;
  88
  89     if (!qobj || qobject_type(qobj) != QTYPE_QDICT) {
  90         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
  91                   "QDict");
  92         return;
  93     }
  94
  95     qmp_input_push(qiv, qobj, &err);
  96     if (err) {
  97         error_propagate(errp, err);
  98         return;
  99     }
 100
 101     if (obj) {
 102         *obj = g_malloc0(size);
 103     }
 104 }
 105
 106 static void qmp_input_end_struct(Visitor *v, Error **errp)
 107 {
 108     QmpInputVisitor *qiv = to_qiv(v);
 109
 110     qmp_input_pop(qiv, errp);
 111 }
 112
 113 static void qmp_input_start_list(Visitor *v, const char *name, Error **errp)
 114 {
 115     QmpInputVisitor *qiv = to_qiv(v);
 116     const QObject *qobj = qmp_input_get_object(qiv, name);
 117
 118     if (!qobj || qobject_type(qobj) != QTYPE_QLIST) {
 119         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 120                   "list");
 121         return;
 122     }
 123
 124     qmp_input_push(qiv, qobj, errp);
 125 }
 126
 127 static GenericList *qmp_input_next_list(Visitor *v, GenericList **list,
 128                                         Error **errp)
 129 {
 130     QmpInputVisitor *qiv = to_qiv(v);
 131     GenericList *entry;
 132     StackObject *so = &qiv->stack[qiv->nb_stack - 1];
 133     bool first;
 134
 135     if (so->entry == NULL) {
 136         so->entry = qlist_first(qobject_to_qlist(so->obj));
 137         first = true;
 138     } else {
 139         so->entry = qlist_next(so->entry);
 140         first = false;
 141     }
 142
 143     if (so->entry == NULL) {
 144         return NULL;
 145     }
 146
 147     entry = g_malloc0(sizeof(*entry));
 148     if (first) {
 149         *list = entry;
 150     } else {
 151         (*list)->next = entry;
 152     }
 153
 154     return entry;
 155 }
 156
 157 static void qmp_input_end_list(Visitor *v, Error **errp)
 158 {
 159     QmpInputVisitor *qiv = to_qiv(v);
 160
 161     qmp_input_pop(qiv, errp);
 162 }
 163
 164 static void qmp_input_type_int(Visitor *v, int64_t *obj, const char *name,
 165                                Error **errp)
 166 {
 167     QmpInputVisitor *qiv = to_qiv(v);
 168     const QObject *qobj = qmp_input_get_object(qiv, name);
 169
 170     if (!qobj || qobject_type(qobj) != QTYPE_QINT) {
 171         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 172                   "integer");
 173         return;
 174     }
 175
 176     *obj = qint_get_int(qobject_to_qint(qobj));
 177 }
 178
 179 static void qmp_input_type_bool(Visitor *v, bool *obj, const char *name,
 180                                 Error **errp)
 181 {
 182     QmpInputVisitor *qiv = to_qiv(v);
 183     const QObject *qobj = qmp_input_get_object(qiv, name);
 184
 185     if (!qobj || qobject_type(qobj) != QTYPE_QBOOL) {
 186         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 187                   "boolean");
 188         return;
 189     }
 190
 191     *obj = qbool_get_int(qobject_to_qbool(qobj));
 192 }
 193
 194 static void qmp_input_type_str(Visitor *v, char **obj, const char *name,
 195                                Error **errp)
 196 {
 197     QmpInputVisitor *qiv = to_qiv(v);
 198     const QObject *qobj = qmp_input_get_object(qiv, name);
 199
 200     if (!qobj || qobject_type(qobj) != QTYPE_QSTRING) {
 201         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 202                   "string");
 203         return;
 204     }
 205
 206     *obj = g_strdup(qstring_get_str(qobject_to_qstring(qobj)));
 207 }
 208
 209 static void qmp_input_type_number(Visitor *v, double *obj, const char *name,
 210                                   Error **errp)
 211 {
 212     QmpInputVisitor *qiv = to_qiv(v);
 213     const QObject *qobj = qmp_input_get_object(qiv, name);
 214
 215     if (!qobj || qobject_type(qobj) != QTYPE_QFLOAT) {
 216         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 217                   "double");
 218         return;
 219     }
 220
 221     *obj = qfloat_get_double(qobject_to_qfloat(qobj));
 222 }
 223
 224 static void qmp_input_start_optional(Visitor *v, bool *present,
 225                                      const char *name, Error **errp)
 226 {
 227     QmpInputVisitor *qiv = to_qiv(v);
 228     const QObject *qobj = qmp_input_get_object(qiv, name);
 229
 230     if (!qobj) {
 231         *present = false;
 232         return;
 233     }
 234
 235     *present = true;
 236 }
 237
 238 Visitor *qmp_input_get_visitor(QmpInputVisitor *v)
 239 {
 240     return &v->visitor;
 241 }
 242
 243 void qmp_input_visitor_cleanup(QmpInputVisitor *v)
 244 {
 245     qobject_decref(v->obj);
 246     g_free(v);
 247 }
 248
 249 QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
 250 {
 251     QmpInputVisitor *v;
 252
 253     v = g_malloc0(sizeof(*v));
 254
 255     v->visitor.start_struct = qmp_input_start_struct;
 256     v->visitor.end_struct = qmp_input_end_struct;
 257     v->visitor.start_list = qmp_input_start_list;
 258     v->visitor.next_list = qmp_input_next_list;
 259     v->visitor.end_list = qmp_input_end_list;
 260     v->visitor.type_enum = input_type_enum;
 261     v->visitor.type_int = qmp_input_type_int;
 262     v->visitor.type_bool = qmp_input_type_bool;
 263     v->visitor.type_str = qmp_input_type_str;
 264     v->visitor.type_number = qmp_input_type_number;
 265     v->visitor.start_optional = qmp_input_start_optional;
 266
 267     v->obj = obj;
 268     qobject_incref(v->obj);
 269
 270     return v;
 271 }