[PATCH 0/4] compare machine type compat_props

[PATCH 0/4] compare machine type compat_props

[Maksim Davydov]

This script is necessary to choose the best machine type in the
appropriate cases. Also we have to check compat_props of the old MT 
after changes to be sure that they haven't broken old the MT. For 
example, pc_compat_3_1 of pc-q35-3.1 has Icelake-Client which was
removed in March.

changes:
* new default value print concept
* QEMU python library is used to collect qmp data
* remove auxiliary patches (that was used to fix ->get sematics)
* print compat_props in the correct order
* delete `absract` field to reduce output JSON size

Maksim Davydov (4):
  qom: add devault value
  qmp: add dump machine type compatible properties
  python/qmp: increase read buffer size
  scripts: add script to compare compatible properties

 hw/core/machine-qmp-cmds.c    |  22 +-
 python/qemu/qmp/qmp_client.py |   4 +-
 qapi/machine.json             |  54 ++++-
 qom/qom-qmp-cmds.c            |   2 +
 scripts/compare_mt.py         | 370 ++++++++++++++++++++++++++++++++++
 tests/qtest/fuzz/qos_fuzz.c   |   2 +-
 6 files changed, 448 insertions(+), 6 deletions(-)
 create mode 100755 scripts/compare_mt.py

-- 
2.25.1

[PATCH 1/4] qom: add devault value

[Maksim Davydov]

qmp_qom_list_properties can print default values if they are available
as qmp_device_list_properties does, because both of them use the
ObjectPropertyInfo structure with default_value field. This can be useful
when working with "not device" types.

Signed-off-by: Maksim Davydov <davydov-max@yandex-team.ru>
---
 qom/qom-qmp-cmds.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/qom/qom-qmp-cmds.c b/qom/qom-qmp-cmds.c
index 2e63a4c184..1d7867dc19 100644
--- a/qom/qom-qmp-cmds.c
+++ b/qom/qom-qmp-cmds.c
@@ -217,6 +217,8 @@ ObjectPropertyInfoList *qmp_qom_list_properties(const char *typename,
         info->type = g_strdup(prop->type);
         info->has_description = !!prop->description;
         info->description = g_strdup(prop->description);
+        info->default_value = qobject_ref(prop->defval);
+        info->has_default_value = !!info->default_value;
 
         QAPI_LIST_PREPEND(prop_list, info);
     }
-- 
2.25.1

Re: [PATCH 1/4] qom: add devault value

[Vladimir Sementsov-Ogievskiy]

On 9/8/22 13:36, Maksim Davydov wrote:
> qmp_qom_list_properties can print default values if they are available
> as qmp_device_list_properties does, because both of them use the
> ObjectPropertyInfo structure with default_value field. This can be useful
> when working with "not device" types.
> 
> Signed-off-by: Maksim Davydov<davydov-max@yandex-team.ru>


Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

-- 
Best regards,
Vladimir

[PATCH 2/4] qmp: add dump machine type compatible properties

[Maksim Davydov]

To control that creating new machine type doesn't affect the previous
types (their compat_props) and to check complex compat_props inheritance
we need qmp command to print machine type compatible properties.
This patch adds the ability to get list of all the compat_props of the
corresponding supported machines for their comparison via new optional
argument of "query-machines" command.

Signed-off-by: Maksim Davydov <davydov-max@yandex-team.ru>
---
 hw/core/machine-qmp-cmds.c  | 22 ++++++++++++++-
 qapi/machine.json           | 54 +++++++++++++++++++++++++++++++++++--
 tests/qtest/fuzz/qos_fuzz.c |  2 +-
 3 files changed, 74 insertions(+), 4 deletions(-)

diff --git a/hw/core/machine-qmp-cmds.c b/hw/core/machine-qmp-cmds.c
index 4f4ab30f8c..a6fc387439 100644
--- a/hw/core/machine-qmp-cmds.c
+++ b/hw/core/machine-qmp-cmds.c
@@ -74,7 +74,8 @@ CpuInfoFastList *qmp_query_cpus_fast(Error **errp)
     return head;
 }
 
-MachineInfoList *qmp_query_machines(Error **errp)
+MachineInfoList *qmp_query_machines(bool has_compat_props, bool compat_props,
+                                    Error **errp)
 {
     GSList *el, *machines = object_class_get_list(TYPE_MACHINE, false);
     MachineInfoList *mach_list = NULL;
@@ -107,6 +108,25 @@ MachineInfoList *qmp_query_machines(Error **errp)
             info->default_ram_id = g_strdup(mc->default_ram_id);
             info->has_default_ram_id = true;
         }
+        if (compat_props && mc->compat_props) {
+            int i;
+            info->compat_props = NULL;
+            CompatPropertyList **tail = &(info->compat_props);
+            info->has_compat_props = true;
+
+            for (i = 0; i < mc->compat_props->len; i++) {
+                GlobalProperty *mt_prop = g_ptr_array_index(mc->compat_props,
+                                                            i);
+                CompatProperty *prop;
+
+                prop = g_malloc0(sizeof(*prop));
+                prop->driver = g_strdup(mt_prop->driver);
+                prop->property = g_strdup(mt_prop->property);
+                prop->value = g_strdup(mt_prop->value);
+
+                QAPI_LIST_APPEND(tail, prop);
+            }
+        }
 
         QAPI_LIST_PREPEND(mach_list, info);
     }
diff --git a/qapi/machine.json b/qapi/machine.json
index 6afd1936b0..b5477224a8 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -127,6 +127,25 @@
 ##
 { 'command': 'query-cpus-fast', 'returns': [ 'CpuInfoFast' ] }
 
+##
+# @CompatProperty:
+#
+# Machine type compatible property. It's based on GlobalProperty and created
+# for machine type compat properties (see scripts)
+#
+# @driver: name of the driver that has GlobalProperty
+#
+# @property: global property name
+#
+# @value: global property value
+#
+# Since: 7.2
+##
+{ 'struct': 'CompatProperty',
+  'data': { 'driver': 'str',
+            'property': 'str',
+            'value': 'str' } }
+
 ##
 # @MachineInfo:
 #
@@ -155,6 +174,9 @@
 #
 # @default-ram-id: the default ID of initial RAM memory backend (since 5.2)
 #
+# @compat-props: List of compatible properties that defines machine type
+#                (since 7.2)
+#
 # Since: 1.2
 ##
 { 'struct': 'MachineInfo',
@@ -162,18 +184,46 @@
             '*is-default': 'bool', 'cpu-max': 'int',
             'hotpluggable-cpus': 'bool',  'numa-mem-supported': 'bool',
             'deprecated': 'bool', '*default-cpu-type': 'str',
-            '*default-ram-id': 'str' } }
+            '*default-ram-id': 'str', '*compat-props': ['CompatProperty'] } }
 
 ##
 # @query-machines:
 #
 # Return a list of supported machines
 #
+# @compat-props: if true return will contain information about machine type
+#                compatible properties (since 7.2)
+#
 # Returns: a list of MachineInfo
 #
 # Since: 1.2
+#
+# Example:
+#
+# -> { "execute": "query-machines", "arguments": { "compat-props": true } }
+# <- { "return": [
+#          {
+#              "hotpluggable-cpus": true,
+#              "name": "pc-q35-6.2",
+#              "compat-props": [
+#                  {
+#                      "driver": "virtio-mem",
+#                      "property": "unplugged-inaccessible",
+#                      "value": "off"
+#                   }
+#               ],
+#               "numa-mem-supported": false,
+#               "default-cpu-type": "qemu64-x86_64-cpu",
+#               "cpu-max": 288,
+#               "deprecated": false,
+#               "default-ram-id": "pc.ram"
+#           },
+#           ...
+#    }
 ##
-{ 'command': 'query-machines', 'returns': ['MachineInfo'] }
+{ 'command': 'query-machines',
+  'data': { '*compat-props': 'bool' },
+  'returns': ['MachineInfo'] }
 
 ##
 # @CurrentMachineParams:
diff --git a/tests/qtest/fuzz/qos_fuzz.c b/tests/qtest/fuzz/qos_fuzz.c
index c856d3d500..f0c9ed4c4b 100644
--- a/tests/qtest/fuzz/qos_fuzz.c
+++ b/tests/qtest/fuzz/qos_fuzz.c
@@ -46,7 +46,7 @@ static void qos_set_machines_devices_available(void)
     MachineInfoList *mach_info;
     ObjectTypeInfoList *type_info;
 
-    mach_info = qmp_query_machines(&error_abort);
+    mach_info = qmp_query_machines(false, false, &error_abort);
     machines_apply_to_node(mach_info);
     qapi_free_MachineInfoList(mach_info);
 
-- 
2.25.1

Re: [PATCH 2/4] qmp: add dump machine type compatible properties

[Vladimir Sementsov-Ogievskiy]

On 9/8/22 13:36, Maksim Davydov wrote:
> To control that creating new machine type doesn't affect the previous
> types (their compat_props) and to check complex compat_props inheritance
> we need qmp command to print machine type compatible properties.
> This patch adds the ability to get list of all the compat_props of the
> corresponding supported machines for their comparison via new optional
> argument of "query-machines" command.
> 
> Signed-off-by: Maksim Davydov<davydov-max@yandex-team.ru>


Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>


-- 
Best regards,
Vladimir

[PATCH 3/4] python/qmp: increase read buffer size

[Maksim Davydov]

After modification of "query-machines" command the buffer size should be
more than 452kB to contain output with compat-props.

Signed-off-by: Maksim Davydov <davydov-max@yandex-team.ru>
---
 python/qemu/qmp/qmp_client.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/python/qemu/qmp/qmp_client.py b/python/qemu/qmp/qmp_client.py
index 5dcda04a75..659fe4d98c 100644
--- a/python/qemu/qmp/qmp_client.py
+++ b/python/qemu/qmp/qmp_client.py
@@ -197,8 +197,8 @@ async def run(self, address='/tmp/qemu.socket'):
     #: Logger object used for debugging messages.
     logger = logging.getLogger(__name__)
 
-    # Read buffer limit; large enough to accept query-qmp-schema
-    _limit = (256 * 1024)
+    # Read buffer limit; large enough to accept query-machines
+    _limit = (512 * 1024)
 
     # Type alias for pending execute() result items
     _PendingT = Union[Message, ExecInterruptedError]
-- 
2.25.1

Re: [PATCH 3/4] python/qmp: increase read buffer size

[Vladimir Sementsov-Ogievskiy]

On 9/8/22 13:36, Maksim Davydov wrote:
> After modification of "query-machines" command the buffer size should be
> more than 452kB to contain output with compat-props.
> 
> Signed-off-by: Maksim Davydov <davydov-max@yandex-team.ru>
> ---
>   python/qemu/qmp/qmp_client.py | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/python/qemu/qmp/qmp_client.py b/python/qemu/qmp/qmp_client.py
> index 5dcda04a75..659fe4d98c 100644
> --- a/python/qemu/qmp/qmp_client.py
> +++ b/python/qemu/qmp/qmp_client.py
> @@ -197,8 +197,8 @@ async def run(self, address='/tmp/qemu.socket'):
>       #: Logger object used for debugging messages.
>       logger = logging.getLogger(__name__)
>   
> -    # Read buffer limit; large enough to accept query-qmp-schema
> -    _limit = (256 * 1024)
> +    # Read buffer limit; large enough to accept query-machines
> +    _limit = (512 * 1024)
>   
>       # Type alias for pending execute() result items
>       _PendingT = Union[Message, ExecInterruptedError]


Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

This patch should better go before 02, to never break things in the history.

-- 
Best regards,
Vladimir

[PATCH 4/4] scripts: add script to compare compatible properties

[Maksim Davydov]

This script run QEMU to obtain compat_props of machines and default
values of different types and produce appropriate table. This table
can be used to compare machine types to choose the most suitable
machine. Also table in json or csv format should be used to check that
new machine doesn't affect previous ones via comparisin tables with and
without new machine.
Default values of properties are needed to fill "holes" in the table (one
machine has these properties and another not).

Notes:
* some init values from the devices can't be available like properties
from virtio-9p when configure has --disable-virtfs. This situations will
be seen in the table as "unavailable driver".
* Default values can be get can be obtained in an unobvious way, like
x86 features. If the script doesn't know how to get property default value
to compare one machine with another it fills "holes" with "unavailable
method". This is done because script uses whitelist model to get default
values of different types. It means that the method that can't be applied
to a new type that can crash this script. It is better to get an
"unavailable driver" when creating a new machine with new compatible
properties than to break this script. So it turns out a more stable and
generic script.
* If the default value can't be obtained because this property doesn't
exist or because this property can't have default value, appropriate
"hole" will be filled by "unknown property" or "no default value"
* If the property is applied to the abstract class, the script collects
default values from all child classes (set of default values)

Example:

scripts/compare_mt.py --MT pc-q35-3.1 pc-q35-2.12

╒════════════════════════════════════╤═══════════════╤═══════════════╕
│                                    │  pc-q35-2.12  │  pc-q35-3.1   │
╞════════════════════════════════════╪═══════════════╪═══════════════╡
│    EPYC-IBPB-x86_64-cpu-xlevel     │  0x8000000a   │  2147483678   │
├────────────────────────────────────┼───────────────┼───────────────┤
│       EPYC-x86_64-cpu-xlevel       │  0x8000000a   │  2147483678   │
├────────────────────────────────────┼───────────────┼───────────────┤
│ Skylake-Server-IBRS-x86_64-cpu-pku │     False     │     True      │
├────────────────────────────────────┼───────────────┼───────────────┤
│   Skylake-Server-x86_64-cpu-pku    │     False     │     True      │
├────────────────────────────────────┼───────────────┼───────────────┤
│         VGA-global-vmstate         │     True      │     False     │
├────────────────────────────────────┼───────────────┼───────────────┤
│     cirrus-vga-global-vmstate      │     True      │     False     │
├────────────────────────────────────┼───────────────┼───────────────┤
│        hda-audio-use-timer         │     False     │     True      │
├────────────────────────────────────┼───────────────┼───────────────┤
│  migration-decompress-error-check  │     False     │     True      │
├────────────────────────────────────┼───────────────┼───────────────┤
│       qxl-vga-global-vmstate       │     True      │     False     │
├────────────────────────────────────┼───────────────┼───────────────┤
│     vmware-svga-global-vmstate     │     True      │     False     │
├────────────────────────────────────┼───────────────┼───────────────┤
│      x86_64-cpu-legacy-cache       │     True      │ [True, False] │
├────────────────────────────────────┼───────────────┼───────────────┤
│         x86_64-cpu-topoext         │     False     │ [True, False] │
├────────────────────────────────────┼───────────────┼───────────────┤
│   x86_64-cpu-x-hv-synic-kvm-only   │     True      │     False     │
╘════════════════════════════════════╧═══════════════╧═══════════════╛

Signed-off-by: Maksim Davydov <davydov-max@yandex-team.ru>
---
 scripts/compare_mt.py | 370 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 370 insertions(+)
 create mode 100755 scripts/compare_mt.py

diff --git a/scripts/compare_mt.py b/scripts/compare_mt.py
new file mode 100755
index 0000000000..a063c79682
--- /dev/null
+++ b/scripts/compare_mt.py
@@ -0,0 +1,370 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) Yandex Technologies LLC, 2022
+#
+# Script to compare machine type compatible properties
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, see <http://www.gnu.org/licenses/>.
+
+from tabulate import tabulate
+import json
+import sys
+from os import path
+from argparse import ArgumentParser, RawTextHelpFormatter
+import pandas as pd
+
+try:
+    qemu_dir = path.abspath(path.dirname(path.dirname(__file__)))
+    sys.path.append(path.join(qemu_dir, 'python'))
+    from qemu.machine import QEMUMachine
+    from qemu.qmp import ConnectError
+except ModuleNotFoundError as exc:
+    print(f"Module '{exc.name}' not found.")
+    print("Try export PYTHONPATH=top-qemu-dir/python or run from top-qemu-dir")
+    sys.exit(1)
+
+
+DEF_CMD_LINE = 'build/qemu-system-x86_64 -enable-kvm -machine none'
+
+
+# Methods to get right values of drivers props
+#
+# Use these methods as a 'whitelist' and add entries only if necessary. It's
+# important in analysis and tests.
+# Names should be in qom-list-types format (486-x86_64-cpu, not 486)
+# The latest definition wins:
+# 1) device
+# 2) cpu
+# 3) 486-x86_64-cpu
+# For 486 will be used - 3) rule, for virtio device - 1), for Haswell - 2)
+def get_device_prop(vm, device, prop_name):
+    args = {'typename': device}
+    device_props = vm.command('device-list-properties', **args)
+    for prop in device_props:
+        if prop['name'] == prop_name:
+            return str(prop.get('default-value', 'No default value'))
+
+    return 'Unknown property'
+
+
+def get_x86_64_cpu_prop(vm, device, prop_name):
+    # crop last 11 chars '-x86_64-cpu'
+    args = {'type': 'full', 'model': {'name': device[:-11]}}
+    props = vm.command('query-cpu-model-expansion', **args)['model']['props']
+    return str(props.get(prop_name, 'Unknown property'))
+
+
+# Now it's stub, because all memory_backend types don't have default values
+# but this behaviour can be changed
+def get_memory_backend_prop(vm, driver, prop_name):
+    args = {'typename': driver}
+    memory_backend_props = vm.command('qom-list-properties', **args)
+    for prop in memory_backend_props:
+        if prop['name'] == prop_name:
+            return str(prop.get('default-value', 'No default value'))
+
+    return 'Unknown property'
+
+
+property_methods = [
+    {'name': 'device', 'method': get_device_prop},
+    {'name': 'x86_64-cpu', 'method': get_x86_64_cpu_prop},
+    {'name': 'memory-backend', 'method': get_memory_backend_prop}
+    ]
+# End of methods definition
+
+
+def parse_args():
+    parser = ArgumentParser(formatter_class=RawTextHelpFormatter,
+                            description='Script to compare machine types '
+                            '(their compat_props).\n\n'
+                            'The script execution with --all option may take '
+                            'several minutes!\n\n'
+                            'If a property applies to an abstract class this '
+                            'script collects default values of all child '
+                            'classes and prints them as a set.\n\n'
+                            '"Unavailable method" - means that this script '
+                            'doesn\'t know how to get default values of the '
+                            'driver. To add method use the construction '
+                            'described at the top of the script.\n'
+                            '"Unavailable driver" - means that this script '
+                            'doesn\'t know this driver. For instance, this '
+                            'can happen if you configure QEMU without this '
+                            'device or if machine type definition has error.\n'
+                            '"No default value" - means that the appropriate '
+                            'method can\'t get the default value and most '
+                            'likely that this property doesn\'t have it.\n'
+                            '"Unknown property" - means that the appropriate '
+                            'method can\'t find property with this name.')
+
+    parser.add_argument('--json', action='store_true',
+                        help='returns table in json format')
+    parser.add_argument('--csv', action='store_true',
+                        help='returns table in csv format')
+    parser.add_argument('--all', action='store_true',
+                        help='prints all available machine types (list of '
+                             'machine types will be ignored)')
+    parser.add_argument('--MT', nargs="*", type=str,
+                        help='list of Machine Types that will be compared')
+    parser.add_argument('--raw', action='store_true',
+                        help='prints ALL defined properties without '
+                             'value transformation. By default, '
+                             'only properties with different values '
+                             'printed and with value transformation(like '
+                             '"on" -> True)')
+    parser.add_argument('--cmd-line', default=DEF_CMD_LINE,
+                        help='command line to start qemu.'
+                             'Default: {}'.format(DEF_CMD_LINE))
+    return parser.parse_args()
+
+
+# return touple (name, major, minor, revision)
+def MT_comp(MT):
+    splited_name = MT['name'].rsplit('-', 1)
+    if len(splited_name) == 2:
+        version = splited_name[1].split('.')
+        if len(version) == 2:
+            return (splited_name[0], int(version[0]), int(version[1]), 0)
+        if len(version) == 3:
+            return (splited_name[0],
+                    int(version[0]), int(version[1]), int(version[2]))
+
+    return (splited_name[0], 0, 0, 0)
+
+
+def get_MT_definitions(vm):
+    args = {'compat-props': True}
+    raw_MT_defs = vm.command('query-machines', **args)
+    MT_defs = [] # MT: {driver_1: set_of_props, ...}
+    for raw_MT in raw_MT_defs:
+        compat_props = {}
+        for prop in raw_MT['compat-props']:
+            if not compat_props.get(prop['driver'], None):
+                compat_props[prop['driver']] = {}
+            compat_props[prop['driver']][prop['property']] = prop['value']
+        MT_defs.append({'name': raw_MT['name'], 'compat-props': compat_props})
+
+    MT_defs.sort(key=MT_comp)
+    return MT_defs
+
+
+def get_req_props(MT_defs):
+    driver_props = {}
+    for MT in MT_defs:
+        compat_props = MT['compat-props']
+        for driver, prop in compat_props.items():
+            if driver not in driver_props:
+                driver_props[driver] = set()
+            driver_props[driver].update(prop.keys())
+
+    return driver_props
+
+
+def get_driver_definitions(vm):
+    args = {'abstract': True}
+    qom_all_types = vm.command('qom-list-types', **args)
+
+    driver_to_def = {}
+    for obj_type in qom_all_types:
+        # parent of Object is None
+        parent = obj_type.get('parent', None)
+        abstr  = obj_type.get('abstract', False)
+        driver_to_def[obj_type['name']] = {
+            'parent': parent,
+            'abstract': abstr,
+            'method': None}
+        if abstr:
+            type_args = {'implements': obj_type['name'], 'abstract': True}
+            list_child_objs = vm.command('qom-list-types', **type_args)
+            child_list = [child['name'] for child in list_child_objs]
+            driver_to_def[obj_type['name']]['child_list'] = child_list
+
+    for driver in property_methods:
+        if not driver_to_def[driver['name']]['abstract']:
+            driver_to_def[driver['name']]['method'] = driver['method']
+            continue
+
+        for child in driver_to_def[driver['name']]['child_list']:
+            driver_to_def[child]['method'] = driver['method']
+
+    return driver_to_def
+
+
+def fill_prop_table(vm, MT_list, driver_props, driver_defs):
+    table = {}
+    for driver, props in sorted(driver_props.items()):
+        for prop in sorted(props):
+            name = '{}-{}'.format(driver, prop)
+            table[name] = []
+            for MT in MT_list:
+                compat_props = MT['compat-props']
+                if compat_props.get(driver, None):
+                    if compat_props[driver].get(prop, None):
+                        table[name].append(compat_props[driver][prop])
+                        continue
+
+                # properties from QEMU (not from machine type compat_props)
+                # properties from another architecture or config
+                if not driver_defs.get(driver, None):
+                    table[name].append('Unavailable driver')
+                    continue
+
+                if not driver_defs[driver]['abstract']:
+                    if driver_defs[driver]['method'] is None:
+                        table[name].append('Unavailable method')
+                    else:
+                        table[name].append(
+                            driver_defs[driver]['method'](vm, driver, prop))
+                else:
+                    children = driver_defs[driver]['child_list']
+                    values = set()
+                    for child in children:
+                        if driver_defs[child]['abstract']:
+                            continue
+
+                        if driver_defs[child]['method'] is None:
+                            values.add('Unavailable method')
+                        else:
+                            values.add(
+                                driver_defs[child]['method'](vm, child, prop))
+
+                    table[name].append(list(values))
+
+    headers = [MT['name'] for MT in MT_list]
+    return pd.DataFrame.from_dict(table, orient='index', columns=headers)
+
+
+def transform_value(value):
+    true_list = ['true', 'on']
+    false_list = ['false', 'off']
+
+    out = value.lower()
+
+    if out in true_list:
+        return True
+
+    if out in false_list:
+        return False
+
+    return out
+
+
+# Only hex, dec and oct formats
+def transform_number(value):
+    try:
+        # C doesn't work with underscore ('2_5' != 25)
+        if '_' in value:
+            raise ValueError
+
+        if 'x' in value or 'X' in value:
+            return int(value, 16)
+
+        if 'o' in value or 'O' in value:
+            return int(value, 8)
+
+        return int(value)
+
+    except ValueError:
+        return None
+
+
+def transformed_table(table):
+    new_table = {}
+    for index, row in table.iterrows():
+        new_row = []
+        all_values = set()
+        # We want to save original hex/decimal format if not all values
+        # are the same in the row. So, transformed and not transformed will be
+        # stored
+        numeric_values = set()
+        for MT_prop_val in row:
+            if type(MT_prop_val) is list:
+                transformed = [transform_value(val) for val in MT_prop_val]
+                if len(transformed) == 1:
+                    new_row.append(transformed[0])
+                else:
+                    new_row.append(transformed)
+
+                numeric_values.update(set([transform_number(val)
+                                           for val in MT_prop_val]))
+                all_values.update(set(transformed))
+            else:
+                transformed = transform_value(MT_prop_val)
+                new_row.append(transformed)
+                numeric_values.add(transform_number(MT_prop_val))
+                all_values.add(transformed)
+
+        if len(table.columns) > 1:
+            if len(all_values) == 1:
+                continue
+
+            if not None in numeric_values and len(numeric_values) == 1:
+                continue
+
+        new_table[index] = new_row
+
+    return pd.DataFrame.from_dict(new_table, orient='index',
+                                  columns=table.columns.values)
+
+
+if __name__ == '__main__':
+    args = parse_args()
+    qemu_arg_list = args.cmd_line.split(' ')
+    with QEMUMachine(binary=qemu_arg_list[0],
+                     qmp_timer=15, args=qemu_arg_list[1:]) as vm:
+        vm.launch()
+        MT_defs = get_MT_definitions(vm)
+        list_MT = [MT['name'] for MT in MT_defs]
+
+        if not args.all:
+            if args.MT is None:
+                print('Enter machine types for comparision or use --help')
+                print('List of available machine types:')
+                print(*list_MT, sep='\n')
+                sys.exit(1)
+
+            for MT in args.MT:
+                if MT not in list_MT:
+                    print('Wrong machine type name')
+                    print('List of available machine types:')
+                    print(*list_MT, sep='\n')
+                    sys.exit(1)
+
+        req_MT = []
+        if args.all:
+            req_MT = MT_defs
+        else:
+            for MT in MT_defs:
+                if MT['name'] in args.MT:
+                    req_MT.append(MT)
+
+        if len(req_MT) == 1:
+            args.full = True
+
+        req_driver_props = get_req_props(req_MT)
+        driver_defs = get_driver_definitions(vm)
+        comp_table = fill_prop_table(vm, req_MT, req_driver_props, driver_defs)
+        if not args.raw:
+            comp_table = transformed_table(comp_table)
+
+        if args.json:
+            print(comp_table.to_json())
+        elif args.csv:
+            print(comp_table.to_csv())
+        else:
+            print(tabulate(comp_table, showindex=True, stralign='center',
+                           tablefmt='fancy_grid', headers='keys',
+                           disable_numparse=True))
+
+        vm.shutdown()
-- 
2.25.1

Re: [PATCH 4/4] scripts: add script to compare compatible properties

[Vladimir Sementsov-Ogievskiy]

On 9/8/22 13:36, Maksim Davydov wrote:
> This script run QEMU to obtain compat_props of machines and default
> values of different types and produce appropriate table. This table
> can be used to compare machine types to choose the most suitable
> machine. Also table in json or csv format should be used to check that
> new machine doesn't affect previous ones via comparisin tables with and
> without new machine.
> Default values of properties are needed to fill "holes" in the table (one
> machine has these properties and another not).
> 
> Notes:
> * some init values from the devices can't be available like properties
> from virtio-9p when configure has --disable-virtfs. This situations will
> be seen in the table as "unavailable driver".
> * Default values can be get can be obtained in an unobvious way, like
> x86 features. If the script doesn't know how to get property default value
> to compare one machine with another it fills "holes" with "unavailable
> method". This is done because script uses whitelist model to get default
> values of different types. It means that the method that can't be applied
> to a new type that can crash this script. It is better to get an
> "unavailable driver" when creating a new machine with new compatible
> properties than to break this script. So it turns out a more stable and
> generic script.
> * If the default value can't be obtained because this property doesn't
> exist or because this property can't have default value, appropriate
> "hole" will be filled by "unknown property" or "no default value"
> * If the property is applied to the abstract class, the script collects
> default values from all child classes (set of default values)
> 
> Example:
> 
> scripts/compare_mt.py --MT pc-q35-3.1 pc-q35-2.12
> 
> ╒════════════════════════════════════╤═══════════════╤═══════════════╕
> │                                    │  pc-q35-2.12  │  pc-q35-3.1   │
> ╞════════════════════════════════════╪═══════════════╪═══════════════╡
> │    EPYC-IBPB-x86_64-cpu-xlevel     │  0x8000000a   │  2147483678   │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │       EPYC-x86_64-cpu-xlevel       │  0x8000000a   │  2147483678   │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │ Skylake-Server-IBRS-x86_64-cpu-pku │     False     │     True      │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │   Skylake-Server-x86_64-cpu-pku    │     False     │     True      │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │         VGA-global-vmstate         │     True      │     False     │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │     cirrus-vga-global-vmstate      │     True      │     False     │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │        hda-audio-use-timer         │     False     │     True      │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │  migration-decompress-error-check  │     False     │     True      │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │       qxl-vga-global-vmstate       │     True      │     False     │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │     vmware-svga-global-vmstate     │     True      │     False     │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │      x86_64-cpu-legacy-cache       │     True      │ [True, False] │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │         x86_64-cpu-topoext         │     False     │ [True, False] │
> ├────────────────────────────────────┼───────────────┼───────────────┤
> │   x86_64-cpu-x-hv-synic-kvm-only   │     True      │     False     │
> ╘════════════════════════════════════╧═══════════════╧═══════════════╛
> 
> Signed-off-by: Maksim Davydov <davydov-max@yandex-team.ru>
> ---
>   scripts/compare_mt.py | 370 ++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 370 insertions(+)
>   create mode 100755 scripts/compare_mt.py
> 
> diff --git a/scripts/compare_mt.py b/scripts/compare_mt.py
> new file mode 100755
> index 0000000000..a063c79682
> --- /dev/null
> +++ b/scripts/compare_mt.py
> @@ -0,0 +1,370 @@
> +#!/usr/bin/env python3
> +#
> +# Copyright (c) Yandex Technologies LLC, 2022
> +#
> +# Script to compare machine type compatible properties
> +#
> +# This program is free software; you can redistribute it and/or modify
> +# it under the terms of the GNU General Public License as published by
> +# the Free Software Foundation; either version 2 of the License, or
> +# (at your option) any later version.
> +#
> +# This program is distributed in the hope that it will be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> +# GNU General Public License for more details.
> +#
> +# You should have received a copy of the GNU General Public License
> +# along with this program; if not, see <http://www.gnu.org/licenses/>.
> +
> +from tabulate import tabulate
> +import json

json import unused

> +import sys
> +from os import path
> +from argparse import ArgumentParser, RawTextHelpFormatter
> +import pandas as pd
> +
> +try:
> +    qemu_dir = path.abspath(path.dirname(path.dirname(__file__)))
> +    sys.path.append(path.join(qemu_dir, 'python'))
> +    from qemu.machine import QEMUMachine
> +    from qemu.qmp import ConnectError

ConnectError unused

> +except ModuleNotFoundError as exc:
> +    print(f"Module '{exc.name}' not found.")
> +    print("Try export PYTHONPATH=top-qemu-dir/python or run from top-qemu-dir")
> +    sys.exit(1)
> +
> +
> +DEF_CMD_LINE = 'build/qemu-system-x86_64 -enable-kvm -machine none'
> +
> +
> +# Methods to get right values of drivers props
> +#
> +# Use these methods as a 'whitelist' and add entries only if necessary. It's
> +# important in analysis and tests.
> +# Names should be in qom-list-types format (486-x86_64-cpu, not 486)
> +# The latest definition wins:
> +# 1) device
> +# 2) cpu
> +# 3) 486-x86_64-cpu
> +# For 486 will be used - 3) rule, for virtio device - 1), for Haswell - 2)
> +def get_device_prop(vm, device, prop_name):
> +    args = {'typename': device}
> +    device_props = vm.command('device-list-properties', **args)
> +    for prop in device_props:
> +        if prop['name'] == prop_name:
> +            return str(prop.get('default-value', 'No default value'))
> +
> +    return 'Unknown property'
> +
> +
> +def get_x86_64_cpu_prop(vm, device, prop_name):
> +    # crop last 11 chars '-x86_64-cpu'
> +    args = {'type': 'full', 'model': {'name': device[:-11]}}
> +    props = vm.command('query-cpu-model-expansion', **args)['model']['props']
> +    return str(props.get(prop_name, 'Unknown property'))
> +
> +
> +# Now it's stub, because all memory_backend types don't have default values
> +# but this behaviour can be changed
> +def get_memory_backend_prop(vm, driver, prop_name):
> +    args = {'typename': driver}
> +    memory_backend_props = vm.command('qom-list-properties', **args)
> +    for prop in memory_backend_props:
> +        if prop['name'] == prop_name:
> +            return str(prop.get('default-value', 'No default value'))
> +
> +    return 'Unknown property'
> +
> +
> +property_methods = [
> +    {'name': 'device', 'method': get_device_prop},
> +    {'name': 'x86_64-cpu', 'method': get_x86_64_cpu_prop},
> +    {'name': 'memory-backend', 'method': get_memory_backend_prop}
> +    ]
> +# End of methods definition
> +
> +
> +def parse_args():
> +    parser = ArgumentParser(formatter_class=RawTextHelpFormatter,
> +                            description='Script to compare machine types '
> +                            '(their compat_props).\n\n'
> +                            'The script execution with --all option may take '
> +                            'several minutes!\n\n'
> +                            'If a property applies to an abstract class this '
> +                            'script collects default values of all child '
> +                            'classes and prints them as a set.\n\n'
> +                            '"Unavailable method" - means that this script '
> +                            'doesn\'t know how to get default values of the '
> +                            'driver. To add method use the construction '
> +                            'described at the top of the script.\n'
> +                            '"Unavailable driver" - means that this script '
> +                            'doesn\'t know this driver. For instance, this '
> +                            'can happen if you configure QEMU without this '
> +                            'device or if machine type definition has error.\n'
> +                            '"No default value" - means that the appropriate '
> +                            'method can\'t get the default value and most '
> +                            'likely that this property doesn\'t have it.\n'
> +                            '"Unknown property" - means that the appropriate '
> +                            'method can\'t find property with this name.')

Please use triple quotes for this, like
      description="""\

A lot of text with new
lines ...
..."""

> +
> +    parser.add_argument('--json', action='store_true',
> +                        help='returns table in json format')
> +    parser.add_argument('--csv', action='store_true',
> +                        help='returns table in csv format')
> +    parser.add_argument('--all', action='store_true',
> +                        help='prints all available machine types (list of '
> +                             'machine types will be ignored)')
> +    parser.add_argument('--MT', nargs="*", type=str,
> +                        help='list of Machine Types that will be compared')
> +    parser.add_argument('--raw', action='store_true',
> +                        help='prints ALL defined properties without '
> +                             'value transformation. By default, '
> +                             'only properties with different values '
> +                             'printed and with value transformation(like '
> +                             '"on" -> True)')
> +    parser.add_argument('--cmd-line', default=DEF_CMD_LINE,
> +                        help='command line to start qemu.'
> +                             'Default: {}'.format(DEF_CMD_LINE))
> +    return parser.parse_args()
> +
> +
> +# return touple (name, major, minor, revision)

tuple

> +def MT_comp(MT):
> +    splited_name = MT['name'].rsplit('-', 1)

accordingly to PEP8 function and variable names should be lowercase. So please don't use uppercase for it, it's harder to read.

> +    if len(splited_name) == 2:
> +        version = splited_name[1].split('.')
> +        if len(version) == 2:
> +            return (splited_name[0], int(version[0]), int(version[1]), 0)
> +        if len(version) == 3:
> +            return (splited_name[0],
> +                    int(version[0]), int(version[1]), int(version[2]))
> +
> +    return (splited_name[0], 0, 0, 0)
> +
> +
> +def get_MT_definitions(vm):
> +    args = {'compat-props': True}
> +    raw_MT_defs = vm.command('query-machines', **args)
> +    MT_defs = [] # MT: {driver_1: set_of_props, ...}
> +    for raw_MT in raw_MT_defs:
> +        compat_props = {}
> +        for prop in raw_MT['compat-props']:
> +            if not compat_props.get(prop['driver'], None):

this condition is better to write like:

    if prop['driver'] not in compat_props:

> +                compat_props[prop['driver']] = {}
> +            compat_props[prop['driver']][prop['property']] = prop['value']
> +        MT_defs.append({'name': raw_MT['name'], 'compat-props': compat_props})
> +
> +    MT_defs.sort(key=MT_comp)
> +    return MT_defs
> +
> +
> +def get_req_props(MT_defs):
> +    driver_props = {}
> +    for MT in MT_defs:
> +        compat_props = MT['compat-props']
> +        for driver, prop in compat_props.items():
> +            if driver not in driver_props:
> +                driver_props[driver] = set()
> +            driver_props[driver].update(prop.keys())
> +
> +    return driver_props
> +
> +
> +def get_driver_definitions(vm):
> +    args = {'abstract': True}
> +    qom_all_types = vm.command('qom-list-types', **args)
> +
> +    driver_to_def = {}
> +    for obj_type in qom_all_types:
> +        # parent of Object is None
> +        parent = obj_type.get('parent', None)
> +        abstr  = obj_type.get('abstract', False)

double space breaks PEP8

> +        driver_to_def[obj_type['name']] = {
> +            'parent': parent,
> +            'abstract': abstr,
> +            'method': None}
> +        if abstr:
> +            type_args = {'implements': obj_type['name'], 'abstract': True}
> +            list_child_objs = vm.command('qom-list-types', **type_args)
> +            child_list = [child['name'] for child in list_child_objs]
> +            driver_to_def[obj_type['name']]['child_list'] = child_list
> +
> +    for driver in property_methods:
> +        if not driver_to_def[driver['name']]['abstract']:
> +            driver_to_def[driver['name']]['method'] = driver['method']
> +            continue
> +
> +        for child in driver_to_def[driver['name']]['child_list']:
> +            driver_to_def[child]['method'] = driver['method']
> +
> +    return driver_to_def
> +
> +
> +def fill_prop_table(vm, MT_list, driver_props, driver_defs):
> +    table = {}
> +    for driver, props in sorted(driver_props.items()):
> +        for prop in sorted(props):
> +            name = '{}-{}'.format(driver, prop)
> +            table[name] = []
> +            for MT in MT_list:
> +                compat_props = MT['compat-props']
> +                if compat_props.get(driver, None):
> +                    if compat_props[driver].get(prop, None):
> +                        table[name].append(compat_props[driver][prop])
> +                        continue
> +
> +                # properties from QEMU (not from machine type compat_props)
> +                # properties from another architecture or config
> +                if not driver_defs.get(driver, None):
> +                    table[name].append('Unavailable driver')
> +                    continue
> +
> +                if not driver_defs[driver]['abstract']:
> +                    if driver_defs[driver]['method'] is None:
> +                        table[name].append('Unavailable method')
> +                    else:
> +                        table[name].append(
> +                            driver_defs[driver]['method'](vm, driver, prop))
> +                else:
> +                    children = driver_defs[driver]['child_list']
> +                    values = set()
> +                    for child in children:
> +                        if driver_defs[child]['abstract']:
> +                            continue
> +
> +                        if driver_defs[child]['method'] is None:
> +                            values.add('Unavailable method')
> +                        else:
> +                            values.add(
> +                                driver_defs[child]['method'](vm, child, prop))
> +
> +                    table[name].append(list(values))
> +
> +    headers = [MT['name'] for MT in MT_list]
> +    return pd.DataFrame.from_dict(table, orient='index', columns=headers)
> +
> +
> +def transform_value(value):
> +    true_list = ['true', 'on']
> +    false_list = ['false', 'off']
> +
> +    out = value.lower()
> +
> +    if out in true_list:
> +        return True
> +
> +    if out in false_list:
> +        return False
> +
> +    return out
> +
> +
> +# Only hex, dec and oct formats
> +def transform_number(value):
> +    try:
> +        # C doesn't work with underscore ('2_5' != 25)
> +        if '_' in value:
> +            raise ValueError
> +
> +        if 'x' in value or 'X' in value:
> +            return int(value, 16)
> +
> +        if 'o' in value or 'O' in value:
> +            return int(value, 8)
> +
> +        return int(value)
> +
> +    except ValueError:
> +        return None
> +
> +
> +def transformed_table(table):
> +    new_table = {}
> +    for index, row in table.iterrows():
> +        new_row = []
> +        all_values = set()
> +        # We want to save original hex/decimal format if not all values
> +        # are the same in the row. So, transformed and not transformed will be
> +        # stored
> +        numeric_values = set()
> +        for MT_prop_val in row:
> +            if type(MT_prop_val) is list:
> +                transformed = [transform_value(val) for val in MT_prop_val]
> +                if len(transformed) == 1:
> +                    new_row.append(transformed[0])
> +                else:
> +                    new_row.append(transformed)
> +
> +                numeric_values.update(set([transform_number(val)
> +                                           for val in MT_prop_val]))
> +                all_values.update(set(transformed))
> +            else:
> +                transformed = transform_value(MT_prop_val)
> +                new_row.append(transformed)
> +                numeric_values.add(transform_number(MT_prop_val))
> +                all_values.add(transformed)
> +
> +        if len(table.columns) > 1:
> +            if len(all_values) == 1:
> +                continue
> +
> +            if not None in numeric_values and len(numeric_values) == 1:

PEP8 recommends "None not in numeric_value" instead of "not None in numeric_values"

> +                continue
> +
> +        new_table[index] = new_row
> +
> +    return pd.DataFrame.from_dict(new_table, orient='index',
> +                                  columns=table.columns.values)
> +
> +
> +if __name__ == '__main__':
> +    args = parse_args()
> +    qemu_arg_list = args.cmd_line.split(' ')
> +    with QEMUMachine(binary=qemu_arg_list[0],
> +                     qmp_timer=15, args=qemu_arg_list[1:]) as vm:
> +        vm.launch()
> +        MT_defs = get_MT_definitions(vm)
> +        list_MT = [MT['name'] for MT in MT_defs]
> +
> +        if not args.all:
> +            if args.MT is None:
> +                print('Enter machine types for comparision or use --help')
> +                print('List of available machine types:')
> +                print(*list_MT, sep='\n')
> +                sys.exit(1)
> +
> +            for MT in args.MT:
> +                if MT not in list_MT:
> +                    print('Wrong machine type name')
> +                    print('List of available machine types:')
> +                    print(*list_MT, sep='\n')
> +                    sys.exit(1)
> +
> +        req_MT = []
> +        if args.all:
> +            req_MT = MT_defs
> +        else:
> +            for MT in MT_defs:
> +                if MT['name'] in args.MT:
> +                    req_MT.append(MT)
> +
> +        if len(req_MT) == 1:
> +            args.full = True
> +
> +        req_driver_props = get_req_props(req_MT)
> +        driver_defs = get_driver_definitions(vm)
> +        comp_table = fill_prop_table(vm, req_MT, req_driver_props, driver_defs)
> +        if not args.raw:
> +            comp_table = transformed_table(comp_table)
> +
> +        if args.json:
> +            print(comp_table.to_json())
> +        elif args.csv:
> +            print(comp_table.to_csv())
> +        else:
> +            print(tabulate(comp_table, showindex=True, stralign='center',
> +                           tablefmt='fancy_grid', headers='keys',
> +                           disable_numparse=True))
> +
> +        vm.shutdown()


-- 
Best regards,
Vladimir