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"
30
* Returns 0 on success, with *p_list either set to describe snapshot
31
* information, or NULL because there are no snapshots. Returns -errno on
32
* error, with *p_list untouched.
34
int bdrv_query_snapshot_info_list(BlockDriverState *bs,
35
SnapshotInfoList **p_list,
39
QEMUSnapshotInfo *sn_tab = NULL;
40
SnapshotInfoList *info_list, *cur_item = NULL, *head = NULL;
43
sn_count = bdrv_snapshot_list(bs, &sn_tab);
45
const char *dev = bdrv_get_device_name(bs);
48
error_setg(errp, "Device '%s' is not inserted", dev);
52
"Device '%s' does not support internal snapshots",
56
error_setg_errno(errp, -sn_count,
57
"Can't list snapshots of device '%s'", dev);
63
for (i = 0; i < sn_count; i++) {
64
info = g_new0(SnapshotInfo, 1);
65
info->id = g_strdup(sn_tab[i].id_str);
66
info->name = g_strdup(sn_tab[i].name);
67
info->vm_state_size = sn_tab[i].vm_state_size;
68
info->date_sec = sn_tab[i].date_sec;
69
info->date_nsec = sn_tab[i].date_nsec;
70
info->vm_clock_sec = sn_tab[i].vm_clock_nsec / 1000000000;
71
info->vm_clock_nsec = sn_tab[i].vm_clock_nsec % 1000000000;
73
info_list = g_new0(SnapshotInfoList, 1);
74
info_list->value = info;
76
/* XXX: waiting for the qapi to support qemu-queue.h types */
78
head = cur_item = info_list;
80
cur_item->next = info_list;
92
* bdrv_query_image_info:
93
* @bs: block device to examine
94
* @p_info: location to store image information
95
* @errp: location to store error information
97
* Store "flat" image information in @p_info.
99
* "Flat" means it does *not* query backing image information,
100
* i.e. (*pinfo)->has_backing_image will be set to false and
101
* (*pinfo)->backing_image to NULL even when the image does in fact have
104
* @p_info will be set only on success. On error, store error in @errp.
106
void bdrv_query_image_info(BlockDriverState *bs,
110
uint64_t total_sectors;
111
const char *backing_filename;
112
char backing_filename2[1024];
116
ImageInfo *info = g_new0(ImageInfo, 1);
118
bdrv_get_geometry(bs, &total_sectors);
120
info->filename = g_strdup(bs->filename);
121
info->format = g_strdup(bdrv_get_format_name(bs));
122
info->virtual_size = total_sectors * 512;
123
info->actual_size = bdrv_get_allocated_file_size(bs);
124
info->has_actual_size = info->actual_size >= 0;
125
if (bdrv_is_encrypted(bs)) {
126
info->encrypted = true;
127
info->has_encrypted = true;
129
if (bdrv_get_info(bs, &bdi) >= 0) {
130
if (bdi.cluster_size != 0) {
131
info->cluster_size = bdi.cluster_size;
132
info->has_cluster_size = true;
134
info->dirty_flag = bdi.is_dirty;
135
info->has_dirty_flag = true;
137
backing_filename = bs->backing_file;
138
if (backing_filename[0] != '\0') {
139
info->backing_filename = g_strdup(backing_filename);
140
info->has_backing_filename = true;
141
bdrv_get_full_backing_filename(bs, backing_filename2,
142
sizeof(backing_filename2));
144
if (strcmp(backing_filename, backing_filename2) != 0) {
145
info->full_backing_filename =
146
g_strdup(backing_filename2);
147
info->has_full_backing_filename = true;
150
if (bs->backing_format[0]) {
151
info->backing_filename_format = g_strdup(bs->backing_format);
152
info->has_backing_filename_format = true;
156
ret = bdrv_query_snapshot_info_list(bs, &info->snapshots, &err);
159
if (info->snapshots) {
160
info->has_snapshots = true;
163
/* recoverable error */
169
error_propagate(errp, err);
170
qapi_free_ImageInfo(info);
177
/* @p_info will be set only on success. */
178
void bdrv_query_info(BlockDriverState *bs,
182
BlockInfo *info = g_malloc0(sizeof(*info));
183
BlockDriverState *bs0;
184
ImageInfo **p_image_info;
185
Error *local_err = NULL;
186
info->device = g_strdup(bs->device_name);
187
info->type = g_strdup("unknown");
188
info->locked = bdrv_dev_is_medium_locked(bs);
189
info->removable = bdrv_dev_has_removable_media(bs);
191
if (bdrv_dev_has_removable_media(bs)) {
192
info->has_tray_open = true;
193
info->tray_open = bdrv_dev_is_tray_open(bs);
196
if (bdrv_iostatus_is_enabled(bs)) {
197
info->has_io_status = true;
198
info->io_status = bs->iostatus;
201
if (bs->dirty_bitmap) {
202
info->has_dirty = true;
203
info->dirty = g_malloc0(sizeof(*info->dirty));
204
info->dirty->count = bdrv_get_dirty_count(bs) * BDRV_SECTOR_SIZE;
205
info->dirty->granularity =
206
((int64_t) BDRV_SECTOR_SIZE << hbitmap_granularity(bs->dirty_bitmap));
210
info->has_inserted = true;
211
info->inserted = g_malloc0(sizeof(*info->inserted));
212
info->inserted->file = g_strdup(bs->filename);
213
info->inserted->ro = bs->read_only;
214
info->inserted->drv = g_strdup(bs->drv->format_name);
215
info->inserted->encrypted = bs->encrypted;
216
info->inserted->encryption_key_missing = bdrv_key_required(bs);
218
if (bs->backing_file[0]) {
219
info->inserted->has_backing_file = true;
220
info->inserted->backing_file = g_strdup(bs->backing_file);
223
info->inserted->backing_file_depth = bdrv_get_backing_file_depth(bs);
225
if (bs->io_limits_enabled) {
226
info->inserted->bps =
227
bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
228
info->inserted->bps_rd =
229
bs->io_limits.bps[BLOCK_IO_LIMIT_READ];
230
info->inserted->bps_wr =
231
bs->io_limits.bps[BLOCK_IO_LIMIT_WRITE];
232
info->inserted->iops =
233
bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
234
info->inserted->iops_rd =
235
bs->io_limits.iops[BLOCK_IO_LIMIT_READ];
236
info->inserted->iops_wr =
237
bs->io_limits.iops[BLOCK_IO_LIMIT_WRITE];
241
p_image_info = &info->inserted->image;
243
bdrv_query_image_info(bs0, p_image_info, &local_err);
244
if (error_is_set(&local_err)) {
245
error_propagate(errp, local_err);
248
if (bs0->drv && bs0->backing_hd) {
249
bs0 = bs0->backing_hd;
250
(*p_image_info)->has_backing_image = true;
251
p_image_info = &((*p_image_info)->backing_image);
262
qapi_free_BlockInfo(info);
265
BlockStats *bdrv_query_stats(const BlockDriverState *bs)
269
s = g_malloc0(sizeof(*s));
271
if (bs->device_name[0]) {
272
s->has_device = true;
273
s->device = g_strdup(bs->device_name);
276
s->stats = g_malloc0(sizeof(*s->stats));
277
s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
278
s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
279
s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
280
s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
281
s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
282
s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
283
s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
284
s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
285
s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
288
s->has_parent = true;
289
s->parent = bdrv_query_stats(bs->file);
295
BlockInfoList *qmp_query_block(Error **errp)
297
BlockInfoList *head = NULL, **p_next = &head;
298
BlockDriverState *bs = NULL;
299
Error *local_err = NULL;
301
while ((bs = bdrv_next(bs))) {
302
BlockInfoList *info = g_malloc0(sizeof(*info));
303
bdrv_query_info(bs, &info->value, &local_err);
304
if (error_is_set(&local_err)) {
305
error_propagate(errp, local_err);
310
p_next = &info->next;
316
qapi_free_BlockInfoList(head);
320
BlockStatsList *qmp_query_blockstats(Error **errp)
322
BlockStatsList *head = NULL, **p_next = &head;
323
BlockDriverState *bs = NULL;
325
while ((bs = bdrv_next(bs))) {
326
BlockStatsList *info = g_malloc0(sizeof(*info));
327
info->value = bdrv_query_stats(bs);
330
p_next = &info->next;
336
#define NB_SUFFIXES 4
338
static char *get_human_readable_size(char *buf, int buf_size, int64_t size)
340
static const char suffixes[NB_SUFFIXES] = "KMGT";
345
snprintf(buf, buf_size, "%" PRId64, size);
348
for (i = 0; i < NB_SUFFIXES; i++) {
349
if (size < (10 * base)) {
350
snprintf(buf, buf_size, "%0.1f%c",
354
} else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
355
snprintf(buf, buf_size, "%" PRId64 "%c",
356
((size + (base >> 1)) / base),
366
void bdrv_snapshot_dump(fprintf_function func_fprintf, void *f,
367
QEMUSnapshotInfo *sn)
369
char buf1[128], date_buf[128], clock_buf[128];
376
"%-10s%-20s%7s%20s%15s",
377
"ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
380
localtime_r(&ti, &tm);
381
strftime(date_buf, sizeof(date_buf),
382
"%Y-%m-%d %H:%M:%S", &tm);
383
secs = sn->vm_clock_nsec / 1000000000;
384
snprintf(clock_buf, sizeof(clock_buf),
385
"%02d:%02d:%02d.%03d",
387
(int)((secs / 60) % 60),
389
(int)((sn->vm_clock_nsec / 1000000) % 1000));
391
"%-10s%-20s%7s%20s%15s",
392
sn->id_str, sn->name,
393
get_human_readable_size(buf1, sizeof(buf1),
400
void bdrv_image_info_dump(fprintf_function func_fprintf, void *f,
403
char size_buf[128], dsize_buf[128];
404
if (!info->has_actual_size) {
405
snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
407
get_human_readable_size(dsize_buf, sizeof(dsize_buf),
410
get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
414
"virtual size: %s (%" PRId64 " bytes)\n"
416
info->filename, info->format, size_buf,
420
if (info->has_encrypted && info->encrypted) {
421
func_fprintf(f, "encrypted: yes\n");
424
if (info->has_cluster_size) {
425
func_fprintf(f, "cluster_size: %" PRId64 "\n",
429
if (info->has_dirty_flag && info->dirty_flag) {
430
func_fprintf(f, "cleanly shut down: no\n");
433
if (info->has_backing_filename) {
434
func_fprintf(f, "backing file: %s", info->backing_filename);
435
if (info->has_full_backing_filename) {
436
func_fprintf(f, " (actual path: %s)", info->full_backing_filename);
438
func_fprintf(f, "\n");
439
if (info->has_backing_filename_format) {
440
func_fprintf(f, "backing file format: %s\n",
441
info->backing_filename_format);
445
if (info->has_snapshots) {
446
SnapshotInfoList *elem;
448
func_fprintf(f, "Snapshot list:\n");
449
bdrv_snapshot_dump(func_fprintf, f, NULL);
450
func_fprintf(f, "\n");
452
/* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
453
* we convert to the block layer's native QEMUSnapshotInfo for now.
455
for (elem = info->snapshots; elem; elem = elem->next) {
456
QEMUSnapshotInfo sn = {
457
.vm_state_size = elem->value->vm_state_size,
458
.date_sec = elem->value->date_sec,
459
.date_nsec = elem->value->date_nsec,
460
.vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
461
elem->value->vm_clock_nsec,
464
pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
465
pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
466
bdrv_snapshot_dump(func_fprintf, f, &sn);
467
func_fprintf(f, "\n");