xref: /openbmc/qemu/include/qapi/visitor.h (revision c964b660)
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 #ifndef QAPI_VISITOR_CORE_H
15 #define QAPI_VISITOR_CORE_H
16 
17 #include "qemu/typedefs.h"
18 #include "qapi/qmp/qobject.h"
19 #include "qapi/error.h"
20 #include <stdlib.h>
21 
22 typedef struct GenericList
23 {
24     union {
25         void *value;
26         uint64_t padding;
27     };
28     struct GenericList *next;
29 } GenericList;
30 
31 void visit_start_struct(Visitor *v, const char *name, void **obj,
32                         size_t size, Error **errp);
33 void visit_end_struct(Visitor *v, Error **errp);
34 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
35                                  Error **errp);
36 void visit_end_implicit_struct(Visitor *v);
37 
38 void visit_start_list(Visitor *v, const char *name, Error **errp);
39 GenericList *visit_next_list(Visitor *v, GenericList **list);
40 void visit_end_list(Visitor *v);
41 
42 /**
43  * Check if an optional member @name of an object needs visiting.
44  * For input visitors, set *@present according to whether the
45  * corresponding visit_type_*() needs calling; for other visitors,
46  * leave *@present unchanged.  Return *@present for convenience.
47  */
48 bool visit_optional(Visitor *v, const char *name, bool *present);
49 
50 /**
51  * Determine the qtype of the item @name in the current object visit.
52  * For input visitors, set *@type to the correct qtype of a qapi
53  * alternate type; for other visitors, leave *@type unchanged.
54  * If @promote_int, treat integers as QTYPE_FLOAT.
55  */
56 void visit_get_next_type(Visitor *v, const char *name, QType *type,
57                          bool promote_int, Error **errp);
58 void visit_type_enum(Visitor *v, const char *name, int *obj,
59                      const char *const strings[], Error **errp);
60 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp);
61 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
62                       Error **errp);
63 void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
64                        Error **errp);
65 void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
66                        Error **errp);
67 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
68                        Error **errp);
69 void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp);
70 void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
71                       Error **errp);
72 void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
73                       Error **errp);
74 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
75                       Error **errp);
76 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
77                      Error **errp);
78 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp);
79 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp);
80 void visit_type_number(Visitor *v, const char *name, double *obj,
81                        Error **errp);
82 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp);
83 bool visit_start_union(Visitor *v, bool data_present, Error **errp);
84 
85 #endif
86