block/qapi.c

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