xref: /openbmc/qemu/block/qapi.c (revision 93d7620c)
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 "qemu/osdep.h"
26 #include "qemu/cutils.h"
27 #include "block/qapi.h"
28 #include "block/block_int.h"
29 #include "block/dirty-bitmap.h"
30 #include "block/throttle-groups.h"
31 #include "block/write-threshold.h"
32 #include "qapi/error.h"
33 #include "qapi/qapi-commands-block-core.h"
34 #include "qapi/qobject-output-visitor.h"
35 #include "qapi/qapi-visit-block-core.h"
36 #include "qapi/qmp/qbool.h"
37 #include "qapi/qmp/qdict.h"
38 #include "qapi/qmp/qlist.h"
39 #include "qapi/qmp/qnum.h"
40 #include "qapi/qmp/qstring.h"
41 #include "qemu/qemu-print.h"
42 #include "sysemu/block-backend.h"
43 
44 BlockDeviceInfo *bdrv_block_device_info(BlockBackend *blk,
45                                         BlockDriverState *bs,
46                                         bool flat,
47                                         Error **errp)
48 {
49     ImageInfo **p_image_info;
50     ImageInfo *backing_info;
51     BlockDriverState *bs0, *backing;
52     BlockDeviceInfo *info;
53     ERRP_GUARD();
54 
55     if (!bs->drv) {
56         error_setg(errp, "Block device %s is ejected", bs->node_name);
57         return NULL;
58     }
59 
60     bdrv_refresh_filename(bs);
61 
62     info = g_malloc0(sizeof(*info));
63     info->file                   = g_strdup(bs->filename);
64     info->ro                     = bdrv_is_read_only(bs);
65     info->drv                    = g_strdup(bs->drv->format_name);
66     info->encrypted              = bs->encrypted;
67 
68     info->cache = g_new(BlockdevCacheInfo, 1);
69     *info->cache = (BlockdevCacheInfo) {
70         .writeback      = blk ? blk_enable_write_cache(blk) : true,
71         .direct         = !!(bs->open_flags & BDRV_O_NOCACHE),
72         .no_flush       = !!(bs->open_flags & BDRV_O_NO_FLUSH),
73     };
74 
75     if (bs->node_name[0]) {
76         info->node_name = g_strdup(bs->node_name);
77     }
78 
79     backing = bdrv_cow_bs(bs);
80     if (backing) {
81         info->backing_file = g_strdup(backing->filename);
82     }
83 
84     if (!QLIST_EMPTY(&bs->dirty_bitmaps)) {
85         info->has_dirty_bitmaps = true;
86         info->dirty_bitmaps = bdrv_query_dirty_bitmaps(bs);
87     }
88 
89     info->detect_zeroes = bs->detect_zeroes;
90 
91     if (blk && blk_get_public(blk)->throttle_group_member.throttle_state) {
92         ThrottleConfig cfg;
93         BlockBackendPublic *blkp = blk_get_public(blk);
94 
95         throttle_group_get_config(&blkp->throttle_group_member, &cfg);
96 
97         info->bps     = cfg.buckets[THROTTLE_BPS_TOTAL].avg;
98         info->bps_rd  = cfg.buckets[THROTTLE_BPS_READ].avg;
99         info->bps_wr  = cfg.buckets[THROTTLE_BPS_WRITE].avg;
100 
101         info->iops    = cfg.buckets[THROTTLE_OPS_TOTAL].avg;
102         info->iops_rd = cfg.buckets[THROTTLE_OPS_READ].avg;
103         info->iops_wr = cfg.buckets[THROTTLE_OPS_WRITE].avg;
104 
105         info->has_bps_max     = cfg.buckets[THROTTLE_BPS_TOTAL].max;
106         info->bps_max         = cfg.buckets[THROTTLE_BPS_TOTAL].max;
107         info->has_bps_rd_max  = cfg.buckets[THROTTLE_BPS_READ].max;
108         info->bps_rd_max      = cfg.buckets[THROTTLE_BPS_READ].max;
109         info->has_bps_wr_max  = cfg.buckets[THROTTLE_BPS_WRITE].max;
110         info->bps_wr_max      = cfg.buckets[THROTTLE_BPS_WRITE].max;
111 
112         info->has_iops_max    = cfg.buckets[THROTTLE_OPS_TOTAL].max;
113         info->iops_max        = cfg.buckets[THROTTLE_OPS_TOTAL].max;
114         info->has_iops_rd_max = cfg.buckets[THROTTLE_OPS_READ].max;
115         info->iops_rd_max     = cfg.buckets[THROTTLE_OPS_READ].max;
116         info->has_iops_wr_max = cfg.buckets[THROTTLE_OPS_WRITE].max;
117         info->iops_wr_max     = cfg.buckets[THROTTLE_OPS_WRITE].max;
118 
119         info->has_bps_max_length     = info->has_bps_max;
120         info->bps_max_length         =
121             cfg.buckets[THROTTLE_BPS_TOTAL].burst_length;
122         info->has_bps_rd_max_length  = info->has_bps_rd_max;
123         info->bps_rd_max_length      =
124             cfg.buckets[THROTTLE_BPS_READ].burst_length;
125         info->has_bps_wr_max_length  = info->has_bps_wr_max;
126         info->bps_wr_max_length      =
127             cfg.buckets[THROTTLE_BPS_WRITE].burst_length;
128 
129         info->has_iops_max_length    = info->has_iops_max;
130         info->iops_max_length        =
131             cfg.buckets[THROTTLE_OPS_TOTAL].burst_length;
132         info->has_iops_rd_max_length = info->has_iops_rd_max;
133         info->iops_rd_max_length     =
134             cfg.buckets[THROTTLE_OPS_READ].burst_length;
135         info->has_iops_wr_max_length = info->has_iops_wr_max;
136         info->iops_wr_max_length     =
137             cfg.buckets[THROTTLE_OPS_WRITE].burst_length;
138 
139         info->has_iops_size = cfg.op_size;
140         info->iops_size = cfg.op_size;
141 
142         info->group =
143             g_strdup(throttle_group_get_name(&blkp->throttle_group_member));
144     }
145 
146     info->write_threshold = bdrv_write_threshold_get(bs);
147 
148     bs0 = bs;
149     p_image_info = &info->image;
150     info->backing_file_depth = 0;
151 
152     /*
153      * Skip automatically inserted nodes that the user isn't aware of for
154      * query-block (blk != NULL), but not for query-named-block-nodes
155      */
156     bdrv_query_image_info(bs0, p_image_info, flat, blk != NULL, errp);
157     if (*errp) {
158         qapi_free_BlockDeviceInfo(info);
159         return NULL;
160     }
161 
162     backing_info = info->image->backing_image;
163     while (backing_info) {
164         info->backing_file_depth++;
165         backing_info = backing_info->backing_image;
166     }
167 
168     return info;
169 }
170 
171 /*
172  * Returns 0 on success, with *p_list either set to describe snapshot
173  * information, or NULL because there are no snapshots.  Returns -errno on
174  * error, with *p_list untouched.
175  */
176 int bdrv_query_snapshot_info_list(BlockDriverState *bs,
177                                   SnapshotInfoList **p_list,
178                                   Error **errp)
179 {
180     int i, sn_count;
181     QEMUSnapshotInfo *sn_tab = NULL;
182     SnapshotInfoList *head = NULL, **tail = &head;
183     SnapshotInfo *info;
184 
185     sn_count = bdrv_snapshot_list(bs, &sn_tab);
186     if (sn_count < 0) {
187         const char *dev = bdrv_get_device_name(bs);
188         switch (sn_count) {
189         case -ENOMEDIUM:
190             error_setg(errp, "Device '%s' is not inserted", dev);
191             break;
192         case -ENOTSUP:
193             error_setg(errp,
194                        "Device '%s' does not support internal snapshots",
195                        dev);
196             break;
197         default:
198             error_setg_errno(errp, -sn_count,
199                              "Can't list snapshots of device '%s'", dev);
200             break;
201         }
202         return sn_count;
203     }
204 
205     for (i = 0; i < sn_count; i++) {
206         info = g_new0(SnapshotInfo, 1);
207         info->id            = g_strdup(sn_tab[i].id_str);
208         info->name          = g_strdup(sn_tab[i].name);
209         info->vm_state_size = sn_tab[i].vm_state_size;
210         info->date_sec      = sn_tab[i].date_sec;
211         info->date_nsec     = sn_tab[i].date_nsec;
212         info->vm_clock_sec  = sn_tab[i].vm_clock_nsec / 1000000000;
213         info->vm_clock_nsec = sn_tab[i].vm_clock_nsec % 1000000000;
214         info->icount        = sn_tab[i].icount;
215         info->has_icount    = sn_tab[i].icount != -1ULL;
216 
217         QAPI_LIST_APPEND(tail, info);
218     }
219 
220     g_free(sn_tab);
221     *p_list = head;
222     return 0;
223 }
224 
225 /**
226  * Helper function for other query info functions.  Store information about @bs
227  * in @info, setting @errp on error.
228  */
229 static void bdrv_do_query_node_info(BlockDriverState *bs,
230                                     BlockNodeInfo *info,
231                                     Error **errp)
232 {
233     int64_t size;
234     const char *backing_filename;
235     BlockDriverInfo bdi;
236     int ret;
237     Error *err = NULL;
238 
239     aio_context_acquire(bdrv_get_aio_context(bs));
240 
241     size = bdrv_getlength(bs);
242     if (size < 0) {
243         error_setg_errno(errp, -size, "Can't get image size '%s'",
244                          bs->exact_filename);
245         goto out;
246     }
247 
248     bdrv_refresh_filename(bs);
249 
250     info->filename        = g_strdup(bs->filename);
251     info->format          = g_strdup(bdrv_get_format_name(bs));
252     info->virtual_size    = size;
253     info->actual_size     = bdrv_get_allocated_file_size(bs);
254     info->has_actual_size = info->actual_size >= 0;
255     if (bs->encrypted) {
256         info->encrypted = true;
257         info->has_encrypted = true;
258     }
259     if (bdrv_get_info(bs, &bdi) >= 0) {
260         if (bdi.cluster_size != 0) {
261             info->cluster_size = bdi.cluster_size;
262             info->has_cluster_size = true;
263         }
264         info->dirty_flag = bdi.is_dirty;
265         info->has_dirty_flag = true;
266     }
267     info->format_specific = bdrv_get_specific_info(bs, &err);
268     if (err) {
269         error_propagate(errp, err);
270         goto out;
271     }
272     backing_filename = bs->backing_file;
273     if (backing_filename[0] != '\0') {
274         char *backing_filename2;
275 
276         info->backing_filename = g_strdup(backing_filename);
277         backing_filename2 = bdrv_get_full_backing_filename(bs, NULL);
278 
279         /* Always report the full_backing_filename if present, even if it's the
280          * same as backing_filename. That they are same is useful info. */
281         if (backing_filename2) {
282             info->full_backing_filename = g_strdup(backing_filename2);
283         }
284 
285         if (bs->backing_format[0]) {
286             info->backing_filename_format = g_strdup(bs->backing_format);
287         }
288         g_free(backing_filename2);
289     }
290 
291     ret = bdrv_query_snapshot_info_list(bs, &info->snapshots, &err);
292     switch (ret) {
293     case 0:
294         if (info->snapshots) {
295             info->has_snapshots = true;
296         }
297         break;
298     /* recoverable error */
299     case -ENOMEDIUM:
300     case -ENOTSUP:
301         error_free(err);
302         break;
303     default:
304         error_propagate(errp, err);
305         goto out;
306     }
307 
308 out:
309     aio_context_release(bdrv_get_aio_context(bs));
310 }
311 
312 /**
313  * bdrv_query_block_node_info:
314  * @bs: block node to examine
315  * @p_info: location to store node information
316  * @errp: location to store error information
317  *
318  * Store image information about @bs in @p_info.
319  *
320  * @p_info will be set only on success. On error, store error in @errp.
321  */
322 void bdrv_query_block_node_info(BlockDriverState *bs,
323                                 BlockNodeInfo **p_info,
324                                 Error **errp)
325 {
326     BlockNodeInfo *info;
327     ERRP_GUARD();
328 
329     info = g_new0(BlockNodeInfo, 1);
330     bdrv_do_query_node_info(bs, info, errp);
331     if (*errp) {
332         qapi_free_BlockNodeInfo(info);
333         return;
334     }
335 
336     *p_info = info;
337 }
338 
339 /**
340  * bdrv_query_image_info:
341  * @bs: block node to examine
342  * @p_info: location to store image information
343  * @flat: skip backing node information
344  * @skip_implicit_filters: skip implicit filters in the backing chain
345  * @errp: location to store error information
346  *
347  * Store image information in @p_info, potentially recursively covering the
348  * backing chain.
349  *
350  * If @flat is true, do not query backing image information, i.e.
351  * (*p_info)->has_backing_image will be set to false and
352  * (*p_info)->backing_image to NULL even when the image does in fact have a
353  * backing image.
354  *
355  * If @skip_implicit_filters is true, implicit filter nodes in the backing chain
356  * will be skipped when querying backing image information.
357  * (@skip_implicit_filters is ignored when @flat is true.)
358  *
359  * @p_info will be set only on success. On error, store error in @errp.
360  */
361 void bdrv_query_image_info(BlockDriverState *bs,
362                            ImageInfo **p_info,
363                            bool flat,
364                            bool skip_implicit_filters,
365                            Error **errp)
366 {
367     ImageInfo *info;
368     ERRP_GUARD();
369 
370     info = g_new0(ImageInfo, 1);
371     bdrv_do_query_node_info(bs, qapi_ImageInfo_base(info), errp);
372     if (*errp) {
373         goto fail;
374     }
375 
376     if (!flat) {
377         BlockDriverState *backing;
378 
379         /*
380          * Use any filtered child here (for backwards compatibility to when
381          * we always took bs->backing, which might be any filtered child).
382          */
383         backing = bdrv_filter_or_cow_bs(bs);
384         if (skip_implicit_filters) {
385             backing = bdrv_skip_implicit_filters(backing);
386         }
387 
388         if (backing) {
389             bdrv_query_image_info(backing, &info->backing_image, false,
390                                   skip_implicit_filters, errp);
391             if (*errp) {
392                 goto fail;
393             }
394         }
395     }
396 
397     *p_info = info;
398     return;
399 
400 fail:
401     assert(*errp);
402     qapi_free_ImageInfo(info);
403 }
404 
405 /**
406  * bdrv_query_block_graph_info:
407  * @bs: root node to start from
408  * @p_info: location to store image information
409  * @errp: location to store error information
410  *
411  * Store image information about the graph starting from @bs in @p_info.
412  *
413  * @p_info will be set only on success. On error, store error in @errp.
414  */
415 void bdrv_query_block_graph_info(BlockDriverState *bs,
416                                  BlockGraphInfo **p_info,
417                                  Error **errp)
418 {
419     BlockGraphInfo *info;
420     BlockChildInfoList **children_list_tail;
421     BdrvChild *c;
422     ERRP_GUARD();
423 
424     info = g_new0(BlockGraphInfo, 1);
425     bdrv_do_query_node_info(bs, qapi_BlockGraphInfo_base(info), errp);
426     if (*errp) {
427         goto fail;
428     }
429 
430     children_list_tail = &info->children;
431 
432     QLIST_FOREACH(c, &bs->children, next) {
433         BlockChildInfo *c_info;
434 
435         c_info = g_new0(BlockChildInfo, 1);
436         QAPI_LIST_APPEND(children_list_tail, c_info);
437 
438         c_info->name = g_strdup(c->name);
439         bdrv_query_block_graph_info(c->bs, &c_info->info, errp);
440         if (*errp) {
441             goto fail;
442         }
443     }
444 
445     *p_info = info;
446     return;
447 
448 fail:
449     assert(*errp != NULL);
450     qapi_free_BlockGraphInfo(info);
451 }
452 
453 /* @p_info will be set only on success. */
454 static void bdrv_query_info(BlockBackend *blk, BlockInfo **p_info,
455                             Error **errp)
456 {
457     BlockInfo *info = g_malloc0(sizeof(*info));
458     BlockDriverState *bs = blk_bs(blk);
459     char *qdev;
460 
461     /* Skip automatically inserted nodes that the user isn't aware of */
462     bs = bdrv_skip_implicit_filters(bs);
463 
464     info->device = g_strdup(blk_name(blk));
465     info->type = g_strdup("unknown");
466     info->locked = blk_dev_is_medium_locked(blk);
467     info->removable = blk_dev_has_removable_media(blk);
468 
469     qdev = blk_get_attached_dev_id(blk);
470     if (qdev && *qdev) {
471         info->qdev = qdev;
472     } else {
473         g_free(qdev);
474     }
475 
476     if (blk_dev_has_tray(blk)) {
477         info->has_tray_open = true;
478         info->tray_open = blk_dev_is_tray_open(blk);
479     }
480 
481     if (blk_iostatus_is_enabled(blk)) {
482         info->has_io_status = true;
483         info->io_status = blk_iostatus(blk);
484     }
485 
486     if (bs && bs->drv) {
487         info->inserted = bdrv_block_device_info(blk, bs, false, errp);
488         if (info->inserted == NULL) {
489             goto err;
490         }
491     }
492 
493     *p_info = info;
494     return;
495 
496  err:
497     qapi_free_BlockInfo(info);
498 }
499 
500 static uint64List *uint64_list(uint64_t *list, int size)
501 {
502     int i;
503     uint64List *out_list = NULL;
504     uint64List **tail = &out_list;
505 
506     for (i = 0; i < size; i++) {
507         QAPI_LIST_APPEND(tail, list[i]);
508     }
509 
510     return out_list;
511 }
512 
513 static BlockLatencyHistogramInfo *
514 bdrv_latency_histogram_stats(BlockLatencyHistogram *hist)
515 {
516     BlockLatencyHistogramInfo *info;
517 
518     if (!hist->bins) {
519         return NULL;
520     }
521 
522     info = g_new0(BlockLatencyHistogramInfo, 1);
523     info->boundaries = uint64_list(hist->boundaries, hist->nbins - 1);
524     info->bins = uint64_list(hist->bins, hist->nbins);
525     return info;
526 }
527 
528 static void bdrv_query_blk_stats(BlockDeviceStats *ds, BlockBackend *blk)
529 {
530     BlockAcctStats *stats = blk_get_stats(blk);
531     BlockAcctTimedStats *ts = NULL;
532     BlockLatencyHistogram *hgram;
533 
534     ds->rd_bytes = stats->nr_bytes[BLOCK_ACCT_READ];
535     ds->wr_bytes = stats->nr_bytes[BLOCK_ACCT_WRITE];
536     ds->unmap_bytes = stats->nr_bytes[BLOCK_ACCT_UNMAP];
537     ds->rd_operations = stats->nr_ops[BLOCK_ACCT_READ];
538     ds->wr_operations = stats->nr_ops[BLOCK_ACCT_WRITE];
539     ds->unmap_operations = stats->nr_ops[BLOCK_ACCT_UNMAP];
540 
541     ds->failed_rd_operations = stats->failed_ops[BLOCK_ACCT_READ];
542     ds->failed_wr_operations = stats->failed_ops[BLOCK_ACCT_WRITE];
543     ds->failed_flush_operations = stats->failed_ops[BLOCK_ACCT_FLUSH];
544     ds->failed_unmap_operations = stats->failed_ops[BLOCK_ACCT_UNMAP];
545 
546     ds->invalid_rd_operations = stats->invalid_ops[BLOCK_ACCT_READ];
547     ds->invalid_wr_operations = stats->invalid_ops[BLOCK_ACCT_WRITE];
548     ds->invalid_flush_operations =
549         stats->invalid_ops[BLOCK_ACCT_FLUSH];
550     ds->invalid_unmap_operations = stats->invalid_ops[BLOCK_ACCT_UNMAP];
551 
552     ds->rd_merged = stats->merged[BLOCK_ACCT_READ];
553     ds->wr_merged = stats->merged[BLOCK_ACCT_WRITE];
554     ds->unmap_merged = stats->merged[BLOCK_ACCT_UNMAP];
555     ds->flush_operations = stats->nr_ops[BLOCK_ACCT_FLUSH];
556     ds->wr_total_time_ns = stats->total_time_ns[BLOCK_ACCT_WRITE];
557     ds->rd_total_time_ns = stats->total_time_ns[BLOCK_ACCT_READ];
558     ds->flush_total_time_ns = stats->total_time_ns[BLOCK_ACCT_FLUSH];
559     ds->unmap_total_time_ns = stats->total_time_ns[BLOCK_ACCT_UNMAP];
560 
561     ds->has_idle_time_ns = stats->last_access_time_ns > 0;
562     if (ds->has_idle_time_ns) {
563         ds->idle_time_ns = block_acct_idle_time_ns(stats);
564     }
565 
566     ds->account_invalid = stats->account_invalid;
567     ds->account_failed = stats->account_failed;
568 
569     while ((ts = block_acct_interval_next(stats, ts))) {
570         BlockDeviceTimedStats *dev_stats = g_malloc0(sizeof(*dev_stats));
571 
572         TimedAverage *rd = &ts->latency[BLOCK_ACCT_READ];
573         TimedAverage *wr = &ts->latency[BLOCK_ACCT_WRITE];
574         TimedAverage *fl = &ts->latency[BLOCK_ACCT_FLUSH];
575 
576         dev_stats->interval_length = ts->interval_length;
577 
578         dev_stats->min_rd_latency_ns = timed_average_min(rd);
579         dev_stats->max_rd_latency_ns = timed_average_max(rd);
580         dev_stats->avg_rd_latency_ns = timed_average_avg(rd);
581 
582         dev_stats->min_wr_latency_ns = timed_average_min(wr);
583         dev_stats->max_wr_latency_ns = timed_average_max(wr);
584         dev_stats->avg_wr_latency_ns = timed_average_avg(wr);
585 
586         dev_stats->min_flush_latency_ns = timed_average_min(fl);
587         dev_stats->max_flush_latency_ns = timed_average_max(fl);
588         dev_stats->avg_flush_latency_ns = timed_average_avg(fl);
589 
590         dev_stats->avg_rd_queue_depth =
591             block_acct_queue_depth(ts, BLOCK_ACCT_READ);
592         dev_stats->avg_wr_queue_depth =
593             block_acct_queue_depth(ts, BLOCK_ACCT_WRITE);
594 
595         QAPI_LIST_PREPEND(ds->timed_stats, dev_stats);
596     }
597 
598     hgram = stats->latency_histogram;
599     ds->rd_latency_histogram
600         = bdrv_latency_histogram_stats(&hgram[BLOCK_ACCT_READ]);
601     ds->wr_latency_histogram
602         = bdrv_latency_histogram_stats(&hgram[BLOCK_ACCT_WRITE]);
603     ds->flush_latency_histogram
604         = bdrv_latency_histogram_stats(&hgram[BLOCK_ACCT_FLUSH]);
605 }
606 
607 static BlockStats *bdrv_query_bds_stats(BlockDriverState *bs,
608                                         bool blk_level)
609 {
610     BdrvChild *parent_child;
611     BlockDriverState *filter_or_cow_bs;
612     BlockStats *s = NULL;
613 
614     s = g_malloc0(sizeof(*s));
615     s->stats = g_malloc0(sizeof(*s->stats));
616 
617     if (!bs) {
618         return s;
619     }
620 
621     /* Skip automatically inserted nodes that the user isn't aware of in
622      * a BlockBackend-level command. Stay at the exact node for a node-level
623      * command. */
624     if (blk_level) {
625         bs = bdrv_skip_implicit_filters(bs);
626     }
627 
628     if (bdrv_get_node_name(bs)[0]) {
629         s->node_name = g_strdup(bdrv_get_node_name(bs));
630     }
631 
632     s->stats->wr_highest_offset = stat64_get(&bs->wr_highest_offset);
633 
634     s->driver_specific = bdrv_get_specific_stats(bs);
635 
636     parent_child = bdrv_primary_child(bs);
637     if (!parent_child ||
638         !(parent_child->role & (BDRV_CHILD_DATA | BDRV_CHILD_FILTERED)))
639     {
640         BdrvChild *c;
641 
642         /*
643          * Look for a unique data-storing child.  We do not need to look for
644          * filtered children, as there would be only one and it would have been
645          * the primary child.
646          */
647         parent_child = NULL;
648         QLIST_FOREACH(c, &bs->children, next) {
649             if (c->role & BDRV_CHILD_DATA) {
650                 if (parent_child) {
651                     /*
652                      * There are multiple data-storing children and we cannot
653                      * choose between them.
654                      */
655                     parent_child = NULL;
656                     break;
657                 }
658                 parent_child = c;
659             }
660         }
661     }
662     if (parent_child) {
663         s->parent = bdrv_query_bds_stats(parent_child->bs, blk_level);
664     }
665 
666     filter_or_cow_bs = bdrv_filter_or_cow_bs(bs);
667     if (blk_level && filter_or_cow_bs) {
668         /*
669          * Put any filtered or COW child here (for backwards
670          * compatibility to when we put bs0->backing here, which might
671          * be either)
672          */
673         s->backing = bdrv_query_bds_stats(filter_or_cow_bs, blk_level);
674     }
675 
676     return s;
677 }
678 
679 BlockInfoList *qmp_query_block(Error **errp)
680 {
681     BlockInfoList *head = NULL, **p_next = &head;
682     BlockBackend *blk;
683     Error *local_err = NULL;
684 
685     for (blk = blk_all_next(NULL); blk; blk = blk_all_next(blk)) {
686         BlockInfoList *info;
687 
688         if (!*blk_name(blk) && !blk_get_attached_dev(blk)) {
689             continue;
690         }
691 
692         info = g_malloc0(sizeof(*info));
693         bdrv_query_info(blk, &info->value, &local_err);
694         if (local_err) {
695             error_propagate(errp, local_err);
696             g_free(info);
697             qapi_free_BlockInfoList(head);
698             return NULL;
699         }
700 
701         *p_next = info;
702         p_next = &info->next;
703     }
704 
705     return head;
706 }
707 
708 BlockStatsList *qmp_query_blockstats(bool has_query_nodes,
709                                      bool query_nodes,
710                                      Error **errp)
711 {
712     BlockStatsList *head = NULL, **tail = &head;
713     BlockBackend *blk;
714     BlockDriverState *bs;
715 
716     /* Just to be safe if query_nodes is not always initialized */
717     if (has_query_nodes && query_nodes) {
718         for (bs = bdrv_next_node(NULL); bs; bs = bdrv_next_node(bs)) {
719             AioContext *ctx = bdrv_get_aio_context(bs);
720 
721             aio_context_acquire(ctx);
722             QAPI_LIST_APPEND(tail, bdrv_query_bds_stats(bs, false));
723             aio_context_release(ctx);
724         }
725     } else {
726         for (blk = blk_all_next(NULL); blk; blk = blk_all_next(blk)) {
727             AioContext *ctx = blk_get_aio_context(blk);
728             BlockStats *s;
729             char *qdev;
730 
731             if (!*blk_name(blk) && !blk_get_attached_dev(blk)) {
732                 continue;
733             }
734 
735             aio_context_acquire(ctx);
736             s = bdrv_query_bds_stats(blk_bs(blk), true);
737             s->device = g_strdup(blk_name(blk));
738 
739             qdev = blk_get_attached_dev_id(blk);
740             if (qdev && *qdev) {
741                 s->qdev = qdev;
742             } else {
743                 g_free(qdev);
744             }
745 
746             bdrv_query_blk_stats(s->stats, blk);
747             aio_context_release(ctx);
748 
749             QAPI_LIST_APPEND(tail, s);
750         }
751     }
752 
753     return head;
754 }
755 
756 void bdrv_snapshot_dump(QEMUSnapshotInfo *sn)
757 {
758     char clock_buf[128];
759     char icount_buf[128] = {0};
760     int64_t secs;
761     char *sizing = NULL;
762 
763     if (!sn) {
764         qemu_printf("%-10s%-17s%8s%20s%13s%11s",
765                     "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK", "ICOUNT");
766     } else {
767         g_autoptr(GDateTime) date = g_date_time_new_from_unix_local(sn->date_sec);
768         g_autofree char *date_buf = g_date_time_format(date, "%Y-%m-%d %H:%M:%S");
769 
770         secs = sn->vm_clock_nsec / 1000000000;
771         snprintf(clock_buf, sizeof(clock_buf),
772                  "%02d:%02d:%02d.%03d",
773                  (int)(secs / 3600),
774                  (int)((secs / 60) % 60),
775                  (int)(secs % 60),
776                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
777         sizing = size_to_str(sn->vm_state_size);
778         if (sn->icount != -1ULL) {
779             snprintf(icount_buf, sizeof(icount_buf),
780                 "%"PRId64, sn->icount);
781         }
782         qemu_printf("%-9s %-16s %8s%20s%13s%11s",
783                     sn->id_str, sn->name,
784                     sizing,
785                     date_buf,
786                     clock_buf,
787                     icount_buf);
788     }
789     g_free(sizing);
790 }
791 
792 static void dump_qdict(int indentation, QDict *dict);
793 static void dump_qlist(int indentation, QList *list);
794 
795 static void dump_qobject(int comp_indent, QObject *obj)
796 {
797     switch (qobject_type(obj)) {
798         case QTYPE_QNUM: {
799             QNum *value = qobject_to(QNum, obj);
800             char *tmp = qnum_to_string(value);
801             qemu_printf("%s", tmp);
802             g_free(tmp);
803             break;
804         }
805         case QTYPE_QSTRING: {
806             QString *value = qobject_to(QString, obj);
807             qemu_printf("%s", qstring_get_str(value));
808             break;
809         }
810         case QTYPE_QDICT: {
811             QDict *value = qobject_to(QDict, obj);
812             dump_qdict(comp_indent, value);
813             break;
814         }
815         case QTYPE_QLIST: {
816             QList *value = qobject_to(QList, obj);
817             dump_qlist(comp_indent, value);
818             break;
819         }
820         case QTYPE_QBOOL: {
821             QBool *value = qobject_to(QBool, obj);
822             qemu_printf("%s", qbool_get_bool(value) ? "true" : "false");
823             break;
824         }
825         default:
826             abort();
827     }
828 }
829 
830 static void dump_qlist(int indentation, QList *list)
831 {
832     const QListEntry *entry;
833     int i = 0;
834 
835     for (entry = qlist_first(list); entry; entry = qlist_next(entry), i++) {
836         QType type = qobject_type(entry->value);
837         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
838         qemu_printf("%*s[%i]:%c", indentation * 4, "", i,
839                     composite ? '\n' : ' ');
840         dump_qobject(indentation + 1, entry->value);
841         if (!composite) {
842             qemu_printf("\n");
843         }
844     }
845 }
846 
847 static void dump_qdict(int indentation, QDict *dict)
848 {
849     const QDictEntry *entry;
850 
851     for (entry = qdict_first(dict); entry; entry = qdict_next(dict, entry)) {
852         QType type = qobject_type(entry->value);
853         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
854         char *key = g_malloc(strlen(entry->key) + 1);
855         int i;
856 
857         /* replace dashes with spaces in key (variable) names */
858         for (i = 0; entry->key[i]; i++) {
859             key[i] = entry->key[i] == '-' ? ' ' : entry->key[i];
860         }
861         key[i] = 0;
862         qemu_printf("%*s%s:%c", indentation * 4, "", key,
863                     composite ? '\n' : ' ');
864         dump_qobject(indentation + 1, entry->value);
865         if (!composite) {
866             qemu_printf("\n");
867         }
868         g_free(key);
869     }
870 }
871 
872 /*
873  * Return whether dumping the given QObject with dump_qobject() would
874  * yield an empty dump, i.e. not print anything.
875  */
876 static bool qobject_is_empty_dump(const QObject *obj)
877 {
878     switch (qobject_type(obj)) {
879     case QTYPE_QNUM:
880     case QTYPE_QSTRING:
881     case QTYPE_QBOOL:
882         return false;
883 
884     case QTYPE_QDICT:
885         return qdict_size(qobject_to(QDict, obj)) == 0;
886 
887     case QTYPE_QLIST:
888         return qlist_empty(qobject_to(QList, obj));
889 
890     default:
891         abort();
892     }
893 }
894 
895 /**
896  * Dumps the given ImageInfoSpecific object in a human-readable form,
897  * prepending an optional prefix if the dump is not empty.
898  */
899 void bdrv_image_info_specific_dump(ImageInfoSpecific *info_spec,
900                                    const char *prefix,
901                                    int indentation)
902 {
903     QObject *obj, *data;
904     Visitor *v = qobject_output_visitor_new(&obj);
905 
906     visit_type_ImageInfoSpecific(v, NULL, &info_spec, &error_abort);
907     visit_complete(v, &obj);
908     data = qdict_get(qobject_to(QDict, obj), "data");
909     if (!qobject_is_empty_dump(data)) {
910         if (prefix) {
911             qemu_printf("%*s%s", indentation * 4, "", prefix);
912         }
913         dump_qobject(indentation + 1, data);
914     }
915     qobject_unref(obj);
916     visit_free(v);
917 }
918 
919 /**
920  * Print the given @info object in human-readable form.  Every field is indented
921  * using the given @indentation (four spaces per indentation level).
922  *
923  * When using this to print a whole block graph, @protocol can be set to true to
924  * signify that the given information is associated with a protocol node, i.e.
925  * just data storage for an image, such that the data it presents is not really
926  * a full VM disk.  If so, several fields change name: For example, "virtual
927  * size" is printed as "file length".
928  * (Consider a qcow2 image, which is represented by a qcow2 node and a file
929  * node.  Printing a "virtual size" for the file node does not make sense,
930  * because without the qcow2 node, it is not really a guest disk, so it does not
931  * have a "virtual size".  Therefore, we call it "file length" instead.)
932  *
933  * @protocol is ignored when @indentation is 0, because we take that to mean
934  * that the associated node is the root node in the queried block graph, and
935  * thus is always to be interpreted as a standalone guest disk.
936  */
937 void bdrv_node_info_dump(BlockNodeInfo *info, int indentation, bool protocol)
938 {
939     char *size_buf, *dsize_buf;
940     g_autofree char *ind_s = g_strdup_printf("%*s", indentation * 4, "");
941 
942     if (indentation == 0) {
943         /* Top level, consider this a normal image */
944         protocol = false;
945     }
946 
947     if (!info->has_actual_size) {
948         dsize_buf = g_strdup("unavailable");
949     } else {
950         dsize_buf = size_to_str(info->actual_size);
951     }
952     size_buf = size_to_str(info->virtual_size);
953     qemu_printf("%s%s: %s\n"
954                 "%s%s: %s\n"
955                 "%s%s: %s (%" PRId64 " bytes)\n"
956                 "%sdisk size: %s\n",
957                 ind_s, protocol ? "filename" : "image", info->filename,
958                 ind_s, protocol ? "protocol type" : "file format",
959                 info->format,
960                 ind_s, protocol ? "file length" : "virtual size",
961                 size_buf, info->virtual_size,
962                 ind_s, dsize_buf);
963     g_free(size_buf);
964     g_free(dsize_buf);
965 
966     if (info->has_encrypted && info->encrypted) {
967         qemu_printf("%sencrypted: yes\n", ind_s);
968     }
969 
970     if (info->has_cluster_size) {
971         qemu_printf("%scluster_size: %" PRId64 "\n",
972                     ind_s, info->cluster_size);
973     }
974 
975     if (info->has_dirty_flag && info->dirty_flag) {
976         qemu_printf("%scleanly shut down: no\n", ind_s);
977     }
978 
979     if (info->backing_filename) {
980         qemu_printf("%sbacking file: %s", ind_s, info->backing_filename);
981         if (!info->full_backing_filename) {
982             qemu_printf(" (cannot determine actual path)");
983         } else if (strcmp(info->backing_filename,
984                           info->full_backing_filename) != 0) {
985             qemu_printf(" (actual path: %s)", info->full_backing_filename);
986         }
987         qemu_printf("\n");
988         if (info->backing_filename_format) {
989             qemu_printf("%sbacking file format: %s\n",
990                         ind_s, info->backing_filename_format);
991         }
992     }
993 
994     if (info->has_snapshots) {
995         SnapshotInfoList *elem;
996 
997         qemu_printf("%sSnapshot list:\n", ind_s);
998         qemu_printf("%s", ind_s);
999         bdrv_snapshot_dump(NULL);
1000         qemu_printf("\n");
1001 
1002         /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
1003          * we convert to the block layer's native QEMUSnapshotInfo for now.
1004          */
1005         for (elem = info->snapshots; elem; elem = elem->next) {
1006             QEMUSnapshotInfo sn = {
1007                 .vm_state_size = elem->value->vm_state_size,
1008                 .date_sec = elem->value->date_sec,
1009                 .date_nsec = elem->value->date_nsec,
1010                 .vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
1011                                  elem->value->vm_clock_nsec,
1012                 .icount = elem->value->has_icount ?
1013                           elem->value->icount : -1ULL,
1014             };
1015 
1016             pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
1017             pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
1018             qemu_printf("%s", ind_s);
1019             bdrv_snapshot_dump(&sn);
1020             qemu_printf("\n");
1021         }
1022     }
1023 
1024     if (info->format_specific) {
1025         bdrv_image_info_specific_dump(info->format_specific,
1026                                       "Format specific information:\n",
1027                                       indentation);
1028     }
1029 }
1030