qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: peter.maydell@linaro.org
Cc: "Alexandre Iooss" <erdnaxe@crans.org>,
	"Mahmoud Mandour" <ma.mandourr@gmail.com>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	qemu-devel@nongnu.org, "Laurent Vivier" <laurent@vivier.eu>
Subject: [PULL 09/22] plugins: allow plugin arguments to be passed directly
Date: Fri,  3 Sep 2021 10:03:26 +0100	[thread overview]
Message-ID: <20210903090339.1074887-10-alex.bennee@linaro.org> (raw)
In-Reply-To: <20210903090339.1074887-1-alex.bennee@linaro.org>

From: Mahmoud Mandour <ma.mandourr@gmail.com>

Passing arguments to plugins had to be done through "arg=<argname>".
This is redundant and introduces confusion especially when the argument
has a name and value (e.g. `-plugin plugin_name,arg="argname=argvalue"`).

This allows passing plugin arguments directly e.g:

    `-plugin plugin_name,argname=argvalue`

For now, passing arguments through "arg=" is still supports but outputs
a deprecation warning.

Also, this commit makes boolean arguments passed to plugins in the
`argname=on|off` form instead of the deprecated short-boolean form.

Signed-off-by: Mahmoud Mandour <ma.mandourr@gmail.com>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20210730135817.17816-2-ma.mandourr@gmail.com>

diff --git a/linux-user/main.c b/linux-user/main.c
index 37ed50d98e..a6094563b6 100644
--- a/linux-user/main.c
+++ b/linux-user/main.c
@@ -463,7 +463,7 @@ static const struct qemu_argument arg_table[] = {
      "",           "[[enable=]<pattern>][,events=<file>][,file=<file>]"},
 #ifdef CONFIG_PLUGIN
     {"plugin",     "QEMU_PLUGIN",      true,  handle_arg_plugin,
-     "",           "[file=]<file>[,arg=<string>]"},
+     "",           "[file=]<file>[,<argname>=<argvalue>]"},
 #endif
     {"version",    "QEMU_VERSION",     false, handle_arg_version,
      "",           "display version information and exit"},
diff --git a/plugins/loader.c b/plugins/loader.c
index 05df40398d..a4ec281692 100644
--- a/plugins/loader.c
+++ b/plugins/loader.c
@@ -94,6 +94,8 @@ static int plugin_add(void *opaque, const char *name, const char *value,
 {
     struct qemu_plugin_parse_arg *arg = opaque;
     struct qemu_plugin_desc *p;
+    bool is_on;
+    char *fullarg;
 
     if (strcmp(name, "file") == 0) {
         if (strcmp(value, "") == 0) {
@@ -107,18 +109,32 @@ static int plugin_add(void *opaque, const char *name, const char *value,
             QTAILQ_INSERT_TAIL(arg->head, p, entry);
         }
         arg->curr = p;
-    } else if (strcmp(name, "arg") == 0) {
+    } else {
         if (arg->curr == NULL) {
             error_setg(errp, "missing earlier '-plugin file=' option");
             return 1;
         }
+
+        if (g_strcmp0(name, "arg") == 0 &&
+                !qapi_bool_parse(name, value, &is_on, NULL)) {
+            if (strchr(value, '=') == NULL) {
+                /* Will treat arg="argname" as "argname=on" */
+                fullarg = g_strdup_printf("%s=%s", value, "on");
+            } else {
+                fullarg = g_strdup_printf("%s", value);
+            }
+            warn_report("using 'arg=%s' is deprecated", value);
+            error_printf("Please use '%s' directly\n", fullarg);
+        } else {
+            fullarg = g_strdup_printf("%s=%s", name, value);
+        }
+
         p = arg->curr;
         p->argc++;
         p->argv = g_realloc_n(p->argv, p->argc, sizeof(char *));
-        p->argv[p->argc - 1] = g_strdup(value);
-    } else {
-        error_setg(errp, "-plugin: unexpected parameter '%s'; ignored", name);
+        p->argv[p->argc - 1] = fullarg;
     }
+
     return 0;
 }
 
diff --git a/qemu-options.hx b/qemu-options.hx
index 83aa59a920..4a9ee722c9 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -4532,19 +4532,18 @@ SRST
 
 ERST
 DEF("plugin", HAS_ARG, QEMU_OPTION_plugin,
-    "-plugin [file=]<file>[,arg=<string>]\n"
+    "-plugin [file=]<file>[,<argname>=<argvalue>]\n"
     "                load a plugin\n",
     QEMU_ARCH_ALL)
 SRST
-``-plugin file=file[,arg=string]``
+``-plugin file=file[,argname=argvalue]``
     Load a plugin.
 
     ``file=file``
         Load the given plugin from a shared library file.
 
-    ``arg=string``
-        Argument string passed to the plugin. (Can be given multiple
-        times.)
+    ``argname=argvalue``
+        Argument passed to the plugin. (Can be given multiple times.)
 ERST
 
 HXCOMM Internal use
-- 
2.30.2



  parent reply	other threads:[~2021-09-03  9:07 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-03  9:03 [PULL 00/22] testing and plugin updates Alex Bennée
2021-09-03  9:03 ` [PULL 01/22] plugins/execlog: removed unintended "s" at the end of log lines Alex Bennée
2021-09-03  9:03 ` [PULL 02/22] gitlab-ci: Merge "build-disabled" with "build-without-default-features" Alex Bennée
2021-09-03  9:03 ` [PULL 03/22] gitlab-ci: Remove superfluous "dnf install" statement Alex Bennée
2021-09-03  9:03 ` [PULL 04/22] gitlab-ci: Fix ..._RUNNER_AVAILABLE variables and document them Alex Bennée
2021-09-03  9:03 ` [PULL 05/22] plugins: do not limit exported symbols if modules are active Alex Bennée
2021-09-03  9:03 ` [PULL 06/22] plugins/cache: supported multicore cache modelling Alex Bennée
2021-09-03  9:03 ` [PULL 07/22] plugins: sort exported symbol list Alex Bennée
2021-09-03  9:03 ` [PULL 08/22] docs/devel/tcg-plugins: added cores arg to cache plugin Alex Bennée
2021-09-03  9:03 ` Alex Bennée [this message]
2021-09-03  9:03 ` [PULL 10/22] plugins/api: added a boolean parsing plugin api Alex Bennée
2021-09-03  9:03 ` [PULL 11/22] plugins/hotpages: introduce sortby arg and parsed bool args correctly Alex Bennée
2021-09-03  9:03 ` [PULL 12/22] plugins/hotblocks: Added correct boolean argument parsing Alex Bennée
2021-09-03  9:03 ` [PULL 13/22] plugins/lockstep: make socket path not positional & parse bool arg Alex Bennée
2021-09-03  9:03 ` [PULL 14/22] plugins/hwprofile: adapt to the new plugin arguments scheme Alex Bennée
2021-09-03  9:03 ` [PULL 15/22] plugins/howvec: adapting to the new argument passing scheme Alex Bennée
2021-09-03  9:03 ` [PULL 16/22] docs/tcg-plugins: new passing parameters scheme for cache docs Alex Bennée
2021-09-03  9:03 ` [PULL 17/22] tests/plugins/bb: adapt to the new arg passing scheme Alex Bennée
2021-09-03  9:03 ` [PULL 18/22] tests/plugins/insn: made arg inline not positional and parse it as bool Alex Bennée
2021-09-03  9:03 ` [PULL 19/22] tests/plugins/mem: introduce "track" arg and make args not positional Alex Bennée
2021-09-03  9:03 ` [PULL 20/22] tests/plugins/syscalls: adhere to new arg-passing scheme Alex Bennée
2021-09-03  9:03 ` [PULL 21/22] docs/deprecated: deprecate passing plugin args through `arg=` Alex Bennée
2021-09-03  9:03 ` [PULL 22/22] docs/devel: be consistent about example plugin names Alex Bennée
2021-09-04 18:20 ` [PULL 00/22] testing and plugin updates Peter Maydell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210903090339.1074887-10-alex.bennee@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=erdnaxe@crans.org \
    --cc=laurent@vivier.eu \
    --cc=ma.mandourr@gmail.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).