blob: b0313cb53a99fb4f11f353ccba2be3be2f8f55ce [file] [log] [blame]
Paolo Bonzinia020f982012-02-09 09:36:37 +01001/*
2 * String printing Visitor
3 *
4 * Copyright Red Hat, Inc. 2012
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
Peter Maydellcbf21152016-01-29 17:49:57 +000013#include "qemu/osdep.h"
Paolo Bonzinia020f982012-02-09 09:36:37 +010014#include "qemu-common.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010015#include "qapi/string-output-visitor.h"
16#include "qapi/visitor-impl.h"
Paolo Bonzini0b7593e2014-02-08 11:01:50 +010017#include "qemu/host-utils.h"
Paolo Bonzinie41b5092014-02-08 11:01:57 +010018#include <math.h>
Hu Tao69e25562014-06-10 19:15:28 +080019#include "qemu/range.h"
20
21enum ListMode {
22 LM_NONE, /* not traversing a list of repeated options */
23 LM_STARTED, /* start_list() succeeded */
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
51 LM_END
52};
53
54typedef enum ListMode ListMode;
Paolo Bonzinia020f982012-02-09 09:36:37 +010055
56struct StringOutputVisitor
57{
58 Visitor visitor;
Paolo Bonzini0b7593e2014-02-08 11:01:50 +010059 bool human;
Hu Tao69e25562014-06-10 19:15:28 +080060 GString *string;
61 bool head;
62 ListMode list_mode;
63 union {
64 int64_t s;
65 uint64_t u;
66 } range_start, range_end;
67 GList *ranges;
Paolo Bonzinia020f982012-02-09 09:36:37 +010068};
69
Eric Blaked7bea752016-01-29 06:48:38 -070070static StringOutputVisitor *to_sov(Visitor *v)
71{
72 return container_of(v, StringOutputVisitor, visitor);
73}
74
Paolo Bonzinia020f982012-02-09 09:36:37 +010075static void string_output_set(StringOutputVisitor *sov, char *string)
76{
Hu Tao69e25562014-06-10 19:15:28 +080077 if (sov->string) {
78 g_string_free(sov->string, true);
79 }
80 sov->string = g_string_new(string);
81 g_free(string);
82}
83
84static void string_output_append(StringOutputVisitor *sov, int64_t a)
85{
86 Range *r = g_malloc0(sizeof(*r));
87 r->begin = a;
88 r->end = a + 1;
89 sov->ranges = g_list_insert_sorted_merged(sov->ranges, r, range_compare);
90}
91
92static void string_output_append_range(StringOutputVisitor *sov,
93 int64_t s, int64_t e)
94{
95 Range *r = g_malloc0(sizeof(*r));
96 r->begin = s;
97 r->end = e + 1;
98 sov->ranges = g_list_insert_sorted_merged(sov->ranges, r, range_compare);
99}
100
101static void format_string(StringOutputVisitor *sov, Range *r, bool next,
102 bool human)
103{
104 if (r->end - r->begin > 1) {
105 if (human) {
Hu Tao684531a2014-06-20 13:55:42 +0800106 g_string_append_printf(sov->string, "0x%" PRIx64 "-0x%" PRIx64,
Hu Tao69e25562014-06-10 19:15:28 +0800107 r->begin, r->end - 1);
108
109 } else {
110 g_string_append_printf(sov->string, "%" PRId64 "-%" PRId64,
111 r->begin, r->end - 1);
112 }
113 } else {
114 if (human) {
Michael S. Tsirkin56fdfb62014-06-18 17:59:51 +0300115 g_string_append_printf(sov->string, "0x%" PRIx64, r->begin);
Hu Tao69e25562014-06-10 19:15:28 +0800116 } else {
117 g_string_append_printf(sov->string, "%" PRId64, r->begin);
118 }
119 }
120 if (next) {
121 g_string_append(sov->string, ",");
122 }
Paolo Bonzinia020f982012-02-09 09:36:37 +0100123}
124
125static void print_type_int(Visitor *v, int64_t *obj, const char *name,
126 Error **errp)
127{
Eric Blaked7bea752016-01-29 06:48:38 -0700128 StringOutputVisitor *sov = to_sov(v);
Hu Tao69e25562014-06-10 19:15:28 +0800129 GList *l;
130
131 switch (sov->list_mode) {
132 case LM_NONE:
133 string_output_append(sov, *obj);
134 break;
135
136 case LM_STARTED:
137 sov->range_start.s = *obj;
138 sov->range_end.s = *obj;
139 sov->list_mode = LM_IN_PROGRESS;
140 return;
141
142 case LM_IN_PROGRESS:
143 if (sov->range_end.s + 1 == *obj) {
144 sov->range_end.s++;
145 } else {
146 if (sov->range_start.s == sov->range_end.s) {
147 string_output_append(sov, sov->range_end.s);
148 } else {
149 assert(sov->range_start.s < sov->range_end.s);
150 string_output_append_range(sov, sov->range_start.s,
151 sov->range_end.s);
152 }
153
154 sov->range_start.s = *obj;
155 sov->range_end.s = *obj;
156 }
157 return;
158
159 case LM_END:
160 if (sov->range_end.s + 1 == *obj) {
161 sov->range_end.s++;
162 assert(sov->range_start.s < sov->range_end.s);
163 string_output_append_range(sov, sov->range_start.s,
164 sov->range_end.s);
165 } else {
166 if (sov->range_start.s == sov->range_end.s) {
167 string_output_append(sov, sov->range_end.s);
168 } else {
169 assert(sov->range_start.s < sov->range_end.s);
170
171 string_output_append_range(sov, sov->range_start.s,
172 sov->range_end.s);
173 }
174 string_output_append(sov, *obj);
175 }
176 break;
177
178 default:
179 abort();
180 }
181
182 l = sov->ranges;
183 while (l) {
184 Range *r = l->data;
185 format_string(sov, r, l->next != NULL, false);
186 l = l->next;
187 }
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100188
189 if (sov->human) {
Hu Tao69e25562014-06-10 19:15:28 +0800190 l = sov->ranges;
191 g_string_append(sov->string, " (");
192 while (l) {
193 Range *r = l->data;
Michael S. Tsirkin56fdfb62014-06-18 17:59:51 +0300194 format_string(sov, r, l->next != NULL, true);
Hu Tao69e25562014-06-10 19:15:28 +0800195 l = l->next;
196 }
197 g_string_append(sov->string, ")");
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100198 }
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100199}
200
201static void print_type_size(Visitor *v, uint64_t *obj, const char *name,
202 Error **errp)
203{
Eric Blaked7bea752016-01-29 06:48:38 -0700204 StringOutputVisitor *sov = to_sov(v);
Paolo Bonzinie41b5092014-02-08 11:01:57 +0100205 static const char suffixes[] = { 'B', 'K', 'M', 'G', 'T', 'P', 'E' };
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100206 uint64_t div, val;
207 char *out;
208 int i;
209
210 if (!sov->human) {
Paolo Bonzinie41b5092014-02-08 11:01:57 +0100211 out = g_strdup_printf("%"PRIu64, *obj);
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100212 string_output_set(sov, out);
213 return;
214 }
215
216 val = *obj;
217
Paolo Bonzinie41b5092014-02-08 11:01:57 +0100218 /* The exponent (returned in i) minus one gives us
219 * floor(log2(val * 1024 / 1000). The correction makes us
220 * switch to the higher power when the integer part is >= 1000.
221 */
222 frexp(val / (1000.0 / 1024.0), &i);
223 i = (i - 1) / 10;
224 assert(i < ARRAY_SIZE(suffixes));
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100225 div = 1ULL << (i * 10);
226
Paolo Bonzinie41b5092014-02-08 11:01:57 +0100227 out = g_strdup_printf("%"PRIu64" (%0.3g %c%s)", val,
228 (double)val/div, suffixes[i], i ? "iB" : "");
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100229 string_output_set(sov, out);
Paolo Bonzinia020f982012-02-09 09:36:37 +0100230}
231
232static void print_type_bool(Visitor *v, bool *obj, const char *name,
233 Error **errp)
234{
Eric Blaked7bea752016-01-29 06:48:38 -0700235 StringOutputVisitor *sov = to_sov(v);
Paolo Bonzinia020f982012-02-09 09:36:37 +0100236 string_output_set(sov, g_strdup(*obj ? "true" : "false"));
237}
238
239static void print_type_str(Visitor *v, char **obj, const char *name,
240 Error **errp)
241{
Eric Blaked7bea752016-01-29 06:48:38 -0700242 StringOutputVisitor *sov = to_sov(v);
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100243 char *out;
244
245 if (sov->human) {
246 out = *obj ? g_strdup_printf("\"%s\"", *obj) : g_strdup("<null>");
247 } else {
248 out = g_strdup(*obj ? *obj : "");
249 }
250 string_output_set(sov, out);
Paolo Bonzinia020f982012-02-09 09:36:37 +0100251}
252
253static void print_type_number(Visitor *v, double *obj, const char *name,
254 Error **errp)
255{
Eric Blaked7bea752016-01-29 06:48:38 -0700256 StringOutputVisitor *sov = to_sov(v);
Michael Roth173bbb72012-04-30 09:33:30 -0500257 string_output_set(sov, g_strdup_printf("%f", *obj));
Paolo Bonzinia020f982012-02-09 09:36:37 +0100258}
259
Hu Tao69e25562014-06-10 19:15:28 +0800260static void
261start_list(Visitor *v, const char *name, Error **errp)
262{
Eric Blaked7bea752016-01-29 06:48:38 -0700263 StringOutputVisitor *sov = to_sov(v);
Hu Tao69e25562014-06-10 19:15:28 +0800264
265 /* we can't traverse a list in a list */
266 assert(sov->list_mode == LM_NONE);
267 sov->list_mode = LM_STARTED;
268 sov->head = true;
269}
270
271static GenericList *
272next_list(Visitor *v, GenericList **list, Error **errp)
273{
Eric Blaked7bea752016-01-29 06:48:38 -0700274 StringOutputVisitor *sov = to_sov(v);
Hu Tao69e25562014-06-10 19:15:28 +0800275 GenericList *ret = NULL;
276 if (*list) {
277 if (sov->head) {
278 ret = *list;
279 } else {
280 ret = (*list)->next;
281 }
282
283 if (sov->head) {
284 if (ret && ret->next == NULL) {
285 sov->list_mode = LM_NONE;
286 }
287 sov->head = false;
288 } else {
289 if (ret && ret->next == NULL) {
290 sov->list_mode = LM_END;
291 }
292 }
293 }
294
295 return ret;
296}
297
298static void
299end_list(Visitor *v, Error **errp)
300{
Eric Blaked7bea752016-01-29 06:48:38 -0700301 StringOutputVisitor *sov = to_sov(v);
Hu Tao69e25562014-06-10 19:15:28 +0800302
303 assert(sov->list_mode == LM_STARTED ||
304 sov->list_mode == LM_END ||
305 sov->list_mode == LM_NONE ||
306 sov->list_mode == LM_IN_PROGRESS);
307 sov->list_mode = LM_NONE;
308 sov->head = true;
309
310}
311
Paolo Bonzinia020f982012-02-09 09:36:37 +0100312char *string_output_get_string(StringOutputVisitor *sov)
313{
Hu Tao69e25562014-06-10 19:15:28 +0800314 char *string = g_string_free(sov->string, false);
Paolo Bonzinia020f982012-02-09 09:36:37 +0100315 sov->string = NULL;
316 return string;
317}
318
319Visitor *string_output_get_visitor(StringOutputVisitor *sov)
320{
321 return &sov->visitor;
322}
323
Michael S. Tsirkin0d156682014-06-16 18:07:03 +0300324static void free_range(void *range, void *dummy)
325{
326 g_free(range);
327}
328
Paolo Bonzinia020f982012-02-09 09:36:37 +0100329void string_output_visitor_cleanup(StringOutputVisitor *sov)
330{
Hu Tao69e25562014-06-10 19:15:28 +0800331 if (sov->string) {
332 g_string_free(sov->string, true);
333 }
334
Michael S. Tsirkin0d156682014-06-16 18:07:03 +0300335 g_list_foreach(sov->ranges, free_range, NULL);
336 g_list_free(sov->ranges);
Paolo Bonzinia020f982012-02-09 09:36:37 +0100337 g_free(sov);
338}
339
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100340StringOutputVisitor *string_output_visitor_new(bool human)
Paolo Bonzinia020f982012-02-09 09:36:37 +0100341{
342 StringOutputVisitor *v;
343
344 v = g_malloc0(sizeof(*v));
345
Hu Tao69e25562014-06-10 19:15:28 +0800346 v->string = g_string_new(NULL);
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100347 v->human = human;
Paolo Bonzinia020f982012-02-09 09:36:37 +0100348 v->visitor.type_enum = output_type_enum;
349 v->visitor.type_int = print_type_int;
Paolo Bonzini0b7593e2014-02-08 11:01:50 +0100350 v->visitor.type_size = print_type_size;
Paolo Bonzinia020f982012-02-09 09:36:37 +0100351 v->visitor.type_bool = print_type_bool;
352 v->visitor.type_str = print_type_str;
353 v->visitor.type_number = print_type_number;
Hu Tao69e25562014-06-10 19:15:28 +0800354 v->visitor.start_list = start_list;
355 v->visitor.next_list = next_list;
356 v->visitor.end_list = end_list;
Paolo Bonzinia020f982012-02-09 09:36:37 +0100357
358 return v;
359}