xref: /openbmc/qemu/block/qapi.c (revision 4a4ff4c5)
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 "block/qapi.h"
27 #include "block/block_int.h"
28 #include "block/throttle-groups.h"
29 #include "block/write-threshold.h"
30 #include "qapi/error.h"
31 #include "qapi/qapi-commands-block-core.h"
32 #include "qapi/qobject-output-visitor.h"
33 #include "qapi/qapi-visit-block-core.h"
34 #include "qapi/qmp/qbool.h"
35 #include "qapi/qmp/qdict.h"
36 #include "qapi/qmp/qlist.h"
37 #include "qapi/qmp/qnum.h"
38 #include "qapi/qmp/qstring.h"
39 #include "sysemu/block-backend.h"
40 #include "qemu/cutils.h"
41 
42 BlockDeviceInfo *bdrv_block_device_info(BlockBackend *blk,
43                                         BlockDriverState *bs, Error **errp)
44 {
45     ImageInfo **p_image_info;
46     BlockDriverState *bs0;
47     BlockDeviceInfo *info;
48 
49     if (!bs->drv) {
50         error_setg(errp, "Block device %s is ejected", bs->node_name);
51         return NULL;
52     }
53 
54     info = g_malloc0(sizeof(*info));
55     info->file                   = g_strdup(bs->filename);
56     info->ro                     = bs->read_only;
57     info->drv                    = g_strdup(bs->drv->format_name);
58     info->encrypted              = bs->encrypted;
59     info->encryption_key_missing = false;
60 
61     info->cache = g_new(BlockdevCacheInfo, 1);
62     *info->cache = (BlockdevCacheInfo) {
63         .writeback      = blk ? blk_enable_write_cache(blk) : true,
64         .direct         = !!(bs->open_flags & BDRV_O_NOCACHE),
65         .no_flush       = !!(bs->open_flags & BDRV_O_NO_FLUSH),
66     };
67 
68     if (bs->node_name[0]) {
69         info->has_node_name = true;
70         info->node_name = g_strdup(bs->node_name);
71     }
72 
73     if (bs->backing_file[0]) {
74         info->has_backing_file = true;
75         info->backing_file = g_strdup(bs->backing_file);
76     }
77 
78     info->detect_zeroes = bs->detect_zeroes;
79 
80     if (blk && blk_get_public(blk)->throttle_group_member.throttle_state) {
81         ThrottleConfig cfg;
82         BlockBackendPublic *blkp = blk_get_public(blk);
83 
84         throttle_group_get_config(&blkp->throttle_group_member, &cfg);
85 
86         info->bps     = cfg.buckets[THROTTLE_BPS_TOTAL].avg;
87         info->bps_rd  = cfg.buckets[THROTTLE_BPS_READ].avg;
88         info->bps_wr  = cfg.buckets[THROTTLE_BPS_WRITE].avg;
89 
90         info->iops    = cfg.buckets[THROTTLE_OPS_TOTAL].avg;
91         info->iops_rd = cfg.buckets[THROTTLE_OPS_READ].avg;
92         info->iops_wr = cfg.buckets[THROTTLE_OPS_WRITE].avg;
93 
94         info->has_bps_max     = cfg.buckets[THROTTLE_BPS_TOTAL].max;
95         info->bps_max         = cfg.buckets[THROTTLE_BPS_TOTAL].max;
96         info->has_bps_rd_max  = cfg.buckets[THROTTLE_BPS_READ].max;
97         info->bps_rd_max      = cfg.buckets[THROTTLE_BPS_READ].max;
98         info->has_bps_wr_max  = cfg.buckets[THROTTLE_BPS_WRITE].max;
99         info->bps_wr_max      = cfg.buckets[THROTTLE_BPS_WRITE].max;
100 
101         info->has_iops_max    = cfg.buckets[THROTTLE_OPS_TOTAL].max;
102         info->iops_max        = cfg.buckets[THROTTLE_OPS_TOTAL].max;
103         info->has_iops_rd_max = cfg.buckets[THROTTLE_OPS_READ].max;
104         info->iops_rd_max     = cfg.buckets[THROTTLE_OPS_READ].max;
105         info->has_iops_wr_max = cfg.buckets[THROTTLE_OPS_WRITE].max;
106         info->iops_wr_max     = cfg.buckets[THROTTLE_OPS_WRITE].max;
107 
108         info->has_bps_max_length     = info->has_bps_max;
109         info->bps_max_length         =
110             cfg.buckets[THROTTLE_BPS_TOTAL].burst_length;
111         info->has_bps_rd_max_length  = info->has_bps_rd_max;
112         info->bps_rd_max_length      =
113             cfg.buckets[THROTTLE_BPS_READ].burst_length;
114         info->has_bps_wr_max_length  = info->has_bps_wr_max;
115         info->bps_wr_max_length      =
116             cfg.buckets[THROTTLE_BPS_WRITE].burst_length;
117 
118         info->has_iops_max_length    = info->has_iops_max;
119         info->iops_max_length        =
120             cfg.buckets[THROTTLE_OPS_TOTAL].burst_length;
121         info->has_iops_rd_max_length = info->has_iops_rd_max;
122         info->iops_rd_max_length     =
123             cfg.buckets[THROTTLE_OPS_READ].burst_length;
124         info->has_iops_wr_max_length = info->has_iops_wr_max;
125         info->iops_wr_max_length     =
126             cfg.buckets[THROTTLE_OPS_WRITE].burst_length;
127 
128         info->has_iops_size = cfg.op_size;
129         info->iops_size = cfg.op_size;
130 
131         info->has_group = true;
132         info->group =
133             g_strdup(throttle_group_get_name(&blkp->throttle_group_member));
134     }
135 
136     info->write_threshold = bdrv_write_threshold_get(bs);
137 
138     bs0 = bs;
139     p_image_info = &info->image;
140     info->backing_file_depth = 0;
141     while (1) {
142         Error *local_err = NULL;
143         bdrv_query_image_info(bs0, p_image_info, &local_err);
144         if (local_err) {
145             error_propagate(errp, local_err);
146             qapi_free_BlockDeviceInfo(info);
147             return NULL;
148         }
149 
150         if (bs0->drv && bs0->backing) {
151             info->backing_file_depth++;
152             bs0 = bs0->backing->bs;
153             (*p_image_info)->has_backing_image = true;
154             p_image_info = &((*p_image_info)->backing_image);
155         } else {
156             break;
157         }
158 
159         /* Skip automatically inserted nodes that the user isn't aware of for
160          * query-block (blk != NULL), but not for query-named-block-nodes */
161         while (blk && bs0->drv && bs0->implicit) {
162             bs0 = backing_bs(bs0);
163             assert(bs0);
164         }
165     }
166 
167     return info;
168 }
169 
170 /*
171  * Returns 0 on success, with *p_list either set to describe snapshot
172  * information, or NULL because there are no snapshots.  Returns -errno on
173  * error, with *p_list untouched.
174  */
175 int bdrv_query_snapshot_info_list(BlockDriverState *bs,
176                                   SnapshotInfoList **p_list,
177                                   Error **errp)
178 {
179     int i, sn_count;
180     QEMUSnapshotInfo *sn_tab = NULL;
181     SnapshotInfoList *info_list, *cur_item = NULL, *head = NULL;
182     SnapshotInfo *info;
183 
184     sn_count = bdrv_snapshot_list(bs, &sn_tab);
185     if (sn_count < 0) {
186         const char *dev = bdrv_get_device_name(bs);
187         switch (sn_count) {
188         case -ENOMEDIUM:
189             error_setg(errp, "Device '%s' is not inserted", dev);
190             break;
191         case -ENOTSUP:
192             error_setg(errp,
193                        "Device '%s' does not support internal snapshots",
194                        dev);
195             break;
196         default:
197             error_setg_errno(errp, -sn_count,
198                              "Can't list snapshots of device '%s'", dev);
199             break;
200         }
201         return sn_count;
202     }
203 
204     for (i = 0; i < sn_count; i++) {
205         info = g_new0(SnapshotInfo, 1);
206         info->id            = g_strdup(sn_tab[i].id_str);
207         info->name          = g_strdup(sn_tab[i].name);
208         info->vm_state_size = sn_tab[i].vm_state_size;
209         info->date_sec      = sn_tab[i].date_sec;
210         info->date_nsec     = sn_tab[i].date_nsec;
211         info->vm_clock_sec  = sn_tab[i].vm_clock_nsec / 1000000000;
212         info->vm_clock_nsec = sn_tab[i].vm_clock_nsec % 1000000000;
213 
214         info_list = g_new0(SnapshotInfoList, 1);
215         info_list->value = info;
216 
217         /* XXX: waiting for the qapi to support qemu-queue.h types */
218         if (!cur_item) {
219             head = cur_item = info_list;
220         } else {
221             cur_item->next = info_list;
222             cur_item = info_list;
223         }
224 
225     }
226 
227     g_free(sn_tab);
228     *p_list = head;
229     return 0;
230 }
231 
232 /**
233  * bdrv_query_image_info:
234  * @bs: block device to examine
235  * @p_info: location to store image information
236  * @errp: location to store error information
237  *
238  * Store "flat" image information in @p_info.
239  *
240  * "Flat" means it does *not* query backing image information,
241  * i.e. (*pinfo)->has_backing_image will be set to false and
242  * (*pinfo)->backing_image to NULL even when the image does in fact have
243  * a backing image.
244  *
245  * @p_info will be set only on success. On error, store error in @errp.
246  */
247 void bdrv_query_image_info(BlockDriverState *bs,
248                            ImageInfo **p_info,
249                            Error **errp)
250 {
251     int64_t size;
252     const char *backing_filename;
253     BlockDriverInfo bdi;
254     int ret;
255     Error *err = NULL;
256     ImageInfo *info;
257 
258     aio_context_acquire(bdrv_get_aio_context(bs));
259 
260     size = bdrv_getlength(bs);
261     if (size < 0) {
262         error_setg_errno(errp, -size, "Can't get image size '%s'",
263                          bs->exact_filename);
264         goto out;
265     }
266 
267     info = g_new0(ImageInfo, 1);
268     info->filename        = g_strdup(bs->filename);
269     info->format          = g_strdup(bdrv_get_format_name(bs));
270     info->virtual_size    = size;
271     info->actual_size     = bdrv_get_allocated_file_size(bs);
272     info->has_actual_size = info->actual_size >= 0;
273     if (bdrv_is_encrypted(bs)) {
274         info->encrypted = true;
275         info->has_encrypted = true;
276     }
277     if (bdrv_get_info(bs, &bdi) >= 0) {
278         if (bdi.cluster_size != 0) {
279             info->cluster_size = bdi.cluster_size;
280             info->has_cluster_size = true;
281         }
282         info->dirty_flag = bdi.is_dirty;
283         info->has_dirty_flag = true;
284     }
285     info->format_specific     = bdrv_get_specific_info(bs);
286     info->has_format_specific = info->format_specific != NULL;
287 
288     backing_filename = bs->backing_file;
289     if (backing_filename[0] != '\0') {
290         char *backing_filename2 = g_malloc0(PATH_MAX);
291         info->backing_filename = g_strdup(backing_filename);
292         info->has_backing_filename = true;
293         bdrv_get_full_backing_filename(bs, backing_filename2, PATH_MAX, &err);
294         if (err) {
295             /* Can't reconstruct the full backing filename, so we must omit
296              * this field and apply a Best Effort to this query. */
297             g_free(backing_filename2);
298             backing_filename2 = NULL;
299             error_free(err);
300             err = NULL;
301         }
302 
303         /* Always report the full_backing_filename if present, even if it's the
304          * same as backing_filename. That they are same is useful info. */
305         if (backing_filename2) {
306             info->full_backing_filename = g_strdup(backing_filename2);
307             info->has_full_backing_filename = true;
308         }
309 
310         if (bs->backing_format[0]) {
311             info->backing_filename_format = g_strdup(bs->backing_format);
312             info->has_backing_filename_format = true;
313         }
314         g_free(backing_filename2);
315     }
316 
317     ret = bdrv_query_snapshot_info_list(bs, &info->snapshots, &err);
318     switch (ret) {
319     case 0:
320         if (info->snapshots) {
321             info->has_snapshots = true;
322         }
323         break;
324     /* recoverable error */
325     case -ENOMEDIUM:
326     case -ENOTSUP:
327         error_free(err);
328         break;
329     default:
330         error_propagate(errp, err);
331         qapi_free_ImageInfo(info);
332         goto out;
333     }
334 
335     *p_info = info;
336 
337 out:
338     aio_context_release(bdrv_get_aio_context(bs));
339 }
340 
341 /* @p_info will be set only on success. */
342 static void bdrv_query_info(BlockBackend *blk, BlockInfo **p_info,
343                             Error **errp)
344 {
345     BlockInfo *info = g_malloc0(sizeof(*info));
346     BlockDriverState *bs = blk_bs(blk);
347     char *qdev;
348 
349     /* Skip automatically inserted nodes that the user isn't aware of */
350     while (bs && bs->drv && bs->implicit) {
351         bs = backing_bs(bs);
352     }
353 
354     info->device = g_strdup(blk_name(blk));
355     info->type = g_strdup("unknown");
356     info->locked = blk_dev_is_medium_locked(blk);
357     info->removable = blk_dev_has_removable_media(blk);
358 
359     qdev = blk_get_attached_dev_id(blk);
360     if (qdev && *qdev) {
361         info->has_qdev = true;
362         info->qdev = qdev;
363     } else {
364         g_free(qdev);
365     }
366 
367     if (blk_dev_has_tray(blk)) {
368         info->has_tray_open = true;
369         info->tray_open = blk_dev_is_tray_open(blk);
370     }
371 
372     if (blk_iostatus_is_enabled(blk)) {
373         info->has_io_status = true;
374         info->io_status = blk_iostatus(blk);
375     }
376 
377     if (bs && !QLIST_EMPTY(&bs->dirty_bitmaps)) {
378         info->has_dirty_bitmaps = true;
379         info->dirty_bitmaps = bdrv_query_dirty_bitmaps(bs);
380     }
381 
382     if (bs && bs->drv) {
383         info->has_inserted = true;
384         info->inserted = bdrv_block_device_info(blk, bs, errp);
385         if (info->inserted == NULL) {
386             goto err;
387         }
388     }
389 
390     *p_info = info;
391     return;
392 
393  err:
394     qapi_free_BlockInfo(info);
395 }
396 
397 static uint64List *uint64_list(uint64_t *list, int size)
398 {
399     int i;
400     uint64List *out_list = NULL;
401     uint64List **pout_list = &out_list;
402 
403     for (i = 0; i < size; i++) {
404         uint64List *entry = g_new(uint64List, 1);
405         entry->value = list[i];
406         *pout_list = entry;
407         pout_list = &entry->next;
408     }
409 
410     *pout_list = NULL;
411 
412     return out_list;
413 }
414 
415 static void bdrv_latency_histogram_stats(BlockLatencyHistogram *hist,
416                                          bool *not_null,
417                                          BlockLatencyHistogramInfo **info)
418 {
419     *not_null = hist->bins != NULL;
420     if (*not_null) {
421         *info = g_new0(BlockLatencyHistogramInfo, 1);
422 
423         (*info)->boundaries = uint64_list(hist->boundaries, hist->nbins - 1);
424         (*info)->bins = uint64_list(hist->bins, hist->nbins);
425     }
426 }
427 
428 static void bdrv_query_blk_stats(BlockDeviceStats *ds, BlockBackend *blk)
429 {
430     BlockAcctStats *stats = blk_get_stats(blk);
431     BlockAcctTimedStats *ts = NULL;
432 
433     ds->rd_bytes = stats->nr_bytes[BLOCK_ACCT_READ];
434     ds->wr_bytes = stats->nr_bytes[BLOCK_ACCT_WRITE];
435     ds->rd_operations = stats->nr_ops[BLOCK_ACCT_READ];
436     ds->wr_operations = stats->nr_ops[BLOCK_ACCT_WRITE];
437 
438     ds->failed_rd_operations = stats->failed_ops[BLOCK_ACCT_READ];
439     ds->failed_wr_operations = stats->failed_ops[BLOCK_ACCT_WRITE];
440     ds->failed_flush_operations = stats->failed_ops[BLOCK_ACCT_FLUSH];
441 
442     ds->invalid_rd_operations = stats->invalid_ops[BLOCK_ACCT_READ];
443     ds->invalid_wr_operations = stats->invalid_ops[BLOCK_ACCT_WRITE];
444     ds->invalid_flush_operations =
445         stats->invalid_ops[BLOCK_ACCT_FLUSH];
446 
447     ds->rd_merged = stats->merged[BLOCK_ACCT_READ];
448     ds->wr_merged = stats->merged[BLOCK_ACCT_WRITE];
449     ds->flush_operations = stats->nr_ops[BLOCK_ACCT_FLUSH];
450     ds->wr_total_time_ns = stats->total_time_ns[BLOCK_ACCT_WRITE];
451     ds->rd_total_time_ns = stats->total_time_ns[BLOCK_ACCT_READ];
452     ds->flush_total_time_ns = stats->total_time_ns[BLOCK_ACCT_FLUSH];
453 
454     ds->has_idle_time_ns = stats->last_access_time_ns > 0;
455     if (ds->has_idle_time_ns) {
456         ds->idle_time_ns = block_acct_idle_time_ns(stats);
457     }
458 
459     ds->account_invalid = stats->account_invalid;
460     ds->account_failed = stats->account_failed;
461 
462     while ((ts = block_acct_interval_next(stats, ts))) {
463         BlockDeviceTimedStatsList *timed_stats =
464             g_malloc0(sizeof(*timed_stats));
465         BlockDeviceTimedStats *dev_stats = g_malloc0(sizeof(*dev_stats));
466         timed_stats->next = ds->timed_stats;
467         timed_stats->value = dev_stats;
468         ds->timed_stats = timed_stats;
469 
470         TimedAverage *rd = &ts->latency[BLOCK_ACCT_READ];
471         TimedAverage *wr = &ts->latency[BLOCK_ACCT_WRITE];
472         TimedAverage *fl = &ts->latency[BLOCK_ACCT_FLUSH];
473 
474         dev_stats->interval_length = ts->interval_length;
475 
476         dev_stats->min_rd_latency_ns = timed_average_min(rd);
477         dev_stats->max_rd_latency_ns = timed_average_max(rd);
478         dev_stats->avg_rd_latency_ns = timed_average_avg(rd);
479 
480         dev_stats->min_wr_latency_ns = timed_average_min(wr);
481         dev_stats->max_wr_latency_ns = timed_average_max(wr);
482         dev_stats->avg_wr_latency_ns = timed_average_avg(wr);
483 
484         dev_stats->min_flush_latency_ns = timed_average_min(fl);
485         dev_stats->max_flush_latency_ns = timed_average_max(fl);
486         dev_stats->avg_flush_latency_ns = timed_average_avg(fl);
487 
488         dev_stats->avg_rd_queue_depth =
489             block_acct_queue_depth(ts, BLOCK_ACCT_READ);
490         dev_stats->avg_wr_queue_depth =
491             block_acct_queue_depth(ts, BLOCK_ACCT_WRITE);
492     }
493 
494     bdrv_latency_histogram_stats(&stats->latency_histogram[BLOCK_ACCT_READ],
495                                  &ds->has_x_rd_latency_histogram,
496                                  &ds->x_rd_latency_histogram);
497     bdrv_latency_histogram_stats(&stats->latency_histogram[BLOCK_ACCT_WRITE],
498                                  &ds->has_x_wr_latency_histogram,
499                                  &ds->x_wr_latency_histogram);
500     bdrv_latency_histogram_stats(&stats->latency_histogram[BLOCK_ACCT_FLUSH],
501                                  &ds->has_x_flush_latency_histogram,
502                                  &ds->x_flush_latency_histogram);
503 }
504 
505 static BlockStats *bdrv_query_bds_stats(BlockDriverState *bs,
506                                         bool blk_level)
507 {
508     BlockStats *s = NULL;
509 
510     s = g_malloc0(sizeof(*s));
511     s->stats = g_malloc0(sizeof(*s->stats));
512 
513     if (!bs) {
514         return s;
515     }
516 
517     /* Skip automatically inserted nodes that the user isn't aware of in
518      * a BlockBackend-level command. Stay at the exact node for a node-level
519      * command. */
520     while (blk_level && bs->drv && bs->implicit) {
521         bs = backing_bs(bs);
522         assert(bs);
523     }
524 
525     if (bdrv_get_node_name(bs)[0]) {
526         s->has_node_name = true;
527         s->node_name = g_strdup(bdrv_get_node_name(bs));
528     }
529 
530     s->stats->wr_highest_offset = stat64_get(&bs->wr_highest_offset);
531 
532     if (bs->file) {
533         s->has_parent = true;
534         s->parent = bdrv_query_bds_stats(bs->file->bs, blk_level);
535     }
536 
537     if (blk_level && bs->backing) {
538         s->has_backing = true;
539         s->backing = bdrv_query_bds_stats(bs->backing->bs, blk_level);
540     }
541 
542     return s;
543 }
544 
545 BlockInfoList *qmp_query_block(Error **errp)
546 {
547     BlockInfoList *head = NULL, **p_next = &head;
548     BlockBackend *blk;
549     Error *local_err = NULL;
550 
551     for (blk = blk_all_next(NULL); blk; blk = blk_all_next(blk)) {
552         BlockInfoList *info;
553 
554         if (!*blk_name(blk) && !blk_get_attached_dev(blk)) {
555             continue;
556         }
557 
558         info = g_malloc0(sizeof(*info));
559         bdrv_query_info(blk, &info->value, &local_err);
560         if (local_err) {
561             error_propagate(errp, local_err);
562             g_free(info);
563             qapi_free_BlockInfoList(head);
564             return NULL;
565         }
566 
567         *p_next = info;
568         p_next = &info->next;
569     }
570 
571     return head;
572 }
573 
574 BlockStatsList *qmp_query_blockstats(bool has_query_nodes,
575                                      bool query_nodes,
576                                      Error **errp)
577 {
578     BlockStatsList *head = NULL, **p_next = &head;
579     BlockBackend *blk;
580     BlockDriverState *bs;
581 
582     /* Just to be safe if query_nodes is not always initialized */
583     if (has_query_nodes && query_nodes) {
584         for (bs = bdrv_next_node(NULL); bs; bs = bdrv_next_node(bs)) {
585             BlockStatsList *info = g_malloc0(sizeof(*info));
586             AioContext *ctx = bdrv_get_aio_context(bs);
587 
588             aio_context_acquire(ctx);
589             info->value = bdrv_query_bds_stats(bs, false);
590             aio_context_release(ctx);
591 
592             *p_next = info;
593             p_next = &info->next;
594         }
595     } else {
596         for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
597             BlockStatsList *info = g_malloc0(sizeof(*info));
598             AioContext *ctx = blk_get_aio_context(blk);
599             BlockStats *s;
600 
601             aio_context_acquire(ctx);
602             s = bdrv_query_bds_stats(blk_bs(blk), true);
603             s->has_device = true;
604             s->device = g_strdup(blk_name(blk));
605             bdrv_query_blk_stats(s->stats, blk);
606             aio_context_release(ctx);
607 
608             info->value = s;
609             *p_next = info;
610             p_next = &info->next;
611         }
612     }
613 
614     return head;
615 }
616 
617 #define NB_SUFFIXES 4
618 
619 static char *get_human_readable_size(char *buf, int buf_size, int64_t size)
620 {
621     static const char suffixes[NB_SUFFIXES] = {'K', 'M', 'G', 'T'};
622     int64_t base;
623     int i;
624 
625     if (size <= 999) {
626         snprintf(buf, buf_size, "%" PRId64, size);
627     } else {
628         base = 1024;
629         for (i = 0; i < NB_SUFFIXES; i++) {
630             if (size < (10 * base)) {
631                 snprintf(buf, buf_size, "%0.1f%c",
632                          (double)size / base,
633                          suffixes[i]);
634                 break;
635             } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
636                 snprintf(buf, buf_size, "%" PRId64 "%c",
637                          ((size + (base >> 1)) / base),
638                          suffixes[i]);
639                 break;
640             }
641             base = base * 1024;
642         }
643     }
644     return buf;
645 }
646 
647 void bdrv_snapshot_dump(fprintf_function func_fprintf, void *f,
648                         QEMUSnapshotInfo *sn)
649 {
650     char buf1[128], date_buf[128], clock_buf[128];
651     struct tm tm;
652     time_t ti;
653     int64_t secs;
654 
655     if (!sn) {
656         func_fprintf(f,
657                      "%-10s%-20s%7s%20s%15s",
658                      "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
659     } else {
660         ti = sn->date_sec;
661         localtime_r(&ti, &tm);
662         strftime(date_buf, sizeof(date_buf),
663                  "%Y-%m-%d %H:%M:%S", &tm);
664         secs = sn->vm_clock_nsec / 1000000000;
665         snprintf(clock_buf, sizeof(clock_buf),
666                  "%02d:%02d:%02d.%03d",
667                  (int)(secs / 3600),
668                  (int)((secs / 60) % 60),
669                  (int)(secs % 60),
670                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
671         func_fprintf(f,
672                      "%-10s%-20s%7s%20s%15s",
673                      sn->id_str, sn->name,
674                      get_human_readable_size(buf1, sizeof(buf1),
675                                              sn->vm_state_size),
676                      date_buf,
677                      clock_buf);
678     }
679 }
680 
681 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
682                        QDict *dict);
683 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
684                        QList *list);
685 
686 static void dump_qobject(fprintf_function func_fprintf, void *f,
687                          int comp_indent, QObject *obj)
688 {
689     switch (qobject_type(obj)) {
690         case QTYPE_QNUM: {
691             QNum *value = qobject_to(QNum, obj);
692             char *tmp = qnum_to_string(value);
693             func_fprintf(f, "%s", tmp);
694             g_free(tmp);
695             break;
696         }
697         case QTYPE_QSTRING: {
698             QString *value = qobject_to(QString, obj);
699             func_fprintf(f, "%s", qstring_get_str(value));
700             break;
701         }
702         case QTYPE_QDICT: {
703             QDict *value = qobject_to(QDict, obj);
704             dump_qdict(func_fprintf, f, comp_indent, value);
705             break;
706         }
707         case QTYPE_QLIST: {
708             QList *value = qobject_to(QList, obj);
709             dump_qlist(func_fprintf, f, comp_indent, value);
710             break;
711         }
712         case QTYPE_QBOOL: {
713             QBool *value = qobject_to(QBool, obj);
714             func_fprintf(f, "%s", qbool_get_bool(value) ? "true" : "false");
715             break;
716         }
717         default:
718             abort();
719     }
720 }
721 
722 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
723                        QList *list)
724 {
725     const QListEntry *entry;
726     int i = 0;
727 
728     for (entry = qlist_first(list); entry; entry = qlist_next(entry), i++) {
729         QType type = qobject_type(entry->value);
730         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
731         func_fprintf(f, "%*s[%i]:%c", indentation * 4, "", i,
732                      composite ? '\n' : ' ');
733         dump_qobject(func_fprintf, f, indentation + 1, entry->value);
734         if (!composite) {
735             func_fprintf(f, "\n");
736         }
737     }
738 }
739 
740 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
741                        QDict *dict)
742 {
743     const QDictEntry *entry;
744 
745     for (entry = qdict_first(dict); entry; entry = qdict_next(dict, entry)) {
746         QType type = qobject_type(entry->value);
747         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
748         char *key = g_malloc(strlen(entry->key) + 1);
749         int i;
750 
751         /* replace dashes with spaces in key (variable) names */
752         for (i = 0; entry->key[i]; i++) {
753             key[i] = entry->key[i] == '-' ? ' ' : entry->key[i];
754         }
755         key[i] = 0;
756         func_fprintf(f, "%*s%s:%c", indentation * 4, "", key,
757                      composite ? '\n' : ' ');
758         dump_qobject(func_fprintf, f, indentation + 1, entry->value);
759         if (!composite) {
760             func_fprintf(f, "\n");
761         }
762         g_free(key);
763     }
764 }
765 
766 void bdrv_image_info_specific_dump(fprintf_function func_fprintf, void *f,
767                                    ImageInfoSpecific *info_spec)
768 {
769     QObject *obj, *data;
770     Visitor *v = qobject_output_visitor_new(&obj);
771 
772     visit_type_ImageInfoSpecific(v, NULL, &info_spec, &error_abort);
773     visit_complete(v, &obj);
774     data = qdict_get(qobject_to(QDict, obj), "data");
775     dump_qobject(func_fprintf, f, 1, data);
776     qobject_unref(obj);
777     visit_free(v);
778 }
779 
780 void bdrv_image_info_dump(fprintf_function func_fprintf, void *f,
781                           ImageInfo *info)
782 {
783     char size_buf[128], dsize_buf[128];
784     if (!info->has_actual_size) {
785         snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
786     } else {
787         get_human_readable_size(dsize_buf, sizeof(dsize_buf),
788                                 info->actual_size);
789     }
790     get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
791     func_fprintf(f,
792                  "image: %s\n"
793                  "file format: %s\n"
794                  "virtual size: %s (%" PRId64 " bytes)\n"
795                  "disk size: %s\n",
796                  info->filename, info->format, size_buf,
797                  info->virtual_size,
798                  dsize_buf);
799 
800     if (info->has_encrypted && info->encrypted) {
801         func_fprintf(f, "encrypted: yes\n");
802     }
803 
804     if (info->has_cluster_size) {
805         func_fprintf(f, "cluster_size: %" PRId64 "\n",
806                        info->cluster_size);
807     }
808 
809     if (info->has_dirty_flag && info->dirty_flag) {
810         func_fprintf(f, "cleanly shut down: no\n");
811     }
812 
813     if (info->has_backing_filename) {
814         func_fprintf(f, "backing file: %s", info->backing_filename);
815         if (!info->has_full_backing_filename) {
816             func_fprintf(f, " (cannot determine actual path)");
817         } else if (strcmp(info->backing_filename,
818                           info->full_backing_filename) != 0) {
819             func_fprintf(f, " (actual path: %s)", info->full_backing_filename);
820         }
821         func_fprintf(f, "\n");
822         if (info->has_backing_filename_format) {
823             func_fprintf(f, "backing file format: %s\n",
824                          info->backing_filename_format);
825         }
826     }
827 
828     if (info->has_snapshots) {
829         SnapshotInfoList *elem;
830 
831         func_fprintf(f, "Snapshot list:\n");
832         bdrv_snapshot_dump(func_fprintf, f, NULL);
833         func_fprintf(f, "\n");
834 
835         /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
836          * we convert to the block layer's native QEMUSnapshotInfo for now.
837          */
838         for (elem = info->snapshots; elem; elem = elem->next) {
839             QEMUSnapshotInfo sn = {
840                 .vm_state_size = elem->value->vm_state_size,
841                 .date_sec = elem->value->date_sec,
842                 .date_nsec = elem->value->date_nsec,
843                 .vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
844                                  elem->value->vm_clock_nsec,
845             };
846 
847             pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
848             pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
849             bdrv_snapshot_dump(func_fprintf, f, &sn);
850             func_fprintf(f, "\n");
851         }
852     }
853 
854     if (info->has_format_specific) {
855         func_fprintf(f, "Format specific information:\n");
856         bdrv_image_info_specific_dump(func_fprintf, f, info->format_specific);
857     }
858 }
859