Add migration stream analyzation script
[qemu.git] / block / qapi.c
blob75c388e90bb2234e8dbaa5c1d53f19076ef464f8
1 /*
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
22 * THE SOFTWARE.
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) {
64 ThrottleConfig cfg;
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;
92 return info;
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,
102 Error **errp)
104 int i, sn_count;
105 QEMUSnapshotInfo *sn_tab = NULL;
106 SnapshotInfoList *info_list, *cur_item = NULL, *head = NULL;
107 SnapshotInfo *info;
109 sn_count = bdrv_snapshot_list(bs, &sn_tab);
110 if (sn_count < 0) {
111 const char *dev = bdrv_get_device_name(bs);
112 switch (sn_count) {
113 case -ENOMEDIUM:
114 error_setg(errp, "Device '%s' is not inserted", dev);
115 break;
116 case -ENOTSUP:
117 error_setg(errp,
118 "Device '%s' does not support internal snapshots",
119 dev);
120 break;
121 default:
122 error_setg_errno(errp, -sn_count,
123 "Can't list snapshots of device '%s'", dev);
124 break;
126 return sn_count;
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 */
143 if (!cur_item) {
144 head = cur_item = info_list;
145 } else {
146 cur_item->next = info_list;
147 cur_item = info_list;
152 g_free(sn_tab);
153 *p_list = head;
154 return 0;
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
168 * a backing image.
170 * @p_info will be set only on success. On error, store error in @errp.
172 void bdrv_query_image_info(BlockDriverState *bs,
173 ImageInfo **p_info,
174 Error **errp)
176 int64_t size;
177 const char *backing_filename;
178 BlockDriverInfo bdi;
179 int ret;
180 Error *err = NULL;
181 ImageInfo *info;
183 size = bdrv_getlength(bs);
184 if (size < 0) {
185 error_setg_errno(errp, -size, "Can't get size of device '%s'",
186 bdrv_get_device_name(bs));
187 return;
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);
217 if (err) {
218 error_propagate(errp, err);
219 qapi_free_ImageInfo(info);
220 g_free(backing_filename2);
221 return;
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);
238 switch (ret) {
239 case 0:
240 if (info->snapshots) {
241 info->has_snapshots = true;
243 break;
244 /* recoverable error */
245 case -ENOMEDIUM:
246 case -ENOTSUP:
247 error_free(err);
248 break;
249 default:
250 error_propagate(errp, err);
251 qapi_free_ImageInfo(info);
252 return;
255 *p_info = info;
258 /* @p_info will be set only on success. */
259 static void bdrv_query_info(BlockBackend *blk, BlockInfo **p_info,
260 Error **errp)
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);
287 if (bs->drv) {
288 info->has_inserted = true;
289 info->inserted = bdrv_block_device_info(bs);
291 bs0 = bs;
292 p_image_info = &info->inserted->image;
293 while (1) {
294 bdrv_query_image_info(bs0, p_image_info, &local_err);
295 if (local_err) {
296 error_propagate(errp, local_err);
297 goto 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);
303 } else {
304 break;
309 *p_info = info;
310 return;
312 err:
313 qapi_free_BlockInfo(info);
316 static BlockStats *bdrv_query_stats(const BlockDriverState *bs,
317 bool query_backing)
319 BlockStats *s;
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->wr_highest_offset =
339 bs->stats.wr_highest_sector * BDRV_SECTOR_SIZE;
340 s->stats->flush_operations = bs->stats.nr_ops[BLOCK_ACCT_FLUSH];
341 s->stats->wr_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_WRITE];
342 s->stats->rd_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_READ];
343 s->stats->flush_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_FLUSH];
345 if (bs->file) {
346 s->has_parent = true;
347 s->parent = bdrv_query_stats(bs->file, query_backing);
350 if (query_backing && bs->backing_hd) {
351 s->has_backing = true;
352 s->backing = bdrv_query_stats(bs->backing_hd, query_backing);
355 return s;
358 BlockInfoList *qmp_query_block(Error **errp)
360 BlockInfoList *head = NULL, **p_next = &head;
361 BlockBackend *blk;
362 Error *local_err = NULL;
364 for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
365 BlockInfoList *info = g_malloc0(sizeof(*info));
366 bdrv_query_info(blk, &info->value, &local_err);
367 if (local_err) {
368 error_propagate(errp, local_err);
369 goto err;
372 *p_next = info;
373 p_next = &info->next;
376 return head;
378 err:
379 qapi_free_BlockInfoList(head);
380 return NULL;
383 BlockStatsList *qmp_query_blockstats(bool has_query_nodes,
384 bool query_nodes,
385 Error **errp)
387 BlockStatsList *head = NULL, **p_next = &head;
388 BlockDriverState *bs = NULL;
390 /* Just to be safe if query_nodes is not always initialized */
391 query_nodes = has_query_nodes && query_nodes;
393 while ((bs = query_nodes ? bdrv_next_node(bs) : bdrv_next(bs))) {
394 BlockStatsList *info = g_malloc0(sizeof(*info));
395 AioContext *ctx = bdrv_get_aio_context(bs);
397 aio_context_acquire(ctx);
398 info->value = bdrv_query_stats(bs, !query_nodes);
399 aio_context_release(ctx);
401 *p_next = info;
402 p_next = &info->next;
405 return head;
408 #define NB_SUFFIXES 4
410 static char *get_human_readable_size(char *buf, int buf_size, int64_t size)
412 static const char suffixes[NB_SUFFIXES] = "KMGT";
413 int64_t base;
414 int i;
416 if (size <= 999) {
417 snprintf(buf, buf_size, "%" PRId64, size);
418 } else {
419 base = 1024;
420 for (i = 0; i < NB_SUFFIXES; i++) {
421 if (size < (10 * base)) {
422 snprintf(buf, buf_size, "%0.1f%c",
423 (double)size / base,
424 suffixes[i]);
425 break;
426 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
427 snprintf(buf, buf_size, "%" PRId64 "%c",
428 ((size + (base >> 1)) / base),
429 suffixes[i]);
430 break;
432 base = base * 1024;
435 return buf;
438 void bdrv_snapshot_dump(fprintf_function func_fprintf, void *f,
439 QEMUSnapshotInfo *sn)
441 char buf1[128], date_buf[128], clock_buf[128];
442 struct tm tm;
443 time_t ti;
444 int64_t secs;
446 if (!sn) {
447 func_fprintf(f,
448 "%-10s%-20s%7s%20s%15s",
449 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
450 } else {
451 ti = sn->date_sec;
452 localtime_r(&ti, &tm);
453 strftime(date_buf, sizeof(date_buf),
454 "%Y-%m-%d %H:%M:%S", &tm);
455 secs = sn->vm_clock_nsec / 1000000000;
456 snprintf(clock_buf, sizeof(clock_buf),
457 "%02d:%02d:%02d.%03d",
458 (int)(secs / 3600),
459 (int)((secs / 60) % 60),
460 (int)(secs % 60),
461 (int)((sn->vm_clock_nsec / 1000000) % 1000));
462 func_fprintf(f,
463 "%-10s%-20s%7s%20s%15s",
464 sn->id_str, sn->name,
465 get_human_readable_size(buf1, sizeof(buf1),
466 sn->vm_state_size),
467 date_buf,
468 clock_buf);
472 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
473 QDict *dict);
474 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
475 QList *list);
477 static void dump_qobject(fprintf_function func_fprintf, void *f,
478 int comp_indent, QObject *obj)
480 switch (qobject_type(obj)) {
481 case QTYPE_QINT: {
482 QInt *value = qobject_to_qint(obj);
483 func_fprintf(f, "%" PRId64, qint_get_int(value));
484 break;
486 case QTYPE_QSTRING: {
487 QString *value = qobject_to_qstring(obj);
488 func_fprintf(f, "%s", qstring_get_str(value));
489 break;
491 case QTYPE_QDICT: {
492 QDict *value = qobject_to_qdict(obj);
493 dump_qdict(func_fprintf, f, comp_indent, value);
494 break;
496 case QTYPE_QLIST: {
497 QList *value = qobject_to_qlist(obj);
498 dump_qlist(func_fprintf, f, comp_indent, value);
499 break;
501 case QTYPE_QFLOAT: {
502 QFloat *value = qobject_to_qfloat(obj);
503 func_fprintf(f, "%g", qfloat_get_double(value));
504 break;
506 case QTYPE_QBOOL: {
507 QBool *value = qobject_to_qbool(obj);
508 func_fprintf(f, "%s", qbool_get_int(value) ? "true" : "false");
509 break;
511 case QTYPE_QERROR: {
512 QString *value = qerror_human((QError *)obj);
513 func_fprintf(f, "%s", qstring_get_str(value));
514 QDECREF(value);
515 break;
517 case QTYPE_NONE:
518 break;
519 case QTYPE_MAX:
520 default:
521 abort();
525 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
526 QList *list)
528 const QListEntry *entry;
529 int i = 0;
531 for (entry = qlist_first(list); entry; entry = qlist_next(entry), i++) {
532 qtype_code type = qobject_type(entry->value);
533 bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
534 const char *format = composite ? "%*s[%i]:\n" : "%*s[%i]: ";
536 func_fprintf(f, format, indentation * 4, "", i);
537 dump_qobject(func_fprintf, f, indentation + 1, entry->value);
538 if (!composite) {
539 func_fprintf(f, "\n");
544 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
545 QDict *dict)
547 const QDictEntry *entry;
549 for (entry = qdict_first(dict); entry; entry = qdict_next(dict, entry)) {
550 qtype_code type = qobject_type(entry->value);
551 bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
552 const char *format = composite ? "%*s%s:\n" : "%*s%s: ";
553 char key[strlen(entry->key) + 1];
554 int i;
556 /* replace dashes with spaces in key (variable) names */
557 for (i = 0; entry->key[i]; i++) {
558 key[i] = entry->key[i] == '-' ? ' ' : entry->key[i];
560 key[i] = 0;
562 func_fprintf(f, format, indentation * 4, "", key);
563 dump_qobject(func_fprintf, f, indentation + 1, entry->value);
564 if (!composite) {
565 func_fprintf(f, "\n");
570 void bdrv_image_info_specific_dump(fprintf_function func_fprintf, void *f,
571 ImageInfoSpecific *info_spec)
573 QmpOutputVisitor *ov = qmp_output_visitor_new();
574 QObject *obj, *data;
576 visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov), &info_spec, NULL,
577 &error_abort);
578 obj = qmp_output_get_qobject(ov);
579 assert(qobject_type(obj) == QTYPE_QDICT);
580 data = qdict_get(qobject_to_qdict(obj), "data");
581 dump_qobject(func_fprintf, f, 1, data);
582 qmp_output_visitor_cleanup(ov);
585 void bdrv_image_info_dump(fprintf_function func_fprintf, void *f,
586 ImageInfo *info)
588 char size_buf[128], dsize_buf[128];
589 if (!info->has_actual_size) {
590 snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
591 } else {
592 get_human_readable_size(dsize_buf, sizeof(dsize_buf),
593 info->actual_size);
595 get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
596 func_fprintf(f,
597 "image: %s\n"
598 "file format: %s\n"
599 "virtual size: %s (%" PRId64 " bytes)\n"
600 "disk size: %s\n",
601 info->filename, info->format, size_buf,
602 info->virtual_size,
603 dsize_buf);
605 if (info->has_encrypted && info->encrypted) {
606 func_fprintf(f, "encrypted: yes\n");
609 if (info->has_cluster_size) {
610 func_fprintf(f, "cluster_size: %" PRId64 "\n",
611 info->cluster_size);
614 if (info->has_dirty_flag && info->dirty_flag) {
615 func_fprintf(f, "cleanly shut down: no\n");
618 if (info->has_backing_filename) {
619 func_fprintf(f, "backing file: %s", info->backing_filename);
620 if (info->has_full_backing_filename) {
621 func_fprintf(f, " (actual path: %s)", info->full_backing_filename);
623 func_fprintf(f, "\n");
624 if (info->has_backing_filename_format) {
625 func_fprintf(f, "backing file format: %s\n",
626 info->backing_filename_format);
630 if (info->has_snapshots) {
631 SnapshotInfoList *elem;
633 func_fprintf(f, "Snapshot list:\n");
634 bdrv_snapshot_dump(func_fprintf, f, NULL);
635 func_fprintf(f, "\n");
637 /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
638 * we convert to the block layer's native QEMUSnapshotInfo for now.
640 for (elem = info->snapshots; elem; elem = elem->next) {
641 QEMUSnapshotInfo sn = {
642 .vm_state_size = elem->value->vm_state_size,
643 .date_sec = elem->value->date_sec,
644 .date_nsec = elem->value->date_nsec,
645 .vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
646 elem->value->vm_clock_nsec,
649 pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
650 pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
651 bdrv_snapshot_dump(func_fprintf, f, &sn);
652 func_fprintf(f, "\n");
656 if (info->has_format_specific) {
657 func_fprintf(f, "Format specific information:\n");
658 bdrv_image_info_specific_dump(func_fprintf, f, info->format_specific);