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     if (qobject_type(obj) == QTYPE_QLIST) {
  68         qiv->stack[qiv->nb_stack].entry = qlist_first(qobject_to_qlist(obj));
  69     }
  70     qiv->nb_stack++;
  71
  72     if (qiv->nb_stack >= QIV_STACK_SIZE) {
  73         error_set(errp, QERR_BUFFER_OVERRUN);
  74         return;
  75     }
  76 }
  77
  78 static void qmp_input_pop(QmpInputVisitor *qiv, Error **errp)
  79 {
  80     assert(qiv->nb_stack > 0);
  81     qiv->nb_stack--;
  82 }
  83
  84 static void qmp_input_start_struct(Visitor *v, void **obj, const char *kind,
  85                                    const char *name, size_t size, Error **errp)
  86 {
  87     QmpInputVisitor *qiv = to_qiv(v);
  88     const QObject *qobj = qmp_input_get_object(qiv, name);
  89     Error *err = NULL;
  90
  91     if (!qobj || qobject_type(qobj) != QTYPE_QDICT) {
  92         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
  93                   "QDict");
  94         return;
  95     }
  96
  97     qmp_input_push(qiv, qobj, &err);
  98     if (err) {
  99         error_propagate(errp, err);
 100         return;
 101     }
 102
 103     if (obj) {
 104         *obj = g_malloc0(size);
 105     }
 106 }
 107
 108 static void qmp_input_end_struct(Visitor *v, Error **errp)
 109 {
 110     QmpInputVisitor *qiv = to_qiv(v);
 111
 112     qmp_input_pop(qiv, errp);
 113 }
 114
 115 static void qmp_input_start_list(Visitor *v, const char *name, Error **errp)
 116 {
 117     QmpInputVisitor *qiv = to_qiv(v);
 118     const QObject *qobj = qmp_input_get_object(qiv, name);
 119
 120     if (!qobj || qobject_type(qobj) != QTYPE_QLIST) {
 121         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 122                   "list");
 123         return;
 124     }
 125
 126     qmp_input_push(qiv, qobj, errp);
 127 }
 128
 129 static GenericList *qmp_input_next_list(Visitor *v, GenericList **list,
 130                                         Error **errp)
 131 {
 132     QmpInputVisitor *qiv = to_qiv(v);
 133     GenericList *entry;
 134     StackObject *so = &qiv->stack[qiv->nb_stack - 1];
 135
 136     if (so->entry == NULL) {
 137         return NULL;
 138     }
 139
 140     entry = g_malloc0(sizeof(*entry));
 141     if (*list) {
 142         so->entry = qlist_next(so->entry);
 143         if (so->entry == NULL) {
 144             g_free(entry);
 145             return NULL;
 146         }
 147         (*list)->next = entry;
 148     }
 149
 150     return entry;
 151 }
 152
 153 static void qmp_input_end_list(Visitor *v, Error **errp)
 154 {
 155     QmpInputVisitor *qiv = to_qiv(v);
 156
 157     qmp_input_pop(qiv, errp);
 158 }
 159
 160 static void qmp_input_type_int(Visitor *v, int64_t *obj, const char *name,
 161                                Error **errp)
 162 {
 163     QmpInputVisitor *qiv = to_qiv(v);
 164     const QObject *qobj = qmp_input_get_object(qiv, name);
 165
 166     if (!qobj || qobject_type(qobj) != QTYPE_QINT) {
 167         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 168                   "integer");
 169         return;
 170     }
 171
 172     *obj = qint_get_int(qobject_to_qint(qobj));
 173 }
 174
 175 static void qmp_input_type_bool(Visitor *v, bool *obj, const char *name,
 176                                 Error **errp)
 177 {
 178     QmpInputVisitor *qiv = to_qiv(v);
 179     const QObject *qobj = qmp_input_get_object(qiv, name);
 180
 181     if (!qobj || qobject_type(qobj) != QTYPE_QBOOL) {
 182         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 183                   "boolean");
 184         return;
 185     }
 186
 187     *obj = qbool_get_int(qobject_to_qbool(qobj));
 188 }
 189
 190 static void qmp_input_type_str(Visitor *v, char **obj, const char *name,
 191                                Error **errp)
 192 {
 193     QmpInputVisitor *qiv = to_qiv(v);
 194     const QObject *qobj = qmp_input_get_object(qiv, name);
 195
 196     if (!qobj || qobject_type(qobj) != QTYPE_QSTRING) {
 197         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 198                   "string");
 199         return;
 200     }
 201
 202     *obj = g_strdup(qstring_get_str(qobject_to_qstring(qobj)));
 203 }
 204
 205 static void qmp_input_type_number(Visitor *v, double *obj, const char *name,
 206                                   Error **errp)
 207 {
 208     QmpInputVisitor *qiv = to_qiv(v);
 209     const QObject *qobj = qmp_input_get_object(qiv, name);
 210
 211     if (!qobj || qobject_type(qobj) != QTYPE_QFLOAT) {
 212         error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 213                   "double");
 214         return;
 215     }
 216
 217     *obj = qfloat_get_double(qobject_to_qfloat(qobj));
 218 }
 219
 220 static void qmp_input_start_optional(Visitor *v, bool *present,
 221                                      const char *name, Error **errp)
 222 {
 223     QmpInputVisitor *qiv = to_qiv(v);
 224     const QObject *qobj = qmp_input_get_object(qiv, name);
 225
 226     if (!qobj) {
 227         *present = false;
 228         return;
 229     }
 230
 231     *present = true;
 232 }
 233
 234 Visitor *qmp_input_get_visitor(QmpInputVisitor *v)
 235 {
 236     return &v->visitor;
 237 }
 238
 239 void qmp_input_visitor_cleanup(QmpInputVisitor *v)
 240 {
 241     qobject_decref(v->obj);
 242     g_free(v);
 243 }
 244
 245 QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
 246 {
 247     QmpInputVisitor *v;
 248
 249     v = g_malloc0(sizeof(*v));
 250
 251     v->visitor.start_struct = qmp_input_start_struct;
 252     v->visitor.end_struct = qmp_input_end_struct;
 253     v->visitor.start_list = qmp_input_start_list;
 254     v->visitor.next_list = qmp_input_next_list;
 255     v->visitor.end_list = qmp_input_end_list;
 256     v->visitor.type_enum = input_type_enum;
 257     v->visitor.type_int = qmp_input_type_int;
 258     v->visitor.type_bool = qmp_input_type_bool;
 259     v->visitor.type_str = qmp_input_type_str;
 260     v->visitor.type_number = qmp_input_type_number;
 261     v->visitor.start_optional = qmp_input_start_optional;
 262
 263     v->obj = obj;
 264     qobject_incref(v->obj);
 265
 266     return v;
 267 }