blob: 6c13510a2bc72ee4b512fa525995fc7da908633a [file] [log] [blame]
Michael Roth2345c772011-07-19 14:50:32 -05001/*
2 * Core Definitions for QAPI Visitor Classes
3 *
Eric Blake7c91aab2016-01-29 06:48:48 -07004 * Copyright (C) 2012-2016 Red Hat, Inc.
Michael Roth2345c772011-07-19 14:50:32 -05005 * 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
Peter Maydellcbf21152016-01-29 17:49:57 +000015#include "qemu/osdep.h"
Markus Armbruster7ce5fc62021-10-28 12:25:19 +020016#include "qapi/compat-policy.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010017#include "qapi/error.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010018#include "qapi/qmp/qerror.h"
19#include "qapi/visitor.h"
20#include "qapi/visitor-impl.h"
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010021#include "trace.h"
Michael Roth2345c772011-07-19 14:50:32 -050022
Markus Armbrustered29bb22021-10-25 06:24:03 +020023/* Zero-initialization must result in default policy */
24QEMU_BUILD_BUG_ON(COMPAT_POLICY_INPUT_ACCEPT || COMPAT_POLICY_OUTPUT_ACCEPT);
25
26
Eric Blake3b098d52016-06-09 10:48:43 -060027void visit_complete(Visitor *v, void *opaque)
28{
29 assert(v->type != VISITOR_OUTPUT || v->complete);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010030 trace_visit_complete(v, opaque);
Eric Blake3b098d52016-06-09 10:48:43 -060031 if (v->complete) {
32 v->complete(v, opaque);
33 }
34}
35
Eric Blake2c0ef9f2016-06-09 10:48:35 -060036void visit_free(Visitor *v)
37{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010038 trace_visit_free(v);
Eric Blake2c0ef9f2016-06-09 10:48:35 -060039 if (v) {
40 v->free(v);
41 }
42}
43
Markus Armbruster012d4c92020-07-07 18:05:45 +020044bool visit_start_struct(Visitor *v, const char *name, void **obj,
Eric Blake337283d2016-01-29 06:48:57 -070045 size_t size, Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -050046{
Markus Armbruster7b3cb802020-07-07 18:06:09 +020047 bool ok;
Eric Blakee58d6952016-04-28 15:45:10 -060048
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010049 trace_visit_start_struct(v, name, obj, size);
Eric Blakeadfb2642016-04-28 15:45:20 -060050 if (obj) {
51 assert(size);
Eric Blakea15fcc32016-06-09 10:48:44 -060052 assert(!(v->type & VISITOR_OUTPUT) || *obj);
Eric Blakeadfb2642016-04-28 15:45:20 -060053 }
Markus Armbruster7b3cb802020-07-07 18:06:09 +020054 ok = v->start_struct(v, name, obj, size, errp);
Eric Blakea15fcc32016-06-09 10:48:44 -060055 if (obj && (v->type & VISITOR_INPUT)) {
Markus Armbruster7b3cb802020-07-07 18:06:09 +020056 assert(ok != !*obj);
Eric Blakee58d6952016-04-28 15:45:10 -060057 }
Markus Armbruster7b3cb802020-07-07 18:06:09 +020058 return ok;
Michael Roth2345c772011-07-19 14:50:32 -050059}
60
Markus Armbruster012d4c92020-07-07 18:05:45 +020061bool visit_check_struct(Visitor *v, Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -050062{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010063 trace_visit_check_struct(v);
Markus Armbruster012d4c92020-07-07 18:05:45 +020064 return v->check_struct ? v->check_struct(v, errp) : true;
Eric Blake15c2f662016-04-28 15:45:27 -060065}
66
Eric Blake1158bb22016-06-09 10:48:34 -060067void visit_end_struct(Visitor *v, void **obj)
Eric Blake15c2f662016-04-28 15:45:27 -060068{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010069 trace_visit_end_struct(v, obj);
Eric Blake1158bb22016-06-09 10:48:34 -060070 v->end_struct(v, obj);
Michael Roth2345c772011-07-19 14:50:32 -050071}
72
Markus Armbruster012d4c92020-07-07 18:05:45 +020073bool visit_start_list(Visitor *v, const char *name, GenericList **list,
Eric Blaked9f62dd2016-04-28 15:45:31 -060074 size_t size, Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -050075{
Markus Armbruster7b3cb802020-07-07 18:06:09 +020076 bool ok;
Eric Blaked9f62dd2016-04-28 15:45:31 -060077
78 assert(!list || size >= sizeof(GenericList));
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010079 trace_visit_start_list(v, name, list, size);
Markus Armbruster7b3cb802020-07-07 18:06:09 +020080 ok = v->start_list(v, name, list, size, errp);
Eric Blakea15fcc32016-06-09 10:48:44 -060081 if (list && (v->type & VISITOR_INPUT)) {
Markus Armbruster7b3cb802020-07-07 18:06:09 +020082 assert(ok || !*list);
Eric Blaked9f62dd2016-04-28 15:45:31 -060083 }
Markus Armbruster7b3cb802020-07-07 18:06:09 +020084 return ok;
Michael Roth2345c772011-07-19 14:50:32 -050085}
86
Eric Blaked9f62dd2016-04-28 15:45:31 -060087GenericList *visit_next_list(Visitor *v, GenericList *tail, size_t size)
Michael Roth2345c772011-07-19 14:50:32 -050088{
Eric Blaked9f62dd2016-04-28 15:45:31 -060089 assert(tail && size >= sizeof(GenericList));
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +010090 trace_visit_next_list(v, tail, size);
Eric Blaked9f62dd2016-04-28 15:45:31 -060091 return v->next_list(v, tail, size);
Michael Roth2345c772011-07-19 14:50:32 -050092}
93
Markus Armbruster012d4c92020-07-07 18:05:45 +020094bool visit_check_list(Visitor *v, Error **errp)
Markus Armbrustera4a1c702017-03-03 13:32:45 +010095{
96 trace_visit_check_list(v);
Markus Armbruster012d4c92020-07-07 18:05:45 +020097 return v->check_list ? v->check_list(v, errp) : true;
Markus Armbrustera4a1c702017-03-03 13:32:45 +010098}
99
Eric Blake1158bb22016-06-09 10:48:34 -0600100void visit_end_list(Visitor *v, void **obj)
Michael Roth2345c772011-07-19 14:50:32 -0500101{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100102 trace_visit_end_list(v, obj);
Eric Blake1158bb22016-06-09 10:48:34 -0600103 v->end_list(v, obj);
Michael Roth2345c772011-07-19 14:50:32 -0500104}
105
Markus Armbruster012d4c92020-07-07 18:05:45 +0200106bool visit_start_alternate(Visitor *v, const char *name,
Eric Blakedbf11922016-02-17 23:48:29 -0700107 GenericAlternate **obj, size_t size,
Marc-André Lureau60390d22017-06-07 20:35:59 +0400108 Error **errp)
Eric Blakedbf11922016-02-17 23:48:29 -0700109{
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200110 bool ok;
Eric Blakee58d6952016-04-28 15:45:10 -0600111
Eric Blakedbf11922016-02-17 23:48:29 -0700112 assert(obj && size >= sizeof(GenericAlternate));
Eric Blakea15fcc32016-06-09 10:48:44 -0600113 assert(!(v->type & VISITOR_OUTPUT) || *obj);
Marc-André Lureau60390d22017-06-07 20:35:59 +0400114 trace_visit_start_alternate(v, name, obj, size);
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200115 if (!v->start_alternate) {
116 assert(!(v->type & VISITOR_INPUT));
117 return true;
Eric Blakedbf11922016-02-17 23:48:29 -0700118 }
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200119 ok = v->start_alternate(v, name, obj, size, errp);
Eric Blakea15fcc32016-06-09 10:48:44 -0600120 if (v->type & VISITOR_INPUT) {
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200121 assert(ok != !*obj);
Eric Blakee58d6952016-04-28 15:45:10 -0600122 }
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200123 return ok;
Eric Blakedbf11922016-02-17 23:48:29 -0700124}
125
Eric Blake1158bb22016-06-09 10:48:34 -0600126void visit_end_alternate(Visitor *v, void **obj)
Eric Blakedbf11922016-02-17 23:48:29 -0700127{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100128 trace_visit_end_alternate(v, obj);
Eric Blakedbf11922016-02-17 23:48:29 -0700129 if (v->end_alternate) {
Eric Blake1158bb22016-06-09 10:48:34 -0600130 v->end_alternate(v, obj);
Eric Blakedbf11922016-02-17 23:48:29 -0700131 }
132}
133
Eric Blake51e72bc2016-01-29 06:48:54 -0700134bool visit_optional(Visitor *v, const char *name, bool *present)
Michael Roth2345c772011-07-19 14:50:32 -0500135{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100136 trace_visit_optional(v, name, present);
Markus Armbruster297a3642014-05-07 09:53:54 +0200137 if (v->optional) {
Eric Blake0b2a0d62016-01-29 06:48:56 -0700138 v->optional(v, name, present);
Michael Roth2345c772011-07-19 14:50:32 -0500139 }
Eric Blake29637a62015-12-01 22:20:53 -0700140 return *present;
Michael Roth2345c772011-07-19 14:50:32 -0500141}
142
Markus Armbrustera1307282021-10-28 12:25:16 +0200143bool visit_policy_reject(Visitor *v, const char *name,
144 unsigned special_features, Error **errp)
Markus Armbrusterdb291642021-03-18 16:55:18 +0100145{
Markus Armbrustera1307282021-10-28 12:25:16 +0200146 trace_visit_policy_reject(v, name);
147 if (v->policy_reject) {
148 return v->policy_reject(v, name, special_features, errp);
Markus Armbrusterdb291642021-03-18 16:55:18 +0100149 }
Markus Armbrustera1307282021-10-28 12:25:16 +0200150 return false;
Markus Armbrusterdb291642021-03-18 16:55:18 +0100151}
152
Markus Armbrustera1307282021-10-28 12:25:16 +0200153bool visit_policy_skip(Visitor *v, const char *name,
154 unsigned special_features)
Markus Armbruster91fa93e2021-03-18 16:55:11 +0100155{
Markus Armbrustera1307282021-10-28 12:25:16 +0200156 trace_visit_policy_skip(v, name);
157 if (v->policy_skip) {
158 return v->policy_skip(v, name, special_features);
Markus Armbruster91fa93e2021-03-18 16:55:11 +0100159 }
Markus Armbrustera1307282021-10-28 12:25:16 +0200160 return false;
Markus Armbruster91fa93e2021-03-18 16:55:11 +0100161}
162
Markus Armbrustered29bb22021-10-25 06:24:03 +0200163void visit_set_policy(Visitor *v, CompatPolicy *policy)
164{
165 v->compat_policy = *policy;
166}
167
Eric Blake68ab47e2016-04-28 15:45:32 -0600168bool visit_is_input(Visitor *v)
169{
170 return v->type == VISITOR_INPUT;
171}
172
Markus Armbruster8e08bf42020-04-24 10:43:29 +0200173bool visit_is_dealloc(Visitor *v)
174{
175 return v->type == VISITOR_DEALLOC;
176}
177
Markus Armbruster012d4c92020-07-07 18:05:45 +0200178bool visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -0500179{
Eric Blakeadfb2642016-04-28 15:45:20 -0600180 assert(obj);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100181 trace_visit_type_int(v, name, obj);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200182 return v->type_int64(v, name, obj, errp);
Michael Roth2345c772011-07-19 14:50:32 -0500183}
184
Markus Armbruster012d4c92020-07-07 18:05:45 +0200185static bool visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
Eric Blake04e070d2016-01-29 06:48:51 -0700186 uint64_t max, const char *type, Error **errp)
187{
Eric Blake04e070d2016-01-29 06:48:51 -0700188 uint64_t value = *obj;
189
Markus Armbrusterfaad5842020-04-24 10:43:32 +0200190 assert(v->type == VISITOR_INPUT || value <= max);
191
Markus Armbruster012d4c92020-07-07 18:05:45 +0200192 if (!v->type_uint64(v, name, &value, errp)) {
193 return false;
194 }
195 if (value > max) {
Markus Armbrusterfaad5842020-04-24 10:43:32 +0200196 assert(v->type == VISITOR_INPUT);
Eric Blake04e070d2016-01-29 06:48:51 -0700197 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
198 name ? name : "null", type);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200199 return false;
Eric Blake04e070d2016-01-29 06:48:51 -0700200 }
Markus Armbruster012d4c92020-07-07 18:05:45 +0200201 *obj = value;
202 return true;
Eric Blake04e070d2016-01-29 06:48:51 -0700203}
204
Markus Armbruster012d4c92020-07-07 18:05:45 +0200205bool visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
Eric Blake51e72bc2016-01-29 06:48:54 -0700206 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500207{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100208 uint64_t value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200209 bool ok;
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100210
211 trace_visit_type_uint8(v, name, obj);
212 value = *obj;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200213 ok = visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp);
Eric Blake04e070d2016-01-29 06:48:51 -0700214 *obj = value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200215 return ok;
Michael Roth4e27e812011-08-25 10:44:50 -0500216}
217
Markus Armbruster012d4c92020-07-07 18:05:45 +0200218bool visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
Eric Blake04e070d2016-01-29 06:48:51 -0700219 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500220{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100221 uint64_t value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200222 bool ok;
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100223
224 trace_visit_type_uint16(v, name, obj);
225 value = *obj;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200226 ok = visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp);
Eric Blake04e070d2016-01-29 06:48:51 -0700227 *obj = value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200228 return ok;
Michael Roth4e27e812011-08-25 10:44:50 -0500229}
230
Markus Armbruster012d4c92020-07-07 18:05:45 +0200231bool visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
Eric Blake04e070d2016-01-29 06:48:51 -0700232 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500233{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100234 uint64_t value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200235 bool ok;
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100236
237 trace_visit_type_uint32(v, name, obj);
238 value = *obj;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200239 ok = visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp);
Eric Blake04e070d2016-01-29 06:48:51 -0700240 *obj = value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200241 return ok;
Michael Roth4e27e812011-08-25 10:44:50 -0500242}
243
Markus Armbruster012d4c92020-07-07 18:05:45 +0200244bool visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
Eric Blake04e070d2016-01-29 06:48:51 -0700245 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500246{
Eric Blakeadfb2642016-04-28 15:45:20 -0600247 assert(obj);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100248 trace_visit_type_uint64(v, name, obj);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200249 return v->type_uint64(v, name, obj, errp);
Michael Roth4e27e812011-08-25 10:44:50 -0500250}
251
Markus Armbruster012d4c92020-07-07 18:05:45 +0200252static bool visit_type_intN(Visitor *v, int64_t *obj, const char *name,
Eric Blake04e070d2016-01-29 06:48:51 -0700253 int64_t min, int64_t max, const char *type,
254 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500255{
Eric Blake04e070d2016-01-29 06:48:51 -0700256 int64_t value = *obj;
Markus Armbruster297a3642014-05-07 09:53:54 +0200257
Markus Armbrusterfaad5842020-04-24 10:43:32 +0200258 assert(v->type == VISITOR_INPUT || (value >= min && value <= max));
259
Markus Armbruster012d4c92020-07-07 18:05:45 +0200260 if (!v->type_int64(v, name, &value, errp)) {
261 return false;
262 }
263 if (value < min || value > max) {
Markus Armbrusterfaad5842020-04-24 10:43:32 +0200264 assert(v->type == VISITOR_INPUT);
Eric Blake04e070d2016-01-29 06:48:51 -0700265 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
266 name ? name : "null", type);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200267 return false;
Michael Roth4e27e812011-08-25 10:44:50 -0500268 }
Markus Armbruster012d4c92020-07-07 18:05:45 +0200269 *obj = value;
270 return true;
Michael Roth4e27e812011-08-25 10:44:50 -0500271}
272
Markus Armbruster012d4c92020-07-07 18:05:45 +0200273bool visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp)
Eric Blake04e070d2016-01-29 06:48:51 -0700274{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100275 int64_t value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200276 bool ok;
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100277
278 trace_visit_type_int8(v, name, obj);
279 value = *obj;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200280 ok = visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp);
Eric Blake04e070d2016-01-29 06:48:51 -0700281 *obj = value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200282 return ok;
Eric Blake04e070d2016-01-29 06:48:51 -0700283}
284
Markus Armbruster012d4c92020-07-07 18:05:45 +0200285bool visit_type_int16(Visitor *v, const char *name, int16_t *obj,
Eric Blake51e72bc2016-01-29 06:48:54 -0700286 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500287{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100288 int64_t value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200289 bool ok;
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100290
291 trace_visit_type_int16(v, name, obj);
292 value = *obj;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200293 ok = visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t",
294 errp);
Eric Blake04e070d2016-01-29 06:48:51 -0700295 *obj = value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200296 return ok;
Michael Roth4e27e812011-08-25 10:44:50 -0500297}
298
Markus Armbruster012d4c92020-07-07 18:05:45 +0200299bool visit_type_int32(Visitor *v, const char *name, int32_t *obj,
Eric Blake51e72bc2016-01-29 06:48:54 -0700300 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500301{
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100302 int64_t value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200303 bool ok;
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100304
305 trace_visit_type_int32(v, name, obj);
306 value = *obj;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200307 ok = visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t",
308 errp);
Eric Blake04e070d2016-01-29 06:48:51 -0700309 *obj = value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200310 return ok;
Michael Roth4e27e812011-08-25 10:44:50 -0500311}
312
Markus Armbruster012d4c92020-07-07 18:05:45 +0200313bool visit_type_int64(Visitor *v, const char *name, int64_t *obj,
Eric Blake51e72bc2016-01-29 06:48:54 -0700314 Error **errp)
Michael Roth4e27e812011-08-25 10:44:50 -0500315{
Eric Blakeadfb2642016-04-28 15:45:20 -0600316 assert(obj);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100317 trace_visit_type_int64(v, name, obj);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200318 return v->type_int64(v, name, obj, errp);
Michael Roth4e27e812011-08-25 10:44:50 -0500319}
320
Markus Armbruster012d4c92020-07-07 18:05:45 +0200321bool visit_type_size(Visitor *v, const char *name, uint64_t *obj,
Eric Blake51e72bc2016-01-29 06:48:54 -0700322 Error **errp)
Laszlo Ersek092705d2012-07-17 16:17:07 +0200323{
Eric Blakeadfb2642016-04-28 15:45:20 -0600324 assert(obj);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100325 trace_visit_type_size(v, name, obj);
Markus Armbruster297a3642014-05-07 09:53:54 +0200326 if (v->type_size) {
Markus Armbruster012d4c92020-07-07 18:05:45 +0200327 return v->type_size(v, name, obj, errp);
Laszlo Ersek092705d2012-07-17 16:17:07 +0200328 }
Markus Armbruster012d4c92020-07-07 18:05:45 +0200329 return v->type_uint64(v, name, obj, errp);
Laszlo Ersek092705d2012-07-17 16:17:07 +0200330}
331
Markus Armbruster012d4c92020-07-07 18:05:45 +0200332bool visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -0500333{
Eric Blakeadfb2642016-04-28 15:45:20 -0600334 assert(obj);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100335 trace_visit_type_bool(v, name, obj);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200336 return v->type_bool(v, name, obj, errp);
Michael Roth2345c772011-07-19 14:50:32 -0500337}
338
Markus Armbruster012d4c92020-07-07 18:05:45 +0200339bool visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -0500340{
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200341 bool ok;
Eric Blakee58d6952016-04-28 15:45:10 -0600342
343 assert(obj);
Eric Blakeadfb2642016-04-28 15:45:20 -0600344 /* TODO: Fix callers to not pass NULL when they mean "", so that we
345 * can enable:
Eric Blakea15fcc32016-06-09 10:48:44 -0600346 assert(!(v->type & VISITOR_OUTPUT) || *obj);
Eric Blakeadfb2642016-04-28 15:45:20 -0600347 */
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100348 trace_visit_type_str(v, name, obj);
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200349 ok = v->type_str(v, name, obj, errp);
Eric Blakea15fcc32016-06-09 10:48:44 -0600350 if (v->type & VISITOR_INPUT) {
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200351 assert(ok != !*obj);
Eric Blakee58d6952016-04-28 15:45:10 -0600352 }
Markus Armbruster7b3cb802020-07-07 18:06:09 +0200353 return ok;
Michael Roth2345c772011-07-19 14:50:32 -0500354}
355
Markus Armbruster012d4c92020-07-07 18:05:45 +0200356bool visit_type_number(Visitor *v, const char *name, double *obj,
Eric Blake51e72bc2016-01-29 06:48:54 -0700357 Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -0500358{
Eric Blakeadfb2642016-04-28 15:45:20 -0600359 assert(obj);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100360 trace_visit_type_number(v, name, obj);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200361 return v->type_number(v, name, obj, errp);
Michael Roth2345c772011-07-19 14:50:32 -0500362}
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100363
Markus Armbruster012d4c92020-07-07 18:05:45 +0200364bool visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
Markus Armbruster28770e02015-09-16 13:06:24 +0200365{
Markus Armbruster012d4c92020-07-07 18:05:45 +0200366 bool ok;
Eric Blakee58d6952016-04-28 15:45:10 -0600367
368 assert(obj);
Eric Blakeadfb2642016-04-28 15:45:20 -0600369 assert(v->type != VISITOR_OUTPUT || *obj);
Daniel P. Berrangeebfd93b2016-09-30 15:45:26 +0100370 trace_visit_type_any(v, name, obj);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200371 ok = v->type_any(v, name, obj, errp);
Eric Blakee58d6952016-04-28 15:45:10 -0600372 if (v->type == VISITOR_INPUT) {
Markus Armbruster012d4c92020-07-07 18:05:45 +0200373 assert(ok != !*obj);
Eric Blakee58d6952016-04-28 15:45:10 -0600374 }
Markus Armbruster012d4c92020-07-07 18:05:45 +0200375 return ok;
Markus Armbruster28770e02015-09-16 13:06:24 +0200376}
377
Markus Armbruster012d4c92020-07-07 18:05:45 +0200378bool visit_type_null(Visitor *v, const char *name, QNull **obj,
Markus Armbrusterd2f95f42017-06-26 18:22:59 +0200379 Error **errp)
Eric Blake3bc97fd2016-04-28 15:45:22 -0600380{
Markus Armbrusterd2f95f42017-06-26 18:22:59 +0200381 trace_visit_type_null(v, name, obj);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200382 return v->type_null(v, name, obj, errp);
Eric Blake3bc97fd2016-04-28 15:45:22 -0600383}
384
Markus Armbruster012d4c92020-07-07 18:05:45 +0200385static bool output_type_enum(Visitor *v, const char *name, int *obj,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200386 const QEnumLookup *lookup, Error **errp)
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100387{
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100388 int value = *obj;
389 char *enum_str;
390
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200391 enum_str = (char *)qapi_enum_lookup(lookup, value);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200392 return visit_type_str(v, name, &enum_str, errp);
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100393}
394
Markus Armbruster012d4c92020-07-07 18:05:45 +0200395static bool input_type_enum(Visitor *v, const char *name, int *obj,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200396 const QEnumLookup *lookup, Error **errp)
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100397{
Markus Armbruster113e47a2017-08-24 10:46:05 +0200398 int64_t value;
Markus Armbrusteraa237042021-10-25 06:24:04 +0200399 g_autofree char *enum_str = NULL;
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100400
Markus Armbruster012d4c92020-07-07 18:05:45 +0200401 if (!visit_type_str(v, name, &enum_str, errp)) {
402 return false;
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100403 }
404
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200405 value = qapi_enum_parse(lookup, enum_str, -1, NULL);
Markus Armbruster113e47a2017-08-24 10:46:05 +0200406 if (value < 0) {
Markus Armbrusterea293312021-10-20 20:02:31 +0200407 error_setg(errp, "Parameter '%s' does not accept value '%s'",
408 name ? name : "null", enum_str);
Markus Armbruster012d4c92020-07-07 18:05:45 +0200409 return false;
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100410 }
411
Markus Armbrusterc8688762021-10-28 12:25:18 +0200412 if (lookup->special_features
Markus Armbruster7ce5fc62021-10-28 12:25:19 +0200413 && !compat_policy_input_ok(lookup->special_features[value],
414 &v->compat_policy,
415 ERROR_CLASS_GENERIC_ERROR,
416 "value", enum_str, errp)) {
417 return false;
Markus Armbrusteraa237042021-10-25 06:24:04 +0200418 }
419
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100420 *obj = value;
Markus Armbruster012d4c92020-07-07 18:05:45 +0200421 return true;
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100422}
Eric Blake983f52d2016-04-28 15:45:09 -0600423
Markus Armbruster012d4c92020-07-07 18:05:45 +0200424bool visit_type_enum(Visitor *v, const char *name, int *obj,
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200425 const QEnumLookup *lookup, Error **errp)
Eric Blake983f52d2016-04-28 15:45:09 -0600426{
Marc-André Lureauf7abe0e2017-08-24 10:46:10 +0200427 assert(obj && lookup);
Stefan Hajnoczi65145322017-01-26 17:16:12 +0000428 trace_visit_type_enum(v, name, obj);
Eric Blakea15fcc32016-06-09 10:48:44 -0600429 switch (v->type) {
430 case VISITOR_INPUT:
Markus Armbruster012d4c92020-07-07 18:05:45 +0200431 return input_type_enum(v, name, obj, lookup, errp);
Eric Blakea15fcc32016-06-09 10:48:44 -0600432 case VISITOR_OUTPUT:
Markus Armbruster012d4c92020-07-07 18:05:45 +0200433 return output_type_enum(v, name, obj, lookup, errp);
Eric Blakea15fcc32016-06-09 10:48:44 -0600434 case VISITOR_CLONE:
435 /* nothing further to do, scalar value was already copied by
436 * g_memdup() during visit_start_*() */
Markus Armbruster012d4c92020-07-07 18:05:45 +0200437 return true;
Eric Blakea15fcc32016-06-09 10:48:44 -0600438 case VISITOR_DEALLOC:
439 /* nothing to deallocate for a scalar */
Markus Armbruster012d4c92020-07-07 18:05:45 +0200440 return true;
441 default:
442 abort();
Eric Blake983f52d2016-04-28 15:45:09 -0600443 }
444}