savevm: Convert all tabs to spaces
[qemu/cris-port.git] / block / qapi.c
bloba32cb79db8e020cfe16aceb2309b423ac5490168
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"
33 * Returns 0 on success, with *p_list either set to describe snapshot
34 * information, or NULL because there are no snapshots. Returns -errno on
35 * error, with *p_list untouched.
37 int bdrv_query_snapshot_info_list(BlockDriverState *bs,
38 SnapshotInfoList **p_list,
39 Error **errp)
41 int i, sn_count;
42 QEMUSnapshotInfo *sn_tab = NULL;
43 SnapshotInfoList *info_list, *cur_item = NULL, *head = NULL;
44 SnapshotInfo *info;
46 sn_count = bdrv_snapshot_list(bs, &sn_tab);
47 if (sn_count < 0) {
48 const char *dev = bdrv_get_device_name(bs);
49 switch (sn_count) {
50 case -ENOMEDIUM:
51 error_setg(errp, "Device '%s' is not inserted", dev);
52 break;
53 case -ENOTSUP:
54 error_setg(errp,
55 "Device '%s' does not support internal snapshots",
56 dev);
57 break;
58 default:
59 error_setg_errno(errp, -sn_count,
60 "Can't list snapshots of device '%s'", dev);
61 break;
63 return sn_count;
66 for (i = 0; i < sn_count; i++) {
67 info = g_new0(SnapshotInfo, 1);
68 info->id = g_strdup(sn_tab[i].id_str);
69 info->name = g_strdup(sn_tab[i].name);
70 info->vm_state_size = sn_tab[i].vm_state_size;
71 info->date_sec = sn_tab[i].date_sec;
72 info->date_nsec = sn_tab[i].date_nsec;
73 info->vm_clock_sec = sn_tab[i].vm_clock_nsec / 1000000000;
74 info->vm_clock_nsec = sn_tab[i].vm_clock_nsec % 1000000000;
76 info_list = g_new0(SnapshotInfoList, 1);
77 info_list->value = info;
79 /* XXX: waiting for the qapi to support qemu-queue.h types */
80 if (!cur_item) {
81 head = cur_item = info_list;
82 } else {
83 cur_item->next = info_list;
84 cur_item = info_list;
89 g_free(sn_tab);
90 *p_list = head;
91 return 0;
94 /**
95 * bdrv_query_image_info:
96 * @bs: block device to examine
97 * @p_info: location to store image information
98 * @errp: location to store error information
100 * Store "flat" image information in @p_info.
102 * "Flat" means it does *not* query backing image information,
103 * i.e. (*pinfo)->has_backing_image will be set to false and
104 * (*pinfo)->backing_image to NULL even when the image does in fact have
105 * a backing image.
107 * @p_info will be set only on success. On error, store error in @errp.
109 void bdrv_query_image_info(BlockDriverState *bs,
110 ImageInfo **p_info,
111 Error **errp)
113 uint64_t total_sectors;
114 const char *backing_filename;
115 char backing_filename2[1024];
116 BlockDriverInfo bdi;
117 int ret;
118 Error *err = NULL;
119 ImageInfo *info = g_new0(ImageInfo, 1);
121 bdrv_get_geometry(bs, &total_sectors);
123 info->filename = g_strdup(bs->filename);
124 info->format = g_strdup(bdrv_get_format_name(bs));
125 info->virtual_size = total_sectors * 512;
126 info->actual_size = bdrv_get_allocated_file_size(bs);
127 info->has_actual_size = info->actual_size >= 0;
128 if (bdrv_is_encrypted(bs)) {
129 info->encrypted = true;
130 info->has_encrypted = true;
132 if (bdrv_get_info(bs, &bdi) >= 0) {
133 if (bdi.cluster_size != 0) {
134 info->cluster_size = bdi.cluster_size;
135 info->has_cluster_size = true;
137 info->dirty_flag = bdi.is_dirty;
138 info->has_dirty_flag = true;
140 info->format_specific = bdrv_get_specific_info(bs);
141 info->has_format_specific = info->format_specific != NULL;
143 backing_filename = bs->backing_file;
144 if (backing_filename[0] != '\0') {
145 info->backing_filename = g_strdup(backing_filename);
146 info->has_backing_filename = true;
147 bdrv_get_full_backing_filename(bs, backing_filename2,
148 sizeof(backing_filename2));
150 if (strcmp(backing_filename, backing_filename2) != 0) {
151 info->full_backing_filename =
152 g_strdup(backing_filename2);
153 info->has_full_backing_filename = true;
156 if (bs->backing_format[0]) {
157 info->backing_filename_format = g_strdup(bs->backing_format);
158 info->has_backing_filename_format = true;
162 ret = bdrv_query_snapshot_info_list(bs, &info->snapshots, &err);
163 switch (ret) {
164 case 0:
165 if (info->snapshots) {
166 info->has_snapshots = true;
168 break;
169 /* recoverable error */
170 case -ENOMEDIUM:
171 case -ENOTSUP:
172 error_free(err);
173 break;
174 default:
175 error_propagate(errp, err);
176 qapi_free_ImageInfo(info);
177 return;
180 *p_info = info;
183 /* @p_info will be set only on success. */
184 void bdrv_query_info(BlockDriverState *bs,
185 BlockInfo **p_info,
186 Error **errp)
188 BlockInfo *info = g_malloc0(sizeof(*info));
189 BlockDriverState *bs0;
190 ImageInfo **p_image_info;
191 Error *local_err = NULL;
192 info->device = g_strdup(bs->device_name);
193 info->type = g_strdup("unknown");
194 info->locked = bdrv_dev_is_medium_locked(bs);
195 info->removable = bdrv_dev_has_removable_media(bs);
197 if (bdrv_dev_has_removable_media(bs)) {
198 info->has_tray_open = true;
199 info->tray_open = bdrv_dev_is_tray_open(bs);
202 if (bdrv_iostatus_is_enabled(bs)) {
203 info->has_io_status = true;
204 info->io_status = bs->iostatus;
207 if (!QLIST_EMPTY(&bs->dirty_bitmaps)) {
208 info->has_dirty_bitmaps = true;
209 info->dirty_bitmaps = bdrv_query_dirty_bitmaps(bs);
212 if (bs->drv) {
213 info->has_inserted = true;
214 info->inserted = g_malloc0(sizeof(*info->inserted));
215 info->inserted->file = g_strdup(bs->filename);
216 info->inserted->ro = bs->read_only;
217 info->inserted->drv = g_strdup(bs->drv->format_name);
218 info->inserted->encrypted = bs->encrypted;
219 info->inserted->encryption_key_missing = bdrv_key_required(bs);
221 if (bs->backing_file[0]) {
222 info->inserted->has_backing_file = true;
223 info->inserted->backing_file = g_strdup(bs->backing_file);
226 info->inserted->backing_file_depth = bdrv_get_backing_file_depth(bs);
228 if (bs->io_limits_enabled) {
229 ThrottleConfig cfg;
230 throttle_get_config(&bs->throttle_state, &cfg);
231 info->inserted->bps = cfg.buckets[THROTTLE_BPS_TOTAL].avg;
232 info->inserted->bps_rd = cfg.buckets[THROTTLE_BPS_READ].avg;
233 info->inserted->bps_wr = cfg.buckets[THROTTLE_BPS_WRITE].avg;
235 info->inserted->iops = cfg.buckets[THROTTLE_OPS_TOTAL].avg;
236 info->inserted->iops_rd = cfg.buckets[THROTTLE_OPS_READ].avg;
237 info->inserted->iops_wr = cfg.buckets[THROTTLE_OPS_WRITE].avg;
239 info->inserted->has_bps_max =
240 cfg.buckets[THROTTLE_BPS_TOTAL].max;
241 info->inserted->bps_max =
242 cfg.buckets[THROTTLE_BPS_TOTAL].max;
243 info->inserted->has_bps_rd_max =
244 cfg.buckets[THROTTLE_BPS_READ].max;
245 info->inserted->bps_rd_max =
246 cfg.buckets[THROTTLE_BPS_READ].max;
247 info->inserted->has_bps_wr_max =
248 cfg.buckets[THROTTLE_BPS_WRITE].max;
249 info->inserted->bps_wr_max =
250 cfg.buckets[THROTTLE_BPS_WRITE].max;
252 info->inserted->has_iops_max =
253 cfg.buckets[THROTTLE_OPS_TOTAL].max;
254 info->inserted->iops_max =
255 cfg.buckets[THROTTLE_OPS_TOTAL].max;
256 info->inserted->has_iops_rd_max =
257 cfg.buckets[THROTTLE_OPS_READ].max;
258 info->inserted->iops_rd_max =
259 cfg.buckets[THROTTLE_OPS_READ].max;
260 info->inserted->has_iops_wr_max =
261 cfg.buckets[THROTTLE_OPS_WRITE].max;
262 info->inserted->iops_wr_max =
263 cfg.buckets[THROTTLE_OPS_WRITE].max;
265 info->inserted->has_iops_size = cfg.op_size;
266 info->inserted->iops_size = cfg.op_size;
269 bs0 = bs;
270 p_image_info = &info->inserted->image;
271 while (1) {
272 bdrv_query_image_info(bs0, p_image_info, &local_err);
273 if (error_is_set(&local_err)) {
274 error_propagate(errp, local_err);
275 goto err;
277 if (bs0->drv && bs0->backing_hd) {
278 bs0 = bs0->backing_hd;
279 (*p_image_info)->has_backing_image = true;
280 p_image_info = &((*p_image_info)->backing_image);
281 } else {
282 break;
287 *p_info = info;
288 return;
290 err:
291 qapi_free_BlockInfo(info);
294 BlockStats *bdrv_query_stats(const BlockDriverState *bs)
296 BlockStats *s;
298 s = g_malloc0(sizeof(*s));
300 if (bs->device_name[0]) {
301 s->has_device = true;
302 s->device = g_strdup(bs->device_name);
305 s->stats = g_malloc0(sizeof(*s->stats));
306 s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
307 s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
308 s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
309 s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
310 s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
311 s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
312 s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
313 s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
314 s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
316 if (bs->file) {
317 s->has_parent = true;
318 s->parent = bdrv_query_stats(bs->file);
321 return s;
324 BlockInfoList *qmp_query_block(Error **errp)
326 BlockInfoList *head = NULL, **p_next = &head;
327 BlockDriverState *bs = NULL;
328 Error *local_err = NULL;
330 while ((bs = bdrv_next(bs))) {
331 BlockInfoList *info = g_malloc0(sizeof(*info));
332 bdrv_query_info(bs, &info->value, &local_err);
333 if (error_is_set(&local_err)) {
334 error_propagate(errp, local_err);
335 goto err;
338 *p_next = info;
339 p_next = &info->next;
342 return head;
344 err:
345 qapi_free_BlockInfoList(head);
346 return NULL;
349 BlockStatsList *qmp_query_blockstats(Error **errp)
351 BlockStatsList *head = NULL, **p_next = &head;
352 BlockDriverState *bs = NULL;
354 while ((bs = bdrv_next(bs))) {
355 BlockStatsList *info = g_malloc0(sizeof(*info));
356 info->value = bdrv_query_stats(bs);
358 *p_next = info;
359 p_next = &info->next;
362 return head;
365 #define NB_SUFFIXES 4
367 static char *get_human_readable_size(char *buf, int buf_size, int64_t size)
369 static const char suffixes[NB_SUFFIXES] = "KMGT";
370 int64_t base;
371 int i;
373 if (size <= 999) {
374 snprintf(buf, buf_size, "%" PRId64, size);
375 } else {
376 base = 1024;
377 for (i = 0; i < NB_SUFFIXES; i++) {
378 if (size < (10 * base)) {
379 snprintf(buf, buf_size, "%0.1f%c",
380 (double)size / base,
381 suffixes[i]);
382 break;
383 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
384 snprintf(buf, buf_size, "%" PRId64 "%c",
385 ((size + (base >> 1)) / base),
386 suffixes[i]);
387 break;
389 base = base * 1024;
392 return buf;
395 void bdrv_snapshot_dump(fprintf_function func_fprintf, void *f,
396 QEMUSnapshotInfo *sn)
398 char buf1[128], date_buf[128], clock_buf[128];
399 struct tm tm;
400 time_t ti;
401 int64_t secs;
403 if (!sn) {
404 func_fprintf(f,
405 "%-10s%-20s%7s%20s%15s",
406 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
407 } else {
408 ti = sn->date_sec;
409 localtime_r(&ti, &tm);
410 strftime(date_buf, sizeof(date_buf),
411 "%Y-%m-%d %H:%M:%S", &tm);
412 secs = sn->vm_clock_nsec / 1000000000;
413 snprintf(clock_buf, sizeof(clock_buf),
414 "%02d:%02d:%02d.%03d",
415 (int)(secs / 3600),
416 (int)((secs / 60) % 60),
417 (int)(secs % 60),
418 (int)((sn->vm_clock_nsec / 1000000) % 1000));
419 func_fprintf(f,
420 "%-10s%-20s%7s%20s%15s",
421 sn->id_str, sn->name,
422 get_human_readable_size(buf1, sizeof(buf1),
423 sn->vm_state_size),
424 date_buf,
425 clock_buf);
429 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
430 QDict *dict);
431 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
432 QList *list);
434 static void dump_qobject(fprintf_function func_fprintf, void *f,
435 int comp_indent, QObject *obj)
437 switch (qobject_type(obj)) {
438 case QTYPE_QINT: {
439 QInt *value = qobject_to_qint(obj);
440 func_fprintf(f, "%" PRId64, qint_get_int(value));
441 break;
443 case QTYPE_QSTRING: {
444 QString *value = qobject_to_qstring(obj);
445 func_fprintf(f, "%s", qstring_get_str(value));
446 break;
448 case QTYPE_QDICT: {
449 QDict *value = qobject_to_qdict(obj);
450 dump_qdict(func_fprintf, f, comp_indent, value);
451 break;
453 case QTYPE_QLIST: {
454 QList *value = qobject_to_qlist(obj);
455 dump_qlist(func_fprintf, f, comp_indent, value);
456 break;
458 case QTYPE_QFLOAT: {
459 QFloat *value = qobject_to_qfloat(obj);
460 func_fprintf(f, "%g", qfloat_get_double(value));
461 break;
463 case QTYPE_QBOOL: {
464 QBool *value = qobject_to_qbool(obj);
465 func_fprintf(f, "%s", qbool_get_int(value) ? "true" : "false");
466 break;
468 case QTYPE_QERROR: {
469 QString *value = qerror_human((QError *)obj);
470 func_fprintf(f, "%s", qstring_get_str(value));
471 break;
473 case QTYPE_NONE:
474 break;
475 case QTYPE_MAX:
476 default:
477 abort();
481 static void dump_qlist(fprintf_function func_fprintf, void *f, int indentation,
482 QList *list)
484 const QListEntry *entry;
485 int i = 0;
487 for (entry = qlist_first(list); entry; entry = qlist_next(entry), i++) {
488 qtype_code type = qobject_type(entry->value);
489 bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
490 const char *format = composite ? "%*s[%i]:\n" : "%*s[%i]: ";
492 func_fprintf(f, format, indentation * 4, "", i);
493 dump_qobject(func_fprintf, f, indentation + 1, entry->value);
494 if (!composite) {
495 func_fprintf(f, "\n");
500 static void dump_qdict(fprintf_function func_fprintf, void *f, int indentation,
501 QDict *dict)
503 const QDictEntry *entry;
505 for (entry = qdict_first(dict); entry; entry = qdict_next(dict, entry)) {
506 qtype_code type = qobject_type(entry->value);
507 bool composite = (type == QTYPE_QDICT || type == QTYPE_QLIST);
508 const char *format = composite ? "%*s%s:\n" : "%*s%s: ";
509 char key[strlen(entry->key) + 1];
510 int i;
512 /* replace dashes with spaces in key (variable) names */
513 for (i = 0; entry->key[i]; i++) {
514 key[i] = entry->key[i] == '-' ? ' ' : entry->key[i];
516 key[i] = 0;
518 func_fprintf(f, format, indentation * 4, "", key);
519 dump_qobject(func_fprintf, f, indentation + 1, entry->value);
520 if (!composite) {
521 func_fprintf(f, "\n");
526 void bdrv_image_info_specific_dump(fprintf_function func_fprintf, void *f,
527 ImageInfoSpecific *info_spec)
529 Error *local_err = NULL;
530 QmpOutputVisitor *ov = qmp_output_visitor_new();
531 QObject *obj, *data;
533 visit_type_ImageInfoSpecific(qmp_output_get_visitor(ov), &info_spec, NULL,
534 &local_err);
535 obj = qmp_output_get_qobject(ov);
536 assert(qobject_type(obj) == QTYPE_QDICT);
537 data = qdict_get(qobject_to_qdict(obj), "data");
538 dump_qobject(func_fprintf, f, 1, data);
539 qmp_output_visitor_cleanup(ov);
542 void bdrv_image_info_dump(fprintf_function func_fprintf, void *f,
543 ImageInfo *info)
545 char size_buf[128], dsize_buf[128];
546 if (!info->has_actual_size) {
547 snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
548 } else {
549 get_human_readable_size(dsize_buf, sizeof(dsize_buf),
550 info->actual_size);
552 get_human_readable_size(size_buf, sizeof(size_buf), info->virtual_size);
553 func_fprintf(f,
554 "image: %s\n"
555 "file format: %s\n"
556 "virtual size: %s (%" PRId64 " bytes)\n"
557 "disk size: %s\n",
558 info->filename, info->format, size_buf,
559 info->virtual_size,
560 dsize_buf);
562 if (info->has_encrypted && info->encrypted) {
563 func_fprintf(f, "encrypted: yes\n");
566 if (info->has_cluster_size) {
567 func_fprintf(f, "cluster_size: %" PRId64 "\n",
568 info->cluster_size);
571 if (info->has_dirty_flag && info->dirty_flag) {
572 func_fprintf(f, "cleanly shut down: no\n");
575 if (info->has_backing_filename) {
576 func_fprintf(f, "backing file: %s", info->backing_filename);
577 if (info->has_full_backing_filename) {
578 func_fprintf(f, " (actual path: %s)", info->full_backing_filename);
580 func_fprintf(f, "\n");
581 if (info->has_backing_filename_format) {
582 func_fprintf(f, "backing file format: %s\n",
583 info->backing_filename_format);
587 if (info->has_snapshots) {
588 SnapshotInfoList *elem;
590 func_fprintf(f, "Snapshot list:\n");
591 bdrv_snapshot_dump(func_fprintf, f, NULL);
592 func_fprintf(f, "\n");
594 /* Ideally bdrv_snapshot_dump() would operate on SnapshotInfoList but
595 * we convert to the block layer's native QEMUSnapshotInfo for now.
597 for (elem = info->snapshots; elem; elem = elem->next) {
598 QEMUSnapshotInfo sn = {
599 .vm_state_size = elem->value->vm_state_size,
600 .date_sec = elem->value->date_sec,
601 .date_nsec = elem->value->date_nsec,
602 .vm_clock_nsec = elem->value->vm_clock_sec * 1000000000ULL +
603 elem->value->vm_clock_nsec,
606 pstrcpy(sn.id_str, sizeof(sn.id_str), elem->value->id);
607 pstrcpy(sn.name, sizeof(sn.name), elem->value->name);
608 bdrv_snapshot_dump(func_fprintf, f, &sn);
609 func_fprintf(f, "\n");
613 if (info->has_format_specific) {
614 func_fprintf(f, "Format specific information:\n");
615 bdrv_image_info_specific_dump(func_fprintf, f, info->format_specific);