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