2015-08-21 07:04:50 +00:00
|
|
|
/*
|
|
|
|
|
* Core Definitions for QAPI Visitor implementations
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2012 Red Hat, Inc.
|
|
|
|
|
*
|
|
|
|
|
* Author: Paolo Bonizni <pbonzini@redhat.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.
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
#ifndef QAPI_VISITOR_IMPL_H
|
|
|
|
|
#define QAPI_VISITOR_IMPL_H
|
|
|
|
|
|
|
|
|
|
#include "qapi/error.h"
|
|
|
|
|
#include "qapi/visitor.h"
|
|
|
|
|
|
|
|
|
|
struct Visitor
|
|
|
|
|
{
|
|
|
|
|
/* Must be set */
|
|
|
|
|
void (*start_struct)(Visitor *v, void **obj, const char *kind,
|
|
|
|
|
const char *name, size_t size, Error **errp);
|
|
|
|
|
void (*end_struct)(Visitor *v, Error **errp);
|
|
|
|
|
|
|
|
|
|
void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
|
|
|
|
|
Error **errp);
|
|
|
|
|
void (*end_implicit_struct)(Visitor *v, Error **errp);
|
|
|
|
|
|
|
|
|
|
void (*start_list)(Visitor *v, const char *name, Error **errp);
|
|
|
|
|
GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
|
|
|
|
|
void (*end_list)(Visitor *v, Error **errp);
|
|
|
|
|
|
|
|
|
|
void (*type_enum)(Visitor *v, int *obj, const char *strings[],
|
|
|
|
|
const char *kind, const char *name, Error **errp);
|
|
|
|
|
void (*get_next_type)(Visitor *v, int *kind, const int *qobjects,
|
|
|
|
|
const char *name, Error **errp);
|
qapi: Prefer type_int64 over type_int in visitors
The qapi builtin type 'int' is basically shorthand for the type
'int64'. In fact, since no visitor was providing the optional
type_int64() callback, visit_type_int64() was just always falling
back to type_int(), cementing the equivalence between the types.
However, some visitors are providing a type_uint64() callback.
For purposes of code consistency, it is nicer if all visitors
use the paired type_int64/type_uint64 names rather than the
mismatched type_int/type_uint64. So this patch just renames
the signed int callbacks in place, dropping the type_int()
callback as redundant, and a later patch will focus on the
unsigned int callbacks.
Add some FIXMEs to questionable reuse of errp in code touched
by the rename, while at it (the reuse works as long as the
callbacks don't modify value when setting an error, but it's not
a good example to set) - a later patch will then fix those.
No change in functionality here, although further cleanups are
in the pipeline.
Backports commit 4c40314a35816de635e7170eaacdc0c35be83a8a from qemu
2018-02-19 16:53:19 +00:00
|
|
|
/* Must be set. */
|
|
|
|
|
void (*type_int64)(Visitor *v, int64_t *obj, const char *name,
|
|
|
|
|
Error **errp);
|
|
|
|
|
/* Must be set. */
|
2015-08-21 07:04:50 +00:00
|
|
|
void (*type_bool)(Visitor *v, bool *obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_str)(Visitor *v, char **obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_number)(Visitor *v, double *obj, const char *name,
|
|
|
|
|
Error **errp);
|
|
|
|
|
|
|
|
|
|
/* May be NULL */
|
|
|
|
|
void (*optional)(Visitor *v, bool *present, const char *name,
|
|
|
|
|
Error **errp);
|
|
|
|
|
|
|
|
|
|
void (*type_uint8)(Visitor *v, uint8_t *obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_uint16)(Visitor *v, uint16_t *obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_uint32)(Visitor *v, uint32_t *obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_int8)(Visitor *v, int8_t *obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_int16)(Visitor *v, int16_t *obj, const char *name, Error **errp);
|
|
|
|
|
void (*type_int32)(Visitor *v, int32_t *obj, const char *name, Error **errp);
|
|
|
|
|
/* visit_type_size() falls back to (*type_uint64)() if type_size is unset */
|
|
|
|
|
void (*type_size)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
|
|
|
|
|
bool (*start_union)(Visitor *v, bool data_present, Error **errp);
|
|
|
|
|
void (*end_union)(Visitor *v, bool data_present, Error **errp);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
void input_type_enum(Visitor *v, int *obj, const char *strings[],
|
|
|
|
|
const char *kind, const char *name, Error **errp);
|
|
|
|
|
void output_type_enum(Visitor *v, int *obj, const char *strings[],
|
|
|
|
|
const char *kind, const char *name, Error **errp);
|
|
|
|
|
|
|
|
|
|
#endif
|
