qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Mahmoud Mandour <ma.mandourr@gmail.com>
To: qemu-devel@nongnu.org
Cc: Mahmoud Mandour <ma.mandourr@gmail.com>, cota@braap.org
Subject: [PATCH 0/9] new plugin argument passing scheme
Date: Fri, 16 Jul 2021 10:03:36 +0200	[thread overview]
Message-ID: <20210716080345.136784-1-ma.mandourr@gmail.com> (raw)

Hello,

This series removes passing arguments to plugins through "arg=" since
it's redundant and reduces readability especially when the argument
itself is composed of a name and a value.

Also, passing arguments through "arg=" still works but is marked as
deprecated and will produce a deprecation warning.

Right now, the code for parsing the argument before passing it to the
plugin is unfortunately not so clean but that's mainly because "arg=" is
still supported.

At first, considering boolean parameters, those were not special to
plugins and QEMU did not complain about passing them in the form
"arg=bool_arg" even though that's considered a short-form boolean, which
is deprecated. As "arg" is removed, a deprecation warning is issued.

This is mitigated by making plugins aware of boolean arguments and
parses them through a newly exposed API, namely the `qapi_bool_parse`
function through a plugin API function. Now plugins expect boolean
parameters to be passed in the form that other parts of QEMU expect,
i.e. "bool_arg=[on|true|yes|off|false|no]".

Since we're still supporting "arg=arg_name", there are some assumptions
that I made that I think are suitable:

    1. "arg=arg_name" will be passed to the plugin as "arg_name=on".
    2. "arg=on" and "arg" will not be assumed to be the old way of
        passing args. Instead, it will assume that the argument name is
        "arg" and it's a boolean parameter. (will be passed to plugin
        as "arg=on")

The docs are updated accordingly and a deprecation notice is put in the
deprecated.rst file.

Mahmoud Mandour (9):
  plugins: allow plugin arguments to be passed directly
  plugins/api: added a boolean parsing plugin api
  plugins/hotpages: introduce sortby arg and parsed bool args correctly
  plugins/hotblocks: Added correct boolean argument parsing
  plugins/lockstep: make socket path not positional & parse bool arg
  plugins/hwprofile: adapt to the new plugin arguments scheme
  plugins/howvec: Adapting to the new argument passing scheme.
  docs/tcg-plugins: new passing parameters scheme for cache docs
  docs/deprecated: deprecate passing plugin args through `arg=`

 contrib/plugins/hotblocks.c | 14 +++++++++++--
 contrib/plugins/hotpages.c  | 30 ++++++++++++++++++----------
 contrib/plugins/howvec.c    | 24 +++++++++++++++--------
 contrib/plugins/hwprofile.c | 39 +++++++++++++++++++++++++------------
 contrib/plugins/lockstep.c  | 31 ++++++++++++++++++++---------
 docs/devel/tcg-plugins.rst  | 38 ++++++++++++++++++------------------
 docs/system/deprecated.rst  |  6 ++++++
 include/qemu/qemu-plugin.h  | 13 +++++++++++++
 linux-user/main.c           |  2 +-
 plugins/api.c               |  5 +++++
 plugins/loader.c            | 24 +++++++++++++++++++----
 qemu-options.hx             |  9 ++++-----
 12 files changed, 165 insertions(+), 70 deletions(-)

-- 
2.25.1



             reply	other threads:[~2021-07-16  8:06 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-16  8:03 Mahmoud Mandour [this message]
2021-07-16  8:03 ` [PATCH 1/9] plugins: allow plugin arguments to be passed directly Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 2/9] plugins/api: added a boolean parsing plugin api Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 3/9] plugins/hotpages: introduce sortby arg and parsed bool args correctly Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 4/9] plugins/hotblocks: Added correct boolean argument parsing Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 5/9] plugins/lockstep: make socket path not positional & parse bool arg Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 6/9] plugins/hwprofile: adapt to the new plugin arguments scheme Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 7/9] plugins/howvec: Adapting to the new argument passing scheme Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 8/9] docs/tcg-plugins: new passing parameters scheme for cache docs Mahmoud Mandour
2021-07-16  8:03 ` [PATCH 9/9] docs/deprecated: deprecate passing plugin args through `arg=` Mahmoud Mandour
2021-07-16  8:11 ` [PATCH 0/9] new plugin argument passing scheme Mahmoud Mandour

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=20210716080345.136784-1-ma.mandourr@gmail.com \
    --to=ma.mandourr@gmail.com \
    --cc=cota@braap.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).