mirror of
https://github.com/yuzu-emu/unicorn.git
synced 2024-12-23 13:05:28 +00:00
5dd5646a9a
JSON uses "name":value, but many of our visitor interfaces were called with visit_type_FOO(v, &value, name, errp). This can be a bit confusing to have to mentally swap the parameter order to match JSON order. It's particularly bad for visit_start_struct(), where the 'name' parameter is smack in the middle of the otherwise-related group of 'obj, kind, size' parameters! It's time to do a global swap of the parameter ordering, so that the 'name' parameter is always immediately after the Visitor argument. Additional reason in favor of the swap: the existing include/qjson.h prefers listing 'name' first in json_prop_*(), and I have plans to unify that file with the qapi visitors; listing 'name' first in qapi will minimize churn to the (admittedly few) qjson.h clients. Later patches will then fix docs, object.h, visitor-impl.h, and those clients to match. Done by first patching scripts/qapi*.py by hand to make generated files do what I want, then by running the following Coccinelle script to affect the rest of the code base: $ spatch --sp-file script `git grep -l '\bvisit_' -- '**/*.[ch]'` I then had to apply some touchups (Coccinelle insisted on TAB indentation in visitor.h, and botched the signature of visit_type_enum() by rewriting 'const char *const strings[]' to the syntactically invalid 'const char*const[] strings'). The movement of parameters is sufficient to provoke compiler errors if any callers were missed. // Part 1: Swap declaration order @@ type TV, TErr, TObj, T1, T2; identifier OBJ, ARG1, ARG2; @@ void visit_start_struct -(TV v, TObj OBJ, T1 ARG1, const char *name, T2 ARG2, TErr errp) +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp) { ... } @@ type bool, TV, T1; identifier ARG1; @@ bool visit_optional -(TV v, T1 ARG1, const char *name) +(TV v, const char *name, T1 ARG1) { ... } @@ type TV, TErr, TObj, T1; identifier OBJ, ARG1; @@ void visit_get_next_type -(TV v, TObj OBJ, T1 ARG1, const char *name, TErr errp) +(TV v, const char *name, TObj OBJ, T1 ARG1, TErr errp) { ... } @@ type TV, TErr, TObj, T1, T2; identifier OBJ, ARG1, ARG2; @@ void visit_type_enum -(TV v, TObj OBJ, T1 ARG1, T2 ARG2, const char *name, TErr errp) +(TV v, const char *name, TObj OBJ, T1 ARG1, T2 ARG2, TErr errp) { ... } @@ type TV, TErr, TObj; identifier OBJ; identifier VISIT_TYPE =~ "^visit_type_"; @@ void VISIT_TYPE -(TV v, TObj OBJ, const char *name, TErr errp) +(TV v, const char *name, TObj OBJ, TErr errp) { ... } // Part 2: swap caller order @@ expression V, NAME, OBJ, ARG1, ARG2, ERR; identifier VISIT_TYPE =~ "^visit_type_"; @@ ( -visit_start_struct(V, OBJ, ARG1, NAME, ARG2, ERR) +visit_start_struct(V, NAME, OBJ, ARG1, ARG2, ERR) | -visit_optional(V, ARG1, NAME) +visit_optional(V, NAME, ARG1) | -visit_get_next_type(V, OBJ, ARG1, NAME, ERR) +visit_get_next_type(V, NAME, OBJ, ARG1, ERR) | -visit_type_enum(V, OBJ, ARG1, ARG2, NAME, ERR) +visit_type_enum(V, NAME, OBJ, ARG1, ARG2, ERR) | -VISIT_TYPE(V, OBJ, NAME, ERR) +VISIT_TYPE(V, NAME, OBJ, ERR) ) Backports commit 51e72bc1dd6ace6e91d675f41a1f09bd00ab8043 from qemu
319 lines
8 KiB
C
319 lines
8 KiB
C
/*
|
|
* Core Definitions for QAPI Visitor Classes
|
|
*
|
|
* Copyright (C) 2012-2016 Red Hat, Inc.
|
|
* Copyright IBM, Corp. 2011
|
|
*
|
|
*
|
|
* Authors:
|
|
* Anthony Liguori <aliguori@us.ibm.com>
|
|
*
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
*
|
|
*/
|
|
|
|
#include "qemu/osdep.h"
|
|
#include "qemu-common.h"
|
|
#include "qapi/qmp/qobject.h"
|
|
#include "qapi/qmp/qerror.h"
|
|
#include "qapi/visitor.h"
|
|
#include "qapi/visitor-impl.h"
|
|
|
|
void visit_start_struct(Visitor *v, const char *name, void **obj,
|
|
const char *kind, size_t size, Error **errp)
|
|
{
|
|
v->start_struct(v, obj, kind, name, size, errp);
|
|
}
|
|
|
|
void visit_end_struct(Visitor *v, Error **errp)
|
|
{
|
|
v->end_struct(v, errp);
|
|
}
|
|
|
|
void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
|
|
Error **errp)
|
|
{
|
|
if (v->start_implicit_struct) {
|
|
v->start_implicit_struct(v, obj, size, errp);
|
|
}
|
|
}
|
|
|
|
void visit_end_implicit_struct(Visitor *v)
|
|
{
|
|
if (v->end_implicit_struct) {
|
|
v->end_implicit_struct(v);
|
|
}
|
|
}
|
|
|
|
void visit_start_list(Visitor *v, const char *name, Error **errp)
|
|
{
|
|
v->start_list(v, name, errp);
|
|
}
|
|
|
|
GenericList *visit_next_list(Visitor *v, GenericList **list)
|
|
{
|
|
return v->next_list(v, list);
|
|
}
|
|
|
|
void visit_end_list(Visitor *v)
|
|
{
|
|
v->end_list(v);
|
|
}
|
|
|
|
bool visit_start_union(Visitor *v, bool data_present, Error **errp)
|
|
{
|
|
if (v->start_union) {
|
|
return v->start_union(v, data_present, errp);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool visit_optional(Visitor *v, const char *name, bool *present)
|
|
{
|
|
if (v->optional) {
|
|
v->optional(v, present, name);
|
|
}
|
|
return *present;
|
|
}
|
|
|
|
void visit_get_next_type(Visitor *v, const char *name, QType *type,
|
|
bool promote_int, Error **errp)
|
|
{
|
|
if (v->get_next_type) {
|
|
v->get_next_type(v, type, promote_int, name, errp);
|
|
}
|
|
}
|
|
|
|
void visit_type_enum(Visitor *v, const char *name, int *obj,
|
|
const char *const strings[], const char *kind,
|
|
Error **errp)
|
|
{
|
|
v->type_enum(v, obj, strings, kind, name, errp);
|
|
}
|
|
|
|
void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
|
|
{
|
|
v->type_int64(v, obj, name, errp);
|
|
}
|
|
|
|
void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
|
|
Error **errp)
|
|
{
|
|
uint64_t value;
|
|
|
|
if (v->type_uint8) {
|
|
v->type_uint8(v, obj, name, errp);
|
|
} else {
|
|
value = *obj;
|
|
v->type_uint64(v, &value, name, errp);
|
|
if (value > UINT8_MAX) {
|
|
/* FIXME questionable reuse of errp if callback changed
|
|
value on error */
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
|
|
name ? name : "null", "uint8_t");
|
|
return;
|
|
}
|
|
*obj = (uint8_t)value;
|
|
}
|
|
}
|
|
|
|
void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
|
|
Error **errp)
|
|
{
|
|
uint64_t value;
|
|
|
|
if (v->type_uint16) {
|
|
v->type_uint16(v, obj, name, errp);
|
|
} else {
|
|
value = *obj;
|
|
v->type_uint64(v, &value, name, errp);
|
|
if (value > UINT16_MAX) {
|
|
/* FIXME questionable reuse of errp if callback changed
|
|
value on error */
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
|
|
name ? name : "null", "uint16_t");
|
|
return;
|
|
}
|
|
*obj = (uint16_t)value;
|
|
}
|
|
}
|
|
|
|
void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
|
|
Error **errp)
|
|
{
|
|
uint64_t value;
|
|
|
|
if (v->type_uint32) {
|
|
v->type_uint32(v, obj, name, errp);
|
|
} else {
|
|
value = *obj;
|
|
v->type_uint64(v, &value, name, errp);
|
|
if (value > UINT32_MAX) {
|
|
/* FIXME questionable reuse of errp if callback changed
|
|
value on error */
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
|
|
name ? name : "null", "uint32_t");
|
|
return;
|
|
}
|
|
*obj = (uint32_t)value;
|
|
}
|
|
}
|
|
|
|
void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
|
|
Error **errp)
|
|
{
|
|
v->type_uint64(v, obj, name, errp);
|
|
}
|
|
|
|
void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp)
|
|
{
|
|
int64_t value;
|
|
|
|
if (v->type_int8) {
|
|
v->type_int8(v, obj, name, errp);
|
|
} else {
|
|
value = *obj;
|
|
v->type_int64(v, &value, name, errp);
|
|
if (value < INT8_MIN || value > INT8_MAX) {
|
|
/* FIXME questionable reuse of errp if callback changed
|
|
value on error */
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
|
|
name ? name : "null", "int8_t");
|
|
return;
|
|
}
|
|
*obj = (int8_t)value;
|
|
}
|
|
}
|
|
|
|
void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
|
|
Error **errp)
|
|
{
|
|
int64_t value;
|
|
|
|
if (v->type_int16) {
|
|
v->type_int16(v, obj, name, errp);
|
|
} else {
|
|
value = *obj;
|
|
v->type_int64(v, &value, name, errp);
|
|
if (value < INT16_MIN || value > INT16_MAX) {
|
|
/* FIXME questionable reuse of errp if callback changed
|
|
value on error */
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
|
|
name ? name : "null", "int16_t");
|
|
return;
|
|
}
|
|
*obj = (int16_t)value;
|
|
}
|
|
}
|
|
|
|
void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
|
|
Error **errp)
|
|
{
|
|
int64_t value;
|
|
|
|
if (v->type_int32) {
|
|
v->type_int32(v, obj, name, errp);
|
|
} else {
|
|
value = *obj;
|
|
v->type_int64(v, &value, name, errp);
|
|
if (value < INT32_MIN || value > INT32_MAX) {
|
|
/* FIXME questionable reuse of errp if callback changed
|
|
value on error */
|
|
error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
|
|
name ? name : "null", "int32_t");
|
|
return;
|
|
}
|
|
*obj = (int32_t)value;
|
|
}
|
|
}
|
|
|
|
void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
|
|
Error **errp)
|
|
{
|
|
v->type_int64(v, obj, name, errp);
|
|
}
|
|
|
|
void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
|
|
Error **errp)
|
|
{
|
|
if (v->type_size) {
|
|
v->type_size(v, obj, name, errp);
|
|
} else {
|
|
v->type_uint64(v, obj, name, errp);
|
|
}
|
|
}
|
|
|
|
void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
|
|
{
|
|
v->type_bool(v, obj, name, errp);
|
|
}
|
|
|
|
void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
|
|
{
|
|
v->type_str(v, obj, name, errp);
|
|
}
|
|
|
|
void visit_type_number(Visitor *v, const char *name, double *obj,
|
|
Error **errp)
|
|
{
|
|
v->type_number(v, obj, name, errp);
|
|
}
|
|
|
|
void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
|
|
{
|
|
v->type_any(v, obj, name, errp);
|
|
}
|
|
|
|
void output_type_enum(Visitor *v, int *obj, const char * const strings[],
|
|
const char *kind, const char *name,
|
|
Error **errp)
|
|
{
|
|
int i = 0;
|
|
int value = *obj;
|
|
char *enum_str;
|
|
|
|
assert(strings);
|
|
while (strings[i++] != NULL);
|
|
if (value < 0 || value >= i - 1) {
|
|
error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null");
|
|
return;
|
|
}
|
|
|
|
enum_str = (char *)strings[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)
|
|
{
|
|
Error *local_err = NULL;
|
|
int64_t value = 0;
|
|
char *enum_str;
|
|
|
|
assert(strings);
|
|
|
|
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) {
|
|
error_setg(errp, QERR_INVALID_PARAMETER, enum_str);
|
|
g_free(enum_str);
|
|
return;
|
|
}
|
|
|
|
g_free(enum_str);
|
|
*obj = (int)value;
|
|
}
|