]> git.ipfire.org Git - thirdparty/qemu.git/blame - qapi/string-output-visitor.c
linux-user: Update TASK_UNMAPPED_BASE for aarch64
[thirdparty/qemu.git] / qapi / string-output-visitor.c
CommitLineData
a020f980
PB
1/*
2 * String printing Visitor
3 *
08f9541d 4 * Copyright Red Hat, Inc. 2012-2016
a020f980
PB
5 *
6 * Author: Paolo Bonzini <pbonzini@redhat.com>
7 *
8 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
9 * See the COPYING.LIB file in the top-level directory.
10 *
11 */
12
cbf21151 13#include "qemu/osdep.h"
31e40415 14#include "qemu/cutils.h"
7b1b5d19
PB
15#include "qapi/string-output-visitor.h"
16#include "qapi/visitor-impl.h"
0b7593e0 17#include "qemu/host-utils.h"
e41b509d 18#include <math.h>
69e25563
HT
19#include "qemu/range.h"
20
21enum ListMode {
22 LM_NONE, /* not traversing a list of repeated options */
d9f62dde 23 LM_STARTED, /* next_list() ready to be called */
69e25563
HT
24
25 LM_IN_PROGRESS, /* next_list() has been called.
26 *
27 * Generating the next list link will consume the most
28 * recently parsed QemuOpt instance of the repeated
29 * option.
30 *
31 * Parsing a value into the list link will examine the
32 * next QemuOpt instance of the repeated option, and
33 * possibly enter LM_SIGNED_INTERVAL or
34 * LM_UNSIGNED_INTERVAL.
35 */
36
37 LM_SIGNED_INTERVAL, /* next_list() has been called.
38 *
39 * Generating the next list link will consume the most
40 * recently stored element from the signed interval,
41 * parsed from the most recent QemuOpt instance of the
42 * repeated option. This may consume QemuOpt itself
43 * and return to LM_IN_PROGRESS.
44 *
45 * Parsing a value into the list link will store the
46 * next element of the signed interval.
47 */
48
49 LM_UNSIGNED_INTERVAL,/* Same as above, only for an unsigned interval. */
50
d9f62dde 51 LM_END, /* next_list() called, about to see last element. */
69e25563
HT
52};
53
54typedef enum ListMode ListMode;
a020f980
PB
55
56struct StringOutputVisitor
57{
58 Visitor visitor;
0b7593e0 59 bool human;
69e25563 60 GString *string;
3b098d56 61 char **result;
69e25563
HT
62 ListMode list_mode;
63 union {
64 int64_t s;
65 uint64_t u;
66 } range_start, range_end;
67 GList *ranges;
1158bb2a 68 void *list; /* Only needed for sanity checking the caller */
a020f980
PB
69};
70
d7bea75d
EB
71static StringOutputVisitor *to_sov(Visitor *v)
72{
73 return container_of(v, StringOutputVisitor, visitor);
74}
75
a020f980
PB
76static void string_output_set(StringOutputVisitor *sov, char *string)
77{
69e25563
HT
78 if (sov->string) {
79 g_string_free(sov->string, true);
80 }
81 sov->string = g_string_new(string);
82 g_free(string);
83}
84
85static void string_output_append(StringOutputVisitor *sov, int64_t a)
86{
87 Range *r = g_malloc0(sizeof(*r));
a0efbf16
MA
88
89 range_set_bounds(r, a, a);
7c47959d 90 sov->ranges = range_list_insert(sov->ranges, r);
69e25563
HT
91}
92
93static void string_output_append_range(StringOutputVisitor *sov,
94 int64_t s, int64_t e)
95{
96 Range *r = g_malloc0(sizeof(*r));
a0efbf16
MA
97
98 range_set_bounds(r, s, e);
7c47959d 99 sov->ranges = range_list_insert(sov->ranges, r);
69e25563
HT
100}
101
102static void format_string(StringOutputVisitor *sov, Range *r, bool next,
103 bool human)
104{
a0efbf16 105 if (range_lob(r) != range_upb(r)) {
69e25563 106 if (human) {
684531ad 107 g_string_append_printf(sov->string, "0x%" PRIx64 "-0x%" PRIx64,
a0efbf16 108 range_lob(r), range_upb(r));
69e25563
HT
109
110 } else {
111 g_string_append_printf(sov->string, "%" PRId64 "-%" PRId64,
a0efbf16 112 range_lob(r), range_upb(r));
69e25563
HT
113 }
114 } else {
115 if (human) {
a0efbf16 116 g_string_append_printf(sov->string, "0x%" PRIx64, range_lob(r));
69e25563 117 } else {
a0efbf16 118 g_string_append_printf(sov->string, "%" PRId64, range_lob(r));
69e25563
HT
119 }
120 }
121 if (next) {
122 g_string_append(sov->string, ",");
123 }
a020f980
PB
124}
125
0b2a0d6b 126static void print_type_int64(Visitor *v, const char *name, int64_t *obj,
4c40314a 127 Error **errp)
a020f980 128{
d7bea75d 129 StringOutputVisitor *sov = to_sov(v);
69e25563
HT
130 GList *l;
131
132 switch (sov->list_mode) {
133 case LM_NONE:
134 string_output_append(sov, *obj);
135 break;
136
137 case LM_STARTED:
138 sov->range_start.s = *obj;
139 sov->range_end.s = *obj;
140 sov->list_mode = LM_IN_PROGRESS;
141 return;
142
143 case LM_IN_PROGRESS:
144 if (sov->range_end.s + 1 == *obj) {
145 sov->range_end.s++;
146 } else {
147 if (sov->range_start.s == sov->range_end.s) {
148 string_output_append(sov, sov->range_end.s);
149 } else {
150 assert(sov->range_start.s < sov->range_end.s);
151 string_output_append_range(sov, sov->range_start.s,
152 sov->range_end.s);
153 }
154
155 sov->range_start.s = *obj;
156 sov->range_end.s = *obj;
157 }
158 return;
159
160 case LM_END:
161 if (sov->range_end.s + 1 == *obj) {
162 sov->range_end.s++;
163 assert(sov->range_start.s < sov->range_end.s);
164 string_output_append_range(sov, sov->range_start.s,
165 sov->range_end.s);
166 } else {
167 if (sov->range_start.s == sov->range_end.s) {
168 string_output_append(sov, sov->range_end.s);
169 } else {
170 assert(sov->range_start.s < sov->range_end.s);
171
172 string_output_append_range(sov, sov->range_start.s,
173 sov->range_end.s);
174 }
175 string_output_append(sov, *obj);
176 }
177 break;
178
179 default:
180 abort();
181 }
182
183 l = sov->ranges;
184 while (l) {
185 Range *r = l->data;
186 format_string(sov, r, l->next != NULL, false);
187 l = l->next;
188 }
0b7593e0
PB
189
190 if (sov->human) {
69e25563
HT
191 l = sov->ranges;
192 g_string_append(sov->string, " (");
193 while (l) {
194 Range *r = l->data;
56fdfb61 195 format_string(sov, r, l->next != NULL, true);
69e25563
HT
196 l = l->next;
197 }
198 g_string_append(sov->string, ")");
0b7593e0 199 }
0b7593e0
PB
200}
201
0b2a0d6b 202static void print_type_uint64(Visitor *v, const char *name, uint64_t *obj,
f755dea7
EB
203 Error **errp)
204{
205 /* FIXME: print_type_int64 mishandles values over INT64_MAX */
206 int64_t i = *obj;
0b2a0d6b 207 print_type_int64(v, name, &i, errp);
f755dea7
EB
208}
209
0b2a0d6b
EB
210static void print_type_size(Visitor *v, const char *name, uint64_t *obj,
211 Error **errp)
0b7593e0 212{
d7bea75d 213 StringOutputVisitor *sov = to_sov(v);
22951aaa
PX
214 uint64_t val;
215 char *out, *psize;
0b7593e0
PB
216
217 if (!sov->human) {
e41b509d 218 out = g_strdup_printf("%"PRIu64, *obj);
0b7593e0
PB
219 string_output_set(sov, out);
220 return;
221 }
222
223 val = *obj;
22951aaa
PX
224 psize = size_to_str(val);
225 out = g_strdup_printf("%"PRIu64" (%s)", val, psize);
0b7593e0 226 string_output_set(sov, out);
22951aaa
PX
227
228 g_free(psize);
a020f980
PB
229}
230
0b2a0d6b 231static void print_type_bool(Visitor *v, const char *name, bool *obj,
a020f980
PB
232 Error **errp)
233{
d7bea75d 234 StringOutputVisitor *sov = to_sov(v);
a020f980
PB
235 string_output_set(sov, g_strdup(*obj ? "true" : "false"));
236}
237
0b2a0d6b 238static void print_type_str(Visitor *v, const char *name, char **obj,
a020f980
PB
239 Error **errp)
240{
d7bea75d 241 StringOutputVisitor *sov = to_sov(v);
0b7593e0
PB
242 char *out;
243
244 if (sov->human) {
245 out = *obj ? g_strdup_printf("\"%s\"", *obj) : g_strdup("<null>");
246 } else {
247 out = g_strdup(*obj ? *obj : "");
248 }
249 string_output_set(sov, out);
a020f980
PB
250}
251
0b2a0d6b 252static void print_type_number(Visitor *v, const char *name, double *obj,
a020f980
PB
253 Error **errp)
254{
d7bea75d 255 StringOutputVisitor *sov = to_sov(v);
173bbb75 256 string_output_set(sov, g_strdup_printf("%f", *obj));
a020f980
PB
257}
258
d2f95f4d
MA
259static void print_type_null(Visitor *v, const char *name, QNull **obj,
260 Error **errp)
a7333712
GK
261{
262 StringOutputVisitor *sov = to_sov(v);
263 char *out;
264
265 if (sov->human) {
266 out = g_strdup("<null>");
267 } else {
268 out = g_strdup("");
269 }
270 string_output_set(sov, out);
271}
272
69e25563 273static void
d9f62dde
EB
274start_list(Visitor *v, const char *name, GenericList **list, size_t size,
275 Error **errp)
69e25563 276{
d7bea75d 277 StringOutputVisitor *sov = to_sov(v);
69e25563
HT
278
279 /* we can't traverse a list in a list */
280 assert(sov->list_mode == LM_NONE);
d9f62dde
EB
281 /* We don't support visits without a list */
282 assert(list);
1158bb2a 283 sov->list = list;
d9f62dde
EB
284 /* List handling is only needed if there are at least two elements */
285 if (*list && (*list)->next) {
286 sov->list_mode = LM_STARTED;
287 }
69e25563
HT
288}
289
d9f62dde 290static GenericList *next_list(Visitor *v, GenericList *tail, size_t size)
69e25563 291{
d7bea75d 292 StringOutputVisitor *sov = to_sov(v);
d9f62dde 293 GenericList *ret = tail->next;
69e25563 294
d9f62dde
EB
295 if (ret && !ret->next) {
296 sov->list_mode = LM_END;
69e25563 297 }
69e25563
HT
298 return ret;
299}
300
1158bb2a 301static void end_list(Visitor *v, void **obj)
69e25563 302{
d7bea75d 303 StringOutputVisitor *sov = to_sov(v);
69e25563 304
1158bb2a 305 assert(sov->list == obj);
69e25563
HT
306 assert(sov->list_mode == LM_STARTED ||
307 sov->list_mode == LM_END ||
308 sov->list_mode == LM_NONE ||
309 sov->list_mode == LM_IN_PROGRESS);
310 sov->list_mode = LM_NONE;
69e25563
HT
311}
312
3b098d56 313static void string_output_complete(Visitor *v, void *opaque)
a020f980 314{
3b098d56 315 StringOutputVisitor *sov = to_sov(v);
a020f980 316
3b098d56
EB
317 assert(opaque == sov->result);
318 *sov->result = g_string_free(sov->string, false);
319 sov->string = NULL;
a020f980
PB
320}
321
0d156683
MT
322static void free_range(void *range, void *dummy)
323{
324 g_free(range);
325}
326
2c0ef9f4
EB
327static void string_output_free(Visitor *v)
328{
329 StringOutputVisitor *sov = to_sov(v);
330
69e25563
HT
331 if (sov->string) {
332 g_string_free(sov->string, true);
333 }
334
0d156683
MT
335 g_list_foreach(sov->ranges, free_range, NULL);
336 g_list_free(sov->ranges);
a020f980
PB
337 g_free(sov);
338}
339
3b098d56 340Visitor *string_output_visitor_new(bool human, char **result)
a020f980
PB
341{
342 StringOutputVisitor *v;
343
344 v = g_malloc0(sizeof(*v));
345
69e25563 346 v->string = g_string_new(NULL);
0b7593e0 347 v->human = human;
3b098d56
EB
348 v->result = result;
349 *result = NULL;
350
983f52d4 351 v->visitor.type = VISITOR_OUTPUT;
4c40314a 352 v->visitor.type_int64 = print_type_int64;
f755dea7 353 v->visitor.type_uint64 = print_type_uint64;
0b7593e0 354 v->visitor.type_size = print_type_size;
a020f980
PB
355 v->visitor.type_bool = print_type_bool;
356 v->visitor.type_str = print_type_str;
357 v->visitor.type_number = print_type_number;
a7333712 358 v->visitor.type_null = print_type_null;
69e25563
HT
359 v->visitor.start_list = start_list;
360 v->visitor.next_list = next_list;
361 v->visitor.end_list = end_list;
3b098d56 362 v->visitor.complete = string_output_complete;
2c0ef9f4 363 v->visitor.free = string_output_free;
a020f980 364
3b098d56 365 return &v->visitor;
a020f980 366}