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 "qapi/qmp/qerror.h" 18 #include "qapi/visitor.h" 19 #include "qapi/visitor-impl.h" 20 #include "trace.h" 21 22 void visit_complete(Visitor *v, void *opaque) 23 { 24 assert(v->type != VISITOR_OUTPUT || v->complete); 25 trace_visit_complete(v, opaque); 26 if (v->complete) { 27 v->complete(v, opaque); 28 } 29 } 30 31 void visit_free(Visitor *v) 32 { 33 trace_visit_free(v); 34 if (v) { 35 v->free(v); 36 } 37 } 38 39 void visit_start_struct(Visitor *v, const char *name, void **obj, 40 size_t size, Error **errp) 41 { 42 Error *err = NULL; 43 44 trace_visit_start_struct(v, name, obj, size); 45 if (obj) { 46 assert(size); 47 assert(!(v->type & VISITOR_OUTPUT) || *obj); 48 } 49 v->start_struct(v, name, obj, size, &err); 50 if (obj && (v->type & VISITOR_INPUT)) { 51 assert(!err != !*obj); 52 } 53 error_propagate(errp, err); 54 } 55 56 void visit_check_struct(Visitor *v, Error **errp) 57 { 58 trace_visit_check_struct(v); 59 if (v->check_struct) { 60 v->check_struct(v, errp); 61 } 62 } 63 64 void visit_end_struct(Visitor *v, void **obj) 65 { 66 trace_visit_end_struct(v, obj); 67 v->end_struct(v, obj); 68 } 69 70 void visit_start_list(Visitor *v, const char *name, GenericList **list, 71 size_t size, Error **errp) 72 { 73 Error *err = NULL; 74 75 assert(!list || size >= sizeof(GenericList)); 76 trace_visit_start_list(v, name, list, size); 77 v->start_list(v, name, list, size, &err); 78 if (list && (v->type & VISITOR_INPUT)) { 79 assert(!(err && *list)); 80 } 81 error_propagate(errp, err); 82 } 83 84 GenericList *visit_next_list(Visitor *v, GenericList *tail, size_t size) 85 { 86 assert(tail && size >= sizeof(GenericList)); 87 trace_visit_next_list(v, tail, size); 88 return v->next_list(v, tail, size); 89 } 90 91 void visit_check_list(Visitor *v, Error **errp) 92 { 93 trace_visit_check_list(v); 94 if (v->check_list) { 95 v->check_list(v, errp); 96 } 97 } 98 99 void visit_end_list(Visitor *v, void **obj) 100 { 101 trace_visit_end_list(v, obj); 102 v->end_list(v, obj); 103 } 104 105 void visit_start_alternate(Visitor *v, const char *name, 106 GenericAlternate **obj, size_t size, 107 Error **errp) 108 { 109 Error *err = NULL; 110 111 assert(obj && size >= sizeof(GenericAlternate)); 112 assert(!(v->type & VISITOR_OUTPUT) || *obj); 113 trace_visit_start_alternate(v, name, obj, size); 114 if (v->start_alternate) { 115 v->start_alternate(v, name, obj, size, &err); 116 } 117 if (v->type & VISITOR_INPUT) { 118 assert(v->start_alternate && !err != !*obj); 119 } 120 error_propagate(errp, err); 121 } 122 123 void visit_end_alternate(Visitor *v, void **obj) 124 { 125 trace_visit_end_alternate(v, obj); 126 if (v->end_alternate) { 127 v->end_alternate(v, obj); 128 } 129 } 130 131 bool visit_optional(Visitor *v, const char *name, bool *present) 132 { 133 trace_visit_optional(v, name, present); 134 if (v->optional) { 135 v->optional(v, name, present); 136 } 137 return *present; 138 } 139 140 bool visit_is_input(Visitor *v) 141 { 142 return v->type == VISITOR_INPUT; 143 } 144 145 bool visit_is_dealloc(Visitor *v) 146 { 147 return v->type == VISITOR_DEALLOC; 148 } 149 150 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp) 151 { 152 assert(obj); 153 trace_visit_type_int(v, name, obj); 154 v->type_int64(v, name, obj, errp); 155 } 156 157 static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name, 158 uint64_t max, const char *type, Error **errp) 159 { 160 Error *err = NULL; 161 uint64_t value = *obj; 162 163 v->type_uint64(v, name, &value, &err); 164 if (err) { 165 error_propagate(errp, err); 166 } else if (value > max) { 167 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, 168 name ? name : "null", type); 169 } else { 170 *obj = value; 171 } 172 } 173 174 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj, 175 Error **errp) 176 { 177 uint64_t value; 178 179 trace_visit_type_uint8(v, name, obj); 180 value = *obj; 181 visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp); 182 *obj = value; 183 } 184 185 void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj, 186 Error **errp) 187 { 188 uint64_t value; 189 190 trace_visit_type_uint16(v, name, obj); 191 value = *obj; 192 visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp); 193 *obj = value; 194 } 195 196 void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj, 197 Error **errp) 198 { 199 uint64_t value; 200 201 trace_visit_type_uint32(v, name, obj); 202 value = *obj; 203 visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp); 204 *obj = value; 205 } 206 207 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj, 208 Error **errp) 209 { 210 assert(obj); 211 trace_visit_type_uint64(v, name, obj); 212 v->type_uint64(v, name, obj, errp); 213 } 214 215 static void visit_type_intN(Visitor *v, int64_t *obj, const char *name, 216 int64_t min, int64_t max, const char *type, 217 Error **errp) 218 { 219 Error *err = NULL; 220 int64_t value = *obj; 221 222 v->type_int64(v, name, &value, &err); 223 if (err) { 224 error_propagate(errp, err); 225 } else if (value < min || value > max) { 226 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, 227 name ? name : "null", type); 228 } else { 229 *obj = value; 230 } 231 } 232 233 void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp) 234 { 235 int64_t value; 236 237 trace_visit_type_int8(v, name, obj); 238 value = *obj; 239 visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp); 240 *obj = value; 241 } 242 243 void visit_type_int16(Visitor *v, const char *name, int16_t *obj, 244 Error **errp) 245 { 246 int64_t value; 247 248 trace_visit_type_int16(v, name, obj); 249 value = *obj; 250 visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp); 251 *obj = value; 252 } 253 254 void visit_type_int32(Visitor *v, const char *name, int32_t *obj, 255 Error **errp) 256 { 257 int64_t value; 258 259 trace_visit_type_int32(v, name, obj); 260 value = *obj; 261 visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp); 262 *obj = value; 263 } 264 265 void visit_type_int64(Visitor *v, const char *name, int64_t *obj, 266 Error **errp) 267 { 268 assert(obj); 269 trace_visit_type_int64(v, name, obj); 270 v->type_int64(v, name, obj, errp); 271 } 272 273 void visit_type_size(Visitor *v, const char *name, uint64_t *obj, 274 Error **errp) 275 { 276 assert(obj); 277 trace_visit_type_size(v, name, obj); 278 if (v->type_size) { 279 v->type_size(v, name, obj, errp); 280 } else { 281 v->type_uint64(v, name, obj, errp); 282 } 283 } 284 285 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp) 286 { 287 assert(obj); 288 trace_visit_type_bool(v, name, obj); 289 v->type_bool(v, name, obj, errp); 290 } 291 292 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp) 293 { 294 Error *err = NULL; 295 296 assert(obj); 297 /* TODO: Fix callers to not pass NULL when they mean "", so that we 298 * can enable: 299 assert(!(v->type & VISITOR_OUTPUT) || *obj); 300 */ 301 trace_visit_type_str(v, name, obj); 302 v->type_str(v, name, obj, &err); 303 if (v->type & VISITOR_INPUT) { 304 assert(!err != !*obj); 305 } 306 error_propagate(errp, err); 307 } 308 309 void visit_type_number(Visitor *v, const char *name, double *obj, 310 Error **errp) 311 { 312 assert(obj); 313 trace_visit_type_number(v, name, obj); 314 v->type_number(v, name, obj, errp); 315 } 316 317 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp) 318 { 319 Error *err = NULL; 320 321 assert(obj); 322 assert(v->type != VISITOR_OUTPUT || *obj); 323 trace_visit_type_any(v, name, obj); 324 v->type_any(v, name, obj, &err); 325 if (v->type == VISITOR_INPUT) { 326 assert(!err != !*obj); 327 } 328 error_propagate(errp, err); 329 } 330 331 void visit_type_null(Visitor *v, const char *name, QNull **obj, 332 Error **errp) 333 { 334 trace_visit_type_null(v, name, obj); 335 v->type_null(v, name, obj, errp); 336 } 337 338 static void output_type_enum(Visitor *v, const char *name, int *obj, 339 const QEnumLookup *lookup, Error **errp) 340 { 341 int value = *obj; 342 char *enum_str; 343 344 /* 345 * TODO why is this an error, not an assertion? If assertion: 346 * delete, and rely on qapi_enum_lookup() 347 */ 348 if (value < 0 || value >= lookup->size) { 349 error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null"); 350 return; 351 } 352 353 enum_str = (char *)qapi_enum_lookup(lookup, value); 354 visit_type_str(v, name, &enum_str, errp); 355 } 356 357 static void input_type_enum(Visitor *v, const char *name, int *obj, 358 const QEnumLookup *lookup, Error **errp) 359 { 360 Error *local_err = NULL; 361 int64_t value; 362 char *enum_str; 363 364 visit_type_str(v, name, &enum_str, &local_err); 365 if (local_err) { 366 error_propagate(errp, local_err); 367 return; 368 } 369 370 value = qapi_enum_parse(lookup, enum_str, -1, NULL); 371 if (value < 0) { 372 error_setg(errp, QERR_INVALID_PARAMETER, enum_str); 373 g_free(enum_str); 374 return; 375 } 376 377 g_free(enum_str); 378 *obj = value; 379 } 380 381 void visit_type_enum(Visitor *v, const char *name, int *obj, 382 const QEnumLookup *lookup, Error **errp) 383 { 384 assert(obj && lookup); 385 trace_visit_type_enum(v, name, obj); 386 switch (v->type) { 387 case VISITOR_INPUT: 388 input_type_enum(v, name, obj, lookup, errp); 389 break; 390 case VISITOR_OUTPUT: 391 output_type_enum(v, name, obj, lookup, errp); 392 break; 393 case VISITOR_CLONE: 394 /* nothing further to do, scalar value was already copied by 395 * g_memdup() during visit_start_*() */ 396 break; 397 case VISITOR_DEALLOC: 398 /* nothing to deallocate for a scalar */ 399 break; 400 } 401 } 402