unicorn/qemu/include/qapi/string-input-visitor.h

/*
 * String parsing Visitor
 *
 * Copyright Red Hat, Inc. 2012
 *
 * 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.
 *
 */

#ifndef STRING_INPUT_VISITOR_H
#define STRING_INPUT_VISITOR_H

#include "qapi/visitor.h"

typedef struct StringInputVisitor StringInputVisitor;

/*
 * The string input visitor does not implement support for visiting
 * QAPI structs, alternates, null, or arbitrary QTypes. Only flat lists
 * of integers (except type "size") are supported.
 */
Visitor *string_input_visitor_new(const char *str);

#endif
import 2015-08-21 09:04:50 +02:00			`/*`
			`* String parsing Visitor`
			`*`
			`* Copyright Red Hat, Inc. 2012`
			`*`
			`* 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.`
			`*`
			`*/`

			`#ifndef STRING_INPUT_VISITOR_H`
			`#define STRING_INPUT_VISITOR_H`

			`#include "qapi/visitor.h"`

			`typedef struct StringInputVisitor StringInputVisitor;`

qapi: Document visitor interfaces, add assertions The visitor interface for mapping between QObject/QemuOpts/string and QAPI is scandalously under-documented, making changes to visitor core, individual visitors, and users of visitors difficult to coordinate. Among other questions: when is it safe to pass NULL, vs. when a string must be provided; which visitors implement which callbacks; the difference between concrete and virtual visits. Correct this by retrofitting proper contracts, and document where some of the interface warts remain (for example, we may want to modify visit_end_* to require the same 'obj' as the visit_start counterpart, so the dealloc visitor can be simplified). Later patches in this series will tackle some, but not all, of these warts. Add assertions to (partially) enforce the contract. Some of these were only made possible by recent cleanup commits. Backports commit adfb264c9ed04bfc694921b72173be8e29e90024 from qemu 2018-02-23 21:45:26 +01:00			`/*`
			`* The string input visitor does not implement support for visiting`
qapi: Rewrite string-input-visitor's integer and list parsing The input visitor has some problems right now, especially - unsigned type "Range" is used to process signed ranges, resulting in inconsistent behavior and ugly/magical code - uint64_t are parsed like int64_t, so big uint64_t values are not supported and error messages are misleading - lists/ranges of int64_t are accepted although no list is parsed and we should rather report an error - lists/ranges are preparsed using int64_t, making it hard to implement uint64_t values or uint64_t lists - types that don't support lists don't bail out - visiting beyond the end of a list is not handled properly - we don't actually parse lists, we parse sets: members are sorted, and duplicates eliminated So let's rewrite it by getting rid of usage of the type "Range" and properly supporting lists of int64_t and uint64_t (including ranges of both types), fixing the above mentioned issues. Lists of other types are not supported and will properly report an error. Virtual walks are now supported. Tests have to be fixed up: - Two BUGs were hardcoded that are fixed now - The string-input-visitor now actually returns a parsed list and not an ordered set. Please note that no users/callers have to be fixed up. Candidates using visit_type_uint16List() and friends are: - backends/hostmem.c:host_memory_backend_set_host_nodes() -- Code can deal with duplicates/unsorted lists - numa.c::query_memdev() -- via object_property_get_uint16List(), the list will still be sorted and without duplicates (via host_memory_backend_get_host_nodes()) - qapi-visit.c::visit_type_Memdev_members() - qapi-visit.c::visit_type_NumaNodeOptions_members() - qapi-visit.c::visit_type_RockerOfDpaGroup_members - qapi-visit.c::visit_type_RxFilterInfo_members() -- Not used with string-input-visitor. Backports commit c9fba9de89db51a07689e2cba4865a1e564b8f0f from qemu 2018-12-18 10:57:23 +01:00			`* QAPI structs, alternates, null, or arbitrary QTypes. Only flat lists`
			`* of integers (except type "size") are supported.`
qapi: Document visitor interfaces, add assertions The visitor interface for mapping between QObject/QemuOpts/string and QAPI is scandalously under-documented, making changes to visitor core, individual visitors, and users of visitors difficult to coordinate. Among other questions: when is it safe to pass NULL, vs. when a string must be provided; which visitors implement which callbacks; the difference between concrete and virtual visits. Correct this by retrofitting proper contracts, and document where some of the interface warts remain (for example, we may want to modify visit_end_* to require the same 'obj' as the visit_start counterpart, so the dealloc visitor can be simplified). Later patches in this series will tackle some, but not all, of these warts. Add assertions to (partially) enforce the contract. Some of these were only made possible by recent cleanup commits. Backports commit adfb264c9ed04bfc694921b72173be8e29e90024 from qemu 2018-02-23 21:45:26 +01:00			`*/`
string-input-visitor: Favor new visit_free() function Now that we have a polymorphic visit_free(), we no longer need string_input_visitor_cleanup(); which in turn means we no longer need to return a subtype from string_input_visitor_new() nor a public upcast function. Backports commit 7a0525c7be6b38d32d586e3fd12e7377ded21faa from qemu 2018-02-25 07:08:00 +01:00			`Visitor string_input_visitor_new(const char str);`
import 2015-08-21 09:04:50 +02:00
			`#endif`