Skip to content

new plugin argument passing scheme

Mahmoud Mandour qemu-devel 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest9 patches 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/9plugins: allow plugin arguments to be passed directlylinux-user/main.c plugins/loader.c qemu-options.hx+25 -100 replies
2/9plugins/api: added a boolean parsing plugin apiinclude/qemu/qemu-plugin.h plugins/api.c+18 -00 replies
3/9plugins/hotpages: introduce sortby arg and parsed bool args correctlycontrib/plugins/hotpages.c+20 -100 replies
4/9plugins/hotblocks: Added correct boolean argument parsingcontrib/plugins/hotblocks.c+12 -20 replies
5/9plugins/lockstep: make socket path not positional & parse bool argcontrib/plugins/lockstep.c docs/devel/tcg-plugins.rst+23 -100 replies
6/9plugins/hwprofile: adapt to the new plugin arguments schemecontrib/plugins/hwprofile.c docs/devel/tcg-plugins.rst+31 -160 replies
7/9plugins/howvec: Adapting to the new argument passing scheme.contrib/plugins/howvec.c docs/devel/tcg-plugins.rst+21 -130 replies
8/9docs/tcg-plugins: new passing parameters scheme for cache docsdocs/devel/tcg-plugins.rst+9 -90 replies
9/9docs/deprecated: deprecate passing plugin args through `arg=`docs/system/deprecated.rst+6 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/9] new plugin argument passing scheme

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(-)
Signature · 1 line
2.25.1