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 "qmp-commands.h"
28 #include "qapi-visit.h"
29 #include "qapi/qmp-output-visitor.h"
30 #include "qapi/qmp/types.h"
31 #include "sysemu/block-backend.h"
33 BlockDeviceInfo
*bdrv_block_device_info(BlockDriverState
*bs
)
35 BlockDeviceInfo
*info
= g_malloc0(sizeof(*info
));
37 info
->file
= g_strdup(bs
->filename
);
38 info
->ro
= bs
->read_only
;
39 info
->drv
= g_strdup(bs
->drv
->format_name
);
40 info
->encrypted
= bs
->encrypted
;
41 info
->encryption_key_missing
= bdrv_key_required(bs
);
43 info
->cache
= g_new(BlockdevCacheInfo
, 1);
44 *info
->cache
= (BlockdevCacheInfo
) {
45 .writeback
= bdrv_enable_write_cache(bs
),
46 .direct
= !!(bs
->open_flags
& BDRV_O_NOCACHE
),
47 .no_flush
= !!(bs
->open_flags
& BDRV_O_NO_FLUSH
),
50 if (bs
->node_name
[0]) {
51 info
->has_node_name
= true;
52 info
->node_name
= g_strdup(bs
->node_name
);
55 if (bs
->backing_file
[0]) {
56 info
->has_backing_file
= true;
57 info
->backing_file
= g_strdup(bs
->backing_file
);
60 info
->backing_file_depth
= bdrv_get_backing_file_depth(bs
);
61 info
->detect_zeroes
= bs
->detect_zeroes
;
63 if (bs
->io_limits_enabled
) {
65 throttle_get_config(&bs
->throttle_state
, &cfg
);
66 info
->bps
= cfg
.buckets
[THROTTLE_BPS_TOTAL
].avg
;
67 info
->bps_rd
= cfg
.buckets
[THROTTLE_BPS_READ
].avg
;
68 info
->bps_wr
= cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
;
70 info
->iops
= cfg
.buckets
[THROTTLE_OPS_TOTAL
].avg
;
71 info
->iops_rd
= cfg
.buckets
[THROTTLE_OPS_READ
].avg
;
72 info
->iops_wr
= cfg
.buckets
[THROTTLE_OPS_WRITE
].avg
;
74 info
->has_bps_max
= cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
;
75 info
->bps_max
= cfg
.buckets
[THROTTLE_BPS_TOTAL
].max
;
76 info
->has_bps_rd_max
= cfg
.buckets
[THROTTLE_BPS_READ
].max
;
77 info
->bps_rd_max
= cfg
.buckets
[THROTTLE_BPS_READ
].max
;
78 info
->has_bps_wr_max
= cfg
.buckets
[THROTTLE_BPS_WRITE
].max
;
79 info
->bps_wr_max
= cfg
.buckets
[THROTTLE_BPS_WRITE
].max
;
81 info
->has_iops_max
= cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
;
82 info
->iops_max
= cfg
.buckets
[THROTTLE_OPS_TOTAL
].max
;
83 info
->has_iops_rd_max
= cfg
.buckets
[THROTTLE_OPS_READ
].max
;
84 info
->iops_rd_max
= cfg
.buckets
[THROTTLE_OPS_READ
].max
;
85 info
->has_iops_wr_max
= cfg
.buckets
[THROTTLE_OPS_WRITE
].max
;
86 info
->iops_wr_max
= cfg
.buckets
[THROTTLE_OPS_WRITE
].max
;
88 info
->has_iops_size
= cfg
.op_size
;
89 info
->iops_size
= cfg
.op_size
;
96 * Returns 0 on success, with *p_list either set to describe snapshot
97 * information, or NULL because there are no snapshots. Returns -errno on
98 * error, with *p_list untouched.
100 int bdrv_query_snapshot_info_list(BlockDriverState
*bs
,
101 SnapshotInfoList
**p_list
,
105 QEMUSnapshotInfo
*sn_tab
= NULL
;
106 SnapshotInfoList
*info_list
, *cur_item
= NULL
, *head
= NULL
;
109 sn_count
= bdrv_snapshot_list(bs
, &sn_tab
);
111 const char *dev
= bdrv_get_device_name(bs
);
114 error_setg(errp
, "Device '%s' is not inserted", dev
);
118 "Device '%s' does not support internal snapshots",
122 error_setg_errno(errp
, -sn_count
,
123 "Can't list snapshots of device '%s'", dev
);
129 for (i
= 0; i
< sn_count
; i
++) {
130 info
= g_new0(SnapshotInfo
, 1);
131 info
->id
= g_strdup(sn_tab
[i
].id_str
);
132 info
->name
= g_strdup(sn_tab
[i
].name
);
133 info
->vm_state_size
= sn_tab
[i
].vm_state_size
;
134 info
->date_sec
= sn_tab
[i
].date_sec
;
135 info
->date_nsec
= sn_tab
[i
].date_nsec
;
136 info
->vm_clock_sec
= sn_tab
[i
].vm_clock_nsec
/ 1000000000;
137 info
->vm_clock_nsec
= sn_tab
[i
].vm_clock_nsec
% 1000000000;
139 info_list
= g_new0(SnapshotInfoList
, 1);
140 info_list
->value
= info
;
142 /* XXX: waiting for the qapi to support qemu-queue.h types */
144 head
= cur_item
= info_list
;
146 cur_item
->next
= info_list
;
147 cur_item
= info_list
;
158 * bdrv_query_image_info:
159 * @bs: block device to examine
160 * @p_info: location to store image information
161 * @errp: location to store error information
163 * Store "flat" image information in @p_info.
165 * "Flat" means it does *not* query backing image information,
166 * i.e. (*pinfo)->has_backing_image will be set to false and
167 * (*pinfo)->backing_image to NULL even when the image does in fact have
170 * @p_info will be set only on success. On error, store error in @errp.
172 void bdrv_query_image_info(BlockDriverState
*bs
,
177 const char *backing_filename
;
183 size
= bdrv_getlength(bs
);
185 error_setg_errno(errp
, -size
, "Can't get size of device '%s'",
186 bdrv_get_device_name(bs
));
190 info
= g_new0(ImageInfo
, 1);
191 info
->filename
= g_strdup(bs
->filename
);
192 info
->format
= g_strdup(bdrv_get_format_name(bs
));
193 info
->virtual_size
= size
;
194 info
->actual_size
= bdrv_get_allocated_file_size(bs
);
195 info
->has_actual_size
= info
->actual_size
>= 0;
196 if (bdrv_is_encrypted(bs
)) {
197 info
->encrypted
= true;
198 info
->has_encrypted
= true;
200 if (bdrv_get_info(bs
, &bdi
) >= 0) {
201 if (bdi
.cluster_size
!= 0) {
202 info
->cluster_size
= bdi
.cluster_size
;
203 info
->has_cluster_size
= true;
205 info
->dirty_flag
= bdi
.is_dirty
;
206 info
->has_dirty_flag
= true;
208 info
->format_specific
= bdrv_get_specific_info(bs
);
209 info
->has_format_specific
= info
->format_specific
!= NULL
;
211 backing_filename
= bs
->backing_file
;
212 if (backing_filename
[0] != '\0') {
213 char *backing_filename2
= g_malloc0(PATH_MAX
);
214 info
->backing_filename
= g_strdup(backing_filename
);
215 info
->has_backing_filename
= true;
216 bdrv_get_full_backing_filename(bs
, backing_filename2
, PATH_MAX
, &err
);
218 error_propagate(errp
, err
);
219 qapi_free_ImageInfo(info
);
220 g_free(backing_filename2
);
224 if (strcmp(backing_filename
, backing_filename2
) != 0) {
225 info
->full_backing_filename
=
226 g_strdup(backing_filename2
);
227 info
->has_full_backing_filename
= true;
230 if (bs
->backing_format
[0]) {
231 info
->backing_filename_format
= g_strdup(bs
->backing_format
);
232 info
->has_backing_filename_format
= true;
234 g_free(backing_filename2
);
237 ret
= bdrv_query_snapshot_info_list(bs
, &info
->snapshots
, &err
);
240 if (info
->snapshots
) {
241 info
->has_snapshots
= true;
244 /* recoverable error */
250 error_propagate(errp
, err
);
251 qapi_free_ImageInfo(info
);
258 /* @p_info will be set only on success. */
259 static void bdrv_query_info(BlockBackend
*blk
, BlockInfo
**p_info
,
262 BlockInfo
*info
= g_malloc0(sizeof(*info
));
263 BlockDriverState
*bs
= blk_bs(blk
);
264 BlockDriverState
*bs0
;
265 ImageInfo
**p_image_info
;
266 Error
*local_err
= NULL
;
267 info
->device
= g_strdup(blk_name(blk
));
268 info
->type
= g_strdup("unknown");
269 info
->locked
= blk_dev_is_medium_locked(blk
);
270 info
->removable
= blk_dev_has_removable_media(blk
);
272 if (blk_dev_has_removable_media(blk
)) {
273 info
->has_tray_open
= true;
274 info
->tray_open
= blk_dev_is_tray_open(blk
);
277 if (bdrv_iostatus_is_enabled(bs
)) {
278 info
->has_io_status
= true;
279 info
->io_status
= bs
->iostatus
;
282 if (!QLIST_EMPTY(&bs
->dirty_bitmaps
)) {
283 info
->has_dirty_bitmaps
= true;
284 info
->dirty_bitmaps
= bdrv_query_dirty_bitmaps(bs
);
288 info
->has_inserted
= true;
289 info
->inserted
= bdrv_block_device_info(bs
);
292 p_image_info
= &info
->inserted
->image
;
294 bdrv_query_image_info(bs0
, p_image_info
, &local_err
);
296 error_propagate(errp
, local_err
);
299 if (bs0
->drv
&& bs0
->backing_hd
) {
300 bs0
= bs0
->backing_hd
;
301 (*p_image_info
)->has_backing_image
= true;
302 p_image_info
= &((*p_image_info
)->backing_image
);
313 qapi_free_BlockInfo(info
);
316 static BlockStats
*bdrv_query_stats(const BlockDriverState
*bs
,
321 s
= g_malloc0(sizeof(*s
));
323 if (bdrv_get_device_name(bs
)[0]) {
324 s
->has_device
= true;
325 s
->device
= g_strdup(bdrv_get_device_name(bs
));
328 if (bdrv_get_node_name(bs
)[0]) {
329 s
->has_node_name
= true;
330 s
->node_name
= g_strdup(bdrv_get_node_name(bs
));
333 s
->stats
= g_malloc0(sizeof(*s
->stats
));
334 s
->stats
->rd_bytes
= bs
->stats
.nr_bytes
[BLOCK_ACCT_READ
];
335 s
->stats
->wr_bytes
= bs
->stats
.nr_bytes
[BLOCK_ACCT_WRITE
];
336 s
->stats
->rd_operations
= bs
->stats
.nr_ops
[BLOCK_ACCT_READ
];
337 s
->stats
->wr_operations
= bs
->stats
.nr_ops
[BLOCK_ACCT_WRITE
];
338 s
->stats
->rd_merged
= bs
->stats
.merged
[BLOCK_ACCT_READ
];
339 s
->stats
->wr_merged
= bs
->stats
.merged
[BLOCK_ACCT_WRITE
];
340 s
->stats
->wr_highest_offset
=
341 bs
->stats
.wr_highest_sector
* BDRV_SECTOR_SIZE
;
342 s
->stats
->flush_operations
= bs
->stats
.nr_ops
[BLOCK_ACCT_FLUSH
];
343 s
->stats
->wr_total_time_ns
= bs
->stats
.total_time_ns
[BLOCK_ACCT_WRITE
];
344 s
->stats
->rd_total_time_ns
= bs
->stats
.total_time_ns
[BLOCK_ACCT_READ
];
345 s
->stats
->flush_total_time_ns
= bs
->stats
.total_time_ns
[BLOCK_ACCT_FLUSH
];
348 s
->has_parent
= true;
349 s
->parent
= bdrv_query_stats(bs
->file
, query_backing
);
352 if (query_backing
&& bs
->backing_hd
) {
353 s
->has_backing
= true;
354 s
->backing
= bdrv_query_stats(bs
->backing_hd
, query_backing
);
360 BlockInfoList
*qmp_query_block(Error
**errp
)
362 BlockInfoList
*head
= NULL
, **p_next
= &head
;
364 Error
*local_err
= NULL
;
366 for (blk
= blk_next(NULL
); blk
; blk
= blk_next(blk
)) {
367 BlockInfoList
*info
= g_malloc0(sizeof(*info
));
368 bdrv_query_info(blk
, &info
->value
, &local_err
);
370 error_propagate(errp
, local_err
);
375 p_next
= &info
->next
;
381 qapi_free_BlockInfoList(head
);
385 BlockStatsList
*qmp_query_blockstats(bool has_query_nodes
,
389 BlockStatsList
*head
= NULL
, **p_next
= &head
;
390 BlockDriverState
*bs
= NULL
;
392 /* Just to be safe if query_nodes is not always initialized */
393 query_nodes
= has_query_nodes
&& query_nodes
;
395 while ((bs
= query_nodes
? bdrv_next_node(bs
) : bdrv_next(bs
))) {
396 BlockStatsList
*info
= g_malloc0(sizeof(*info
));
397 AioContext
*ctx
= bdrv_get_aio_context(bs
);
399 aio_context_acquire(ctx
);
400 info
->value
= bdrv_query_stats(bs
, !query_nodes
);
401 aio_context_release(ctx
);
404 p_next
= &info
->next
;
410 #define NB_SUFFIXES 4
412 static char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
414 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
419 snprintf(buf
, buf_size
, "%" PRId64
, size
);
422 for (i
= 0; i
< NB_SUFFIXES
; i
++) {
423 if (size
< (10 * base
)) {
424 snprintf(buf
, buf_size
, "%0.1f%c",
428 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
429 snprintf(buf
, buf_size
, "%" PRId64
"%c",
430 ((size
+ (base
>> 1)) / base
),
440 void bdrv_snapshot_dump(fprintf_function func_fprintf
, void *f
,
441 QEMUSnapshotInfo
*sn
)
443 char buf1
[128], date_buf
[128], clock_buf
[128];
450 "%-10s%-20s%7s%20s%15s",
451 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
454 localtime_r(&ti
, &tm
);
455 strftime(date_buf
, sizeof(date_buf
),
456 "%Y-%m-%d %H:%M:%S", &tm
);
457 secs
= sn
->vm_clock_nsec
/ 1000000000;
458 snprintf(clock_buf
, sizeof(clock_buf
),
459 "%02d:%02d:%02d.%03d",
461 (int)((secs
/ 60) % 60),
463 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
465 "%-10s%-20s%7s%20s%15s",
466 sn
->id_str
, sn
->name
,
467 get_human_readable_size(buf1
, sizeof(buf1
),
474 static void dump_qdict(fprintf_function func_fprintf
, void *f
, int indentation
,
476 static void dump_qlist(fprintf_function func_fprintf
, void *f
, int indentation
,
479 static void dump_qobject(fprintf_function func_fprintf
, void *f
,
480 int comp_indent
, QObject
*obj
)
482 switch (qobject_type(obj
)) {
484 QInt
*value
= qobject_to_qint(obj
);
485 func_fprintf(f
, "%" PRId64
, qint_get_int(value
));
488 case QTYPE_QSTRING
: {
489 QString
*value
= qobject_to_qstring(obj
);
490 func_fprintf(f
, "%s", qstring_get_str(value
));
494 QDict
*value
= qobject_to_qdict(obj
);
495 dump_qdict(func_fprintf
, f
, comp_indent
, value
);
499 QList
*value
= qobject_to_qlist(obj
);
500 dump_qlist(func_fprintf
, f
, comp_indent
, value
);
504 QFloat
*value
= qobject_to_qfloat(obj
);
505 func_fprintf(f
, "%g", qfloat_get_double(value
));
509 QBool
*value
= qobject_to_qbool(obj
);
510 func_fprintf(f
, "%s", qbool_get_int(value
) ? "true" : "false");
514 QString
*value
= qerror_human((QError
*)obj
);
515 func_fprintf(f
, "%s", qstring_get_str(value
));
527 static void dump_qlist(fprintf_function func_fprintf
, void *f
, int indentation
,
530 const QListEntry
*entry
;
533 for (entry
= qlist_first(list
); entry
; entry
= qlist_next(entry
), i
++) {
534 qtype_code type
= qobject_type(entry
->value
);
535 bool composite
= (type
== QTYPE_QDICT
|| type
== QTYPE_QLIST
);
536 const char *format
= composite
? "%*s[%i]:\n" : "%*s[%i]: ";
538 func_fprintf(f
, format
, indentation
* 4, "", i
);
539 dump_qobject(func_fprintf
, f
, indentation
+ 1, entry
->value
);
541 func_fprintf(f
, "\n");
546 static void dump_qdict(fprintf_function func_fprintf
, void *f
, int indentation
,
549 const QDictEntry
*entry
;
551 for (entry
= qdict_first(dict
); entry
; entry
= qdict_next(dict
, entry
)) {
552 qtype_code type
= qobject_type(entry
->value
);
553 bool composite
= (type
== QTYPE_QDICT
|| type
== QTYPE_QLIST
);
554 const char *format
= composite
? "%*s%s:\n" : "%*s%s: ";
555 char key
[strlen(entry
->key
) + 1];
558 /* replace dashes with spaces in key (variable) names */
559 for (i
= 0; entry
->key
[i
]; i
++) {
560 key
[i
] = entry
->key
[i
] == '-' ? ' ' : entry
->key
[i
];
564 func_fprintf(f
, format
, indentation
* 4, "", key
);
565 dump_qobject(func_fprintf
, f
, indentation
+ 1, entry
->value
);
567 func_fprintf(f
, "\n");
572 void bdrv_image_info_specific_dump(fprintf_function func_fprintf
, void *f
,
573 ImageInfoSpecific
*info_spec
)
575 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
578 visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov
), &info_spec
, NULL
,
580 obj
= qmp_output_get_qobject(ov
);
581 assert(qobject_type(obj
) == QTYPE_QDICT
);
582 data
= qdict_get(qobject_to_qdict(obj
), "data");
583 dump_qobject(func_fprintf
, f
, 1, data
);
584 qmp_output_visitor_cleanup(ov
);
587 void bdrv_image_info_dump(fprintf_function func_fprintf
, void *f
,
590 char size_buf
[128], dsize_buf
[128];
591 if (!info
->has_actual_size
) {
592 snprintf(dsize_buf
, sizeof(dsize_buf
), "unavailable");
594 get_human_readable_size(dsize_buf
, sizeof(dsize_buf
),
597 get_human_readable_size(size_buf
, sizeof(size_buf
), info
->virtual_size
);
601 "virtual size: %s (%" PRId64
" bytes)\n"
603 info
->filename
, info
->format
, size_buf
,
607 if (info
->has_encrypted
&& info
->encrypted
) {
608 func_fprintf(f
, "encrypted: yes\n");
611 if (info
->has_cluster_size
) {
612 func_fprintf(f
, "cluster_size: %" PRId64
"\n",
616 if (info
->has_dirty_flag
&& info
->dirty_flag
) {
617 func_fprintf(f
, "cleanly shut down: no\n");
620 if (info
->has_backing_filename
) {
621 func_fprintf(f
, "backing file: %s", info
->backing_filename
);
622 if (info
->has_full_backing_filename
) {
623 func_fprintf(f
, " (actual path: %s)", info
->full_backing_filename
);
625 func_fprintf(f
, "\n");
626 if (info
->has_backing_filename_format
) {
627 func_fprintf(f
, "backing file format: %s\n",
628 info
->backing_filename_format
);
632 if (info
->has_snapshots
) {
633 SnapshotInfoList
*elem
;
635 func_fprintf(f
, "Snapshot list:\n");
636 bdrv_snapshot_dump(func_fprintf
, f
, NULL
);
637 func_fprintf(f
, "\n");
639 /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
640 * we convert to the block layer's native QEMUSnapshotInfo for now.
642 for (elem
= info
->snapshots
; elem
; elem
= elem
->next
) {
643 QEMUSnapshotInfo sn
= {
644 .vm_state_size
= elem
->value
->vm_state_size
,
645 .date_sec
= elem
->value
->date_sec
,
646 .date_nsec
= elem
->value
->date_nsec
,
647 .vm_clock_nsec
= elem
->value
->vm_clock_sec
* 1000000000ULL +
648 elem
->value
->vm_clock_nsec
,
651 pstrcpy(sn
.id_str
, sizeof(sn
.id_str
), elem
->value
->id
);
652 pstrcpy(sn
.name
, sizeof(sn
.name
), elem
->value
->name
);
653 bdrv_snapshot_dump(func_fprintf
, f
, &sn
);
654 func_fprintf(f
, "\n");
658 if (info
->has_format_specific
) {
659 func_fprintf(f
, "Format specific information:\n");
660 bdrv_image_info_specific_dump(func_fprintf
, f
, info
->format_specific
);