[mirror_qemu.git] / qapi / string-output-visitor.c

/*
 * String printing Visitor
 *
 * Copyright Red Hat, Inc. 2012-2016
 *
 * Author: Paolo Bonzini <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.
 *
 */

#include "qemu/osdep.h"
#include "qemu-common.h"
#include "qapi/string-output-visitor.h"
#include "qapi/visitor-impl.h"
#include "qemu/host-utils.h"
#include <math.h>
#include "qemu/range.h"

enum ListMode {
    LM_NONE,             /* not traversing a list of repeated options */
    LM_STARTED,          /* start_list() succeeded */

    LM_IN_PROGRESS,      /* next_list() has been called.
                          *
                          * Generating the next list link will consume the most
                          * recently parsed QemuOpt instance of the repeated
                          * option.
                          *
                          * Parsing a value into the list link will examine the
                          * next QemuOpt instance of the repeated option, and
                          * possibly enter LM_SIGNED_INTERVAL or
                          * LM_UNSIGNED_INTERVAL.
                          */

    LM_SIGNED_INTERVAL,  /* next_list() has been called.
                          *
                          * Generating the next list link will consume the most
                          * recently stored element from the signed interval,
                          * parsed from the most recent QemuOpt instance of the
                          * repeated option. This may consume QemuOpt itself
                          * and return to LM_IN_PROGRESS.
                          *
                          * Parsing a value into the list link will store the
                          * next element of the signed interval.
                          */

    LM_UNSIGNED_INTERVAL,/* Same as above, only for an unsigned interval. */

    LM_END
};

typedef enum ListMode ListMode;

struct StringOutputVisitor
{
    Visitor visitor;
    bool human;
    GString *string;
    bool head;
    ListMode list_mode;
    union {
        int64_t s;
        uint64_t u;
    } range_start, range_end;
    GList *ranges;
};

static StringOutputVisitor *to_sov(Visitor *v)
{
    return container_of(v, StringOutputVisitor, visitor);
}

static void string_output_set(StringOutputVisitor *sov, char *string)
{
    if (sov->string) {
        g_string_free(sov->string, true);
    }
    sov->string = g_string_new(string);
    g_free(string);
}

static void string_output_append(StringOutputVisitor *sov, int64_t a)
{
    Range *r = g_malloc0(sizeof(*r));
    r->begin = a;
    r->end = a + 1;
    sov->ranges = g_list_insert_sorted_merged(sov->ranges, r, range_compare);
}

static void string_output_append_range(StringOutputVisitor *sov,
                                       int64_t s, int64_t e)
{
    Range *r = g_malloc0(sizeof(*r));
    r->begin = s;
    r->end = e + 1;
    sov->ranges = g_list_insert_sorted_merged(sov->ranges, r, range_compare);
}

static void format_string(StringOutputVisitor *sov, Range *r, bool next,
                          bool human)
{
    if (r->end - r->begin > 1) {
        if (human) {
            g_string_append_printf(sov->string, "0x%" PRIx64 "-0x%" PRIx64,
                                   r->begin, r->end - 1);

        } else {
            g_string_append_printf(sov->string, "%" PRId64 "-%" PRId64,
                                   r->begin, r->end - 1);
        }
    } else {
        if (human) {
            g_string_append_printf(sov->string, "0x%" PRIx64, r->begin);
        } else {
            g_string_append_printf(sov->string, "%" PRId64, r->begin);
        }
    }
    if (next) {
        g_string_append(sov->string, ",");
    }
}

static void print_type_int64(Visitor *v, const char *name, int64_t *obj,
                             Error **errp)
{
    StringOutputVisitor *sov = to_sov(v);
    GList *l;

    switch (sov->list_mode) {
    case LM_NONE:
        string_output_append(sov, *obj);
        break;

    case LM_STARTED:
        sov->range_start.s = *obj;
        sov->range_end.s = *obj;
        sov->list_mode = LM_IN_PROGRESS;
        return;

    case LM_IN_PROGRESS:
        if (sov->range_end.s + 1 == *obj) {
            sov->range_end.s++;
        } else {
            if (sov->range_start.s == sov->range_end.s) {
                string_output_append(sov, sov->range_end.s);
            } else {
                assert(sov->range_start.s < sov->range_end.s);
                string_output_append_range(sov, sov->range_start.s,
                                           sov->range_end.s);
            }

            sov->range_start.s = *obj;
            sov->range_end.s = *obj;
        }
        return;

    case LM_END:
        if (sov->range_end.s + 1 == *obj) {
            sov->range_end.s++;
            assert(sov->range_start.s < sov->range_end.s);
            string_output_append_range(sov, sov->range_start.s,
                                       sov->range_end.s);
        } else {
            if (sov->range_start.s == sov->range_end.s) {
                string_output_append(sov, sov->range_end.s);
            } else {
                assert(sov->range_start.s < sov->range_end.s);

                string_output_append_range(sov, sov->range_start.s,
                                           sov->range_end.s);
            }
            string_output_append(sov, *obj);
        }
        break;

    default:
        abort();
    }

    l = sov->ranges;
    while (l) {
        Range *r = l->data;
        format_string(sov, r, l->next != NULL, false);
        l = l->next;
    }

    if (sov->human) {
        l = sov->ranges;
        g_string_append(sov->string, " (");
        while (l) {
            Range *r = l->data;
            format_string(sov, r, l->next != NULL, true);
            l = l->next;
        }
        g_string_append(sov->string, ")");
    }
}

static void print_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                             Error **errp)
{
    /* FIXME: print_type_int64 mishandles values over INT64_MAX */
    int64_t i = *obj;
    print_type_int64(v, name, &i, errp);
}

static void print_type_size(Visitor *v, const char *name, uint64_t *obj,
                            Error **errp)
{
    StringOutputVisitor *sov = to_sov(v);
    static const char suffixes[] = { 'B', 'K', 'M', 'G', 'T', 'P', 'E' };
    uint64_t div, val;
    char *out;
    int i;

    if (!sov->human) {
        out = g_strdup_printf("%"PRIu64, *obj);
        string_output_set(sov, out);
        return;
    }

    val = *obj;

    /* The exponent (returned in i) minus one gives us
     * floor(log2(val * 1024 / 1000).  The correction makes us
     * switch to the higher power when the integer part is >= 1000.
     */
    frexp(val / (1000.0 / 1024.0), &i);
    i = (i - 1) / 10;
    assert(i < ARRAY_SIZE(suffixes));
    div = 1ULL << (i * 10);

    out = g_strdup_printf("%"PRIu64" (%0.3g %c%s)", val,
                          (double)val/div, suffixes[i], i ? "iB" : "");
    string_output_set(sov, out);
}

static void print_type_bool(Visitor *v, const char *name, bool *obj,
                            Error **errp)
{
    StringOutputVisitor *sov = to_sov(v);
    string_output_set(sov, g_strdup(*obj ? "true" : "false"));
}

static void print_type_str(Visitor *v, const char *name, char **obj,
                           Error **errp)
{
    StringOutputVisitor *sov = to_sov(v);
    char *out;

    if (sov->human) {
        out = *obj ? g_strdup_printf("\"%s\"", *obj) : g_strdup("<null>");
    } else {
        out = g_strdup(*obj ? *obj : "");
    }
    string_output_set(sov, out);
}

static void print_type_number(Visitor *v, const char *name, double *obj,
                              Error **errp)
{
    StringOutputVisitor *sov = to_sov(v);
    string_output_set(sov, g_strdup_printf("%f", *obj));
}

static void
start_list(Visitor *v, const char *name, Error **errp)
{
    StringOutputVisitor *sov = to_sov(v);

    /* we can't traverse a list in a list */
    assert(sov->list_mode == LM_NONE);
    sov->list_mode = LM_STARTED;
    sov->head = true;
}

static GenericList *next_list(Visitor *v, GenericList **list)
{
    StringOutputVisitor *sov = to_sov(v);
    GenericList *ret = NULL;
    if (*list) {
        if (sov->head) {
            ret = *list;
        } else {
            ret = (*list)->next;
        }

        if (sov->head) {
            if (ret && ret->next == NULL) {
                sov->list_mode = LM_NONE;
            }
            sov->head = false;
        } else {
            if (ret && ret->next == NULL) {
                sov->list_mode = LM_END;
            }
        }
    }

    return ret;
}

static void end_list(Visitor *v)
{
    StringOutputVisitor *sov = to_sov(v);

    assert(sov->list_mode == LM_STARTED ||
           sov->list_mode == LM_END ||
           sov->list_mode == LM_NONE ||
           sov->list_mode == LM_IN_PROGRESS);
    sov->list_mode = LM_NONE;
    sov->head = true;

}

char *string_output_get_string(StringOutputVisitor *sov)
{
    char *string = g_string_free(sov->string, false);
    sov->string = NULL;
    return string;
}

Visitor *string_output_get_visitor(StringOutputVisitor *sov)
{
    return &sov->visitor;
}

static void free_range(void *range, void *dummy)
{
    g_free(range);
}

void string_output_visitor_cleanup(StringOutputVisitor *sov)
{
    if (sov->string) {
        g_string_free(sov->string, true);
    }

    g_list_foreach(sov->ranges, free_range, NULL);
    g_list_free(sov->ranges);
    g_free(sov);
}

StringOutputVisitor *string_output_visitor_new(bool human)
{
    StringOutputVisitor *v;

    v = g_malloc0(sizeof(*v));

    v->string = g_string_new(NULL);
    v->human = human;
    v->visitor.type_enum = output_type_enum;
    v->visitor.type_int64 = print_type_int64;
    v->visitor.type_uint64 = print_type_uint64;
    v->visitor.type_size = print_type_size;
    v->visitor.type_bool = print_type_bool;
    v->visitor.type_str = print_type_str;
    v->visitor.type_number = print_type_number;
    v->visitor.start_list = start_list;
    v->visitor.next_list = next_list;
    v->visitor.end_list = end_list;

    return v;
}
Commit	Line	Data
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"
a020f980	14	#include "qemu-common.h"
7b1b5d19 PB	15	#include "qapi/string-output-visitor.h"
7b1b5d19 PB	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
	21	enum 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
	54	typedef enum ListMode ListMode;
a020f980 PB	55
	56	struct StringOutputVisitor
	57	{
	58	Visitor visitor;
0b7593e0	59	bool human;
69e25563 HT	60	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;
a020f980 PB	68	};
a020f980 PB	69
d7bea75d EB	70	static StringOutputVisitor to_sov(Visitor v)
	71	{
	72	return container_of(v, StringOutputVisitor, visitor);
	73	}
	74
a020f980 PB	75	static void string_output_set(StringOutputVisitor sov, char string)
a020f980 PB	76	{
69e25563 HT	77	if (sov->string) {
	78	g_string_free(sov->string, true);
	79	}
	80	sov->string = g_string_new(string);
	81	g_free(string);
	82	}
	83
	84	static 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
	92	static 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
	101	static void format_string(StringOutputVisitor sov, Range r, bool next,
	102	bool human)
	103	{
	104	if (r->end - r->begin > 1) {
	105	if (human) {
684531ad	106	g_string_append_printf(sov->string, "0x%" PRIx64 "-0x%" PRIx64,
69e25563 HT	107	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) {
56fdfb61	115	g_string_append_printf(sov->string, "0x%" PRIx64, r->begin);
69e25563 HT	116	} else {
	117	g_string_append_printf(sov->string, "%" PRId64, r->begin);
	118	}
	119	}
	120	if (next) {
	121	g_string_append(sov->string, ",");
	122	}
a020f980 PB	123	}
a020f980 PB	124
0b2a0d6b	125	static void print_type_int64(Visitor v, const char name, int64_t *obj,
4c40314a	126	Error **errp)
a020f980	127	{
d7bea75d	128	StringOutputVisitor *sov = to_sov(v);
69e25563 HT	129	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	}
0b7593e0 PB	188
0b7593e0 PB	189	if (sov->human) {
69e25563 HT	190	l = sov->ranges;
	191	g_string_append(sov->string, " (");
	192	while (l) {
	193	Range *r = l->data;
56fdfb61	194	format_string(sov, r, l->next != NULL, true);
69e25563 HT	195	l = l->next;
	196	}
	197	g_string_append(sov->string, ")");
0b7593e0	198	}
0b7593e0 PB	199	}
0b7593e0 PB	200
0b2a0d6b	201	static void print_type_uint64(Visitor v, const char name, uint64_t *obj,
f755dea7 EB	202	Error **errp)
	203	{
	204	/* FIXME: print_type_int64 mishandles values over INT64_MAX */
	205	int64_t i = *obj;
0b2a0d6b	206	print_type_int64(v, name, &i, errp);
f755dea7 EB	207	}
f755dea7 EB	208
0b2a0d6b EB	209	static void print_type_size(Visitor v, const char name, uint64_t *obj,
0b2a0d6b EB	210	Error **errp)
0b7593e0	211	{
d7bea75d	212	StringOutputVisitor *sov = to_sov(v);
e41b509d	213	static const char suffixes[] = { 'B', 'K', 'M', 'G', 'T', 'P', 'E' };
0b7593e0 PB	214	uint64_t div, val;
	215	char *out;
	216	int i;
	217
	218	if (!sov->human) {
e41b509d	219	out = g_strdup_printf("%"PRIu64, *obj);
0b7593e0 PB	220	string_output_set(sov, out);
	221	return;
	222	}
	223
	224	val = *obj;
	225
e41b509d PB	226	/* The exponent (returned in i) minus one gives us
	227	* floor(log2(val * 1024 / 1000). The correction makes us
	228	* switch to the higher power when the integer part is >= 1000.
	229	*/
	230	frexp(val / (1000.0 / 1024.0), &i);
	231	i = (i - 1) / 10;
	232	assert(i < ARRAY_SIZE(suffixes));
0b7593e0 PB	233	div = 1ULL << (i * 10);
0b7593e0 PB	234
e41b509d PB	235	out = g_strdup_printf("%"PRIu64" (%0.3g %c%s)", val,
e41b509d PB	236	(double)val/div, suffixes[i], i ? "iB" : "");
0b7593e0	237	string_output_set(sov, out);
a020f980 PB	238	}
a020f980 PB	239
0b2a0d6b	240	static void print_type_bool(Visitor v, const char name, bool *obj,
a020f980 PB	241	Error **errp)
a020f980 PB	242	{
d7bea75d	243	StringOutputVisitor *sov = to_sov(v);
a020f980 PB	244	string_output_set(sov, g_strdup(*obj ? "true" : "false"));
	245	}
	246
0b2a0d6b	247	static void print_type_str(Visitor v, const char name, char **obj,
a020f980 PB	248	Error **errp)
a020f980 PB	249	{
d7bea75d	250	StringOutputVisitor *sov = to_sov(v);
0b7593e0 PB	251	char *out;
	252
	253	if (sov->human) {
	254	out = obj ? g_strdup_printf("\"%s\"", obj) : g_strdup("<null>");
	255	} else {
	256	out = g_strdup(obj ? obj : "");
	257	}
	258	string_output_set(sov, out);
a020f980 PB	259	}
a020f980 PB	260
0b2a0d6b	261	static void print_type_number(Visitor v, const char name, double *obj,
a020f980 PB	262	Error **errp)
a020f980 PB	263	{
d7bea75d	264	StringOutputVisitor *sov = to_sov(v);
173bbb75	265	string_output_set(sov, g_strdup_printf("%f", *obj));
a020f980 PB	266	}
a020f980 PB	267
69e25563 HT	268	static void
	269	start_list(Visitor v, const char name, Error **errp)
	270	{
d7bea75d	271	StringOutputVisitor *sov = to_sov(v);
69e25563 HT	272
	273	/* we can't traverse a list in a list */
	274	assert(sov->list_mode == LM_NONE);
	275	sov->list_mode = LM_STARTED;
	276	sov->head = true;
	277	}
	278
08f9541d	279	static GenericList next_list(Visitor v, GenericList **list)
69e25563	280	{
d7bea75d	281	StringOutputVisitor *sov = to_sov(v);
69e25563 HT	282	GenericList *ret = NULL;
	283	if (*list) {
	284	if (sov->head) {
	285	ret = *list;
	286	} else {
	287	ret = (*list)->next;
	288	}
	289
	290	if (sov->head) {
	291	if (ret && ret->next == NULL) {
	292	sov->list_mode = LM_NONE;
	293	}
	294	sov->head = false;
	295	} else {
	296	if (ret && ret->next == NULL) {
	297	sov->list_mode = LM_END;
	298	}
	299	}
	300	}
	301
	302	return ret;
	303	}
	304
08f9541d	305	static void end_list(Visitor *v)
69e25563	306	{
d7bea75d	307	StringOutputVisitor *sov = to_sov(v);
69e25563 HT	308
	309	assert(sov->list_mode == LM_STARTED \|\|
	310	sov->list_mode == LM_END \|\|
	311	sov->list_mode == LM_NONE \|\|
	312	sov->list_mode == LM_IN_PROGRESS);
	313	sov->list_mode = LM_NONE;
	314	sov->head = true;
	315
	316	}
	317
a020f980 PB	318	char string_output_get_string(StringOutputVisitor sov)
a020f980 PB	319	{
69e25563	320	char *string = g_string_free(sov->string, false);
a020f980 PB	321	sov->string = NULL;
	322	return string;
	323	}
	324
	325	Visitor string_output_get_visitor(StringOutputVisitor sov)
	326	{
	327	return &sov->visitor;
	328	}
	329
0d156683 MT	330	static void free_range(void range, void dummy)
	331	{
	332	g_free(range);
	333	}
	334
a020f980 PB	335	void string_output_visitor_cleanup(StringOutputVisitor *sov)
a020f980 PB	336	{
69e25563 HT	337	if (sov->string) {
	338	g_string_free(sov->string, true);
	339	}
	340
0d156683 MT	341	g_list_foreach(sov->ranges, free_range, NULL);
0d156683 MT	342	g_list_free(sov->ranges);
a020f980 PB	343	g_free(sov);
	344	}
	345
0b7593e0	346	StringOutputVisitor *string_output_visitor_new(bool human)
a020f980 PB	347	{
	348	StringOutputVisitor *v;
	349
	350	v = g_malloc0(sizeof(*v));
	351
69e25563	352	v->string = g_string_new(NULL);
0b7593e0	353	v->human = human;
a020f980	354	v->visitor.type_enum = output_type_enum;
4c40314a	355	v->visitor.type_int64 = print_type_int64;
f755dea7	356	v->visitor.type_uint64 = print_type_uint64;
0b7593e0	357	v->visitor.type_size = print_type_size;
a020f980 PB	358	v->visitor.type_bool = print_type_bool;
	359	v->visitor.type_str = print_type_str;
	360	v->visitor.type_number = print_type_number;
69e25563 HT	361	v->visitor.start_list = start_list;
	362	v->visitor.next_list = next_list;
	363	v->visitor.end_list = end_list;
a020f980 PB	364
	365	return v;
	366	}