/*
* Core Definitions for QAPI Visitor Classes
*
+ * Copyright (C) 2012-2016 Red Hat, Inc.
* Copyright IBM, Corp. 2011
*
* Authors:
*
*/
+#include "qemu/osdep.h"
+#include "qapi/error.h"
#include "qemu-common.h"
#include "qapi/qmp/qobject.h"
#include "qapi/qmp/qerror.h"
#include "qapi/visitor.h"
#include "qapi/visitor-impl.h"
+#include "trace.h"
-void visit_start_struct(Visitor *v, void **obj, const char *kind,
- const char *name, size_t size, Error **errp)
+void visit_complete(Visitor *v, void *opaque)
{
- v->start_struct(v, obj, kind, name, size, errp);
+ assert(v->type != VISITOR_OUTPUT || v->complete);
+ trace_visit_complete(v, opaque);
+ if (v->complete) {
+ v->complete(v, opaque);
+ }
}
-void visit_end_struct(Visitor *v, Error **errp)
+void visit_free(Visitor *v)
{
- v->end_struct(v, errp);
+ trace_visit_free(v);
+ if (v) {
+ v->free(v);
+ }
}
-void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
- Error **errp)
+void visit_start_struct(Visitor *v, const char *name, void **obj,
+ size_t size, Error **errp)
{
- if (v->start_implicit_struct) {
- v->start_implicit_struct(v, obj, size, errp);
+ Error *err = NULL;
+
+ trace_visit_start_struct(v, name, obj, size);
+ if (obj) {
+ assert(size);
+ assert(!(v->type & VISITOR_OUTPUT) || *obj);
}
+ v->start_struct(v, name, obj, size, &err);
+ if (obj && (v->type & VISITOR_INPUT)) {
+ assert(!err != !*obj);
+ }
+ error_propagate(errp, err);
}
-void visit_end_implicit_struct(Visitor *v, Error **errp)
+void visit_check_struct(Visitor *v, Error **errp)
{
- if (v->end_implicit_struct) {
- v->end_implicit_struct(v, errp);
+ trace_visit_check_struct(v);
+ if (v->check_struct) {
+ v->check_struct(v, errp);
}
}
-void visit_start_list(Visitor *v, const char *name, Error **errp)
+void visit_end_struct(Visitor *v, void **obj)
{
- v->start_list(v, name, errp);
+ trace_visit_end_struct(v, obj);
+ v->end_struct(v, obj);
}
-GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp)
+void visit_start_list(Visitor *v, const char *name, GenericList **list,
+ size_t size, Error **errp)
{
- return v->next_list(v, list, errp);
+ Error *err = NULL;
+
+ assert(!list || size >= sizeof(GenericList));
+ trace_visit_start_list(v, name, list, size);
+ v->start_list(v, name, list, size, &err);
+ if (list && (v->type & VISITOR_INPUT)) {
+ assert(!(err && *list));
+ }
+ error_propagate(errp, err);
}
-void visit_end_list(Visitor *v, Error **errp)
+GenericList *visit_next_list(Visitor *v, GenericList *tail, size_t size)
{
- v->end_list(v, errp);
+ assert(tail && size >= sizeof(GenericList));
+ trace_visit_next_list(v, tail, size);
+ return v->next_list(v, tail, size);
}
-bool visit_start_union(Visitor *v, bool data_present, Error **errp)
+void visit_check_list(Visitor *v, Error **errp)
{
- if (v->start_union) {
- return v->start_union(v, data_present, errp);
+ trace_visit_check_list(v);
+ if (v->check_list) {
+ v->check_list(v, errp);
}
- return true;
}
-void visit_end_union(Visitor *v, bool data_present, Error **errp)
+void visit_end_list(Visitor *v, void **obj)
{
- if (v->end_union) {
- v->end_union(v, data_present, errp);
- }
+ trace_visit_end_list(v, obj);
+ v->end_list(v, obj);
}
-void visit_optional(Visitor *v, bool *present, const char *name,
- Error **errp)
+void visit_start_alternate(Visitor *v, const char *name,
+ GenericAlternate **obj, size_t size,
+ Error **errp)
{
- if (v->optional) {
- v->optional(v, present, name, errp);
+ Error *err = NULL;
+
+ assert(obj && size >= sizeof(GenericAlternate));
+ assert(!(v->type & VISITOR_OUTPUT) || *obj);
+ trace_visit_start_alternate(v, name, obj, size);
+ if (v->start_alternate) {
+ v->start_alternate(v, name, obj, size, &err);
}
+ if (v->type & VISITOR_INPUT) {
+ assert(v->start_alternate && !err != !*obj);
+ }
+ error_propagate(errp, err);
}
-void visit_get_next_type(Visitor *v, int *obj, const int *qtypes,
- const char *name, Error **errp)
+void visit_end_alternate(Visitor *v, void **obj)
{
- if (v->get_next_type) {
- v->get_next_type(v, obj, qtypes, name, errp);
+ trace_visit_end_alternate(v, obj);
+ if (v->end_alternate) {
+ v->end_alternate(v, obj);
}
}
-void visit_type_enum(Visitor *v, int *obj, const char * const strings[],
- const char *kind, const char *name, Error **errp)
+bool visit_optional(Visitor *v, const char *name, bool *present)
{
- v->type_enum(v, obj, strings, kind, name, errp);
+ trace_visit_optional(v, name, present);
+ if (v->optional) {
+ v->optional(v, name, present);
+ }
+ return *present;
}
-void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
+bool visit_is_input(Visitor *v)
{
- v->type_int(v, obj, name, errp);
+ return v->type == VISITOR_INPUT;
}
-void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
+void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
{
- int64_t value;
+ assert(obj);
+ trace_visit_type_int(v, name, obj);
+ v->type_int64(v, name, obj, errp);
+}
- if (v->type_uint8) {
- v->type_uint8(v, obj, name, errp);
+static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
+ uint64_t max, const char *type, Error **errp)
+{
+ Error *err = NULL;
+ uint64_t value = *obj;
+
+ v->type_uint64(v, name, &value, &err);
+ if (err) {
+ error_propagate(errp, err);
+ } else if (value > max) {
+ error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
+ name ? name : "null", type);
} else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- if (value < 0 || value > UINT8_MAX) {
- error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
- name ? name : "null", "uint8_t");
- return;
- }
*obj = value;
}
}
-void visit_type_uint16(Visitor *v, uint16_t *obj, const char *name, Error **errp)
+void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
+ Error **errp)
{
- int64_t value;
+ uint64_t value;
- if (v->type_uint16) {
- v->type_uint16(v, obj, name, errp);
- } else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- if (value < 0 || value > UINT16_MAX) {
- error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
- name ? name : "null", "uint16_t");
- return;
- }
- *obj = value;
- }
+ trace_visit_type_uint8(v, name, obj);
+ value = *obj;
+ visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp);
+ *obj = value;
}
-void visit_type_uint32(Visitor *v, uint32_t *obj, const char *name, Error **errp)
+void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
+ Error **errp)
{
- int64_t value;
+ uint64_t value;
- if (v->type_uint32) {
- v->type_uint32(v, obj, name, errp);
- } else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- if (value < 0 || value > UINT32_MAX) {
- error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
- name ? name : "null", "uint32_t");
- return;
- }
- *obj = value;
- }
+ trace_visit_type_uint16(v, name, obj);
+ value = *obj;
+ visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp);
+ *obj = value;
}
-void visit_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp)
+void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
+ Error **errp)
{
- int64_t value;
+ uint64_t value;
- if (v->type_uint64) {
- v->type_uint64(v, obj, name, errp);
- } else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- *obj = value;
- }
+ trace_visit_type_uint32(v, name, obj);
+ value = *obj;
+ visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp);
+ *obj = value;
}
-void visit_type_int8(Visitor *v, int8_t *obj, const char *name, Error **errp)
+void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
+ Error **errp)
{
- int64_t value;
+ assert(obj);
+ trace_visit_type_uint64(v, name, obj);
+ v->type_uint64(v, name, obj, errp);
+}
- if (v->type_int8) {
- v->type_int8(v, obj, name, errp);
+static void visit_type_intN(Visitor *v, int64_t *obj, const char *name,
+ int64_t min, int64_t max, const char *type,
+ Error **errp)
+{
+ Error *err = NULL;
+ int64_t value = *obj;
+
+ v->type_int64(v, name, &value, &err);
+ if (err) {
+ error_propagate(errp, err);
+ } else if (value < min || value > max) {
+ error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
+ name ? name : "null", type);
} else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- if (value < INT8_MIN || value > INT8_MAX) {
- error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
- name ? name : "null", "int8_t");
- return;
- }
*obj = value;
}
}
-void visit_type_int16(Visitor *v, int16_t *obj, const char *name, Error **errp)
+void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp)
{
int64_t value;
- if (v->type_int16) {
- v->type_int16(v, obj, name, errp);
- } else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- if (value < INT16_MIN || value > INT16_MAX) {
- error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
- name ? name : "null", "int16_t");
- return;
- }
- *obj = value;
- }
+ trace_visit_type_int8(v, name, obj);
+ value = *obj;
+ visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp);
+ *obj = value;
}
-void visit_type_int32(Visitor *v, int32_t *obj, const char *name, Error **errp)
+void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
+ Error **errp)
{
int64_t value;
- if (v->type_int32) {
- v->type_int32(v, obj, name, errp);
- } else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- if (value < INT32_MIN || value > INT32_MAX) {
- error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
- name ? name : "null", "int32_t");
- return;
- }
- *obj = value;
- }
+ trace_visit_type_int16(v, name, obj);
+ value = *obj;
+ visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp);
+ *obj = value;
}
-void visit_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp)
+void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
+ Error **errp)
{
- if (v->type_int64) {
- v->type_int64(v, obj, name, errp);
- } else {
- v->type_int(v, obj, name, errp);
- }
+ int64_t value;
+
+ trace_visit_type_int32(v, name, obj);
+ value = *obj;
+ visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp);
+ *obj = value;
}
-void visit_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
+void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
+ Error **errp)
{
- int64_t value;
+ assert(obj);
+ trace_visit_type_int64(v, name, obj);
+ v->type_int64(v, name, obj, errp);
+}
+void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
+ Error **errp)
+{
+ assert(obj);
+ trace_visit_type_size(v, name, obj);
if (v->type_size) {
- v->type_size(v, obj, name, errp);
- } else if (v->type_uint64) {
- v->type_uint64(v, obj, name, errp);
+ v->type_size(v, name, obj, errp);
} else {
- value = *obj;
- v->type_int(v, &value, name, errp);
- *obj = value;
+ v->type_uint64(v, name, obj, errp);
}
}
-void visit_type_bool(Visitor *v, bool *obj, const char *name, Error **errp)
+void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
{
- v->type_bool(v, obj, name, errp);
+ assert(obj);
+ trace_visit_type_bool(v, name, obj);
+ v->type_bool(v, name, obj, errp);
}
-void visit_type_str(Visitor *v, char **obj, const char *name, Error **errp)
+void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
{
- v->type_str(v, obj, name, errp);
+ Error *err = NULL;
+
+ assert(obj);
+ /* TODO: Fix callers to not pass NULL when they mean "", so that we
+ * can enable:
+ assert(!(v->type & VISITOR_OUTPUT) || *obj);
+ */
+ trace_visit_type_str(v, name, obj);
+ v->type_str(v, name, obj, &err);
+ if (v->type & VISITOR_INPUT) {
+ assert(!err != !*obj);
+ }
+ error_propagate(errp, err);
}
-void visit_type_number(Visitor *v, double *obj, const char *name, Error **errp)
+void visit_type_number(Visitor *v, const char *name, double *obj,
+ Error **errp)
{
- v->type_number(v, obj, name, errp);
+ assert(obj);
+ trace_visit_type_number(v, name, obj);
+ v->type_number(v, name, obj, errp);
}
-void visit_type_any(Visitor *v, QObject **obj, const char *name,
- Error **errp)
+void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
{
- v->type_any(v, obj, name, errp);
+ Error *err = NULL;
+
+ assert(obj);
+ assert(v->type != VISITOR_OUTPUT || *obj);
+ trace_visit_type_any(v, name, obj);
+ v->type_any(v, name, obj, &err);
+ if (v->type == VISITOR_INPUT) {
+ assert(!err != !*obj);
+ }
+ error_propagate(errp, err);
}
-void output_type_enum(Visitor *v, int *obj, const char * const strings[],
- const char *kind, const char *name,
- Error **errp)
+void visit_type_null(Visitor *v, const char *name, QNull **obj,
+ Error **errp)
+{
+ trace_visit_type_null(v, name, obj);
+ v->type_null(v, name, obj, errp);
+}
+
+static void output_type_enum(Visitor *v, const char *name, int *obj,
+ const QEnumLookup *lookup, Error **errp)
{
- int i = 0;
int value = *obj;
char *enum_str;
- assert(strings);
- while (strings[i++] != NULL);
- if (value < 0 || value >= i - 1) {
+ /*
+ * TODO why is this an error, not an assertion? If assertion:
+ * delete, and rely on qapi_enum_lookup()
+ */
+ if (value < 0 || value >= lookup->size) {
error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null");
return;
}
- enum_str = (char *)strings[value];
- visit_type_str(v, &enum_str, name, errp);
+ enum_str = (char *)qapi_enum_lookup(lookup, value);
+ visit_type_str(v, name, &enum_str, errp);
}
-void input_type_enum(Visitor *v, int *obj, const char * const strings[],
- const char *kind, const char *name,
- Error **errp)
+static void input_type_enum(Visitor *v, const char *name, int *obj,
+ const QEnumLookup *lookup, Error **errp)
{
Error *local_err = NULL;
- int64_t value = 0;
+ int64_t value;
char *enum_str;
- assert(strings);
-
- visit_type_str(v, &enum_str, name, &local_err);
+ visit_type_str(v, name, &enum_str, &local_err);
if (local_err) {
error_propagate(errp, local_err);
return;
}
- while (strings[value] != NULL) {
- if (strcmp(strings[value], enum_str) == 0) {
- break;
- }
- value++;
- }
-
- if (strings[value] == NULL) {
+ value = qapi_enum_parse(lookup, enum_str, -1, NULL);
+ if (value < 0) {
error_setg(errp, QERR_INVALID_PARAMETER, enum_str);
g_free(enum_str);
return;
g_free(enum_str);
*obj = value;
}
+
+void visit_type_enum(Visitor *v, const char *name, int *obj,
+ const QEnumLookup *lookup, Error **errp)
+{
+ assert(obj && lookup);
+ trace_visit_type_enum(v, name, obj);
+ switch (v->type) {
+ case VISITOR_INPUT:
+ input_type_enum(v, name, obj, lookup, errp);
+ break;
+ case VISITOR_OUTPUT:
+ output_type_enum(v, name, obj, lookup, errp);
+ break;
+ case VISITOR_CLONE:
+ /* nothing further to do, scalar value was already copied by
+ * g_memdup() during visit_start_*() */
+ break;
+ case VISITOR_DEALLOC:
+ /* nothing to deallocate for a scalar */
+ break;
+ }
+}