]> Git Repo - qemu.git/blob - block/qapi.c
block: Include "node-name" if present in query-blockstats
[qemu.git] / 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 "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"
32
33 BlockDeviceInfo *bdrv_block_device_info(BlockDriverState *bs)
34 {
35     BlockDeviceInfo *info = g_malloc0(sizeof(*info));
36
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);
42
43     if (bs->node_name[0]) {
44         info->has_node_name = true;
45         info->node_name = g_strdup(bs->node_name);
46     }
47
48     if (bs->backing_file[0]) {
49         info->has_backing_file = true;
50         info->backing_file = g_strdup(bs->backing_file);
51     }
52
53     info->backing_file_depth = bdrv_get_backing_file_depth(bs);
54     info->detect_zeroes = bs->detect_zeroes;
55
56     if (bs->io_limits_enabled) {
57         ThrottleConfig cfg;
58         throttle_get_config(&bs->throttle_state, &cfg);
59         info->bps     = cfg.buckets[THROTTLE_BPS_TOTAL].avg;
60         info->bps_rd  = cfg.buckets[THROTTLE_BPS_READ].avg;
61         info->bps_wr  = cfg.buckets[THROTTLE_BPS_WRITE].avg;
62
63         info->iops    = cfg.buckets[THROTTLE_OPS_TOTAL].avg;
64         info->iops_rd = cfg.buckets[THROTTLE_OPS_READ].avg;
65         info->iops_wr = cfg.buckets[THROTTLE_OPS_WRITE].avg;
66
67         info->has_bps_max     = cfg.buckets[THROTTLE_BPS_TOTAL].max;
68         info->bps_max         = cfg.buckets[THROTTLE_BPS_TOTAL].max;
69         info->has_bps_rd_max  = cfg.buckets[THROTTLE_BPS_READ].max;
70         info->bps_rd_max      = cfg.buckets[THROTTLE_BPS_READ].max;
71         info->has_bps_wr_max  = cfg.buckets[THROTTLE_BPS_WRITE].max;
72         info->bps_wr_max      = cfg.buckets[THROTTLE_BPS_WRITE].max;
73
74         info->has_iops_max    = cfg.buckets[THROTTLE_OPS_TOTAL].max;
75         info->iops_max        = cfg.buckets[THROTTLE_OPS_TOTAL].max;
76         info->has_iops_rd_max = cfg.buckets[THROTTLE_OPS_READ].max;
77         info->iops_rd_max     = cfg.buckets[THROTTLE_OPS_READ].max;
78         info->has_iops_wr_max = cfg.buckets[THROTTLE_OPS_WRITE].max;
79         info->iops_wr_max     = cfg.buckets[THROTTLE_OPS_WRITE].max;
80
81         info->has_iops_size = cfg.op_size;
82         info->iops_size = cfg.op_size;
83     }
84
85     return info;
86 }
87
88 /*
89  * Returns 0 on success, with *p_list either set to describe snapshot
90  * information, or NULL because there are no snapshots.  Returns -errno on
91  * error, with *p_list untouched.
92  */
93 int bdrv_query_snapshot_info_list(BlockDriverState *bs,
94                                   SnapshotInfoList **p_list,
95                                   Error **errp)
96 {
97     int i, sn_count;
98     QEMUSnapshotInfo *sn_tab = NULL;
99     SnapshotInfoList *info_list, *cur_item = NULL, *head = NULL;
100     SnapshotInfo *info;
101
102     sn_count = bdrv_snapshot_list(bs, &sn_tab);
103     if (sn_count < 0) {
104         const char *dev = bdrv_get_device_name(bs);
105         switch (sn_count) {
106         case -ENOMEDIUM:
107             error_setg(errp, "Device '%s' is not inserted", dev);
108             break;
109         case -ENOTSUP:
110             error_setg(errp,
111                        "Device '%s' does not support internal snapshots",
112                        dev);
113             break;
114         default:
115             error_setg_errno(errp, -sn_count,
116                              "Can't list snapshots of device '%s'", dev);
117             break;
118         }
119         return sn_count;
120     }
121
122     for (i = 0; i < sn_count; i++) {
123         info = g_new0(SnapshotInfo, 1);
124         info->id            = g_strdup(sn_tab[i].id_str);
125         info->name          = g_strdup(sn_tab[i].name);
126         info->vm_state_size = sn_tab[i].vm_state_size;
127         info->date_sec      = sn_tab[i].date_sec;
128         info->date_nsec     = sn_tab[i].date_nsec;
129         info->vm_clock_sec  = sn_tab[i].vm_clock_nsec / 1000000000;
130         info->vm_clock_nsec = sn_tab[i].vm_clock_nsec % 1000000000;
131
132         info_list = g_new0(SnapshotInfoList, 1);
133         info_list->value = info;
134
135         /* XXX: waiting for the qapi to support qemu-queue.h types */
136         if (!cur_item) {
137             head = cur_item = info_list;
138         } else {
139             cur_item->next = info_list;
140             cur_item = info_list;
141         }
142
143     }
144
145     g_free(sn_tab);
146     *p_list = head;
147     return 0;
148 }
149
150 /**
151  * bdrv_query_image_info:
152  * @bs: block device to examine
153  * @p_info: location to store image information
154  * @errp: location to store error information
155  *
156  * Store "flat" image information in @p_info.
157  *
158  * "Flat" means it does *not* query backing image information,
159  * i.e. (*pinfo)->has_backing_image will be set to false and
160  * (*pinfo)->backing_image to NULL even when the image does in fact have
161  * a backing image.
162  *
163  * @p_info will be set only on success. On error, store error in @errp.
164  */
165 void bdrv_query_image_info(BlockDriverState *bs,
166                            ImageInfo **p_info,
167                            Error **errp)
168 {
169     int64_t size;
170     const char *backing_filename;
171     char backing_filename2[1024];
172     BlockDriverInfo bdi;
173     int ret;
174     Error *err = NULL;
175     ImageInfo *info;
176
177     size = bdrv_getlength(bs);
178     if (size < 0) {
179         error_setg_errno(errp, -size, "Can't get size of device '%s'",
180                          bdrv_get_device_name(bs));
181         return;
182     }
183
184     info = g_new0(ImageInfo, 1);
185     info->filename        = g_strdup(bs->filename);
186     info->format          = g_strdup(bdrv_get_format_name(bs));
187     info->virtual_size    = size;
188     info->actual_size     = bdrv_get_allocated_file_size(bs);
189     info->has_actual_size = info->actual_size >= 0;
190     if (bdrv_is_encrypted(bs)) {
191         info->encrypted = true;
192         info->has_encrypted = true;
193     }
194     if (bdrv_get_info(bs, &bdi) >= 0) {
195         if (bdi.cluster_size != 0) {
196             info->cluster_size = bdi.cluster_size;
197             info->has_cluster_size = true;
198         }
199         info->dirty_flag = bdi.is_dirty;
200         info->has_dirty_flag = true;
201     }
202     info->format_specific     = bdrv_get_specific_info(bs);
203     info->has_format_specific = info->format_specific != NULL;
204
205     backing_filename = bs->backing_file;
206     if (backing_filename[0] != '\0') {
207         info->backing_filename = g_strdup(backing_filename);
208         info->has_backing_filename = true;
209         bdrv_get_full_backing_filename(bs, backing_filename2,
210                                        sizeof(backing_filename2));
211
212         if (strcmp(backing_filename, backing_filename2) != 0) {
213             info->full_backing_filename =
214                         g_strdup(backing_filename2);
215             info->has_full_backing_filename = true;
216         }
217
218         if (bs->backing_format[0]) {
219             info->backing_filename_format = g_strdup(bs->backing_format);
220             info->has_backing_filename_format = true;
221         }
222     }
223
224     ret = bdrv_query_snapshot_info_list(bs, &info->snapshots, &err);
225     switch (ret) {
226     case 0:
227         if (info->snapshots) {
228             info->has_snapshots = true;
229         }
230         break;
231     /* recoverable error */
232     case -ENOMEDIUM:
233     case -ENOTSUP:
234         error_free(err);
235         break;
236     default:
237         error_propagate(errp, err);
238         qapi_free_ImageInfo(info);
239         return;
240     }
241
242     *p_info = info;
243 }
244
245 /* @p_info will be set only on success. */
246 static void bdrv_query_info(BlockBackend *blk, BlockInfo **p_info,
247                             Error **errp)
248 {
249     BlockInfo *info = g_malloc0(sizeof(*info));
250     BlockDriverState *bs = blk_bs(blk);
251     BlockDriverState *bs0;
252     ImageInfo **p_image_info;
253     Error *local_err = NULL;
254     info->device = g_strdup(blk_name(blk));
255     info->type = g_strdup("unknown");
256     info->locked = blk_dev_is_medium_locked(blk);
257     info->removable = blk_dev_has_removable_media(blk);
258
259     if (blk_dev_has_removable_media(blk)) {
260         info->has_tray_open = true;
261         info->tray_open = blk_dev_is_tray_open(blk);
262     }
263
264     if (bdrv_iostatus_is_enabled(bs)) {
265         info->has_io_status = true;
266         info->io_status = bs->iostatus;
267     }
268
269     if (!QLIST_EMPTY(&bs->dirty_bitmaps)) {
270         info->has_dirty_bitmaps = true;
271         info->dirty_bitmaps = bdrv_query_dirty_bitmaps(bs);
272     }
273
274     if (bs->drv) {
275         info->has_inserted = true;
276         info->inserted = bdrv_block_device_info(bs);
277
278         bs0 = bs;
279         p_image_info = &info->inserted->image;
280         while (1) {
281             bdrv_query_image_info(bs0, p_image_info, &local_err);
282             if (local_err) {
283                 error_propagate(errp, local_err);
284                 goto err;
285             }
286             if (bs0->drv && bs0->backing_hd) {
287                 bs0 = bs0->backing_hd;
288                 (*p_image_info)->has_backing_image = true;
289                 p_image_info = &((*p_image_info)->backing_image);
290             } else {
291                 break;
292             }
293         }
294     }
295
296     *p_info = info;
297     return;
298
299  err:
300     qapi_free_BlockInfo(info);
301 }
302
303 static BlockStats *bdrv_query_stats(const BlockDriverState *bs)
304 {
305     BlockStats *s;
306
307     s = g_malloc0(sizeof(*s));
308
309     if (bdrv_get_device_name(bs)[0]) {
310         s->has_device = true;
311         s->device = g_strdup(bdrv_get_device_name(bs));
312     }
313
314     if (bdrv_get_node_name(bs)[0]) {
315         s->has_node_name = true;
316         s->node_name = g_strdup(bdrv_get_node_name(bs));
317     }
318
319     s->stats = g_malloc0(sizeof(*s->stats));
320     s->stats->rd_bytes = bs->stats.nr_bytes[BLOCK_ACCT_READ];
321     s->stats->wr_bytes = bs->stats.nr_bytes[BLOCK_ACCT_WRITE];
322     s->stats->rd_operations = bs->stats.nr_ops[BLOCK_ACCT_READ];
323     s->stats->wr_operations = bs->stats.nr_ops[BLOCK_ACCT_WRITE];
324     s->stats->wr_highest_offset =
325         bs->stats.wr_highest_sector * BDRV_SECTOR_SIZE;
326     s->stats->flush_operations = bs->stats.nr_ops[BLOCK_ACCT_FLUSH];
327     s->stats->wr_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_WRITE];
328     s->stats->rd_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_READ];
329     s->stats->flush_total_time_ns = bs->stats.total_time_ns[BLOCK_ACCT_FLUSH];
330
331     if (bs->file) {
332         s->has_parent = true;
333         s->parent = bdrv_query_stats(bs->file);
334     }
335
336     if (bs->backing_hd) {
337         s->has_backing = true;
338         s->backing = bdrv_query_stats(bs->backing_hd);
339     }
340
341     return s;
342 }
343
344 BlockInfoList *qmp_query_block(Error **errp)
345 {
346     BlockInfoList *head = NULL, **p_next = &head;
347     BlockBackend *blk;
348     Error *local_err = NULL;
349
350     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
351         BlockInfoList *info = g_malloc0(sizeof(*info));
352         bdrv_query_info(blk, &info->value, &local_err);
353         if (local_err) {
354             error_propagate(errp, local_err);
355             goto err;
356         }
357
358         *p_next = info;
359         p_next = &info->next;
360     }
361
362     return head;
363
364  err:
365     qapi_free_BlockInfoList(head);
366     return NULL;
367 }
368
369 BlockStatsList *qmp_query_blockstats(Error **errp)
370 {
371     BlockStatsList *head = NULL, **p_next = &head;
372     BlockDriverState *bs = NULL;
373
374      while ((bs = bdrv_next(bs))) {
375         BlockStatsList *info = g_malloc0(sizeof(*info));
376         AioContext *ctx = bdrv_get_aio_context(bs);
377
378         aio_context_acquire(ctx);
379         info->value = bdrv_query_stats(bs);
380         aio_context_release(ctx);
381
382         *p_next = info;
383         p_next = &info->next;
384     }
385
386     return head;
387 }
388
389 #define NB_SUFFIXES 4
390
391 static char *get_human_readable_size(char *buf, int buf_size, int64_t size)
392 {
393     static const char suffixes[NB_SUFFIXES] = "KMGT";
394     int64_t base;
395     int i;
396
397     if (size <= 999) {
398         snprintf(buf, buf_size, "%" PRId64, size);
399     } else {
400         base = 1024;
401         for (i = 0; i < NB_SUFFIXES; i++) {
402             if (size < (10 * base)) {
403                 snprintf(buf, buf_size, "%0.1f%c",
404                          (double)size / base,
405                          suffixes[i]);
406                 break;
407             } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
408                 snprintf(buf, buf_size, "%" PRId64 "%c",
409                          ((size + (base >> 1)) / base),
410                          suffixes[i]);
411                 break;
412             }
413             base = base * 1024;
414         }
415     }
416     return buf;
417 }
418
419 void bdrv_snapshot_dump(fprintf_function func_fprintf, void *f,
420                         QEMUSnapshotInfo *sn)
421 {
422     char buf1[128], date_buf[128], clock_buf[128];
423     struct tm tm;
424     time_t ti;
425     int64_t secs;
426
427     if (!sn) {
428         func_fprintf(f,
429                      "%-10s%-20s%7s%20s%15s",
430                      "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
431     } else {
432         ti = sn->date_sec;
433         localtime_r(&ti, &tm);
434         strftime(date_buf, sizeof(date_buf),
435                  "%Y-%m-%d %H:%M:%S", &tm);
436         secs = sn->vm_clock_nsec / 1000000000;
437         snprintf(clock_buf, sizeof(clock_buf),
438                  "%02d:%02d:%02d.%03d",
439                  (int)(secs / 3600),
440                  (int)((secs / 60) % 60),
441                  (int)(secs % 60),
442                  (int)((sn->vm_clock_nsec / 1000000) % 1000));
443         func_fprintf(f,
444                      "%-10s%-20s%7s%20s%15s",
445                      sn->id_str, sn->name,
446                      get_human_readable_size(buf1, sizeof(buf1),
447                                              sn->vm_state_size),
448                      date_buf,
449                      clock_buf);
450     }
451 }
452
453 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
454                        QDict *dict);
455 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
456                        QList *list);
457
458 static void dump_qobject(fprintf_function func_fprintf, void *f,
459                          int comp_indent, QObject *obj)
460 {
461     switch (qobject_type(obj)) {
462         case QTYPE_QINT: {
463             QInt *value = qobject_to_qint(obj);
464             func_fprintf(f, "%" PRId64, qint_get_int(value));
465             break;
466         }
467         case QTYPE_QSTRING: {
468             QString *value = qobject_to_qstring(obj);
469             func_fprintf(f, "%s", qstring_get_str(value));
470             break;
471         }
472         case QTYPE_QDICT: {
473             QDict *value = qobject_to_qdict(obj);
474             dump_qdict(func_fprintf, f, comp_indent, value);
475             break;
476         }
477         case QTYPE_QLIST: {
478             QList *value = qobject_to_qlist(obj);
479             dump_qlist(func_fprintf, f, comp_indent, value);
480             break;
481         }
482         case QTYPE_QFLOAT: {
483             QFloat *value = qobject_to_qfloat(obj);
484             func_fprintf(f, "%g", qfloat_get_double(value));
485             break;
486         }
487         case QTYPE_QBOOL: {
488             QBool *value = qobject_to_qbool(obj);
489             func_fprintf(f, "%s", qbool_get_int(value) ? "true" : "false");
490             break;
491         }
492         case QTYPE_QERROR: {
493             QString *value = qerror_human((QError *)obj);
494             func_fprintf(f, "%s", qstring_get_str(value));
495             QDECREF(value);
496             break;
497         }
498         case QTYPE_NONE:
499             break;
500         case QTYPE_MAX:
501         default:
502             abort();
503     }
504 }
505
506 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
507                        QList *list)
508 {
509     const QListEntry *entry;
510     int i = 0;
511
512     for (entry = qlist_first(list); entry; entry = qlist_next(entry), i++) {
513         qtype_code type = qobject_type(entry->value);
514         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
515         const char *format = composite ? "%*s[%i]:\n" : "%*s[%i]: ";
516
517         func_fprintf(f, format, indentation * 4, "", i);
518         dump_qobject(func_fprintf, f, indentation + 1, entry->value);
519         if (!composite) {
520             func_fprintf(f, "\n");
521         }
522     }
523 }
524
525 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
526                        QDict *dict)
527 {
528     const QDictEntry *entry;
529
530     for (entry = qdict_first(dict); entry; entry = qdict_next(dict, entry)) {
531         qtype_code type = qobject_type(entry->value);
532         bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
533         const char *format = composite ? "%*s%s:\n" : "%*s%s: ";
534         char key[strlen(entry->key) + 1];
535         int i;
536
537         /* replace dashes with spaces in key (variable) names */
538         for (i = 0; entry->key[i]; i++) {
539             key[i] = entry->key[i] == '-' ? ' ' : entry->key[i];
540         }
541         key[i] = 0;
542
543         func_fprintf(f, format, indentation * 4, "", key);
544         dump_qobject(func_fprintf, f, indentation + 1, entry->value);
545         if (!composite) {
546             func_fprintf(f, "\n");
547         }
548     }
549 }
550
551 void bdrv_image_info_specific_dump(fprintf_function func_fprintf, void *f,
552                                    ImageInfoSpecific *info_spec)
553 {
554     QmpOutputVisitor *ov = qmp_output_visitor_new();
555     QObject *obj, *data;
556
557     visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov), &info_spec, NULL,
558                                  &error_abort);
559     obj = qmp_output_get_qobject(ov);
560     assert(qobject_type(obj) == QTYPE_QDICT);
561     data = qdict_get(qobject_to_qdict(obj), "data");
562     dump_qobject(func_fprintf, f, 1, data);
563     qmp_output_visitor_cleanup(ov);
564 }
565
566 void bdrv_image_info_dump(fprintf_function func_fprintf, void *f,
567                           ImageInfo *info)
568 {
569     char size_buf[128], dsize_buf[128];
570     if (!info->has_actual_size) {
571         snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
572     } else {
573         get_human_readable_size(dsize_buf, sizeof(dsize_buf),
574                                 info->actual_size);
575     }
576     get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
577     func_fprintf(f,
578                  "image: %s\n"
579                  "file format: %s\n"
580                  "virtual size: %s (%" PRId64 " bytes)\n"
581                  "disk size: %s\n",
582                  info->filename, info->format, size_buf,
583                  info->virtual_size,
584                  dsize_buf);
585
586     if (info->has_encrypted && info->encrypted) {
587         func_fprintf(f, "encrypted: yes\n");
588     }
589
590     if (info->has_cluster_size) {
591         func_fprintf(f, "cluster_size: %" PRId64 "\n",
592                        info->cluster_size);
593     }
594
595     if (info->has_dirty_flag && info->dirty_flag) {
596         func_fprintf(f, "cleanly shut down: no\n");
597     }
598
599     if (info->has_backing_filename) {
600         func_fprintf(f, "backing file: %s", info->backing_filename);
601         if (info->has_full_backing_filename) {
602             func_fprintf(f, " (actual path: %s)", info->full_backing_filename);
603         }
604         func_fprintf(f, "\n");
605         if (info->has_backing_filename_format) {
606             func_fprintf(f, "backing file format: %s\n",
607                          info->backing_filename_format);
608         }
609     }
610
611     if (info->has_snapshots) {
612         SnapshotInfoList *elem;
613
614         func_fprintf(f, "Snapshot list:\n");
615         bdrv_snapshot_dump(func_fprintf, f, NULL);
616         func_fprintf(f, "\n");
617
618         /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
619          * we convert to the block layer's native QEMUSnapshotInfo for now.
620          */
621         for (elem = info->snapshots; elem; elem = elem->next) {
622             QEMUSnapshotInfo sn = {
623                 .vm_state_size = elem->value->vm_state_size,
624                 .date_sec = elem->value->date_sec,
625                 .date_nsec = elem->value->date_nsec,
626                 .vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
627                                  elem->value->vm_clock_nsec,
628             };
629
630             pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
631             pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
632             bdrv_snapshot_dump(func_fprintf, f, &sn);
633             func_fprintf(f, "\n");
634         }
635     }
636
637     if (info->has_format_specific) {
638         func_fprintf(f, "Format specific information:\n");
639         bdrv_image_info_specific_dump(func_fprintf, f, info->format_specific);
640     }
641 }
This page took 0.062836 seconds and 4 git commands to generate.