xref: /openbmc/qemu/block/qapi.c (revision 61b9251a)
1 /*
2  * Block layer qmp and info dump related functions
3  *
4  * Copyright (c) 2003-2008 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #include "block/qapi.h"
26 #include "block/block_int.h"
27 #include "block/throttle-groups.h"
28 #include "block/write-threshold.h"
29 #include "qmp-commands.h"
30 #include "qapi-visit.h"
31 #include "qapi/qmp-output-visitor.h"
32 #include "qapi/qmp/types.h"
33 #include "sysemu/block-backend.h"
34 
35 BlockDeviceInfo *bdrv_block_device_info(BlockDriverState *bs, Error **errp)
36 {
37     ImageInfo **p_image_info;
38     BlockDriverState *bs0;
39     BlockDeviceInfo *info = g_malloc0(sizeof(*info));
40 
41     info->file                   = g_strdup(bs->filename);
42     info->ro                     = bs->read_only;
43     info->drv                    = g_strdup(bs->drv->format_name);
44     info->encrypted              = bs->encrypted;
45     info->encryption_key_missing = bdrv_key_required(bs);
46 
47     info->cache = g_new(BlockdevCacheInfo, 1);
48     *info->cache = (BlockdevCacheInfo) {
49         .writeback      = bdrv_enable_write_cache(bs),
50         .direct         = !!(bs->open_flags & BDRV_O_NOCACHE),
51         .no_flush       = !!(bs->open_flags & BDRV_O_NO_FLUSH),
52     };
53 
54     if (bs->node_name[0]) {
55         info->has_node_name = true;
56         info->node_name = g_strdup(bs->node_name);
57     }
58 
59     if (bs->backing_file[0]) {
60         info->has_backing_file = true;
61         info->backing_file = g_strdup(bs->backing_file);
62     }
63 
64     info->backing_file_depth = bdrv_get_backing_file_depth(bs);
65     info->detect_zeroes = bs->detect_zeroes;
66 
67     if (bs->throttle_state) {
68         ThrottleConfig cfg;
69 
70         throttle_group_get_config(bs, &cfg);
71 
72         info->bps     = cfg.buckets[THROTTLE_BPS_TOTAL].avg;
73         info->bps_rd  = cfg.buckets[THROTTLE_BPS_READ].avg;
74         info->bps_wr  = cfg.buckets[THROTTLE_BPS_WRITE].avg;
75 
76         info->iops    = cfg.buckets[THROTTLE_OPS_TOTAL].avg;
77         info->iops_rd = cfg.buckets[THROTTLE_OPS_READ].avg;
78         info->iops_wr = cfg.buckets[THROTTLE_OPS_WRITE].avg;
79 
80         info->has_bps_max     = cfg.buckets[THROTTLE_BPS_TOTAL].max;
81         info->bps_max         = cfg.buckets[THROTTLE_BPS_TOTAL].max;
82         info->has_bps_rd_max  = cfg.buckets[THROTTLE_BPS_READ].max;
83         info->bps_rd_max      = cfg.buckets[THROTTLE_BPS_READ].max;
84         info->has_bps_wr_max  = cfg.buckets[THROTTLE_BPS_WRITE].max;
85         info->bps_wr_max      = cfg.buckets[THROTTLE_BPS_WRITE].max;
86 
87         info->has_iops_max    = cfg.buckets[THROTTLE_OPS_TOTAL].max;
88         info->iops_max        = cfg.buckets[THROTTLE_OPS_TOTAL].max;
89         info->has_iops_rd_max = cfg.buckets[THROTTLE_OPS_READ].max;
90         info->iops_rd_max     = cfg.buckets[THROTTLE_OPS_READ].max;
91         info->has_iops_wr_max = cfg.buckets[THROTTLE_OPS_WRITE].max;
92         info->iops_wr_max     = cfg.buckets[THROTTLE_OPS_WRITE].max;
93 
94         info->has_iops_size = cfg.op_size;
95         info->iops_size = cfg.op_size;
96 
97         info->has_group = true;
98         info->group = g_strdup(throttle_group_get_name(bs));
99     }
100 
101     info->write_threshold = bdrv_write_threshold_get(bs);
102 
103     bs0 = bs;
104     p_image_info = &info->image;
105     while (1) {
106         Error *local_err = NULL;
107         bdrv_query_image_info(bs0, p_image_info, &local_err);
108         if (local_err) {
109             error_propagate(errp, local_err);
110             qapi_free_BlockDeviceInfo(info);
111             return NULL;
112         }
113         if (bs0->drv && bs0->backing) {
114             bs0 = bs0->backing->bs;
115             (*p_image_info)->has_backing_image = true;
116             p_image_info = &((*p_image_info)->backing_image);
117         } else {
118             break;
119         }
120     }
121 
122     return info;
123 }
124 
125 /*
126  * Returns 0 on success, with *p_list either set to describe snapshot
127  * information, or NULL because there are no snapshots.  Returns -errno on
128  * error, with *p_list untouched.
129  */
130 int bdrv_query_snapshot_info_list(BlockDriverState *bs,
131                                   SnapshotInfoList **p_list,
132                                   Error **errp)
133 {
134     int i, sn_count;
135     QEMUSnapshotInfo *sn_tab = NULL;
136     SnapshotInfoList *info_list, *cur_item = NULL, *head = NULL;
137     SnapshotInfo *info;
138 
139     sn_count = bdrv_snapshot_list(bs, &sn_tab);
140     if (sn_count < 0) {
141         const char *dev = bdrv_get_device_name(bs);
142         switch (sn_count) {
143         case -ENOMEDIUM:
144             error_setg(errp, "Device '%s' is not inserted", dev);
145             break;
146         case -ENOTSUP:
147             error_setg(errp,
148                        "Device '%s' does not support internal snapshots",
149                        dev);
150             break;
151         default:
152             error_setg_errno(errp, -sn_count,
153                              "Can't list snapshots of device '%s'", dev);
154             break;
155         }
156         return sn_count;
157     }
158 
159     for (i = 0; i < sn_count; i++) {
160         info = g_new0(SnapshotInfo, 1);
161         info->id            = g_strdup(sn_tab[i].id_str);
162         info->name          = g_strdup(sn_tab[i].name);
163         info->vm_state_size = sn_tab[i].vm_state_size;
164         info->date_sec      = sn_tab[i].date_sec;
165         info->date_nsec     = sn_tab[i].date_nsec;
166         info->vm_clock_sec  = sn_tab[i].vm_clock_nsec / 1000000000;
167         info->vm_clock_nsec = sn_tab[i].vm_clock_nsec % 1000000000;
168 
169         info_list = g_new0(SnapshotInfoList, 1);
170         info_list->value = info;
171 
172         /* XXX: waiting for the qapi to support qemu-queue.h types */
173         if (!cur_item) {
174             head = cur_item = info_list;
175         } else {
176             cur_item->next = info_list;
177             cur_item = info_list;
178         }
179 
180     }
181 
182     g_free(sn_tab);
183     *p_list = head;
184     return 0;
185 }
186 
187 /**
188  * bdrv_query_image_info:
189  * @bs: block device to examine
190  * @p_info: location to store image information
191  * @errp: location to store error information
192  *
193  * Store "flat" image information in @p_info.
194  *
195  * "Flat" means it does *not* query backing image information,
196  * i.e. (*pinfo)->has_backing_image will be set to false and
197  * (*pinfo)->backing_image to NULL even when the image does in fact have
198  * a backing image.
199  *
200  * @p_info will be set only on success. On error, store error in @errp.
201  */
202 void bdrv_query_image_info(BlockDriverState *bs,
203                            ImageInfo **p_info,
204                            Error **errp)
205 {
206     int64_t size;
207     const char *backing_filename;
208     BlockDriverInfo bdi;
209     int ret;
210     Error *err = NULL;
211     ImageInfo *info;
212 
213     size = bdrv_getlength(bs);
214     if (size < 0) {
215         error_setg_errno(errp, -size, "Can't get size of device '%s'",
216                          bdrv_get_device_name(bs));
217         return;
218     }
219 
220     info = g_new0(ImageInfo, 1);
221     info->filename        = g_strdup(bs->filename);
222     info->format          = g_strdup(bdrv_get_format_name(bs));
223     info->virtual_size    = size;
224     info->actual_size     = bdrv_get_allocated_file_size(bs);
225     info->has_actual_size = info->actual_size >= 0;
226     if (bdrv_is_encrypted(bs)) {
227         info->encrypted = true;
228         info->has_encrypted = true;
229     }
230     if (bdrv_get_info(bs, &bdi) >= 0) {
231         if (bdi.cluster_size != 0) {
232             info->cluster_size = bdi.cluster_size;
233             info->has_cluster_size = true;
234         }
235         info->dirty_flag = bdi.is_dirty;
236         info->has_dirty_flag = true;
237     }
238     info->format_specific     = bdrv_get_specific_info(bs);
239     info->has_format_specific = info->format_specific != NULL;
240 
241     backing_filename = bs->backing_file;
242     if (backing_filename[0] != '\0') {
243         char *backing_filename2 = g_malloc0(PATH_MAX);
244         info->backing_filename = g_strdup(backing_filename);
245         info->has_backing_filename = true;
246         bdrv_get_full_backing_filename(bs, backing_filename2, PATH_MAX, &err);
247         if (err) {
248             error_propagate(errp, err);
249             qapi_free_ImageInfo(info);
250             g_free(backing_filename2);
251             return;
252         }
253 
254         if (strcmp(backing_filename, backing_filename2) != 0) {
255             info->full_backing_filename =
256                         g_strdup(backing_filename2);
257             info->has_full_backing_filename = true;
258         }
259 
260         if (bs->backing_format[0]) {
261             info->backing_filename_format = g_strdup(bs->backing_format);
262             info->has_backing_filename_format = true;
263         }
264         g_free(backing_filename2);
265     }
266 
267     ret = bdrv_query_snapshot_info_list(bs, &info->snapshots, &err);
268     switch (ret) {
269     case 0:
270         if (info->snapshots) {
271             info->has_snapshots = true;
272         }
273         break;
274     /* recoverable error */
275     case -ENOMEDIUM:
276     case -ENOTSUP:
277         error_free(err);
278         break;
279     default:
280         error_propagate(errp, err);
281         qapi_free_ImageInfo(info);
282         return;
283     }
284 
285     *p_info = info;
286 }
287 
288 /* @p_info will be set only on success. */
289 static void bdrv_query_info(BlockBackend *blk, BlockInfo **p_info,
290                             Error **errp)
291 {
292     BlockInfo *info = g_malloc0(sizeof(*info));
293     BlockDriverState *bs = blk_bs(blk);
294     info->device = g_strdup(blk_name(blk));
295     info->type = g_strdup("unknown");
296     info->locked = blk_dev_is_medium_locked(blk);
297     info->removable = blk_dev_has_removable_media(blk);
298 
299     if (blk_dev_has_removable_media(blk)) {
300         info->has_tray_open = true;
301         info->tray_open = blk_dev_is_tray_open(blk);
302     }
303 
304     if (blk_iostatus_is_enabled(blk)) {
305         info->has_io_status = true;
306         info->io_status = blk_iostatus(blk);
307     }
308 
309     if (bs && !QLIST_EMPTY(&bs->dirty_bitmaps)) {
310         info->has_dirty_bitmaps = true;
311         info->dirty_bitmaps = bdrv_query_dirty_bitmaps(bs);
312     }
313 
314     if (bs && bs->drv) {
315         info->has_inserted = true;
316         info->inserted = bdrv_block_device_info(bs, errp);
317         if (info->inserted == NULL) {
318             goto err;
319         }
320     }
321 
322     *p_info = info;
323     return;
324 
325  err:
326     qapi_free_BlockInfo(info);
327 }
328 
329 static BlockStats *bdrv_query_stats(const BlockDriverState *bs,
330                                     bool query_backing)
331 {
332     BlockStats *s;
333 
334     s = g_malloc0(sizeof(*s));
335 
336     if (bdrv_get_device_name(bs)[0]) {
337         s->has_device = true;
338         s->device = g_strdup(bdrv_get_device_name(bs));
339     }
340 
341     if (bdrv_get_node_name(bs)[0]) {
342         s->has_node_name = true;
343         s->node_name = g_strdup(bdrv_get_node_name(bs));
344     }
345 
346     s->stats = g_malloc0(sizeof(*s->stats));
347     if (bs->blk) {
348         BlockAcctStats *stats = blk_get_stats(bs->blk);
349         BlockAcctTimedStats *ts = NULL;
350 
351         s->stats->rd_bytes = stats->nr_bytes[BLOCK_ACCT_READ];
352         s->stats->wr_bytes = stats->nr_bytes[BLOCK_ACCT_WRITE];
353         s->stats->rd_operations = stats->nr_ops[BLOCK_ACCT_READ];
354         s->stats->wr_operations = stats->nr_ops[BLOCK_ACCT_WRITE];
355 
356         s->stats->failed_rd_operations = stats->failed_ops[BLOCK_ACCT_READ];
357         s->stats->failed_wr_operations = stats->failed_ops[BLOCK_ACCT_WRITE];
358         s->stats->failed_flush_operations = stats->failed_ops[BLOCK_ACCT_FLUSH];
359 
360         s->stats->invalid_rd_operations = stats->invalid_ops[BLOCK_ACCT_READ];
361         s->stats->invalid_wr_operations = stats->invalid_ops[BLOCK_ACCT_WRITE];
362         s->stats->invalid_flush_operations =
363             stats->invalid_ops[BLOCK_ACCT_FLUSH];
364 
365         s->stats->rd_merged = stats->merged[BLOCK_ACCT_READ];
366         s->stats->wr_merged = stats->merged[BLOCK_ACCT_WRITE];
367         s->stats->flush_operations = stats->nr_ops[BLOCK_ACCT_FLUSH];
368         s->stats->wr_total_time_ns = stats->total_time_ns[BLOCK_ACCT_WRITE];
369         s->stats->rd_total_time_ns = stats->total_time_ns[BLOCK_ACCT_READ];
370         s->stats->flush_total_time_ns = stats->total_time_ns[BLOCK_ACCT_FLUSH];
371 
372         s->stats->has_idle_time_ns = stats->last_access_time_ns > 0;
373         if (s->stats->has_idle_time_ns) {
374             s->stats->idle_time_ns = block_acct_idle_time_ns(stats);
375         }
376 
377         s->stats->account_invalid = stats->account_invalid;
378         s->stats->account_failed = stats->account_failed;
379 
380         while ((ts = block_acct_interval_next(stats, ts))) {
381             BlockDeviceTimedStatsList *timed_stats =
382                 g_malloc0(sizeof(*timed_stats));
383             BlockDeviceTimedStats *dev_stats = g_malloc0(sizeof(*dev_stats));
384             timed_stats->next = s->stats->timed_stats;
385             timed_stats->value = dev_stats;
386             s->stats->timed_stats = timed_stats;
387 
388             TimedAverage *rd = &ts->latency[BLOCK_ACCT_READ];
389             TimedAverage *wr = &ts->latency[BLOCK_ACCT_WRITE];
390             TimedAverage *fl = &ts->latency[BLOCK_ACCT_FLUSH];
391 
392             dev_stats->interval_length = ts->interval_length;
393 
394             dev_stats->min_rd_latency_ns = timed_average_min(rd);
395             dev_stats->max_rd_latency_ns = timed_average_max(rd);
396             dev_stats->avg_rd_latency_ns = timed_average_avg(rd);
397 
398             dev_stats->min_wr_latency_ns = timed_average_min(wr);
399             dev_stats->max_wr_latency_ns = timed_average_max(wr);
400             dev_stats->avg_wr_latency_ns = timed_average_avg(wr);
401 
402             dev_stats->min_flush_latency_ns = timed_average_min(fl);
403             dev_stats->max_flush_latency_ns = timed_average_max(fl);
404             dev_stats->avg_flush_latency_ns = timed_average_avg(fl);
405 
406             dev_stats->avg_rd_queue_depth =
407                 block_acct_queue_depth(ts, BLOCK_ACCT_READ);
408             dev_stats->avg_wr_queue_depth =
409                 block_acct_queue_depth(ts, BLOCK_ACCT_WRITE);
410         }
411     }
412 
413     s->stats->wr_highest_offset = bs->wr_highest_offset;
414 
415     if (bs->file) {
416         s->has_parent = true;
417         s->parent = bdrv_query_stats(bs->file->bs, query_backing);
418     }
419 
420     if (query_backing && bs->backing) {
421         s->has_backing = true;
422         s->backing = bdrv_query_stats(bs->backing->bs, query_backing);
423     }
424 
425     return s;
426 }
427 
428 BlockInfoList *qmp_query_block(Error **errp)
429 {
430     BlockInfoList *head = NULL, **p_next = &head;
431     BlockBackend *blk;
432     Error *local_err = NULL;
433 
434     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
435         BlockInfoList *info = g_malloc0(sizeof(*info));
436         bdrv_query_info(blk, &info->value, &local_err);
437         if (local_err) {
438             error_propagate(errp, local_err);
439             goto err;
440         }
441 
442         *p_next = info;
443         p_next = &info->next;
444     }
445 
446     return head;
447 
448  err:
449     qapi_free_BlockInfoList(head);
450     return NULL;
451 }
452 
453 BlockStatsList *qmp_query_blockstats(bool has_query_nodes,
454                                      bool query_nodes,
455                                      Error **errp)
456 {
457     BlockStatsList *head = NULL, **p_next = &head;
458     BlockDriverState *bs = NULL;
459 
460     /* Just to be safe if query_nodes is not always initialized */
461     query_nodes = has_query_nodes && query_nodes;
462 
463     while ((bs = query_nodes ? bdrv_next_node(bs) : bdrv_next(bs))) {
464         BlockStatsList *info = g_malloc0(sizeof(*info));
465         AioContext *ctx = bdrv_get_aio_context(bs);
466 
467         aio_context_acquire(ctx);
468         info->value = bdrv_query_stats(bs, !query_nodes);
469         aio_context_release(ctx);
470 
471         *p_next = info;
472         p_next = &info->next;
473     }
474 
475     return head;
476 }
477 
478 #define NB_SUFFIXES 4
479 
480 static char *get_human_readable_size(char *buf, int buf_size, int64_t size)
481 {
482     static const char suffixes[NB_SUFFIXES] = {'K', 'M', 'G', 'T'};
483     int64_t base;
484     int i;
485 
486     if (size <= 999) {
487         snprintf(buf, buf_size, "%" PRId64, size);
488     } else {
489         base = 1024;
490         for (i = 0; i < NB_SUFFIXES; i++) {
491             if (size < (10 * base)) {
492                 snprintf(buf, buf_size, "%0.1f%c",
493                          (double)size / base,
494                          suffixes[i]);
495                 break;
496             } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
497                 snprintf(buf, buf_size, "%" PRId64 "%c",
498                          ((size + (base >> 1)) / base),
499                          suffixes[i]);
500                 break;
501             }
502             base = base * 1024;
503         }
504     }
505     return buf;
506 }
507 
508 void bdrv_snapshot_dump(fprintf_function func_fprintf, void *f,
509                         QEMUSnapshotInfo *sn)
510 {
511     char buf1[128], date_buf[128], clock_buf[128];
512     struct tm tm;
513     time_t ti;
514     int64_t secs;
515 
516     if (!sn) {
517         func_fprintf(f,
518                      "%-10s%-20s%7s%20s%15s",
519                      "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
520     } else {
521         ti = sn->date_sec;
522         localtime_r(&ti, &tm);
523         strftime(date_buf, sizeof(date_buf),
524                  "%Y-%m-%d %H:%M:%S", &tm);
525         secs = sn->vm_clock_nsec / 1000000000;
526         snprintf(clock_buf, sizeof(clock_buf),
527                  "%02d:%02d:%02d.%03d",
528                  (int)(secs / 3600),
529                  (int)((secs / 60) % 60),
530                  (int)(secs % 60),
531                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
532         func_fprintf(f,
533                      "%-10s%-20s%7s%20s%15s",
534                      sn->id_str, sn->name,
535                      get_human_readable_size(buf1, sizeof(buf1),
536                                              sn->vm_state_size),
537                      date_buf,
538                      clock_buf);
539     }
540 }
541 
542 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
543                        QDict *dict);
544 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
545                        QList *list);
546 
547 static void dump_qobject(fprintf_function func_fprintf, void *f,
548                          int comp_indent, QObject *obj)
549 {
550     switch (qobject_type(obj)) {
551         case QTYPE_QINT: {
552             QInt *value = qobject_to_qint(obj);
553             func_fprintf(f, "%" PRId64, qint_get_int(value));
554             break;
555         }
556         case QTYPE_QSTRING: {
557             QString *value = qobject_to_qstring(obj);
558             func_fprintf(f, "%s", qstring_get_str(value));
559             break;
560         }
561         case QTYPE_QDICT: {
562             QDict *value = qobject_to_qdict(obj);
563             dump_qdict(func_fprintf, f, comp_indent, value);
564             break;
565         }
566         case QTYPE_QLIST: {
567             QList *value = qobject_to_qlist(obj);
568             dump_qlist(func_fprintf, f, comp_indent, value);
569             break;
570         }
571         case QTYPE_QFLOAT: {
572             QFloat *value = qobject_to_qfloat(obj);
573             func_fprintf(f, "%g", qfloat_get_double(value));
574             break;
575         }
576         case QTYPE_QBOOL: {
577             QBool *value = qobject_to_qbool(obj);
578             func_fprintf(f, "%s", qbool_get_bool(value) ? "true" : "false");
579             break;
580         }
581         default:
582             abort();
583     }
584 }
585 
586 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
587                        QList *list)
588 {
589     const QListEntry *entry;
590     int i = 0;
591 
592     for (entry = qlist_first(list); entry; entry = qlist_next(entry), i++) {
593         qtype_code type = qobject_type(entry->value);
594         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
595         const char *format = composite ? "%*s[%i]:\n" : "%*s[%i]: ";
596 
597         func_fprintf(f, format, indentation * 4, "", i);
598         dump_qobject(func_fprintf, f, indentation + 1, entry->value);
599         if (!composite) {
600             func_fprintf(f, "\n");
601         }
602     }
603 }
604 
605 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
606                        QDict *dict)
607 {
608     const QDictEntry *entry;
609 
610     for (entry = qdict_first(dict); entry; entry = qdict_next(dict, entry)) {
611         qtype_code type = qobject_type(entry->value);
612         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
613         const char *format = composite ? "%*s%s:\n" : "%*s%s: ";
614         char key[strlen(entry->key) + 1];
615         int i;
616 
617         /* replace dashes with spaces in key (variable) names */
618         for (i = 0; entry->key[i]; i++) {
619             key[i] = entry->key[i] == '-' ? ' ' : entry->key[i];
620         }
621         key[i] = 0;
622 
623         func_fprintf(f, format, indentation * 4, "", key);
624         dump_qobject(func_fprintf, f, indentation + 1, entry->value);
625         if (!composite) {
626             func_fprintf(f, "\n");
627         }
628     }
629 }
630 
631 void bdrv_image_info_specific_dump(fprintf_function func_fprintf, void *f,
632                                    ImageInfoSpecific *info_spec)
633 {
634     QmpOutputVisitor *ov = qmp_output_visitor_new();
635     QObject *obj, *data;
636 
637     visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov), &info_spec, NULL,
638                                  &error_abort);
639     obj = qmp_output_get_qobject(ov);
640     assert(qobject_type(obj) == QTYPE_QDICT);
641     data = qdict_get(qobject_to_qdict(obj), "data");
642     dump_qobject(func_fprintf, f, 1, data);
643     qmp_output_visitor_cleanup(ov);
644 }
645 
646 void bdrv_image_info_dump(fprintf_function func_fprintf, void *f,
647                           ImageInfo *info)
648 {
649     char size_buf[128], dsize_buf[128];
650     if (!info->has_actual_size) {
651         snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
652     } else {
653         get_human_readable_size(dsize_buf, sizeof(dsize_buf),
654                                 info->actual_size);
655     }
656     get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
657     func_fprintf(f,
658                  "image: %s\n"
659                  "file format: %s\n"
660                  "virtual size: %s (%" PRId64 " bytes)\n"
661                  "disk size: %s\n",
662                  info->filename, info->format, size_buf,
663                  info->virtual_size,
664                  dsize_buf);
665 
666     if (info->has_encrypted && info->encrypted) {
667         func_fprintf(f, "encrypted: yes\n");
668     }
669 
670     if (info->has_cluster_size) {
671         func_fprintf(f, "cluster_size: %" PRId64 "\n",
672                        info->cluster_size);
673     }
674 
675     if (info->has_dirty_flag && info->dirty_flag) {
676         func_fprintf(f, "cleanly shut down: no\n");
677     }
678 
679     if (info->has_backing_filename) {
680         func_fprintf(f, "backing file: %s", info->backing_filename);
681         if (info->has_full_backing_filename) {
682             func_fprintf(f, " (actual path: %s)", info->full_backing_filename);
683         }
684         func_fprintf(f, "\n");
685         if (info->has_backing_filename_format) {
686             func_fprintf(f, "backing file format: %s\n",
687                          info->backing_filename_format);
688         }
689     }
690 
691     if (info->has_snapshots) {
692         SnapshotInfoList *elem;
693 
694         func_fprintf(f, "Snapshot list:\n");
695         bdrv_snapshot_dump(func_fprintf, f, NULL);
696         func_fprintf(f, "\n");
697 
698         /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
699          * we convert to the block layer's native QEMUSnapshotInfo for now.
700          */
701         for (elem = info->snapshots; elem; elem = elem->next) {
702             QEMUSnapshotInfo sn = {
703                 .vm_state_size = elem->value->vm_state_size,
704                 .date_sec = elem->value->date_sec,
705                 .date_nsec = elem->value->date_nsec,
706                 .vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
707                                  elem->value->vm_clock_nsec,
708             };
709 
710             pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
711             pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
712             bdrv_snapshot_dump(func_fprintf, f, &sn);
713             func_fprintf(f, "\n");
714         }
715     }
716 
717     if (info->has_format_specific) {
718         func_fprintf(f, "Format specific information:\n");
719         bdrv_image_info_specific_dump(func_fprintf, f, info->format_specific);
720     }
721 }
722