qapi/qapi-visit-core.c

   1 /*
   2  * Core Definitions for QAPI Visitor Classes
   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 "qemu-common.h"
  18 #include "qapi/qmp/qobject.h"
  19 #include "qapi/qmp/qerror.h"
  20 #include "qapi/visitor.h"
  21 #include "qapi/visitor-impl.h"
  22
  23 void visit_start_struct(Visitor *v, const char *name, void **obj,
  24                         size_t size, Error **errp)
  25 {
  26     Error *err = NULL;
  27
  28     if (obj) {
  29         assert(size);
  30         assert(v->type != VISITOR_OUTPUT || *obj);
  31     }
  32     v->start_struct(v, name, obj, size, &err);
  33     if (obj && v->type == VISITOR_INPUT) {
  34         assert(!err != !*obj);
  35     }
  36     error_propagate(errp, err);
  37 }
  38
  39 void visit_end_struct(Visitor *v, Error **errp)
  40 {
  41     v->end_struct(v, errp);
  42 }
  43
  44 void visit_start_list(Visitor *v, const char *name, Error **errp)
  45 {
  46     v->start_list(v, name, errp);
  47 }
  48
  49 GenericList *visit_next_list(Visitor *v, GenericList **list, size_t size)
  50 {
  51     assert(list && size >= sizeof(GenericList));
  52     return v->next_list(v, list, size);
  53 }
  54
  55 void visit_end_list(Visitor *v)
  56 {
  57     v->end_list(v);
  58 }
  59
  60 void visit_start_alternate(Visitor *v, const char *name,
  61                            GenericAlternate **obj, size_t size,
  62                            bool promote_int, Error **errp)
  63 {
  64     Error *err = NULL;
  65
  66     assert(obj && size >= sizeof(GenericAlternate));
  67     assert(v->type != VISITOR_OUTPUT || *obj);
  68     if (v->start_alternate) {
  69         v->start_alternate(v, name, obj, size, promote_int, &err);
  70     }
  71     if (v->type == VISITOR_INPUT) {
  72         assert(v->start_alternate && !err != !*obj);
  73     }
  74     error_propagate(errp, err);
  75 }
  76
  77 void visit_end_alternate(Visitor *v)
  78 {
  79     if (v->end_alternate) {
  80         v->end_alternate(v);
  81     }
  82 }
  83
  84 bool visit_optional(Visitor *v, const char *name, bool *present)
  85 {
  86     if (v->optional) {
  87         v->optional(v, name, present);
  88     }
  89     return *present;
  90 }
  91
  92 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
  93 {
  94     assert(obj);
  95     v->type_int64(v, name, obj, errp);
  96 }
  97
  98 static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
  99                              uint64_t max, const char *type, Error **errp)
 100 {
 101     Error *err = NULL;
 102     uint64_t value = *obj;
 103
 104     v->type_uint64(v, name, &value, &err);
 105     if (err) {
 106         error_propagate(errp, err);
 107     } else if (value > max) {
 108         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
 109                    name ? name : "null", type);
 110     } else {
 111         *obj = value;
 112     }
 113 }
 114
 115 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
 116                       Error **errp)
 117 {
 118     uint64_t value = *obj;
 119     visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp);
 120     *obj = value;
 121 }
 122
 123 void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
 124                        Error **errp)
 125 {
 126     uint64_t value = *obj;
 127     visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp);
 128     *obj = value;
 129 }
 130
 131 void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
 132                        Error **errp)
 133 {
 134     uint64_t value = *obj;
 135     visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp);
 136     *obj = value;
 137 }
 138
 139 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
 140                        Error **errp)
 141 {
 142     assert(obj);
 143     v->type_uint64(v, name, obj, errp);
 144 }
 145
 146 static void visit_type_intN(Visitor *v, int64_t *obj, const char *name,
 147                             int64_t min, int64_t max, const char *type,
 148                             Error **errp)
 149 {
 150     Error *err = NULL;
 151     int64_t value = *obj;
 152
 153     v->type_int64(v, name, &value, &err);
 154     if (err) {
 155         error_propagate(errp, err);
 156     } else if (value < min || value > max) {
 157         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
 158                    name ? name : "null", type);
 159     } else {
 160         *obj = value;
 161     }
 162 }
 163
 164 void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp)
 165 {
 166     int64_t value = *obj;
 167     visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp);
 168     *obj = value;
 169 }
 170
 171 void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
 172                       Error **errp)
 173 {
 174     int64_t value = *obj;
 175     visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp);
 176     *obj = value;
 177 }
 178
 179 void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
 180                       Error **errp)
 181 {
 182     int64_t value = *obj;
 183     visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp);
 184     *obj = value;
 185 }
 186
 187 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
 188                       Error **errp)
 189 {
 190     assert(obj);
 191     v->type_int64(v, name, obj, errp);
 192 }
 193
 194 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
 195                      Error **errp)
 196 {
 197     assert(obj);
 198     if (v->type_size) {
 199         v->type_size(v, name, obj, errp);
 200     } else {
 201         v->type_uint64(v, name, obj, errp);
 202     }
 203 }
 204
 205 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
 206 {
 207     assert(obj);
 208     v->type_bool(v, name, obj, errp);
 209 }
 210
 211 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
 212 {
 213     Error *err = NULL;
 214
 215     assert(obj);
 216     /* TODO: Fix callers to not pass NULL when they mean "", so that we
 217      * can enable:
 218     assert(v->type != VISITOR_OUTPUT || *obj);
 219      */
 220     v->type_str(v, name, obj, &err);
 221     if (v->type == VISITOR_INPUT) {
 222         assert(!err != !*obj);
 223     }
 224     error_propagate(errp, err);
 225 }
 226
 227 void visit_type_number(Visitor *v, const char *name, double *obj,
 228                        Error **errp)
 229 {
 230     assert(obj);
 231     v->type_number(v, name, obj, errp);
 232 }
 233
 234 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
 235 {
 236     Error *err = NULL;
 237
 238     assert(obj);
 239     assert(v->type != VISITOR_OUTPUT || *obj);
 240     v->type_any(v, name, obj, &err);
 241     if (v->type == VISITOR_INPUT) {
 242         assert(!err != !*obj);
 243     }
 244     error_propagate(errp, err);
 245 }
 246
 247 static void output_type_enum(Visitor *v, const char *name, int *obj,
 248                              const char *const strings[], Error **errp)
 249 {
 250     int i = 0;
 251     int value = *obj;
 252     char *enum_str;
 253
 254     while (strings[i++] != NULL);
 255     if (value < 0 || value >= i - 1) {
 256         error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null");
 257         return;
 258     }
 259
 260     enum_str = (char *)strings[value];
 261     visit_type_str(v, name, &enum_str, errp);
 262 }
 263
 264 static void input_type_enum(Visitor *v, const char *name, int *obj,
 265                             const char *const strings[], Error **errp)
 266 {
 267     Error *local_err = NULL;
 268     int64_t value = 0;
 269     char *enum_str;
 270
 271     visit_type_str(v, name, &enum_str, &local_err);
 272     if (local_err) {
 273         error_propagate(errp, local_err);
 274         return;
 275     }
 276
 277     while (strings[value] != NULL) {
 278         if (strcmp(strings[value], enum_str) == 0) {
 279             break;
 280         }
 281         value++;
 282     }
 283
 284     if (strings[value] == NULL) {
 285         error_setg(errp, QERR_INVALID_PARAMETER, enum_str);
 286         g_free(enum_str);
 287         return;
 288     }
 289
 290     g_free(enum_str);
 291     *obj = value;
 292 }
 293
 294 void visit_type_enum(Visitor *v, const char *name, int *obj,
 295                      const char *const strings[], Error **errp)
 296 {
 297     assert(obj && strings);
 298     if (v->type == VISITOR_INPUT) {
 299         input_type_enum(v, name, obj, strings, errp);
 300     } else if (v->type == VISITOR_OUTPUT) {
 301         output_type_enum(v, name, obj, strings, errp);
 302     }
 303 }