new plugin argument passing scheme
v3 cover 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.
Based-on: <[email protected]>
However, the dependency is so light and it should only be in the patch
docs/tcg-plugins: new passing parameters scheme for cache docs
where it depends on
docs/devel/tcg-plugins: added cores arg to cache plugin
in the aforementioned series (conflict lies in the argument "cores=N" only.)
Patches that still need review:
plugins/api: added a boolean parsing plugin api docs/deprecated: deprecate passing plugin args through arg=
v2 -> v3:
1. Protected calling qapi_bool_parse by ensuring name & value are not NULL.
2. Updated the docs for the hotpages plugin to include its arguments
3. Typo in tests/plugins/mem (hadrr -> haddr)
4. Reword the deprecation entry in deprecated.rst
Mahmoud Mandour (13):
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 tests/plugins/bb: adapt to the new arg passing scheme tests/plugins/insn: made arg inline not positional and parse it as
bool
tests/plugins/mem: introduce "track" arg and make args not positional tests/plugins/syscalls: adhere to new arg-passing scheme docs/deprecated: deprecate passing plugin args through arg=
contrib/plugins/hotblocks.c | 14 ++++++++-- contrib/plugins/hotpages.c | 30 ++++++++++++++------- contrib/plugins/howvec.c | 27 +++++++++++++------ contrib/plugins/hwprofile.c | 39 ++++++++++++++++++--------- contrib/plugins/lockstep.c | 31 +++++++++++++++------- docs/devel/tcg-plugins.rst | 53 ++++++++++++++++++++++++------------- docs/system/deprecated.rst | 7 +++++ include/qemu/qemu-plugin.h | 13 +++++++++ linux-user/main.c | 2 +- plugins/api.c | 5 ++++ plugins/loader.c | 24 ++++++++++++++--- qemu-options.hx | 9 +++---- tests/plugin/bb.c | 15 ++++++++--- tests/plugin/insn.c | 14 ++++++++-- tests/plugin/mem.c | 47 +++++++++++++++++++------------- tests/plugin/syscall.c | 23 +++++++++++----- 16 files changed, 252 insertions(+), 101 deletions(-)
Signature · 1 line
2.25.1
PATCH v3 1/13 plugins: allow plugin arguments to be passed directly
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.
--- linux-user/main.c | 2 +- plugins/loader.c | 24 ++++++++++++++++++++---- qemu-options.hx | 9 ++++----- 3 files changed, 25 insertions(+), 10 deletions(-)
linux-user/main.c +1 -1
@@ -462,7 +462,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"},
plugins/loader.c +20 -4
@@ -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 ; }
qemu-options.hx +4 -5
@@ -4459,19 +4459,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
Signature · 1 line
2.25.1
PATCH v3 2/13 plugins/api: added a boolean parsing plugin api
In reply to Mahmoud MandourThis call will help boolean argument parsing since arguments are now passed to plugins as a name and value.
--- include/qemu/qemu-plugin.h | 13 +++++++++++++ plugins/api.c | 5 +++++ 2 files changed, 18 insertions(+)
include/qemu/qemu-plugin.h +13 -0
@@ -564,4 +564,17 @@ int qemu_plugin_n_max_vcpus(void);*/ void qemu_plugin_outs (const char *string); +/** +* qemu_plugin_bool_parse() - parses a boolean argument in the form of +* "<argname>=[on|yes|true|off|no|false]" +* +* @name: argument name, the part before the equals sign +* @val: argument value, what's after the equals sign +* @ret: output return value +* +* returns true if the combination @name=@val parses correctly to a boolean +* argument, and false otherwise +*/ +bool qemu_plugin_bool_parse (const char *name,const char *val,bool *ret); +#endif /* QEMU_PLUGIN_API_H */
plugins/api.c +5 -0
@@ -383,3 +383,8 @@ void qemu_plugin_outs(const char *string) {qemu_log_mask (CPU_LOG_PLUGIN ,"%s" , string); } + +bool qemu_plugin_bool_parse (const char *name,const char *value,bool *ret) +{ +return name && value &&qapi_bool_parse (name, value, ret,NULL ); +}
Signature · 1 line
2.25.1
PATCH v3 3/13 plugins/hotpages: introduce sortby arg and parsed bool args correctly
In reply to Mahmoud MandourSince plugin arguments now expect boolean arguments, a plugin argument name "sortby" now expects a value of "read", "write", or "address".
"io" arg is now expected to be passed as a full-form boolean parameter, i.e. "io=on|true|yes|off|false|no"
--- contrib/plugins/hotpages.c | 30 ++++++++++++++++++++---------- docs/devel/tcg-plugins.rst | 15 +++++++++++++++ 2 files changed, 35 insertions(+), 10 deletions(-)
contrib/plugins/hotpages.c +20 -10
@@ -169,16 +169,26 @@ int qemu_plugin_install(qemu_plugin_id_t id, const qemu_info_t *info,for (i =0 ; i < argc; i++) {char *opt = argv[i]; -if (g_strcmp0 (opt,"reads" ) ==0 ) { - sort_by =SORT_R ; - }else if (g_strcmp0 (opt,"writes" ) ==0 ) { - sort_by =SORT_W ; - }else if (g_strcmp0 (opt,"address" ) ==0 ) { - sort_by =SORT_A ; - }else if (g_strcmp0 (opt,"io" ) ==0 ) { - track_io = true; - }else if (g_str_has_prefix (opt,"pagesize=" )) { - page_size =g_ascii_strtoull (opt +9 ,NULL ,10 ); + g_autofree char **tokens = g_strsplit(opt, "=", -1); + +if (g_strcmp0 (tokens[0 ],"sortby" ) ==0 ) { +if (g_strcmp0 (tokens[1 ],"reads" ) ==0 ) { + sort_by =SORT_R ; + }else if (g_strcmp0 (tokens[1 ],"writes" ) ==0 ) { + sort_by =SORT_W ; + }else if (g_strcmp0 (tokens[1 ],"address" ) ==0 ) { + sort_by =SORT_A ; + }else { +fprintf (stderr,"invalid value to sortby: %s\n" , tokens[1 ]); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"io" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &track_io)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"pagesize" ) ==0 ) { + page_size =g_ascii_strtoull (tokens[1 ],NULL ,10 ); }else {fprintf (stderr,"option parsing failed: %s\n" , opt);return -1 ;
docs/devel/tcg-plugins.rst +15 -0
@@ -192,6 +192,21 @@ Similar to hotblocks but this time tracks memory accesses:: 0x0000000048b000, 0x0001, 130594, 0x0001, 355 0x0000000048a000, 0x0001, 1826, 0x0001, 11 +The hotpages plugin can be configured using the following arguments: + + * sortby=reads|writes|address + + Log the data sorted by either the number of reads, the number of writes, or + memory address. (Default: entries are sorted by the sum of reads and writes) + + * io=on + + Track IO addresses. Only relevant to full system emulation. (Default: off) + + * pagesize=N + + The page size used. (Default: N = 4096) + - contrib/plugins/howvec.c This is an instruction classifier so can be used to count different
Signature · 1 line
2.25.1
PATCH v3 4/13 plugins/hotblocks: Added correct boolean argument parsing
In reply to Mahmoud Mandour--- contrib/plugins/hotblocks.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)
contrib/plugins/hotblocks.c +12 -2
@@ -133,8 +133,18 @@ QEMU_PLUGIN_EXPORTint qemu_plugin_install (qemu_plugin_id_t id,const qemu_info_t *info,int argc,char **argv) { -if (argc &&strcmp (argv[0 ],"inline" ) ==0 ) { - do_inline = true; +for (int i =0 ; i < argc; i++) { +char *opt = argv[i]; + g_autofree char **tokens = g_strsplit(opt, "=", 2); +if (g_strcmp0 (tokens[0 ],"inline" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_inline)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else { +fprintf (stderr,"option parsing failed: %s\n" , opt); +return -1 ; + } }plugin_init ();
Signature · 1 line
2.25.1
PATCH v3 5/13 plugins/lockstep: make socket path not positional & parse bool arg
In reply to Mahmoud Mandour--- contrib/plugins/lockstep.c | 31 ++++++++++++++++++++++--------- docs/devel/tcg-plugins.rst | 2 +- 2 files changed, 23 insertions(+), 10 deletions(-)
contrib/plugins/lockstep.c +22 -9
@@ -319,22 +319,35 @@ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id, int argc, char **argv) { int i; - -if (!argc || !argv[0 ]) { -qemu_plugin_outs ("Need a socket path to talk to other instance." ); -return -1 ; - } + g_autofree char *sock_path = NULL;for (i =0 ; i < argc; i++) {char *p = argv[i]; -if (strcmp (p,"verbose" ) ==0 ) { - verbose = true; - }else if (!setup_unix_socket (argv[0 ])) { -qemu_plugin_outs ("Failed to setup socket for communications." ); + g_autofree char **tokens = g_strsplit(p, "=", 2); + +if (g_strcmp0 (tokens[0 ],"verbose" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &verbose)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , p); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"sockpath" ) ==0 ) { + sock_path = tokens[1 ]; + }else { +fprintf (stderr,"option parsing failed: %s\n" , p);return -1 ; } } +if (sock_path ==NULL ) { +fprintf (stderr,"Need a socket path to talk to other instance.\n" ); +return -1 ; + } + +if (!setup_unix_socket (sock_path)) { +fprintf (stderr,"Failed to setup socket for communications.\n" ); +return -1 ; + } + our_id = id;qemu_plugin_register_vcpu_tb_trans_cb (id, vcpu_tb_trans);
docs/devel/tcg-plugins.rst +1 -1
@@ -285,7 +285,7 @@ communicate over:: ./sparc-softmmu/qemu-system-sparc -monitor none -parallel none \ -net none -M SS-20 -m 256 -kernel day11/zImage.elf \ - -plugin ./contrib/plugins/liblockstep.so,arg=lockstep-sparc.sock \ + -plugin ./contrib/plugins/liblockstep.so,sockpath=lockstep-sparc.sock \ -d plugin,nochain which will eventually report::
Signature · 1 line
2.25.1
PATCH v3 6/13 plugins/hwprofile: adapt to the new plugin arguments scheme
In reply to Mahmoud MandourParsing boolean arguments correctly (e.g. pattern=on or source=false). Introduced a new "track" argument that takes a [read|write] value. This substitutes passing read or write to "arg=" that is deprecated.
Also, matches are now taken one by one through the "match" argument.
--- contrib/plugins/hwprofile.c | 39 +++++++++++++++++++++++++------------ docs/devel/tcg-plugins.rst | 8 ++++---- 2 files changed, 31 insertions(+), 16 deletions(-)
contrib/plugins/hwprofile.c +27 -12
@@ -259,27 +259,42 @@ int qemu_plugin_install(qemu_plugin_id_t id, const qemu_info_t *info, int argc, char **argv) { int i; +g_autoptr (GString) matches_raw =g_string_new ("" );for (i =0 ; i < argc; i++) {char *opt = argv[i]; -if (g_strcmp0 (opt,"read" ) ==0 ) { - rw =QEMU_PLUGIN_MEM_R ; - }else if (g_strcmp0 (opt,"write" ) ==0 ) { - rw =QEMU_PLUGIN_MEM_W ; - }else if (g_strcmp0 (opt,"pattern" ) ==0 ) { - pattern = true; - }else if (g_strcmp0 (opt,"source" ) ==0 ) { - source = true; - }else if (g_str_has_prefix (opt,"match" )) { -gchar **parts =g_strsplit (opt,"=" ,2 ); + g_autofree char **tokens = g_strsplit(opt, "=", 2); + +if (g_strcmp0 (tokens[0 ],"track" ) ==0 ) { +if (g_strcmp0 (tokens[1 ],"read" ) ==0 ) { + rw =QEMU_PLUGIN_MEM_R ; + }else if (g_strcmp0 (tokens[1 ],"write" ) ==0 ) { + rw =QEMU_PLUGIN_MEM_W ; + }else { +fprintf (stderr,"invalid value for track: %s\n" , tokens[1 ]); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"pattern" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &pattern)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"source" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &source)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"match" ) ==0 ) { check_match = true; - matches =g_strsplit (parts[1 ],"," ,-1 ); -g_strfreev (parts); +g_string_append_printf (matches_raw,"%s," , tokens[1 ]); }else {fprintf (stderr,"option parsing failed: %s\n" , opt);return -1 ; } } +if (check_match) { + matches =g_strsplit (matches_raw->str,"," ,-1 ); + }if (source && pattern) {fprintf (stderr,"can only currently track either source or pattern.\n" );
docs/devel/tcg-plugins.rst +4 -4
@@ -305,22 +305,22 @@ which will eventually report:: The hwprofile tool can only be used with system emulation and allows the user to see what hardware is accessed how often. It has a number of options: - * arg=read or arg=write + * track=read or track=write By default the plugin tracks both reads and writes. You can use one of these options to limit the tracking to just one class of accesses. - * arg=source + * source Will include a detailed break down of what the guest PC that made the - access was. Not compatible with arg=pattern. Example output:: + access was. Not compatible with the pattern option. Example output:: cirrus-low-memory @ 0xfffffd00000a0000 pc:fffffc0000005cdc, 1, 256 pc:fffffc0000005ce8, 1, 256 pc:fffffc0000005cec, 1, 256 - * arg=pattern + * pattern Instead break down the accesses based on the offset into the HW region. This can be useful for seeing the most used registers of a
Signature · 1 line
2.25.1
PATCH v3 7/13 plugins/howvec: Adapting to the new argument passing scheme.
In reply to Mahmoud MandourCorrectly parsing plugin argument since they now must be provided as full-form boolean parameters, e.g.:
-plugin ./contrib/plugins/libhowvec.so,verbose=on,inline=on
Also, introduced the argument "count" that accepts one opt to count individually at a time.
--- contrib/plugins/howvec.c | 27 +++++++++++++++++++-------- docs/devel/tcg-plugins.rst | 10 +++++----- 2 files changed, 24 insertions(+), 13 deletions(-)
contrib/plugins/howvec.c +19 -8
@@ -333,23 +333,34 @@ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,for (i =0 ; i < argc; i++) {char *p = argv[i]; -if (strcmp (p,"inline" ) ==0 ) { - do_inline = true; - }else if (strcmp (p,"verbose" ) ==0 ) { - verbose = true; - }else { + g_autofree char **tokens = g_strsplit(p, "=", -1); +if (g_strcmp0 (tokens[0 ],"inline" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_inline)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , p); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"verbose" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &verbose)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , p); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"count" ) ==0 ) { +char *value = tokens[1 ];int j;CountType type =COUNT_INDIVIDUAL ; -if (*p =='!' ) { +if (*value =='!' ) { type =COUNT_NONE ; - p++; + value++; }for (j =0 ; j < class_table_sz; j++) { -if (strcmp (p, class_table[j].opt) ==0 ) { +if (strcmp (value, class_table[j].opt) ==0 ) { class_table[j].what = type;break ; } } + }else { +fprintf (stderr,"option parsing failed: %s\n" , p); +return -1 ; } }
docs/devel/tcg-plugins.rst +5 -5
@@ -79,7 +79,7 @@ Once built a program can be run with multiple plugins loaded each with their own arguments:: $QEMU $OTHER_QEMU_ARGS \ - -plugin tests/plugin/libhowvec.so,arg=inline,arg=hint \ + -plugin tests/plugin/libhowvec.so,inline=on,count=hint \ -plugin tests/plugin/libhotblocks.so Arguments are plugin specific and can be used to modify their
@@ -211,13 +211,13 @@ The hotpages plugin can be configured using the following arguments: This is an instruction classifier so can be used to count different types of instructions. It has a number of options to refine which get -counted. You can give an argument for a class of instructions to break -it down fully, so for example to see all the system registers -accesses:: +counted. You can give a value to the `count` argument for a class of +instructions to break it down fully, so for example to see all the system +registers accesses:: ./aarch64-softmmu/qemu-system-aarch64 $(QEMU_ARGS) \ -append "root=/dev/sda2 systemd.unit=benchmark.service" \ - -smp 4 -plugin ./contrib/plugins/libhowvec.so,arg=sreg -d plugin + -smp 4 -plugin ./contrib/plugins/libhowvec.so,count=sreg -d plugin which will lead to a sorted list after the class breakdown::
Signature · 1 line
2.25.1
PATCH v3 8/13 docs/tcg-plugins: new passing parameters scheme for cache docs
In reply to Mahmoud Mandour--- docs/devel/tcg-plugins.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)
docs/devel/tcg-plugins.rst +9 -9
@@ -364,34 +364,34 @@ will report the following:: The plugin has a number of arguments, all of them are optional: - * arg="limit=N" + * limit=N Print top N icache and dcache thrashing instructions along with their address, number of misses, and its disassembly. (default: 32) - * arg="icachesize=N" - * arg="iblksize=B" - * arg="iassoc=A" + * icachesize=N + * iblksize=B + * iassoc=A Instruction cache configuration arguments. They specify the cache size, block size, and associativity of the instruction cache, respectively. (default: N = 16384, B = 64, A = 8) - * arg="dcachesize=N" - * arg="dblksize=B" - * arg="dassoc=A" + * dcachesize=N + * dblksize=B + * dassoc=A Data cache configuration arguments. They specify the cache size, block size, and associativity of the data cache, respectively. (default: N = 16384, B = 64, A = 8) - * arg="evict=POLICY" + * evict=POLICY Sets the eviction policy to POLICY. Available policies are: :code:`lru`, :code:`fifo`, and :code:`rand`. The plugin will use the specified policy for both instruction and data caches. (default: POLICY = :code:`lru`) - * arg="cores=N" + * cores=N Sets the number of cores for which we maintain separate icache and dcache. (default: for linux-user, N = 1, for full system emulation: N = cores
Signature · 1 line
2.25.1
PATCH v3 9/13 tests/plugins/bb: adapt to the new arg passing scheme
In reply to Mahmoud Mandour--- tests/plugin/bb.c | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-)
tests/plugin/bb.c +11 -4
@@ -104,10 +104,17 @@ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,for (i =0 ; i < argc; i++) {char *opt = argv[i]; -if (g_strcmp0 (opt,"inline" ) ==0 ) { - do_inline = true; - }else if (g_strcmp0 (opt,"idle" ) ==0 ) { - idle_report = true; + g_autofree char **tokens = g_strsplit(opt, "=", 2); +if (g_strcmp0 (tokens[0 ],"inline" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_inline)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"idle" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &idle_report)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } }else {fprintf (stderr,"option parsing failed: %s\n" , opt);return -1 ;
Signature · 1 line
2.25.1
PATCH v3 10/13 tests/plugins/insn: made arg inline not positional and parse it as bool
In reply to Mahmoud MandourMade argument "inline" not positional, this has two benefits. First is that we adhere to how QEMU passes args generally, by taking the last value of an argument and drop the others. And the second is that this sets up a framework for potentially adding new args easily.
--- tests/plugin/insn.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)
tests/plugin/insn.c +12 -2
@@ -62,8 +62,18 @@ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,const qemu_info_t *info, int argc, char **argv) { - if (argc && !strcmp(argv[0], "inline")) { - do_inline = true; + for (int i = 0; i < argc; i++) { +char *opt = argv[i]; + g_autofree char **tokens = g_strsplit(opt, "=", 2); +if (g_strcmp0 (tokens[0 ],"inline" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_inline)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else { +fprintf (stderr,"option parsing failed: %s\n" , opt); +return -1 ; + } }qemu_plugin_register_vcpu_tb_trans_cb (id, vcpu_tb_trans);
Signature · 1 line
2.25.1
PATCH v3 11/13 tests/plugins/mem: introduce "track" arg and make args not positional
In reply to Mahmoud MandourThis commit makes the plugin adhere to the new plugins arg-passing scheme by expecting full-form boolean args instead of short-form booleans. This necessitates that we introduce a new argument, here "track", to accept "r", "w", or "rw".
Also, it makes arguments not positional and we only care about the last value specified for a certain argument.
callback/inline args are now supplied separately as bool arguments so that both can be enabled individually.
--- tests/plugin/mem.c | 47 ++++++++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 18 deletions(-)
tests/plugin/mem.c +29 -18
@@ -80,29 +80,40 @@ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,const qemu_info_t *info, int argc, char **argv) { - if (argc) { - if (argc >= 3) { - if (!strcmp(argv[2], "haddr")) { - do_haddr = true; - } - } -if (argc >=2 ) { -const char *str = argv[1 ]; -if (!strcmp (str,"r" )) { + for (int i = 0; i < argc; i++) { +char *opt = argv[i]; + g_autofree char **tokens = g_strsplit(opt, "=", 2); + +if (g_strcmp0 (tokens[0 ],"haddr" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_haddr)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"track" ) ==0 ) { +if (g_strcmp0 (tokens[1 ],"r" ) ==0 ) { rw =QEMU_PLUGIN_MEM_R ; - }else if (!strcmp (str,"w" )) { + }else if (g_strcmp0 (tokens[1 ],"w" ) ==0 ) { rw =QEMU_PLUGIN_MEM_W ; + }else if (g_strcmp0 (tokens[1 ],"rw" ) ==0 ) { + rw =QEMU_PLUGIN_MEM_RW ; + }else { +fprintf (stderr,"invaild value for argument track: %s\n" , opt); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"inline" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_inline)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; + } + }else if (g_strcmp0 (tokens[0 ],"callback" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_callback)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); +return -1 ; } - } -if (!strcmp (argv[0 ],"inline" )) { - do_inline = true; - do_callback = false; - }else if (!strcmp (argv[0 ],"both" )) { - do_inline = true; - do_callback = true; }else { - do_callback = true; +fprintf (stderr,"option parsing failed: %s\n" , opt); +return -1 ; } }
Signature · 1 line
2.25.1
PATCH v3 12/13 tests/plugins/syscalls: adhere to new arg-passing scheme
In reply to Mahmoud Mandour--- tests/plugin/syscall.c | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-)
tests/plugin/syscall.c +16 -7
@@ -119,17 +119,26 @@ QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id,const qemu_info_t *info, int argc, char **argv) { - if (argc == 0) { - statistics =g_hash_table_new_full (NULL , g_direct_equal,NULL , g_free); - } else { -for (int i =0 ; i < argc; i++) { -if (g_strcmp0 (argv[i],"print" ) !=0 ) { -fprintf (stderr,"unsupported argument: %s\n" , argv[i]); -return -1 ; + bool do_print = false; + +for (int i =0 ; i < argc; i++) { +char *opt = argv[i]; + g_autofree char **tokens = g_strsplit(opt, "=", 2); + +if (g_strcmp0 (tokens[0 ],"print" ) ==0 ) { +if (!qemu_plugin_bool_parse (tokens[0 ], tokens[1 ], &do_print)) { +fprintf (stderr,"boolean argument parsing failed: %s\n" , opt); } + }else { +fprintf (stderr,"unsupported argument: %s\n" , argv[i]); +return -1 ; } } +if (!do_print) { + statistics =g_hash_table_new_full (NULL , g_direct_equal,NULL , g_free); + } +qemu_plugin_register_vcpu_syscall_cb (id, vcpu_syscall);qemu_plugin_register_vcpu_syscall_ret_cb (id, vcpu_syscall_ret);qemu_plugin_register_atexit_cb (id, plugin_exit,NULL );
Signature · 1 line
2.25.1
PATCH v3 13/13 docs/deprecated: deprecate passing plugin args through `arg=`
In reply to Mahmoud Mandour--- docs/system/deprecated.rst | 7 +++++++ 1 file changed, 7 insertions(+)
docs/system/deprecated.rst +7 -0
@@ -126,6 +126,13 @@ other options have been processed. This will either have no effect (if if they were not given. The property is therefore useless and should not be specified. +Plugin argument passing through ``arg=<string>`` (since 6.1) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Passing TCG plugins arguments through ``arg=`` is redundant is makes the +command-line less readable, especially when the argument itself consist of a +name and a value, e.g. ``-plugin plugin_name,arg="arg_name=arg_value"``. +Therefore, the usage of ``arg`` is redundant. QEMU Machine Protocol (QMP) commands ------------------------------------
Signature · 1 line
2.25.1
Quoted 44 lines · Mahmoud Mandour
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_parsefunction 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.rstfile.Based-on: <[email protected]>
However, the dependency is so light and it should only be in the patch
docs/tcg-plugins: new passing parameters scheme for cache docs
where it depends on
Quoted 9 lines
docs/devel/tcg-plugins: added cores arg to cache plugin
in the aforementioned series (conflict lies in the argument "cores=N" only.)
Patches that still need review:
plugins/api: added a boolean parsing plugin api docs/deprecated: deprecate passing plugin args througharg=
The patch
plugins/hwprofile: adapt to the new plugin arguments scheme
was also not reviewed in the previous versions so it still needs review.
Quoted 46 lines
v2 -> v3:
1. Protected callingqapi_bool_parseby ensuring name & value are not NULL.
2. Updated the docs for the hotpages plugin to include its arguments
3. Typo in tests/plugins/mem (hadrr -> haddr)
4. Reword the deprecation entry indeprecated.rstMahmoud Mandour (13):
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 tests/plugins/bb: adapt to the new arg passing scheme tests/plugins/insn: made arg inline not positional and parse it as
bool
tests/plugins/mem: introduce "track" arg and make args not positional tests/plugins/syscalls: adhere to new arg-passing scheme docs/deprecated: deprecate passing plugin args througharg=contrib/plugins/hotblocks.c | 14 ++++++++-- contrib/plugins/hotpages.c | 30 ++++++++++++++------- contrib/plugins/howvec.c | 27 +++++++++++++------ contrib/plugins/hwprofile.c | 39 ++++++++++++++++++--------- contrib/plugins/lockstep.c | 31 +++++++++++++++------- docs/devel/tcg-plugins.rst | 53 ++++++++++++++++++++++++------------- docs/system/deprecated.rst | 7 +++++ include/qemu/qemu-plugin.h | 13 +++++++++ linux-user/main.c | 2 +- plugins/api.c | 5 ++++ plugins/loader.c | 24 ++++++++++++++--- qemu-options.hx | 9 +++---- tests/plugin/bb.c | 15 ++++++++--- tests/plugin/insn.c | 14 ++++++++-- tests/plugin/mem.c | 47 +++++++++++++++++++------------- tests/plugin/syscall.c | 23 +++++++++++----- 16 files changed, 252 insertions(+), 101 deletions(-)--
2.25.1