From patchwork Sun Sep 11 05:53:01 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lin Ma X-Patchwork-Id: 668414 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3sX0Wc4pCHz9sCZ for ; Sun, 11 Sep 2016 15:54:34 +1000 (AEST) Received: from localhost ([::1]:36628 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bixiU-00046N-PW for incoming@patchwork.ozlabs.org; Sun, 11 Sep 2016 01:54:10 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41608) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bixhp-0003pp-EY for qemu-devel@nongnu.org; Sun, 11 Sep 2016 01:53:30 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bixhk-0007hM-FB for qemu-devel@nongnu.org; Sun, 11 Sep 2016 01:53:28 -0400 Received: from prv3-mh.provo.novell.com ([137.65.250.26]:48226) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bixhk-0007go-67 for qemu-devel@nongnu.org; Sun, 11 Sep 2016 01:53:24 -0400 Received: from localhost.localdomain (prv-ext-foundry1int.gns.novell.com [137.65.251.240]) by prv3-mh.provo.novell.com with ESMTP (NOT encrypted); Sat, 10 Sep 2016 23:53:11 -0600 From: Lin Ma To: qemu-devel@nongnu.org Date: Sun, 11 Sep 2016 13:53:01 +0800 Message-Id: <20160911055301.26650-1-lma@suse.com> X-Mailer: git-send-email 2.9.2 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 137.65.250.26 Subject: [Qemu-devel] [PATCH v2] object: Add 'help' option for all available backends and properties X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: pbonzini@redhat.com, armbru@redhat.com Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" '-object help' prints available user creatable backends. '-object $typename,help' prints relevant properties. Signed-off-by: Lin Ma --- include/qom/object_interfaces.h | 2 + qemu-options.hx | 7 ++- qom/object_interfaces.c | 112 ++++++++++++++++++++++++++++++++++++++++ vl.c | 5 ++ 4 files changed, 125 insertions(+), 1 deletion(-) diff --git a/include/qom/object_interfaces.h b/include/qom/object_interfaces.h index 8b17f4d..197cd5f 100644 --- a/include/qom/object_interfaces.h +++ b/include/qom/object_interfaces.h @@ -165,4 +165,6 @@ int user_creatable_add_opts_foreach(void *opaque, */ void user_creatable_del(const char *id, Error **errp); +int user_creatable_help_func(void *opaque, QemuOpts *opts, Error **errp); + #endif diff --git a/qemu-options.hx b/qemu-options.hx index a71aaf8..fade53c 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -3752,7 +3752,9 @@ DEF("object", HAS_ARG, QEMU_OPTION_object, " create a new object of type TYPENAME setting properties\n" " in the order they are specified. Note that the 'id'\n" " property must be set. These objects are placed in the\n" - " '/objects' path.\n", + " '/objects' path.\n" + " Use '-object help' to print available backend types and\n" + " '-object typename,help' to print relevant properties.\n", QEMU_ARCH_ALL) STEXI @item -object @var{typename}[,@var{prop1}=@var{value1},...] @@ -3762,6 +3764,9 @@ in the order they are specified. Note that the 'id' property must be set. These objects are placed in the '/objects' path. +Use '-object help' to print available backend types and +'-object typename,help' to print relevant properties. + @table @option @item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off} diff --git a/qom/object_interfaces.c b/qom/object_interfaces.c index bf59846..4ee8643 100644 --- a/qom/object_interfaces.c +++ b/qom/object_interfaces.c @@ -5,6 +5,7 @@ #include "qapi-visit.h" #include "qapi/qmp-output-visitor.h" #include "qapi/opts-visitor.h" +#include "qemu/help_option.h" void user_creatable_complete(Object *obj, Error **errp) { @@ -212,6 +213,117 @@ void user_creatable_del(const char *id, Error **errp) object_unparent(obj); } +int user_creatable_help_func(void *opaque, QemuOpts *opts, Error **errp) +{ + Visitor *v; + char *type = NULL; + Error *local_err = NULL; + + int i; + char *values = NULL; + Object *obj; + ObjectPropertyInfoList *props = NULL; + ObjectProperty *prop; + ObjectPropertyIterator iter; + ObjectPropertyInfoList *start; + + struct EnumProperty { + const char * const *strings; + int (*get)(Object *, Error **); + void (*set)(Object *, int, Error **); + } *enumprop; + + v = opts_visitor_new(opts); + visit_start_struct(v, NULL, NULL, 0, &local_err); + if (local_err) { + goto out; + } + + visit_type_str(v, "qom-type", &type, &local_err); + if (local_err) { + goto out_visit; + } + + if (type && is_help_option(type)) { + printf("Available object backend types:\n"); + GSList *list = object_class_get_list(TYPE_USER_CREATABLE, false); + while (list) { + const char *name; + name = object_class_get_name(OBJECT_CLASS(list->data)); + if (strcmp(name, TYPE_USER_CREATABLE)) { + printf("%s\n", name); + } + list = list->next; + } + g_slist_free(list); + goto out_visit; + } + + if (!type || !qemu_opt_has_help_opt(opts)) { + visit_end_struct(v, NULL); + return 0; + } + + if (!object_class_by_name(type)) { + printf("invalid object type: %s\n", type); + goto out_visit; + } + obj = object_new(type); + object_property_iter_init(&iter, obj); + + while ((prop = object_property_iter_next(&iter))) { + ObjectPropertyInfoList *entry = g_malloc0(sizeof(*entry)); + entry->value = g_malloc0(sizeof(ObjectPropertyInfo)); + entry->next = props; + props = entry; + entry->value->name = g_strdup(prop->name); + i = 0; + enumprop = prop->opaque; + if (!g_str_equal(prop->type, "string") && \ + !g_str_equal(prop->type, "bool") && \ + !g_str_equal(prop->type, "struct tm") && \ + !g_str_equal(prop->type, "int") && \ + !g_str_equal(prop->type, "uint8") && \ + !g_str_equal(prop->type, "uint16") && \ + !g_str_equal(prop->type, "uint32") && \ + !g_str_equal(prop->type, "uint64")) { + while (enumprop->strings[i] != NULL) { + if (i != 0) { + values = g_strdup_printf("%s/%s", + values, enumprop->strings[i]); + } else { + values = g_strdup_printf("%s", enumprop->strings[i]); + } + i++; + } + entry->value->type = g_strdup_printf("%s, available values: %s", + prop->type, values); + } else { + entry->value->type = g_strdup(prop->type); + } + } + + start = props; + while (props != NULL) { + ObjectPropertyInfo *value = props->value; + printf("%s (%s)\n", value->name, value->type); + props = props->next; + } + qapi_free_ObjectPropertyInfoList(start); + +out_visit: + visit_end_struct(v, NULL); + +out: + g_free(values); + g_free(type); + object_unref(obj); + if (local_err) { + error_report_err(local_err); + } + return 1; +} + static void register_types(void) { static const TypeInfo uc_interface_info = { diff --git a/vl.c b/vl.c index ee557a1..a2230c8 100644 --- a/vl.c +++ b/vl.c @@ -4251,6 +4251,11 @@ int main(int argc, char **argv, char **envp) page_size_init(); socket_init(); + if (qemu_opts_foreach(qemu_find_opts("object"), user_creatable_help_func, + NULL, NULL)) { + exit(1); + } + if (qemu_opts_foreach(qemu_find_opts("object"), user_creatable_add_opts_foreach, object_create_initial, NULL)) {