From ea73e9de42b446ce1049805c23f7706e4f87ed1f Mon Sep 17 00:00:00 2001

From: Hanna Reitz <hreitz@redhat.com>

Date: Mon, 20 Jun 2022 18:27:03 +0200

Subject: [PATCH 16/20] qemu-img: Let info print block graph

RH-Author: Hanna Czenczek <hreitz@redhat.com>

RH-MergeRequest: 145: Show protocol-level information in qemu-img info

RH-Bugzilla: 1860292

RH-Acked-by: Kevin Wolf <kwolf@redhat.com>

RH-Acked-by: Stefan Hajnoczi <stefanha@redhat.com>

RH-Acked-by: Stefano Garzarella <sgarzare@redhat.com>

RH-Commit: [11/12] 2c1b8a03c918484449e876acf4c6663766848ad8 (hreitz/qemu-kvm-c-9-s)

For every node in the backing chain, collect its BlockGraphInfo struct

using bdrv_query_block_graph_info().  Print all nodes' information,

indenting child nodes and labelling them with a path constructed from

the child names leading to the node from the root (e.g. /file/file).

Note that we open each image with BDRV_O_NO_BACKING, so its backing

child is omitted from this graph, and thus presented in the previous

manner: By simply concatenating all images' information, separated with

blank lines.

This affects two iotests:

- 065: Here we try to get the format node's format specific information.

  The pre-patch code does so by taking all lines from "Format specific

  information:" until an empty line.  This format specific information

  is no longer followed by an empty line, though, but by child node

  information, so limit the range by "Child node '/file':".

- 302: Calls qemu_img() for qemu-img info directly, which does not

  filter the output, so the child node information ends up in the

  output.

Signed-off-by: Hanna Reitz <hreitz@redhat.com>

Message-Id: <20220620162704.80987-12-hreitz@redhat.com>

Reviewed-by: Kevin Wolf <kwolf@redhat.com>

Signed-off-by: Kevin Wolf <kwolf@redhat.com>

(cherry picked from commit c04d0ab026201d21873a63f768cb69c4554dfec1)

Signed-off-by: Hanna Czenczek <hreitz@redhat.com>

---

 qapi/block-core.json       |  4 +--

 qemu-img.c                 | 69 ++++++++++++++++++++++++++------------

 tests/qemu-iotests/065     |  2 +-

 tests/qemu-iotests/302.out |  5 +++

 4 files changed, 56 insertions(+), 24 deletions(-)

diff --git a/qapi/block-core.json b/qapi/block-core.json

index d703e0fb16..7f331eb8ea 100644

--- a/qapi/block-core.json

+++ b/qapi/block-core.json

@@ -5831,9 +5831,9 @@

 ##

 # @DummyBlockCoreForceArrays:

 #

-# Not used by QMP; hack to let us use BlockNodeInfoList internally

+# Not used by QMP; hack to let us use BlockGraphInfoList internally

 #

 # Since: 8.0

 ##

 { 'struct': 'DummyBlockCoreForceArrays',

-  'data': { 'unused-block-node-info': ['BlockNodeInfo'] } }

+  'data': { 'unused-block-graph-info': ['BlockGraphInfo'] } }

diff --git a/qemu-img.c b/qemu-img.c

index 30b4ea58bb..e281011245 100644

--- a/qemu-img.c

+++ b/qemu-img.c

@@ -2816,13 +2816,13 @@ static void dump_snapshots(BlockDriverState *bs)

     g_free(sn_tab);

 }

-static void dump_json_block_node_info_list(BlockNodeInfoList *list)

+static void dump_json_block_graph_info_list(BlockGraphInfoList *list)

 {

     GString *str;

     QObject *obj;

     Visitor *v = qobject_output_visitor_new(&obj);

-    visit_type_BlockNodeInfoList(v, NULL, &list, &error_abort);

+    visit_type_BlockGraphInfoList(v, NULL, &list, &error_abort);

     visit_complete(v, &obj);

     str = qobject_to_json_pretty(obj, true);

     assert(str != NULL);

@@ -2832,13 +2832,13 @@ static void dump_json_block_node_info_list(BlockNodeInfoList *list)

     g_string_free(str, true);

 }

-static void dump_json_block_node_info(BlockNodeInfo *info)

+static void dump_json_block_graph_info(BlockGraphInfo *info)

 {

     GString *str;

     QObject *obj;

     Visitor *v = qobject_output_visitor_new(&obj);

-    visit_type_BlockNodeInfo(v, NULL, &info, &error_abort);

+    visit_type_BlockGraphInfo(v, NULL, &info, &error_abort);

     visit_complete(v, &obj);

     str = qobject_to_json_pretty(obj, true);

     assert(str != NULL);

@@ -2848,9 +2848,29 @@ static void dump_json_block_node_info(BlockNodeInfo *info)

     g_string_free(str, true);

 }

-static void dump_human_image_info_list(BlockNodeInfoList *list)

+static void dump_human_image_info(BlockGraphInfo *info, int indentation,

+                                  const char *path)

 {

-    BlockNodeInfoList *elem;

+    BlockChildInfoList *children_list;

+

+    bdrv_node_info_dump(qapi_BlockGraphInfo_base(info), indentation);

+

+    for (children_list = info->children; children_list;

+         children_list = children_list->next)

+    {

+        BlockChildInfo *child = children_list->value;

+        g_autofree char *child_path = NULL;

+

+        printf("%*sChild node '%s%s':\n",

+               indentation * 4, "", path, child->name);

+        child_path = g_strdup_printf("%s%s/", path, child->name);

+        dump_human_image_info(child->info, indentation + 1, child_path);

+    }

+}

+

+static void dump_human_image_info_list(BlockGraphInfoList *list)

+{

+    BlockGraphInfoList *elem;

     bool delim = false;

     for (elem = list; elem; elem = elem->next) {

@@ -2859,7 +2879,7 @@ static void dump_human_image_info_list(BlockNodeInfoList *list)

         }

         delim = true;

-        bdrv_node_info_dump(elem->value, 0);

+        dump_human_image_info(elem->value, 0, "/");

     }

 }

@@ -2869,7 +2889,7 @@ static gboolean str_equal_func(gconstpointer a, gconstpointer b)

 }

 /**

- * Open an image file chain and return an BlockNodeInfoList

+ * Open an image file chain and return an BlockGraphInfoList

  *

  * @filename: topmost image filename

  * @fmt: topmost image format (may be NULL to autodetect)

@@ -2880,13 +2900,13 @@ static gboolean str_equal_func(gconstpointer a, gconstpointer b)

  * opening an image file.  If there was an error a message will have been

  * printed to stderr.

  */

-static BlockNodeInfoList *collect_image_info_list(bool image_opts,

-                                                  const char *filename,

-                                                  const char *fmt,

-                                                  bool chain, bool force_share)

+static BlockGraphInfoList *collect_image_info_list(bool image_opts,

+                                                   const char *filename,

+                                                   const char *fmt,

+                                                   bool chain, bool force_share)

 {

-    BlockNodeInfoList *head = NULL;

-    BlockNodeInfoList **tail = &head;

+    BlockGraphInfoList *head = NULL;

+    BlockGraphInfoList **tail = &head;

     GHashTable *filenames;

     Error *err = NULL;

@@ -2895,7 +2915,7 @@ static BlockNodeInfoList *collect_image_info_list(bool image_opts,

     while (filename) {

         BlockBackend *blk;

         BlockDriverState *bs;

-        BlockNodeInfo *info;

+        BlockGraphInfo *info;

         if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {

             error_report("Backing file '%s' creates an infinite loop.",

@@ -2912,7 +2932,14 @@ static BlockNodeInfoList *collect_image_info_list(bool image_opts,

         }

         bs = blk_bs(blk);

-        bdrv_query_block_node_info(bs, &info, &err;;

+        /*

+         * Note that the returned BlockGraphInfo object will not have

+         * information about this image's backing node, because we have opened

+         * it with BDRV_O_NO_BACKING.  Printing this object will therefore not

+         * duplicate the backing chain information that we obtain by walking

+         * the chain manually here.

+         */

+        bdrv_query_block_graph_info(bs, &info, &err;;

         if (err) {

             error_report_err(err);

             blk_unref(blk);

@@ -2945,7 +2972,7 @@ static BlockNodeInfoList *collect_image_info_list(bool image_opts,

     return head;

 err:

-    qapi_free_BlockNodeInfoList(head);

+    qapi_free_BlockGraphInfoList(head);

     g_hash_table_destroy(filenames);

     return NULL;

 }

@@ -2956,7 +2983,7 @@ static int img_info(int argc, char **argv)

     OutputFormat output_format = OFORMAT_HUMAN;

     bool chain = false;

     const char *filename, *fmt, *output;

-    BlockNodeInfoList *list;

+    BlockGraphInfoList *list;

     bool image_opts = false;

     bool force_share = false;

@@ -3035,14 +3062,14 @@ static int img_info(int argc, char **argv)

         break;

     case OFORMAT_JSON:

         if (chain) {

-            dump_json_block_node_info_list(list);

+            dump_json_block_graph_info_list(list);

         } else {

-            dump_json_block_node_info(list->value);

+            dump_json_block_graph_info(list->value);

         }

         break;

     }

-    qapi_free_BlockNodeInfoList(list);

+    qapi_free_BlockGraphInfoList(list);

     return 0;

 }

diff --git a/tests/qemu-iotests/065 b/tests/qemu-iotests/065

index b724c89c7c..b76701c71e 100755

--- a/tests/qemu-iotests/065

+++ b/tests/qemu-iotests/065

@@ -56,7 +56,7 @@ class TestQemuImgInfo(TestImageInfoSpecific):

     def test_human(self):

         data = qemu_img('info', '--output=human', test_img).stdout.split('\n')

         data = data[(data.index('Format specific information:') + 1)

-                    :data.index('')]

+                    :data.index("Child node '/file':")]

         for field in data:

             self.assertTrue(re.match('^ {4}[^ ]', field) is not None)

         data = [line.strip() for line in data]

diff --git a/tests/qemu-iotests/302.out b/tests/qemu-iotests/302.out

index 3e7c281b91..edfa1c4f05 100644

--- a/tests/qemu-iotests/302.out

+++ b/tests/qemu-iotests/302.out

@@ -4,6 +4,11 @@ image: nbd+unix:///exp?socket=SOCK_DIR/PID-nbd-sock

 file format: raw

 virtual size: 448 KiB (458752 bytes)

 disk size: unavailable

+Child node '/file':

+    image: nbd+unix:///exp?socket=SOCK_DIR/PID-nbd-sock

+    file format: nbd

+    virtual size: 448 KiB (458752 bytes)

+    disk size: unavailable

 === Converted image info ===

 image: TEST_IMG

-- 

2.31.1