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