2 * Block layer qmp and info dump related functions
4 * Copyright (c) 2003-2008 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
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"
35 BlockDeviceInfo *bdrv_block_device_info(BlockDriverState *bs, Error **errp)
37 ImageInfo **p_image_info;
38 BlockDriverState *bs0;
39 BlockDeviceInfo *info = g_malloc0(sizeof(*info));
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);
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),
54 if (bs->node_name[0]) {
55 info->has_node_name = true;
56 info->node_name = g_strdup(bs->node_name);
59 if (bs->backing_file[0]) {
60 info->has_backing_file = true;
61 info->backing_file = g_strdup(bs->backing_file);
64 info->backing_file_depth = bdrv_get_backing_file_depth(bs);
65 info->detect_zeroes = bs->detect_zeroes;
67 if (bs->io_limits_enabled) {
70 throttle_group_get_config(bs, &cfg);
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;
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;
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;
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;
94 info->has_iops_size = cfg.op_size;
95 info->iops_size = cfg.op_size;
97 info->has_group = true;
98 info->group = g_strdup(throttle_group_get_name(bs));
101 info->write_threshold = bdrv_write_threshold_get(bs);
104 p_image_info = &info->image;
106 Error *local_err = NULL;
107 bdrv_query_image_info(bs0, p_image_info, &local_err);
109 error_propagate(errp, local_err);
110 qapi_free_BlockDeviceInfo(info);
113 if (bs0->drv && bs0->backing_hd) {
114 bs0 = bs0->backing_hd;
115 (*p_image_info)->has_backing_image = true;
116 p_image_info = &((*p_image_info)->backing_image);
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.
130 int bdrv_query_snapshot_info_list(BlockDriverState *bs,
131 SnapshotInfoList **p_list,
135 QEMUSnapshotInfo *sn_tab = NULL;
136 SnapshotInfoList *info_list, *cur_item = NULL, *head = NULL;
139 sn_count = bdrv_snapshot_list(bs, &sn_tab);
141 const char *dev = bdrv_get_device_name(bs);
144 error_setg(errp, "Device '%s' is not inserted", dev);
148 "Device '%s' does not support internal snapshots",
152 error_setg_errno(errp, -sn_count,
153 "Can't list snapshots of device '%s'", dev);
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;
169 info_list = g_new0(SnapshotInfoList, 1);
170 info_list->value = info;
172 /* XXX: waiting for the qapi to support qemu-queue.h types */
174 head = cur_item = info_list;
176 cur_item->next = info_list;
177 cur_item = info_list;
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
193 * Store "flat" image information in @p_info.
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
200 * @p_info will be set only on success. On error, store error in @errp.
202 void bdrv_query_image_info(BlockDriverState *bs,
207 const char *backing_filename;
213 size = bdrv_getlength(bs);
215 error_setg_errno(errp, -size, "Can't get size of device '%s'",
216 bdrv_get_device_name(bs));
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;
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;
235 info->dirty_flag = bdi.is_dirty;
236 info->has_dirty_flag = true;
238 info->format_specific = bdrv_get_specific_info(bs);
239 info->has_format_specific = info->format_specific != NULL;
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);
248 error_propagate(errp, err);
249 qapi_free_ImageInfo(info);
250 g_free(backing_filename2);
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;
260 if (bs->backing_format[0]) {
261 info->backing_filename_format = g_strdup(bs->backing_format);
262 info->has_backing_filename_format = true;
264 g_free(backing_filename2);
267 ret = bdrv_query_snapshot_info_list(bs, &info->snapshots, &err);
270 if (info->snapshots) {
271 info->has_snapshots = true;
274 /* recoverable error */
280 error_propagate(errp, err);
281 qapi_free_ImageInfo(info);
288 /* @p_info will be set only on success. */
289 static void bdrv_query_info(BlockBackend *blk, BlockInfo **p_info,
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);
299 if (blk_dev_has_removable_media(blk)) {
300 info->has_tray_open = true;
301 info->tray_open = blk_dev_is_tray_open(blk);
304 if (bdrv_iostatus_is_enabled(bs)) {
305 info->has_io_status = true;
306 info->io_status = bs->iostatus;
309 if (!QLIST_EMPTY(&bs->dirty_bitmaps)) {
310 info->has_dirty_bitmaps = true;
311 info->dirty_bitmaps = bdrv_query_dirty_bitmaps(bs);
315 info->has_inserted = true;
316 info->inserted = bdrv_block_device_info(bs, errp);
317 if (info->inserted == NULL) {
326 qapi_free_BlockInfo(info);
329 static BlockStats *bdrv_query_stats(const BlockDriverState *bs,
334 s = g_malloc0(sizeof(*s));
336 if (bdrv_get_device_name(bs)[0]) {
337 s->has_device = true;
338 s->device = g_strdup(bdrv_get_device_name(bs));
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));
346 s->stats = g_malloc0(sizeof(*s->stats));
347 s->stats->rd_bytes = bs->stats.nr_bytes[BLOCK_ACCT_READ];
348 s->stats->wr_bytes = bs->stats.nr_bytes[BLOCK_ACCT_WRITE];
349 s->stats->rd_operations = bs->stats.nr_ops[BLOCK_ACCT_READ];
350 s->stats->wr_operations = bs->stats.nr_ops[BLOCK_ACCT_WRITE];
351 s->stats->rd_merged = bs->stats.merged[BLOCK_ACCT_READ];
352 s->stats->wr_merged = bs->stats.merged[BLOCK_ACCT_WRITE];
353 s->stats->wr_highest_offset =
354 bs->stats.wr_highest_sector * BDRV_SECTOR_SIZE;
355 s->stats->flush_operations = bs->stats.nr_ops[BLOCK_ACCT_FLUSH];
356 s->stats->wr_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_WRITE];
357 s->stats->rd_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_READ];
358 s->stats->flush_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_FLUSH];
361 s->has_parent = true;
362 s->parent = bdrv_query_stats(bs->file, query_backing);
365 if (query_backing && bs->backing_hd) {
366 s->has_backing = true;
367 s->backing = bdrv_query_stats(bs->backing_hd, query_backing);
373 BlockInfoList *qmp_query_block(Error **errp)
375 BlockInfoList *head = NULL, **p_next = &head;
377 Error *local_err = NULL;
379 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
380 BlockInfoList *info = g_malloc0(sizeof(*info));
381 bdrv_query_info(blk, &info->value, &local_err);
383 error_propagate(errp, local_err);
388 p_next = &info->next;
394 qapi_free_BlockInfoList(head);
398 BlockStatsList *qmp_query_blockstats(bool has_query_nodes,
402 BlockStatsList *head = NULL, **p_next = &head;
403 BlockDriverState *bs = NULL;
405 /* Just to be safe if query_nodes is not always initialized */
406 query_nodes = has_query_nodes && query_nodes;
408 while ((bs = query_nodes ? bdrv_next_node(bs) : bdrv_next(bs))) {
409 BlockStatsList *info = g_malloc0(sizeof(*info));
410 AioContext *ctx = bdrv_get_aio_context(bs);
412 aio_context_acquire(ctx);
413 info->value = bdrv_query_stats(bs, !query_nodes);
414 aio_context_release(ctx);
417 p_next = &info->next;
423 #define NB_SUFFIXES 4
425 static char *get_human_readable_size(char *buf, int buf_size, int64_t size)
427 static const char suffixes[NB_SUFFIXES] = {'K', 'M', 'G', 'T'};
432 snprintf(buf, buf_size, "%" PRId64, size);
435 for (i = 0; i < NB_SUFFIXES; i++) {
436 if (size < (10 * base)) {
437 snprintf(buf, buf_size, "%0.1f%c",
441 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
442 snprintf(buf, buf_size, "%" PRId64 "%c",
443 ((size + (base >> 1)) / base),
453 void bdrv_snapshot_dump(fprintf_function func_fprintf, void *f,
454 QEMUSnapshotInfo *sn)
456 char buf1[128], date_buf[128], clock_buf[128];
463 "%-10s%-20s%7s%20s%15s",
464 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
467 localtime_r(&ti, &tm);
468 strftime(date_buf, sizeof(date_buf),
469 "%Y-%m-%d %H:%M:%S", &tm);
470 secs = sn->vm_clock_nsec / 1000000000;
471 snprintf(clock_buf, sizeof(clock_buf),
472 "%02d:%02d:%02d.%03d",
474 (int)((secs / 60) % 60),
476 (int)((sn->vm_clock_nsec / 1000000) % 1000));
478 "%-10s%-20s%7s%20s%15s",
479 sn->id_str, sn->name,
480 get_human_readable_size(buf1, sizeof(buf1),
487 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
489 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
492 static void dump_qobject(fprintf_function func_fprintf, void *f,
493 int comp_indent, QObject *obj)
495 switch (qobject_type(obj)) {
497 QInt *value = qobject_to_qint(obj);
498 func_fprintf(f, "%" PRId64, qint_get_int(value));
501 case QTYPE_QSTRING: {
502 QString *value = qobject_to_qstring(obj);
503 func_fprintf(f, "%s", qstring_get_str(value));
507 QDict *value = qobject_to_qdict(obj);
508 dump_qdict(func_fprintf, f, comp_indent, value);
512 QList *value = qobject_to_qlist(obj);
513 dump_qlist(func_fprintf, f, comp_indent, value);
517 QFloat *value = qobject_to_qfloat(obj);
518 func_fprintf(f, "%g", qfloat_get_double(value));
522 QBool *value = qobject_to_qbool(obj);
523 func_fprintf(f, "%s", qbool_get_bool(value) ? "true" : "false");
531 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
534 const QListEntry *entry;
537 for (entry = qlist_first(list); entry; entry = qlist_next(entry), i++) {
538 qtype_code type = qobject_type(entry->value);
539 bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
540 const char *format = composite ? "%*s[%i]:\n" : "%*s[%i]: ";
542 func_fprintf(f, format, indentation * 4, "", i);
543 dump_qobject(func_fprintf, f, indentation + 1, entry->value);
545 func_fprintf(f, "\n");
550 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
553 const QDictEntry *entry;
555 for (entry = qdict_first(dict); entry; entry = qdict_next(dict, entry)) {
556 qtype_code type = qobject_type(entry->value);
557 bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
558 const char *format = composite ? "%*s%s:\n" : "%*s%s: ";
559 char key[strlen(entry->key) + 1];
562 /* replace dashes with spaces in key (variable) names */
563 for (i = 0; entry->key[i]; i++) {
564 key[i] = entry->key[i] == '-' ? ' ' : entry->key[i];
568 func_fprintf(f, format, indentation * 4, "", key);
569 dump_qobject(func_fprintf, f, indentation + 1, entry->value);
571 func_fprintf(f, "\n");
576 void bdrv_image_info_specific_dump(fprintf_function func_fprintf, void *f,
577 ImageInfoSpecific *info_spec)
579 QmpOutputVisitor *ov = qmp_output_visitor_new();
582 visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov), &info_spec, NULL,
584 obj = qmp_output_get_qobject(ov);
585 assert(qobject_type(obj) == QTYPE_QDICT);
586 data = qdict_get(qobject_to_qdict(obj), "data");
587 dump_qobject(func_fprintf, f, 1, data);
588 qmp_output_visitor_cleanup(ov);
591 void bdrv_image_info_dump(fprintf_function func_fprintf, void *f,
594 char size_buf[128], dsize_buf[128];
595 if (!info->has_actual_size) {
596 snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
598 get_human_readable_size(dsize_buf, sizeof(dsize_buf),
601 get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
605 "virtual size: %s (%" PRId64 " bytes)\n"
607 info->filename, info->format, size_buf,
611 if (info->has_encrypted && info->encrypted) {
612 func_fprintf(f, "encrypted: yes\n");
615 if (info->has_cluster_size) {
616 func_fprintf(f, "cluster_size: %" PRId64 "\n",
620 if (info->has_dirty_flag && info->dirty_flag) {
621 func_fprintf(f, "cleanly shut down: no\n");
624 if (info->has_backing_filename) {
625 func_fprintf(f, "backing file: %s", info->backing_filename);
626 if (info->has_full_backing_filename) {
627 func_fprintf(f, " (actual path: %s)", info->full_backing_filename);
629 func_fprintf(f, "\n");
630 if (info->has_backing_filename_format) {
631 func_fprintf(f, "backing file format: %s\n",
632 info->backing_filename_format);
636 if (info->has_snapshots) {
637 SnapshotInfoList *elem;
639 func_fprintf(f, "Snapshot list:\n");
640 bdrv_snapshot_dump(func_fprintf, f, NULL);
641 func_fprintf(f, "\n");
643 /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
644 * we convert to the block layer's native QEMUSnapshotInfo for now.
646 for (elem = info->snapshots; elem; elem = elem->next) {
647 QEMUSnapshotInfo sn = {
648 .vm_state_size = elem->value->vm_state_size,
649 .date_sec = elem->value->date_sec,
650 .date_nsec = elem->value->date_nsec,
651 .vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
652 elem->value->vm_clock_nsec,
655 pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
656 pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
657 bdrv_snapshot_dump(func_fprintf, f, &sn);
658 func_fprintf(f, "\n");
662 if (info->has_format_specific) {
663 func_fprintf(f, "Format specific information:\n");
664 bdrv_image_info_specific_dump(func_fprintf, f, info->format_specific);