]> git.proxmox.com Git - mirror_qemu.git/blame - block.c
coroutine: add test-coroutine --benchmark-lifecycle
[mirror_qemu.git] / block.c
CommitLineData
fc01f7e7
FB
1/*
2 * QEMU System Emulator block driver
5fafdf24 3 *
fc01f7e7 4 * Copyright (c) 2003 Fabrice Bellard
5fafdf24 5 *
fc01f7e7
FB
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 */
3990d09a 24#include "config-host.h"
faf07963 25#include "qemu-common.h"
6d519a5f 26#include "trace.h"
376253ec 27#include "monitor.h"
ea2384d3 28#include "block_int.h"
5efa9d5a 29#include "module.h"
d15e5465 30#include "qemu-objects.h"
fc01f7e7 31
71e72a19 32#ifdef CONFIG_BSD
7674e7bf
FB
33#include <sys/types.h>
34#include <sys/stat.h>
35#include <sys/ioctl.h>
72cf2d4f 36#include <sys/queue.h>
c5e97233 37#ifndef __DragonFly__
7674e7bf
FB
38#include <sys/disk.h>
39#endif
c5e97233 40#endif
7674e7bf 41
49dc768d
AL
42#ifdef _WIN32
43#include <windows.h>
44#endif
45
f141eafe
AL
46static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
47 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
c87c0672 48 BlockDriverCompletionFunc *cb, void *opaque);
f141eafe
AL
49static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
50 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 51 BlockDriverCompletionFunc *cb, void *opaque);
b2e12bc6
CH
52static BlockDriverAIOCB *bdrv_aio_flush_em(BlockDriverState *bs,
53 BlockDriverCompletionFunc *cb, void *opaque);
016f5cf6
AG
54static BlockDriverAIOCB *bdrv_aio_noop_em(BlockDriverState *bs,
55 BlockDriverCompletionFunc *cb, void *opaque);
5fafdf24 56static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
83f64091
FB
57 uint8_t *buf, int nb_sectors);
58static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
59 const uint8_t *buf, int nb_sectors);
ec530c81 60
1b7bdbc1
SH
61static QTAILQ_HEAD(, BlockDriverState) bdrv_states =
62 QTAILQ_HEAD_INITIALIZER(bdrv_states);
7ee930d0 63
8a22f02a
SH
64static QLIST_HEAD(, BlockDriver) bdrv_drivers =
65 QLIST_HEAD_INITIALIZER(bdrv_drivers);
ea2384d3 66
f9092b10
MA
67/* The device to use for VM snapshots */
68static BlockDriverState *bs_snapshots;
69
eb852011
MA
70/* If non-zero, use only whitelisted block drivers */
71static int use_bdrv_whitelist;
72
9e0b22f4
SH
73#ifdef _WIN32
74static int is_windows_drive_prefix(const char *filename)
75{
76 return (((filename[0] >= 'a' && filename[0] <= 'z') ||
77 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
78 filename[1] == ':');
79}
80
81int is_windows_drive(const char *filename)
82{
83 if (is_windows_drive_prefix(filename) &&
84 filename[2] == '\0')
85 return 1;
86 if (strstart(filename, "\\\\.\\", NULL) ||
87 strstart(filename, "//./", NULL))
88 return 1;
89 return 0;
90}
91#endif
92
93/* check if the path starts with "<protocol>:" */
94static int path_has_protocol(const char *path)
95{
96#ifdef _WIN32
97 if (is_windows_drive(path) ||
98 is_windows_drive_prefix(path)) {
99 return 0;
100 }
101#endif
102
103 return strchr(path, ':') != NULL;
104}
105
83f64091 106int path_is_absolute(const char *path)
3b0d4f61 107{
83f64091 108 const char *p;
21664424
FB
109#ifdef _WIN32
110 /* specific case for names like: "\\.\d:" */
111 if (*path == '/' || *path == '\\')
112 return 1;
113#endif
83f64091
FB
114 p = strchr(path, ':');
115 if (p)
116 p++;
117 else
118 p = path;
3b9f94e1
FB
119#ifdef _WIN32
120 return (*p == '/' || *p == '\\');
121#else
122 return (*p == '/');
123#endif
3b0d4f61
FB
124}
125
83f64091
FB
126/* if filename is absolute, just copy it to dest. Otherwise, build a
127 path to it by considering it is relative to base_path. URL are
128 supported. */
129void path_combine(char *dest, int dest_size,
130 const char *base_path,
131 const char *filename)
3b0d4f61 132{
83f64091
FB
133 const char *p, *p1;
134 int len;
135
136 if (dest_size <= 0)
137 return;
138 if (path_is_absolute(filename)) {
139 pstrcpy(dest, dest_size, filename);
140 } else {
141 p = strchr(base_path, ':');
142 if (p)
143 p++;
144 else
145 p = base_path;
3b9f94e1
FB
146 p1 = strrchr(base_path, '/');
147#ifdef _WIN32
148 {
149 const char *p2;
150 p2 = strrchr(base_path, '\\');
151 if (!p1 || p2 > p1)
152 p1 = p2;
153 }
154#endif
83f64091
FB
155 if (p1)
156 p1++;
157 else
158 p1 = base_path;
159 if (p1 > p)
160 p = p1;
161 len = p - base_path;
162 if (len > dest_size - 1)
163 len = dest_size - 1;
164 memcpy(dest, base_path, len);
165 dest[len] = '\0';
166 pstrcat(dest, dest_size, filename);
3b0d4f61 167 }
3b0d4f61
FB
168}
169
5efa9d5a 170void bdrv_register(BlockDriver *bdrv)
ea2384d3 171{
f141eafe 172 if (!bdrv->bdrv_aio_readv) {
83f64091 173 /* add AIO emulation layer */
f141eafe
AL
174 bdrv->bdrv_aio_readv = bdrv_aio_readv_em;
175 bdrv->bdrv_aio_writev = bdrv_aio_writev_em;
eda578e5 176 } else if (!bdrv->bdrv_read) {
83f64091
FB
177 /* add synchronous IO emulation layer */
178 bdrv->bdrv_read = bdrv_read_em;
179 bdrv->bdrv_write = bdrv_write_em;
180 }
b2e12bc6
CH
181
182 if (!bdrv->bdrv_aio_flush)
183 bdrv->bdrv_aio_flush = bdrv_aio_flush_em;
184
8a22f02a 185 QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list);
ea2384d3 186}
b338082b
FB
187
188/* create a new block device (by default it is empty) */
189BlockDriverState *bdrv_new(const char *device_name)
190{
1b7bdbc1 191 BlockDriverState *bs;
b338082b
FB
192
193 bs = qemu_mallocz(sizeof(BlockDriverState));
b338082b 194 pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
ea2384d3 195 if (device_name[0] != '\0') {
1b7bdbc1 196 QTAILQ_INSERT_TAIL(&bdrv_states, bs, list);
ea2384d3 197 }
b338082b
FB
198 return bs;
199}
200
ea2384d3
FB
201BlockDriver *bdrv_find_format(const char *format_name)
202{
203 BlockDriver *drv1;
8a22f02a
SH
204 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
205 if (!strcmp(drv1->format_name, format_name)) {
ea2384d3 206 return drv1;
8a22f02a 207 }
ea2384d3
FB
208 }
209 return NULL;
210}
211
eb852011
MA
212static int bdrv_is_whitelisted(BlockDriver *drv)
213{
214 static const char *whitelist[] = {
215 CONFIG_BDRV_WHITELIST
216 };
217 const char **p;
218
219 if (!whitelist[0])
220 return 1; /* no whitelist, anything goes */
221
222 for (p = whitelist; *p; p++) {
223 if (!strcmp(drv->format_name, *p)) {
224 return 1;
225 }
226 }
227 return 0;
228}
229
230BlockDriver *bdrv_find_whitelisted_format(const char *format_name)
231{
232 BlockDriver *drv = bdrv_find_format(format_name);
233 return drv && bdrv_is_whitelisted(drv) ? drv : NULL;
234}
235
0e7e1989
KW
236int bdrv_create(BlockDriver *drv, const char* filename,
237 QEMUOptionParameter *options)
ea2384d3
FB
238{
239 if (!drv->bdrv_create)
240 return -ENOTSUP;
0e7e1989
KW
241
242 return drv->bdrv_create(filename, options);
ea2384d3
FB
243}
244
84a12e66
CH
245int bdrv_create_file(const char* filename, QEMUOptionParameter *options)
246{
247 BlockDriver *drv;
248
b50cbabc 249 drv = bdrv_find_protocol(filename);
84a12e66 250 if (drv == NULL) {
16905d71 251 return -ENOENT;
84a12e66
CH
252 }
253
254 return bdrv_create(drv, filename, options);
255}
256
d5249393 257#ifdef _WIN32
95389c86 258void get_tmp_filename(char *filename, int size)
d5249393 259{
3b9f94e1 260 char temp_dir[MAX_PATH];
3b46e624 261
3b9f94e1
FB
262 GetTempPath(MAX_PATH, temp_dir);
263 GetTempFileName(temp_dir, "qem", 0, filename);
d5249393
FB
264}
265#else
95389c86 266void get_tmp_filename(char *filename, int size)
fc01f7e7 267{
67b915a5 268 int fd;
7ccfb2eb 269 const char *tmpdir;
d5249393 270 /* XXX: race condition possible */
0badc1ee
AJ
271 tmpdir = getenv("TMPDIR");
272 if (!tmpdir)
273 tmpdir = "/tmp";
274 snprintf(filename, size, "%s/vl.XXXXXX", tmpdir);
ea2384d3
FB
275 fd = mkstemp(filename);
276 close(fd);
277}
d5249393 278#endif
fc01f7e7 279
84a12e66
CH
280/*
281 * Detect host devices. By convention, /dev/cdrom[N] is always
282 * recognized as a host CDROM.
283 */
284static BlockDriver *find_hdev_driver(const char *filename)
285{
286 int score_max = 0, score;
287 BlockDriver *drv = NULL, *d;
288
289 QLIST_FOREACH(d, &bdrv_drivers, list) {
290 if (d->bdrv_probe_device) {
291 score = d->bdrv_probe_device(filename);
292 if (score > score_max) {
293 score_max = score;
294 drv = d;
295 }
296 }
297 }
298
299 return drv;
300}
301
b50cbabc 302BlockDriver *bdrv_find_protocol(const char *filename)
83f64091
FB
303{
304 BlockDriver *drv1;
305 char protocol[128];
1cec71e3 306 int len;
83f64091 307 const char *p;
19cb3738 308
66f82cee
KW
309 /* TODO Drivers without bdrv_file_open must be specified explicitly */
310
39508e7a
CH
311 /*
312 * XXX(hch): we really should not let host device detection
313 * override an explicit protocol specification, but moving this
314 * later breaks access to device names with colons in them.
315 * Thanks to the brain-dead persistent naming schemes on udev-
316 * based Linux systems those actually are quite common.
317 */
318 drv1 = find_hdev_driver(filename);
319 if (drv1) {
320 return drv1;
321 }
322
9e0b22f4 323 if (!path_has_protocol(filename)) {
39508e7a 324 return bdrv_find_format("file");
84a12e66 325 }
9e0b22f4
SH
326 p = strchr(filename, ':');
327 assert(p != NULL);
1cec71e3
AL
328 len = p - filename;
329 if (len > sizeof(protocol) - 1)
330 len = sizeof(protocol) - 1;
331 memcpy(protocol, filename, len);
332 protocol[len] = '\0';
8a22f02a 333 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
5fafdf24 334 if (drv1->protocol_name &&
8a22f02a 335 !strcmp(drv1->protocol_name, protocol)) {
83f64091 336 return drv1;
8a22f02a 337 }
83f64091
FB
338 }
339 return NULL;
340}
341
c98ac35d 342static int find_image_format(const char *filename, BlockDriver **pdrv)
f3a5d3f8
CH
343{
344 int ret, score, score_max;
345 BlockDriver *drv1, *drv;
346 uint8_t buf[2048];
347 BlockDriverState *bs;
348
f5edb014 349 ret = bdrv_file_open(&bs, filename, 0);
c98ac35d
SW
350 if (ret < 0) {
351 *pdrv = NULL;
352 return ret;
353 }
f8ea0b00 354
08a00559
KW
355 /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
356 if (bs->sg || !bdrv_is_inserted(bs)) {
1a396859 357 bdrv_delete(bs);
c98ac35d
SW
358 drv = bdrv_find_format("raw");
359 if (!drv) {
360 ret = -ENOENT;
361 }
362 *pdrv = drv;
363 return ret;
1a396859 364 }
f8ea0b00 365
83f64091
FB
366 ret = bdrv_pread(bs, 0, buf, sizeof(buf));
367 bdrv_delete(bs);
368 if (ret < 0) {
c98ac35d
SW
369 *pdrv = NULL;
370 return ret;
83f64091
FB
371 }
372
ea2384d3 373 score_max = 0;
84a12e66 374 drv = NULL;
8a22f02a 375 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
83f64091
FB
376 if (drv1->bdrv_probe) {
377 score = drv1->bdrv_probe(buf, ret, filename);
378 if (score > score_max) {
379 score_max = score;
380 drv = drv1;
381 }
0849bf08 382 }
fc01f7e7 383 }
c98ac35d
SW
384 if (!drv) {
385 ret = -ENOENT;
386 }
387 *pdrv = drv;
388 return ret;
ea2384d3
FB
389}
390
51762288
SH
391/**
392 * Set the current 'total_sectors' value
393 */
394static int refresh_total_sectors(BlockDriverState *bs, int64_t hint)
395{
396 BlockDriver *drv = bs->drv;
397
396759ad
NB
398 /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
399 if (bs->sg)
400 return 0;
401
51762288
SH
402 /* query actual device if possible, otherwise just trust the hint */
403 if (drv->bdrv_getlength) {
404 int64_t length = drv->bdrv_getlength(bs);
405 if (length < 0) {
406 return length;
407 }
408 hint = length >> BDRV_SECTOR_BITS;
409 }
410
411 bs->total_sectors = hint;
412 return 0;
413}
414
57915332
KW
415/*
416 * Common part for opening disk images and files
417 */
418static int bdrv_open_common(BlockDriverState *bs, const char *filename,
419 int flags, BlockDriver *drv)
420{
421 int ret, open_flags;
422
423 assert(drv != NULL);
424
66f82cee 425 bs->file = NULL;
51762288 426 bs->total_sectors = 0;
57915332
KW
427 bs->encrypted = 0;
428 bs->valid_key = 0;
429 bs->open_flags = flags;
430 /* buffer_alignment defaulted to 512, drivers can change this value */
431 bs->buffer_alignment = 512;
432
433 pstrcpy(bs->filename, sizeof(bs->filename), filename);
434
435 if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv)) {
436 return -ENOTSUP;
437 }
438
439 bs->drv = drv;
440 bs->opaque = qemu_mallocz(drv->instance_size);
441
a6599793 442 if (flags & BDRV_O_CACHE_WB)
57915332
KW
443 bs->enable_write_cache = 1;
444
445 /*
446 * Clear flags that are internal to the block layer before opening the
447 * image.
448 */
449 open_flags = flags & ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
450
451 /*
ebabb67a 452 * Snapshots should be writable.
57915332
KW
453 */
454 if (bs->is_temporary) {
455 open_flags |= BDRV_O_RDWR;
456 }
457
66f82cee
KW
458 /* Open the image, either directly or using a protocol */
459 if (drv->bdrv_file_open) {
460 ret = drv->bdrv_file_open(bs, filename, open_flags);
461 } else {
462 ret = bdrv_file_open(&bs->file, filename, open_flags);
463 if (ret >= 0) {
464 ret = drv->bdrv_open(bs, open_flags);
465 }
466 }
467
57915332
KW
468 if (ret < 0) {
469 goto free_and_fail;
470 }
471
472 bs->keep_read_only = bs->read_only = !(open_flags & BDRV_O_RDWR);
51762288
SH
473
474 ret = refresh_total_sectors(bs, bs->total_sectors);
475 if (ret < 0) {
476 goto free_and_fail;
57915332 477 }
51762288 478
57915332
KW
479#ifndef _WIN32
480 if (bs->is_temporary) {
481 unlink(filename);
482 }
483#endif
484 return 0;
485
486free_and_fail:
66f82cee
KW
487 if (bs->file) {
488 bdrv_delete(bs->file);
489 bs->file = NULL;
490 }
57915332
KW
491 qemu_free(bs->opaque);
492 bs->opaque = NULL;
493 bs->drv = NULL;
494 return ret;
495}
496
b6ce07aa
KW
497/*
498 * Opens a file using a protocol (file, host_device, nbd, ...)
499 */
83f64091 500int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags)
ea2384d3 501{
83f64091 502 BlockDriverState *bs;
6db95603 503 BlockDriver *drv;
83f64091
FB
504 int ret;
505
b50cbabc 506 drv = bdrv_find_protocol(filename);
6db95603
CH
507 if (!drv) {
508 return -ENOENT;
509 }
510
83f64091 511 bs = bdrv_new("");
b6ce07aa 512 ret = bdrv_open_common(bs, filename, flags, drv);
83f64091
FB
513 if (ret < 0) {
514 bdrv_delete(bs);
515 return ret;
3b0d4f61 516 }
71d0770c 517 bs->growable = 1;
83f64091
FB
518 *pbs = bs;
519 return 0;
520}
521
b6ce07aa
KW
522/*
523 * Opens a disk image (raw, qcow2, vmdk, ...)
524 */
d6e9098e
KW
525int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
526 BlockDriver *drv)
ea2384d3 527{
b6ce07aa 528 int ret;
712e7874 529
83f64091 530 if (flags & BDRV_O_SNAPSHOT) {
ea2384d3
FB
531 BlockDriverState *bs1;
532 int64_t total_size;
7c96d46e 533 int is_protocol = 0;
91a073a9
KW
534 BlockDriver *bdrv_qcow2;
535 QEMUOptionParameter *options;
b6ce07aa
KW
536 char tmp_filename[PATH_MAX];
537 char backing_filename[PATH_MAX];
3b46e624 538
ea2384d3
FB
539 /* if snapshot, we create a temporary backing file and open it
540 instead of opening 'filename' directly */
33e3963e 541
ea2384d3
FB
542 /* if there is a backing file, use it */
543 bs1 = bdrv_new("");
d6e9098e 544 ret = bdrv_open(bs1, filename, 0, drv);
51d7c00c 545 if (ret < 0) {
ea2384d3 546 bdrv_delete(bs1);
51d7c00c 547 return ret;
ea2384d3 548 }
3e82990b 549 total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
7c96d46e
AL
550
551 if (bs1->drv && bs1->drv->protocol_name)
552 is_protocol = 1;
553
ea2384d3 554 bdrv_delete(bs1);
3b46e624 555
ea2384d3 556 get_tmp_filename(tmp_filename, sizeof(tmp_filename));
7c96d46e
AL
557
558 /* Real path is meaningless for protocols */
559 if (is_protocol)
560 snprintf(backing_filename, sizeof(backing_filename),
561 "%s", filename);
114cdfa9
KS
562 else if (!realpath(filename, backing_filename))
563 return -errno;
7c96d46e 564
91a073a9
KW
565 bdrv_qcow2 = bdrv_find_format("qcow2");
566 options = parse_option_parameters("", bdrv_qcow2->create_options, NULL);
567
3e82990b 568 set_option_parameter_int(options, BLOCK_OPT_SIZE, total_size);
91a073a9
KW
569 set_option_parameter(options, BLOCK_OPT_BACKING_FILE, backing_filename);
570 if (drv) {
571 set_option_parameter(options, BLOCK_OPT_BACKING_FMT,
572 drv->format_name);
573 }
574
575 ret = bdrv_create(bdrv_qcow2, tmp_filename, options);
d748768c 576 free_option_parameters(options);
51d7c00c
AL
577 if (ret < 0) {
578 return ret;
ea2384d3 579 }
91a073a9 580
ea2384d3 581 filename = tmp_filename;
91a073a9 582 drv = bdrv_qcow2;
ea2384d3
FB
583 bs->is_temporary = 1;
584 }
712e7874 585
b6ce07aa 586 /* Find the right image format driver */
6db95603 587 if (!drv) {
c98ac35d 588 ret = find_image_format(filename, &drv);
51d7c00c 589 }
6987307c 590
51d7c00c 591 if (!drv) {
51d7c00c 592 goto unlink_and_fail;
ea2384d3 593 }
b6ce07aa
KW
594
595 /* Open the image */
596 ret = bdrv_open_common(bs, filename, flags, drv);
597 if (ret < 0) {
6987307c
CH
598 goto unlink_and_fail;
599 }
600
b6ce07aa
KW
601 /* If there is a backing file, use it */
602 if ((flags & BDRV_O_NO_BACKING) == 0 && bs->backing_file[0] != '\0') {
603 char backing_filename[PATH_MAX];
604 int back_flags;
605 BlockDriver *back_drv = NULL;
606
607 bs->backing_hd = bdrv_new("");
df2dbb4a
SH
608
609 if (path_has_protocol(bs->backing_file)) {
610 pstrcpy(backing_filename, sizeof(backing_filename),
611 bs->backing_file);
612 } else {
613 path_combine(backing_filename, sizeof(backing_filename),
614 filename, bs->backing_file);
615 }
616
617 if (bs->backing_format[0] != '\0') {
b6ce07aa 618 back_drv = bdrv_find_format(bs->backing_format);
df2dbb4a 619 }
b6ce07aa
KW
620
621 /* backing files always opened read-only */
622 back_flags =
623 flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
624
625 ret = bdrv_open(bs->backing_hd, backing_filename, back_flags, back_drv);
626 if (ret < 0) {
627 bdrv_close(bs);
628 return ret;
629 }
630 if (bs->is_temporary) {
631 bs->backing_hd->keep_read_only = !(flags & BDRV_O_RDWR);
632 } else {
633 /* base image inherits from "parent" */
634 bs->backing_hd->keep_read_only = bs->keep_read_only;
635 }
636 }
637
638 if (!bdrv_key_required(bs)) {
639 /* call the change callback */
640 bs->media_changed = 1;
641 if (bs->change_cb)
db97ee6a 642 bs->change_cb(bs->change_opaque, CHANGE_MEDIA);
b6ce07aa
KW
643 }
644
645 return 0;
646
647unlink_and_fail:
648 if (bs->is_temporary) {
649 unlink(filename);
650 }
651 return ret;
652}
653
fc01f7e7
FB
654void bdrv_close(BlockDriverState *bs)
655{
19cb3738 656 if (bs->drv) {
f9092b10
MA
657 if (bs == bs_snapshots) {
658 bs_snapshots = NULL;
659 }
557df6ac 660 if (bs->backing_hd) {
ea2384d3 661 bdrv_delete(bs->backing_hd);
557df6ac
SH
662 bs->backing_hd = NULL;
663 }
ea2384d3
FB
664 bs->drv->bdrv_close(bs);
665 qemu_free(bs->opaque);
666#ifdef _WIN32
667 if (bs->is_temporary) {
668 unlink(bs->filename);
669 }
67b915a5 670#endif
ea2384d3
FB
671 bs->opaque = NULL;
672 bs->drv = NULL;
b338082b 673
66f82cee
KW
674 if (bs->file != NULL) {
675 bdrv_close(bs->file);
676 }
677
b338082b 678 /* call the change callback */
19cb3738 679 bs->media_changed = 1;
b338082b 680 if (bs->change_cb)
db97ee6a 681 bs->change_cb(bs->change_opaque, CHANGE_MEDIA);
b338082b
FB
682 }
683}
684
2bc93fed
MK
685void bdrv_close_all(void)
686{
687 BlockDriverState *bs;
688
689 QTAILQ_FOREACH(bs, &bdrv_states, list) {
690 bdrv_close(bs);
691 }
692}
693
d22b2f41
RH
694/* make a BlockDriverState anonymous by removing from bdrv_state list.
695 Also, NULL terminate the device_name to prevent double remove */
696void bdrv_make_anon(BlockDriverState *bs)
697{
698 if (bs->device_name[0] != '\0') {
699 QTAILQ_REMOVE(&bdrv_states, bs, list);
700 }
701 bs->device_name[0] = '\0';
702}
703
b338082b
FB
704void bdrv_delete(BlockDriverState *bs)
705{
18846dee
MA
706 assert(!bs->peer);
707
1b7bdbc1 708 /* remove from list, if necessary */
d22b2f41 709 bdrv_make_anon(bs);
34c6f050 710
b338082b 711 bdrv_close(bs);
66f82cee
KW
712 if (bs->file != NULL) {
713 bdrv_delete(bs->file);
714 }
715
f9092b10 716 assert(bs != bs_snapshots);
b338082b 717 qemu_free(bs);
fc01f7e7
FB
718}
719
18846dee
MA
720int bdrv_attach(BlockDriverState *bs, DeviceState *qdev)
721{
722 if (bs->peer) {
723 return -EBUSY;
724 }
725 bs->peer = qdev;
726 return 0;
727}
728
729void bdrv_detach(BlockDriverState *bs, DeviceState *qdev)
730{
731 assert(bs->peer == qdev);
732 bs->peer = NULL;
a19712b0
MA
733 bs->change_cb = NULL;
734 bs->change_opaque = NULL;
18846dee
MA
735}
736
737DeviceState *bdrv_get_attached(BlockDriverState *bs)
738{
739 return bs->peer;
740}
741
e97fc193
AL
742/*
743 * Run consistency checks on an image
744 *
e076f338 745 * Returns 0 if the check could be completed (it doesn't mean that the image is
a1c7273b 746 * free of errors) or -errno when an internal error occurred. The results of the
e076f338 747 * check are stored in res.
e97fc193 748 */
e076f338 749int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res)
e97fc193
AL
750{
751 if (bs->drv->bdrv_check == NULL) {
752 return -ENOTSUP;
753 }
754
e076f338 755 memset(res, 0, sizeof(*res));
9ac228e0 756 return bs->drv->bdrv_check(bs, res);
e97fc193
AL
757}
758
8a426614
KW
759#define COMMIT_BUF_SECTORS 2048
760
33e3963e
FB
761/* commit COW file into the raw image */
762int bdrv_commit(BlockDriverState *bs)
763{
19cb3738 764 BlockDriver *drv = bs->drv;
ee181196 765 BlockDriver *backing_drv;
8a426614
KW
766 int64_t sector, total_sectors;
767 int n, ro, open_flags;
4dca4b63 768 int ret = 0, rw_ret = 0;
8a426614 769 uint8_t *buf;
4dca4b63
NS
770 char filename[1024];
771 BlockDriverState *bs_rw, *bs_ro;
33e3963e 772
19cb3738
FB
773 if (!drv)
774 return -ENOMEDIUM;
4dca4b63
NS
775
776 if (!bs->backing_hd) {
777 return -ENOTSUP;
33e3963e
FB
778 }
779
4dca4b63
NS
780 if (bs->backing_hd->keep_read_only) {
781 return -EACCES;
782 }
ee181196
KW
783
784 backing_drv = bs->backing_hd->drv;
4dca4b63
NS
785 ro = bs->backing_hd->read_only;
786 strncpy(filename, bs->backing_hd->filename, sizeof(filename));
787 open_flags = bs->backing_hd->open_flags;
788
789 if (ro) {
790 /* re-open as RW */
791 bdrv_delete(bs->backing_hd);
792 bs->backing_hd = NULL;
793 bs_rw = bdrv_new("");
ee181196
KW
794 rw_ret = bdrv_open(bs_rw, filename, open_flags | BDRV_O_RDWR,
795 backing_drv);
4dca4b63
NS
796 if (rw_ret < 0) {
797 bdrv_delete(bs_rw);
798 /* try to re-open read-only */
799 bs_ro = bdrv_new("");
ee181196
KW
800 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR,
801 backing_drv);
4dca4b63
NS
802 if (ret < 0) {
803 bdrv_delete(bs_ro);
804 /* drive not functional anymore */
805 bs->drv = NULL;
806 return ret;
807 }
808 bs->backing_hd = bs_ro;
809 return rw_ret;
810 }
811 bs->backing_hd = bs_rw;
ea2384d3 812 }
33e3963e 813
6ea44308 814 total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
8a426614
KW
815 buf = qemu_malloc(COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE);
816
817 for (sector = 0; sector < total_sectors; sector += n) {
818 if (drv->bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n)) {
819
820 if (bdrv_read(bs, sector, buf, n) != 0) {
821 ret = -EIO;
822 goto ro_cleanup;
823 }
824
825 if (bdrv_write(bs->backing_hd, sector, buf, n) != 0) {
826 ret = -EIO;
827 goto ro_cleanup;
828 }
ea2384d3 829 }
33e3963e 830 }
95389c86 831
1d44952f
CH
832 if (drv->bdrv_make_empty) {
833 ret = drv->bdrv_make_empty(bs);
834 bdrv_flush(bs);
835 }
95389c86 836
3f5075ae
CH
837 /*
838 * Make sure all data we wrote to the backing device is actually
839 * stable on disk.
840 */
841 if (bs->backing_hd)
842 bdrv_flush(bs->backing_hd);
4dca4b63
NS
843
844ro_cleanup:
8a426614 845 qemu_free(buf);
4dca4b63
NS
846
847 if (ro) {
848 /* re-open as RO */
849 bdrv_delete(bs->backing_hd);
850 bs->backing_hd = NULL;
851 bs_ro = bdrv_new("");
ee181196
KW
852 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR,
853 backing_drv);
4dca4b63
NS
854 if (ret < 0) {
855 bdrv_delete(bs_ro);
856 /* drive not functional anymore */
857 bs->drv = NULL;
858 return ret;
859 }
860 bs->backing_hd = bs_ro;
861 bs->backing_hd->keep_read_only = 0;
862 }
863
1d44952f 864 return ret;
33e3963e
FB
865}
866
6ab4b5ab
MA
867void bdrv_commit_all(void)
868{
869 BlockDriverState *bs;
870
871 QTAILQ_FOREACH(bs, &bdrv_states, list) {
872 bdrv_commit(bs);
873 }
874}
875
756e6736
KW
876/*
877 * Return values:
878 * 0 - success
879 * -EINVAL - backing format specified, but no file
880 * -ENOSPC - can't update the backing file because no space is left in the
881 * image file header
882 * -ENOTSUP - format driver doesn't support changing the backing file
883 */
884int bdrv_change_backing_file(BlockDriverState *bs,
885 const char *backing_file, const char *backing_fmt)
886{
887 BlockDriver *drv = bs->drv;
888
889 if (drv->bdrv_change_backing_file != NULL) {
890 return drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
891 } else {
892 return -ENOTSUP;
893 }
894}
895
71d0770c
AL
896static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
897 size_t size)
898{
899 int64_t len;
900
901 if (!bdrv_is_inserted(bs))
902 return -ENOMEDIUM;
903
904 if (bs->growable)
905 return 0;
906
907 len = bdrv_getlength(bs);
908
fbb7b4e0
KW
909 if (offset < 0)
910 return -EIO;
911
912 if ((offset > len) || (len - offset < size))
71d0770c
AL
913 return -EIO;
914
915 return 0;
916}
917
918static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
919 int nb_sectors)
920{
eb5a3165
JS
921 return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
922 nb_sectors * BDRV_SECTOR_SIZE);
71d0770c
AL
923}
924
19cb3738 925/* return < 0 if error. See bdrv_write() for the return codes */
5fafdf24 926int bdrv_read(BlockDriverState *bs, int64_t sector_num,
fc01f7e7
FB
927 uint8_t *buf, int nb_sectors)
928{
ea2384d3
FB
929 BlockDriver *drv = bs->drv;
930
19cb3738
FB
931 if (!drv)
932 return -ENOMEDIUM;
71d0770c
AL
933 if (bdrv_check_request(bs, sector_num, nb_sectors))
934 return -EIO;
b338082b 935
eda578e5 936 return drv->bdrv_read(bs, sector_num, buf, nb_sectors);
fc01f7e7
FB
937}
938
7cd1e32a 939static void set_dirty_bitmap(BlockDriverState *bs, int64_t sector_num,
a55eb92c 940 int nb_sectors, int dirty)
7cd1e32a
LS
941{
942 int64_t start, end;
c6d22830 943 unsigned long val, idx, bit;
a55eb92c 944
6ea44308 945 start = sector_num / BDRV_SECTORS_PER_DIRTY_CHUNK;
c6d22830 946 end = (sector_num + nb_sectors - 1) / BDRV_SECTORS_PER_DIRTY_CHUNK;
a55eb92c
JK
947
948 for (; start <= end; start++) {
c6d22830
JK
949 idx = start / (sizeof(unsigned long) * 8);
950 bit = start % (sizeof(unsigned long) * 8);
951 val = bs->dirty_bitmap[idx];
952 if (dirty) {
6d59fec1 953 if (!(val & (1UL << bit))) {
aaa0eb75 954 bs->dirty_count++;
6d59fec1 955 val |= 1UL << bit;
aaa0eb75 956 }
c6d22830 957 } else {
6d59fec1 958 if (val & (1UL << bit)) {
aaa0eb75 959 bs->dirty_count--;
6d59fec1 960 val &= ~(1UL << bit);
aaa0eb75 961 }
c6d22830
JK
962 }
963 bs->dirty_bitmap[idx] = val;
7cd1e32a
LS
964 }
965}
966
5fafdf24 967/* Return < 0 if error. Important errors are:
19cb3738
FB
968 -EIO generic I/O error (may happen for all errors)
969 -ENOMEDIUM No media inserted.
970 -EINVAL Invalid sector number or nb_sectors
971 -EACCES Trying to write a read-only device
972*/
5fafdf24 973int bdrv_write(BlockDriverState *bs, int64_t sector_num,
fc01f7e7
FB
974 const uint8_t *buf, int nb_sectors)
975{
83f64091 976 BlockDriver *drv = bs->drv;
19cb3738
FB
977 if (!bs->drv)
978 return -ENOMEDIUM;
0849bf08 979 if (bs->read_only)
19cb3738 980 return -EACCES;
71d0770c
AL
981 if (bdrv_check_request(bs, sector_num, nb_sectors))
982 return -EIO;
a55eb92c 983
c6d22830 984 if (bs->dirty_bitmap) {
7cd1e32a
LS
985 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
986 }
a55eb92c 987
294cc35f
KW
988 if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
989 bs->wr_highest_sector = sector_num + nb_sectors - 1;
990 }
991
42fb2807 992 return drv->bdrv_write(bs, sector_num, buf, nb_sectors);
83f64091
FB
993}
994
eda578e5
AL
995int bdrv_pread(BlockDriverState *bs, int64_t offset,
996 void *buf, int count1)
83f64091 997{
6ea44308 998 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
83f64091
FB
999 int len, nb_sectors, count;
1000 int64_t sector_num;
9a8c4cce 1001 int ret;
83f64091
FB
1002
1003 count = count1;
1004 /* first read to align to sector start */
6ea44308 1005 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
83f64091
FB
1006 if (len > count)
1007 len = count;
6ea44308 1008 sector_num = offset >> BDRV_SECTOR_BITS;
83f64091 1009 if (len > 0) {
9a8c4cce
KW
1010 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1011 return ret;
6ea44308 1012 memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
83f64091
FB
1013 count -= len;
1014 if (count == 0)
1015 return count1;
1016 sector_num++;
1017 buf += len;
1018 }
1019
1020 /* read the sectors "in place" */
6ea44308 1021 nb_sectors = count >> BDRV_SECTOR_BITS;
83f64091 1022 if (nb_sectors > 0) {
9a8c4cce
KW
1023 if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
1024 return ret;
83f64091 1025 sector_num += nb_sectors;
6ea44308 1026 len = nb_sectors << BDRV_SECTOR_BITS;
83f64091
FB
1027 buf += len;
1028 count -= len;
1029 }
1030
1031 /* add data from the last sector */
1032 if (count > 0) {
9a8c4cce
KW
1033 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1034 return ret;
83f64091
FB
1035 memcpy(buf, tmp_buf, count);
1036 }
1037 return count1;
1038}
1039
eda578e5
AL
1040int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
1041 const void *buf, int count1)
83f64091 1042{
6ea44308 1043 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
83f64091
FB
1044 int len, nb_sectors, count;
1045 int64_t sector_num;
9a8c4cce 1046 int ret;
83f64091
FB
1047
1048 count = count1;
1049 /* first write to align to sector start */
6ea44308 1050 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
83f64091
FB
1051 if (len > count)
1052 len = count;
6ea44308 1053 sector_num = offset >> BDRV_SECTOR_BITS;
83f64091 1054 if (len > 0) {
9a8c4cce
KW
1055 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1056 return ret;
6ea44308 1057 memcpy(tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), buf, len);
9a8c4cce
KW
1058 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
1059 return ret;
83f64091
FB
1060 count -= len;
1061 if (count == 0)
1062 return count1;
1063 sector_num++;
1064 buf += len;
1065 }
1066
1067 /* write the sectors "in place" */
6ea44308 1068 nb_sectors = count >> BDRV_SECTOR_BITS;
83f64091 1069 if (nb_sectors > 0) {
9a8c4cce
KW
1070 if ((ret = bdrv_write(bs, sector_num, buf, nb_sectors)) < 0)
1071 return ret;
83f64091 1072 sector_num += nb_sectors;
6ea44308 1073 len = nb_sectors << BDRV_SECTOR_BITS;
83f64091
FB
1074 buf += len;
1075 count -= len;
1076 }
1077
1078 /* add data from the last sector */
1079 if (count > 0) {
9a8c4cce
KW
1080 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1081 return ret;
83f64091 1082 memcpy(tmp_buf, buf, count);
9a8c4cce
KW
1083 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
1084 return ret;
83f64091
FB
1085 }
1086 return count1;
1087}
83f64091 1088
f08145fe
KW
1089/*
1090 * Writes to the file and ensures that no writes are reordered across this
1091 * request (acts as a barrier)
1092 *
1093 * Returns 0 on success, -errno in error cases.
1094 */
1095int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
1096 const void *buf, int count)
1097{
1098 int ret;
1099
1100 ret = bdrv_pwrite(bs, offset, buf, count);
1101 if (ret < 0) {
1102 return ret;
1103 }
1104
1105 /* No flush needed for cache=writethrough, it uses O_DSYNC */
1106 if ((bs->open_flags & BDRV_O_CACHE_MASK) != 0) {
1107 bdrv_flush(bs);
1108 }
1109
1110 return 0;
1111}
1112
83f64091
FB
1113/**
1114 * Truncate file to 'offset' bytes (needed only for file protocols)
1115 */
1116int bdrv_truncate(BlockDriverState *bs, int64_t offset)
1117{
1118 BlockDriver *drv = bs->drv;
51762288 1119 int ret;
83f64091 1120 if (!drv)
19cb3738 1121 return -ENOMEDIUM;
83f64091
FB
1122 if (!drv->bdrv_truncate)
1123 return -ENOTSUP;
59f2689d
NS
1124 if (bs->read_only)
1125 return -EACCES;
8591675f
MT
1126 if (bdrv_in_use(bs))
1127 return -EBUSY;
51762288
SH
1128 ret = drv->bdrv_truncate(bs, offset);
1129 if (ret == 0) {
1130 ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
db97ee6a
CH
1131 if (bs->change_cb) {
1132 bs->change_cb(bs->change_opaque, CHANGE_SIZE);
1133 }
51762288
SH
1134 }
1135 return ret;
83f64091
FB
1136}
1137
4a1d5e1f
FZ
1138/**
1139 * Length of a allocated file in bytes. Sparse files are counted by actual
1140 * allocated space. Return < 0 if error or unknown.
1141 */
1142int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
1143{
1144 BlockDriver *drv = bs->drv;
1145 if (!drv) {
1146 return -ENOMEDIUM;
1147 }
1148 if (drv->bdrv_get_allocated_file_size) {
1149 return drv->bdrv_get_allocated_file_size(bs);
1150 }
1151 if (bs->file) {
1152 return bdrv_get_allocated_file_size(bs->file);
1153 }
1154 return -ENOTSUP;
1155}
1156
83f64091
FB
1157/**
1158 * Length of a file in bytes. Return < 0 if error or unknown.
1159 */
1160int64_t bdrv_getlength(BlockDriverState *bs)
1161{
1162 BlockDriver *drv = bs->drv;
1163 if (!drv)
19cb3738 1164 return -ENOMEDIUM;
51762288 1165
46a4e4e6
SH
1166 if (bs->growable || bs->removable) {
1167 if (drv->bdrv_getlength) {
1168 return drv->bdrv_getlength(bs);
1169 }
83f64091 1170 }
46a4e4e6 1171 return bs->total_sectors * BDRV_SECTOR_SIZE;
fc01f7e7
FB
1172}
1173
19cb3738 1174/* return 0 as number of sectors if no device present or error */
96b8f136 1175void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
fc01f7e7 1176{
19cb3738
FB
1177 int64_t length;
1178 length = bdrv_getlength(bs);
1179 if (length < 0)
1180 length = 0;
1181 else
6ea44308 1182 length = length >> BDRV_SECTOR_BITS;
19cb3738 1183 *nb_sectors_ptr = length;
fc01f7e7 1184}
cf98951b 1185
f3d54fc4
AL
1186struct partition {
1187 uint8_t boot_ind; /* 0x80 - active */
1188 uint8_t head; /* starting head */
1189 uint8_t sector; /* starting sector */
1190 uint8_t cyl; /* starting cylinder */
1191 uint8_t sys_ind; /* What partition type */
1192 uint8_t end_head; /* end head */
1193 uint8_t end_sector; /* end sector */
1194 uint8_t end_cyl; /* end cylinder */
1195 uint32_t start_sect; /* starting sector counting from 0 */
1196 uint32_t nr_sects; /* nr of sectors in partition */
1197} __attribute__((packed));
1198
1199/* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
1200static int guess_disk_lchs(BlockDriverState *bs,
1201 int *pcylinders, int *pheads, int *psectors)
1202{
eb5a3165 1203 uint8_t buf[BDRV_SECTOR_SIZE];
f3d54fc4
AL
1204 int ret, i, heads, sectors, cylinders;
1205 struct partition *p;
1206 uint32_t nr_sects;
a38131b6 1207 uint64_t nb_sectors;
f3d54fc4
AL
1208
1209 bdrv_get_geometry(bs, &nb_sectors);
1210
1211 ret = bdrv_read(bs, 0, buf, 1);
1212 if (ret < 0)
1213 return -1;
1214 /* test msdos magic */
1215 if (buf[510] != 0x55 || buf[511] != 0xaa)
1216 return -1;
1217 for(i = 0; i < 4; i++) {
1218 p = ((struct partition *)(buf + 0x1be)) + i;
1219 nr_sects = le32_to_cpu(p->nr_sects);
1220 if (nr_sects && p->end_head) {
1221 /* We make the assumption that the partition terminates on
1222 a cylinder boundary */
1223 heads = p->end_head + 1;
1224 sectors = p->end_sector & 63;
1225 if (sectors == 0)
1226 continue;
1227 cylinders = nb_sectors / (heads * sectors);
1228 if (cylinders < 1 || cylinders > 16383)
1229 continue;
1230 *pheads = heads;
1231 *psectors = sectors;
1232 *pcylinders = cylinders;
1233#if 0
1234 printf("guessed geometry: LCHS=%d %d %d\n",
1235 cylinders, heads, sectors);
1236#endif
1237 return 0;
1238 }
1239 }
1240 return -1;
1241}
1242
1243void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs)
1244{
1245 int translation, lba_detected = 0;
1246 int cylinders, heads, secs;
a38131b6 1247 uint64_t nb_sectors;
f3d54fc4
AL
1248
1249 /* if a geometry hint is available, use it */
1250 bdrv_get_geometry(bs, &nb_sectors);
1251 bdrv_get_geometry_hint(bs, &cylinders, &heads, &secs);
1252 translation = bdrv_get_translation_hint(bs);
1253 if (cylinders != 0) {
1254 *pcyls = cylinders;
1255 *pheads = heads;
1256 *psecs = secs;
1257 } else {
1258 if (guess_disk_lchs(bs, &cylinders, &heads, &secs) == 0) {
1259 if (heads > 16) {
1260 /* if heads > 16, it means that a BIOS LBA
1261 translation was active, so the default
1262 hardware geometry is OK */
1263 lba_detected = 1;
1264 goto default_geometry;
1265 } else {
1266 *pcyls = cylinders;
1267 *pheads = heads;
1268 *psecs = secs;
1269 /* disable any translation to be in sync with
1270 the logical geometry */
1271 if (translation == BIOS_ATA_TRANSLATION_AUTO) {
1272 bdrv_set_translation_hint(bs,
1273 BIOS_ATA_TRANSLATION_NONE);
1274 }
1275 }
1276 } else {
1277 default_geometry:
1278 /* if no geometry, use a standard physical disk geometry */
1279 cylinders = nb_sectors / (16 * 63);
1280
1281 if (cylinders > 16383)
1282 cylinders = 16383;
1283 else if (cylinders < 2)
1284 cylinders = 2;
1285 *pcyls = cylinders;
1286 *pheads = 16;
1287 *psecs = 63;
1288 if ((lba_detected == 1) && (translation == BIOS_ATA_TRANSLATION_AUTO)) {
1289 if ((*pcyls * *pheads) <= 131072) {
1290 bdrv_set_translation_hint(bs,
1291 BIOS_ATA_TRANSLATION_LARGE);
1292 } else {
1293 bdrv_set_translation_hint(bs,
1294 BIOS_ATA_TRANSLATION_LBA);
1295 }
1296 }
1297 }
1298 bdrv_set_geometry_hint(bs, *pcyls, *pheads, *psecs);
1299 }
1300}
1301
5fafdf24 1302void bdrv_set_geometry_hint(BlockDriverState *bs,
b338082b
FB
1303 int cyls, int heads, int secs)
1304{
1305 bs->cyls = cyls;
1306 bs->heads = heads;
1307 bs->secs = secs;
1308}
1309
46d4767d
FB
1310void bdrv_set_translation_hint(BlockDriverState *bs, int translation)
1311{
1312 bs->translation = translation;
1313}
1314
5fafdf24 1315void bdrv_get_geometry_hint(BlockDriverState *bs,
b338082b
FB
1316 int *pcyls, int *pheads, int *psecs)
1317{
1318 *pcyls = bs->cyls;
1319 *pheads = bs->heads;
1320 *psecs = bs->secs;
1321}
1322
5bbdbb46
BS
1323/* Recognize floppy formats */
1324typedef struct FDFormat {
1325 FDriveType drive;
1326 uint8_t last_sect;
1327 uint8_t max_track;
1328 uint8_t max_head;
1329} FDFormat;
1330
1331static const FDFormat fd_formats[] = {
1332 /* First entry is default format */
1333 /* 1.44 MB 3"1/2 floppy disks */
1334 { FDRIVE_DRV_144, 18, 80, 1, },
1335 { FDRIVE_DRV_144, 20, 80, 1, },
1336 { FDRIVE_DRV_144, 21, 80, 1, },
1337 { FDRIVE_DRV_144, 21, 82, 1, },
1338 { FDRIVE_DRV_144, 21, 83, 1, },
1339 { FDRIVE_DRV_144, 22, 80, 1, },
1340 { FDRIVE_DRV_144, 23, 80, 1, },
1341 { FDRIVE_DRV_144, 24, 80, 1, },
1342 /* 2.88 MB 3"1/2 floppy disks */
1343 { FDRIVE_DRV_288, 36, 80, 1, },
1344 { FDRIVE_DRV_288, 39, 80, 1, },
1345 { FDRIVE_DRV_288, 40, 80, 1, },
1346 { FDRIVE_DRV_288, 44, 80, 1, },
1347 { FDRIVE_DRV_288, 48, 80, 1, },
1348 /* 720 kB 3"1/2 floppy disks */
1349 { FDRIVE_DRV_144, 9, 80, 1, },
1350 { FDRIVE_DRV_144, 10, 80, 1, },
1351 { FDRIVE_DRV_144, 10, 82, 1, },
1352 { FDRIVE_DRV_144, 10, 83, 1, },
1353 { FDRIVE_DRV_144, 13, 80, 1, },
1354 { FDRIVE_DRV_144, 14, 80, 1, },
1355 /* 1.2 MB 5"1/4 floppy disks */
1356 { FDRIVE_DRV_120, 15, 80, 1, },
1357 { FDRIVE_DRV_120, 18, 80, 1, },
1358 { FDRIVE_DRV_120, 18, 82, 1, },
1359 { FDRIVE_DRV_120, 18, 83, 1, },
1360 { FDRIVE_DRV_120, 20, 80, 1, },
1361 /* 720 kB 5"1/4 floppy disks */
1362 { FDRIVE_DRV_120, 9, 80, 1, },
1363 { FDRIVE_DRV_120, 11, 80, 1, },
1364 /* 360 kB 5"1/4 floppy disks */
1365 { FDRIVE_DRV_120, 9, 40, 1, },
1366 { FDRIVE_DRV_120, 9, 40, 0, },
1367 { FDRIVE_DRV_120, 10, 41, 1, },
1368 { FDRIVE_DRV_120, 10, 42, 1, },
1369 /* 320 kB 5"1/4 floppy disks */
1370 { FDRIVE_DRV_120, 8, 40, 1, },
1371 { FDRIVE_DRV_120, 8, 40, 0, },
1372 /* 360 kB must match 5"1/4 better than 3"1/2... */
1373 { FDRIVE_DRV_144, 9, 80, 0, },
1374 /* end */
1375 { FDRIVE_DRV_NONE, -1, -1, 0, },
1376};
1377
1378void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
1379 int *max_track, int *last_sect,
1380 FDriveType drive_in, FDriveType *drive)
1381{
1382 const FDFormat *parse;
1383 uint64_t nb_sectors, size;
1384 int i, first_match, match;
1385
1386 bdrv_get_geometry_hint(bs, nb_heads, max_track, last_sect);
1387 if (*nb_heads != 0 && *max_track != 0 && *last_sect != 0) {
1388 /* User defined disk */
1389 } else {
1390 bdrv_get_geometry(bs, &nb_sectors);
1391 match = -1;
1392 first_match = -1;
1393 for (i = 0; ; i++) {
1394 parse = &fd_formats[i];
1395 if (parse->drive == FDRIVE_DRV_NONE) {
1396 break;
1397 }
1398 if (drive_in == parse->drive ||
1399 drive_in == FDRIVE_DRV_NONE) {
1400 size = (parse->max_head + 1) * parse->max_track *
1401 parse->last_sect;
1402 if (nb_sectors == size) {
1403 match = i;
1404 break;
1405 }
1406 if (first_match == -1) {
1407 first_match = i;
1408 }
1409 }
1410 }
1411 if (match == -1) {
1412 if (first_match == -1) {
1413 match = 1;
1414 } else {
1415 match = first_match;
1416 }
1417 parse = &fd_formats[match];
1418 }
1419 *nb_heads = parse->max_head + 1;
1420 *max_track = parse->max_track;
1421 *last_sect = parse->last_sect;
1422 *drive = parse->drive;
1423 }
1424}
1425
46d4767d
FB
1426int bdrv_get_translation_hint(BlockDriverState *bs)
1427{
1428 return bs->translation;
1429}
1430
abd7f68d
MA
1431void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
1432 BlockErrorAction on_write_error)
1433{
1434 bs->on_read_error = on_read_error;
1435 bs->on_write_error = on_write_error;
1436}
1437
1438BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read)
1439{
1440 return is_read ? bs->on_read_error : bs->on_write_error;
1441}
1442
7d0d6950
MA
1443void bdrv_set_removable(BlockDriverState *bs, int removable)
1444{
1445 bs->removable = removable;
1446 if (removable && bs == bs_snapshots) {
1447 bs_snapshots = NULL;
1448 }
1449}
1450
b338082b
FB
1451int bdrv_is_removable(BlockDriverState *bs)
1452{
1453 return bs->removable;
1454}
1455
1456int bdrv_is_read_only(BlockDriverState *bs)
1457{
1458 return bs->read_only;
1459}
1460
985a03b0
TS
1461int bdrv_is_sg(BlockDriverState *bs)
1462{
1463 return bs->sg;
1464}
1465
e900a7b7
CH
1466int bdrv_enable_write_cache(BlockDriverState *bs)
1467{
1468 return bs->enable_write_cache;
1469}
1470
19cb3738 1471/* XXX: no longer used */
5fafdf24 1472void bdrv_set_change_cb(BlockDriverState *bs,
db97ee6a
CH
1473 void (*change_cb)(void *opaque, int reason),
1474 void *opaque)
b338082b
FB
1475{
1476 bs->change_cb = change_cb;
1477 bs->change_opaque = opaque;
1478}
1479
ea2384d3
FB
1480int bdrv_is_encrypted(BlockDriverState *bs)
1481{
1482 if (bs->backing_hd && bs->backing_hd->encrypted)
1483 return 1;
1484 return bs->encrypted;
1485}
1486
c0f4ce77
AL
1487int bdrv_key_required(BlockDriverState *bs)
1488{
1489 BlockDriverState *backing_hd = bs->backing_hd;
1490
1491 if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
1492 return 1;
1493 return (bs->encrypted && !bs->valid_key);
1494}
1495
ea2384d3
FB
1496int bdrv_set_key(BlockDriverState *bs, const char *key)
1497{
1498 int ret;
1499 if (bs->backing_hd && bs->backing_hd->encrypted) {
1500 ret = bdrv_set_key(bs->backing_hd, key);
1501 if (ret < 0)
1502 return ret;
1503 if (!bs->encrypted)
1504 return 0;
1505 }
fd04a2ae
SH
1506 if (!bs->encrypted) {
1507 return -EINVAL;
1508 } else if (!bs->drv || !bs->drv->bdrv_set_key) {
1509 return -ENOMEDIUM;
1510 }
c0f4ce77 1511 ret = bs->drv->bdrv_set_key(bs, key);
bb5fc20f
AL
1512 if (ret < 0) {
1513 bs->valid_key = 0;
1514 } else if (!bs->valid_key) {
1515 bs->valid_key = 1;
1516 /* call the change callback now, we skipped it on open */
1517 bs->media_changed = 1;
1518 if (bs->change_cb)
db97ee6a 1519 bs->change_cb(bs->change_opaque, CHANGE_MEDIA);
bb5fc20f 1520 }
c0f4ce77 1521 return ret;
ea2384d3
FB
1522}
1523
1524void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size)
1525{
19cb3738 1526 if (!bs->drv) {
ea2384d3
FB
1527 buf[0] = '\0';
1528 } else {
1529 pstrcpy(buf, buf_size, bs->drv->format_name);
1530 }
1531}
1532
5fafdf24 1533void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
ea2384d3
FB
1534 void *opaque)
1535{
1536 BlockDriver *drv;
1537
8a22f02a 1538 QLIST_FOREACH(drv, &bdrv_drivers, list) {
ea2384d3
FB
1539 it(opaque, drv->format_name);
1540 }
1541}
1542
b338082b
FB
1543BlockDriverState *bdrv_find(const char *name)
1544{
1545 BlockDriverState *bs;
1546
1b7bdbc1
SH
1547 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1548 if (!strcmp(name, bs->device_name)) {
b338082b 1549 return bs;
1b7bdbc1 1550 }
b338082b
FB
1551 }
1552 return NULL;
1553}
1554
2f399b0a
MA
1555BlockDriverState *bdrv_next(BlockDriverState *bs)
1556{
1557 if (!bs) {
1558 return QTAILQ_FIRST(&bdrv_states);
1559 }
1560 return QTAILQ_NEXT(bs, list);
1561}
1562
51de9760 1563void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
81d0912d
FB
1564{
1565 BlockDriverState *bs;
1566
1b7bdbc1 1567 QTAILQ_FOREACH(bs, &bdrv_states, list) {
51de9760 1568 it(opaque, bs);
81d0912d
FB
1569 }
1570}
1571
ea2384d3
FB
1572const char *bdrv_get_device_name(BlockDriverState *bs)
1573{
1574 return bs->device_name;
1575}
1576
205ef796 1577int bdrv_flush(BlockDriverState *bs)
7a6cba61 1578{
016f5cf6 1579 if (bs->open_flags & BDRV_O_NO_FLUSH) {
205ef796
KW
1580 return 0;
1581 }
1582
1583 if (bs->drv && bs->drv->bdrv_flush) {
1584 return bs->drv->bdrv_flush(bs);
016f5cf6
AG
1585 }
1586
205ef796
KW
1587 /*
1588 * Some block drivers always operate in either writethrough or unsafe mode
1589 * and don't support bdrv_flush therefore. Usually qemu doesn't know how
1590 * the server works (because the behaviour is hardcoded or depends on
1591 * server-side configuration), so we can't ensure that everything is safe
1592 * on disk. Returning an error doesn't work because that would break guests
1593 * even if the server operates in writethrough mode.
1594 *
1595 * Let's hope the user knows what he's doing.
1596 */
1597 return 0;
7a6cba61
PB
1598}
1599
c6ca28d6
AL
1600void bdrv_flush_all(void)
1601{
1602 BlockDriverState *bs;
1603
1b7bdbc1
SH
1604 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1605 if (bs->drv && !bdrv_is_read_only(bs) &&
1606 (!bdrv_is_removable(bs) || bdrv_is_inserted(bs))) {
c6ca28d6 1607 bdrv_flush(bs);
1b7bdbc1
SH
1608 }
1609 }
c6ca28d6
AL
1610}
1611
f2feebbd
KW
1612int bdrv_has_zero_init(BlockDriverState *bs)
1613{
1614 assert(bs->drv);
1615
336c1c12
KW
1616 if (bs->drv->bdrv_has_zero_init) {
1617 return bs->drv->bdrv_has_zero_init(bs);
f2feebbd
KW
1618 }
1619
1620 return 1;
1621}
1622
bb8bf76f
CH
1623int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
1624{
1625 if (!bs->drv) {
1626 return -ENOMEDIUM;
1627 }
1628 if (!bs->drv->bdrv_discard) {
1629 return 0;
1630 }
1631 return bs->drv->bdrv_discard(bs, sector_num, nb_sectors);
1632}
1633
f58c7b35
TS
1634/*
1635 * Returns true iff the specified sector is present in the disk image. Drivers
1636 * not implementing the functionality are assumed to not support backing files,
1637 * hence all their sectors are reported as allocated.
1638 *
1639 * 'pnum' is set to the number of sectors (including and immediately following
1640 * the specified sector) that are known to be in the same
1641 * allocated/unallocated state.
1642 *
1643 * 'nb_sectors' is the max value 'pnum' should be set to.
1644 */
1645int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
1646 int *pnum)
1647{
1648 int64_t n;
1649 if (!bs->drv->bdrv_is_allocated) {
1650 if (sector_num >= bs->total_sectors) {
1651 *pnum = 0;
1652 return 0;
1653 }
1654 n = bs->total_sectors - sector_num;
1655 *pnum = (n < nb_sectors) ? (n) : (nb_sectors);
1656 return 1;
1657 }
1658 return bs->drv->bdrv_is_allocated(bs, sector_num, nb_sectors, pnum);
1659}
1660
2582bfed
LC
1661void bdrv_mon_event(const BlockDriverState *bdrv,
1662 BlockMonEventAction action, int is_read)
1663{
1664 QObject *data;
1665 const char *action_str;
1666
1667 switch (action) {
1668 case BDRV_ACTION_REPORT:
1669 action_str = "report";
1670 break;
1671 case BDRV_ACTION_IGNORE:
1672 action_str = "ignore";
1673 break;
1674 case BDRV_ACTION_STOP:
1675 action_str = "stop";
1676 break;
1677 default:
1678 abort();
1679 }
1680
1681 data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
1682 bdrv->device_name,
1683 action_str,
1684 is_read ? "read" : "write");
1685 monitor_protocol_event(QEVENT_BLOCK_IO_ERROR, data);
1686
1687 qobject_decref(data);
1688}
1689
d15e5465 1690static void bdrv_print_dict(QObject *obj, void *opaque)
b338082b 1691{
d15e5465
LC
1692 QDict *bs_dict;
1693 Monitor *mon = opaque;
1694
1695 bs_dict = qobject_to_qdict(obj);
1696
d8aeeb31 1697 monitor_printf(mon, "%s: removable=%d",
d15e5465 1698 qdict_get_str(bs_dict, "device"),
d15e5465
LC
1699 qdict_get_bool(bs_dict, "removable"));
1700
1701 if (qdict_get_bool(bs_dict, "removable")) {
1702 monitor_printf(mon, " locked=%d", qdict_get_bool(bs_dict, "locked"));
1703 }
1704
1705 if (qdict_haskey(bs_dict, "inserted")) {
1706 QDict *qdict = qobject_to_qdict(qdict_get(bs_dict, "inserted"));
1707
1708 monitor_printf(mon, " file=");
1709 monitor_print_filename(mon, qdict_get_str(qdict, "file"));
1710 if (qdict_haskey(qdict, "backing_file")) {
1711 monitor_printf(mon, " backing_file=");
1712 monitor_print_filename(mon, qdict_get_str(qdict, "backing_file"));
1713 }
1714 monitor_printf(mon, " ro=%d drv=%s encrypted=%d",
1715 qdict_get_bool(qdict, "ro"),
1716 qdict_get_str(qdict, "drv"),
1717 qdict_get_bool(qdict, "encrypted"));
1718 } else {
1719 monitor_printf(mon, " [not inserted]");
1720 }
1721
1722 monitor_printf(mon, "\n");
1723}
1724
1725void bdrv_info_print(Monitor *mon, const QObject *data)
1726{
1727 qlist_iter(qobject_to_qlist(data), bdrv_print_dict, mon);
1728}
1729
d15e5465
LC
1730void bdrv_info(Monitor *mon, QObject **ret_data)
1731{
1732 QList *bs_list;
b338082b
FB
1733 BlockDriverState *bs;
1734
d15e5465
LC
1735 bs_list = qlist_new();
1736
1b7bdbc1 1737 QTAILQ_FOREACH(bs, &bdrv_states, list) {
d15e5465 1738 QObject *bs_obj;
d15e5465 1739
d8aeeb31 1740 bs_obj = qobject_from_jsonf("{ 'device': %s, 'type': 'unknown', "
d15e5465 1741 "'removable': %i, 'locked': %i }",
d8aeeb31 1742 bs->device_name, bs->removable,
d15e5465 1743 bs->locked);
d15e5465 1744
19cb3738 1745 if (bs->drv) {
d15e5465
LC
1746 QObject *obj;
1747 QDict *bs_dict = qobject_to_qdict(bs_obj);
1748
1749 obj = qobject_from_jsonf("{ 'file': %s, 'ro': %i, 'drv': %s, "
1750 "'encrypted': %i }",
1751 bs->filename, bs->read_only,
1752 bs->drv->format_name,
1753 bdrv_is_encrypted(bs));
fef30743 1754 if (bs->backing_file[0] != '\0') {
d15e5465
LC
1755 QDict *qdict = qobject_to_qdict(obj);
1756 qdict_put(qdict, "backing_file",
1757 qstring_from_str(bs->backing_file));
376253ec 1758 }
d15e5465
LC
1759
1760 qdict_put_obj(bs_dict, "inserted", obj);
b338082b 1761 }
d15e5465 1762 qlist_append_obj(bs_list, bs_obj);
b338082b 1763 }
d15e5465
LC
1764
1765 *ret_data = QOBJECT(bs_list);
b338082b 1766}
a36e69dd 1767
218a536a 1768static void bdrv_stats_iter(QObject *data, void *opaque)
a36e69dd 1769{
218a536a
LC
1770 QDict *qdict;
1771 Monitor *mon = opaque;
1772
1773 qdict = qobject_to_qdict(data);
1774 monitor_printf(mon, "%s:", qdict_get_str(qdict, "device"));
1775
1776 qdict = qobject_to_qdict(qdict_get(qdict, "stats"));
1777 monitor_printf(mon, " rd_bytes=%" PRId64
1778 " wr_bytes=%" PRId64
1779 " rd_operations=%" PRId64
1780 " wr_operations=%" PRId64
1781 "\n",
1782 qdict_get_int(qdict, "rd_bytes"),
1783 qdict_get_int(qdict, "wr_bytes"),
1784 qdict_get_int(qdict, "rd_operations"),
1785 qdict_get_int(qdict, "wr_operations"));
1786}
1787
1788void bdrv_stats_print(Monitor *mon, const QObject *data)
1789{
1790 qlist_iter(qobject_to_qlist(data), bdrv_stats_iter, mon);
1791}
1792
294cc35f
KW
1793static QObject* bdrv_info_stats_bs(BlockDriverState *bs)
1794{
1795 QObject *res;
1796 QDict *dict;
1797
1798 res = qobject_from_jsonf("{ 'stats': {"
1799 "'rd_bytes': %" PRId64 ","
1800 "'wr_bytes': %" PRId64 ","
1801 "'rd_operations': %" PRId64 ","
1802 "'wr_operations': %" PRId64 ","
1803 "'wr_highest_offset': %" PRId64
1804 "} }",
1805 bs->rd_bytes, bs->wr_bytes,
1806 bs->rd_ops, bs->wr_ops,
5ffbbc67
BS
1807 bs->wr_highest_sector *
1808 (uint64_t)BDRV_SECTOR_SIZE);
294cc35f
KW
1809 dict = qobject_to_qdict(res);
1810
1811 if (*bs->device_name) {
1812 qdict_put(dict, "device", qstring_from_str(bs->device_name));
1813 }
1814
1815 if (bs->file) {
1816 QObject *parent = bdrv_info_stats_bs(bs->file);
1817 qdict_put_obj(dict, "parent", parent);
1818 }
1819
1820 return res;
1821}
1822
218a536a
LC
1823void bdrv_info_stats(Monitor *mon, QObject **ret_data)
1824{
1825 QObject *obj;
1826 QList *devices;
a36e69dd
TS
1827 BlockDriverState *bs;
1828
218a536a
LC
1829 devices = qlist_new();
1830
1b7bdbc1 1831 QTAILQ_FOREACH(bs, &bdrv_states, list) {
294cc35f 1832 obj = bdrv_info_stats_bs(bs);
218a536a 1833 qlist_append_obj(devices, obj);
a36e69dd 1834 }
218a536a
LC
1835
1836 *ret_data = QOBJECT(devices);
a36e69dd 1837}
ea2384d3 1838
045df330
AL
1839const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
1840{
1841 if (bs->backing_hd && bs->backing_hd->encrypted)
1842 return bs->backing_file;
1843 else if (bs->encrypted)
1844 return bs->filename;
1845 else
1846 return NULL;
1847}
1848
5fafdf24 1849void bdrv_get_backing_filename(BlockDriverState *bs,
83f64091
FB
1850 char *filename, int filename_size)
1851{
b783e409 1852 if (!bs->backing_file) {
83f64091
FB
1853 pstrcpy(filename, filename_size, "");
1854 } else {
1855 pstrcpy(filename, filename_size, bs->backing_file);
1856 }
1857}
1858
5fafdf24 1859int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
faea38e7
FB
1860 const uint8_t *buf, int nb_sectors)
1861{
1862 BlockDriver *drv = bs->drv;
1863 if (!drv)
19cb3738 1864 return -ENOMEDIUM;
faea38e7
FB
1865 if (!drv->bdrv_write_compressed)
1866 return -ENOTSUP;
fbb7b4e0
KW
1867 if (bdrv_check_request(bs, sector_num, nb_sectors))
1868 return -EIO;
a55eb92c 1869
c6d22830 1870 if (bs->dirty_bitmap) {
7cd1e32a
LS
1871 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
1872 }
a55eb92c 1873
faea38e7
FB
1874 return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
1875}
3b46e624 1876
faea38e7
FB
1877int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1878{
1879 BlockDriver *drv = bs->drv;
1880 if (!drv)
19cb3738 1881 return -ENOMEDIUM;
faea38e7
FB
1882 if (!drv->bdrv_get_info)
1883 return -ENOTSUP;
1884 memset(bdi, 0, sizeof(*bdi));
1885 return drv->bdrv_get_info(bs, bdi);
1886}
1887
45566e9c
CH
1888int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
1889 int64_t pos, int size)
178e08a5
AL
1890{
1891 BlockDriver *drv = bs->drv;
1892 if (!drv)
1893 return -ENOMEDIUM;
7cdb1f6d
MK
1894 if (drv->bdrv_save_vmstate)
1895 return drv->bdrv_save_vmstate(bs, buf, pos, size);
1896 if (bs->file)
1897 return bdrv_save_vmstate(bs->file, buf, pos, size);
1898 return -ENOTSUP;
178e08a5
AL
1899}
1900
45566e9c
CH
1901int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
1902 int64_t pos, int size)
178e08a5
AL
1903{
1904 BlockDriver *drv = bs->drv;
1905 if (!drv)
1906 return -ENOMEDIUM;
7cdb1f6d
MK
1907 if (drv->bdrv_load_vmstate)
1908 return drv->bdrv_load_vmstate(bs, buf, pos, size);
1909 if (bs->file)
1910 return bdrv_load_vmstate(bs->file, buf, pos, size);
1911 return -ENOTSUP;
178e08a5
AL
1912}
1913
8b9b0cc2
KW
1914void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
1915{
1916 BlockDriver *drv = bs->drv;
1917
1918 if (!drv || !drv->bdrv_debug_event) {
1919 return;
1920 }
1921
1922 return drv->bdrv_debug_event(bs, event);
1923
1924}
1925
faea38e7
FB
1926/**************************************************************/
1927/* handling of snapshots */
1928
feeee5ac
MDCF
1929int bdrv_can_snapshot(BlockDriverState *bs)
1930{
1931 BlockDriver *drv = bs->drv;
1932 if (!drv || bdrv_is_removable(bs) || bdrv_is_read_only(bs)) {
1933 return 0;
1934 }
1935
1936 if (!drv->bdrv_snapshot_create) {
1937 if (bs->file != NULL) {
1938 return bdrv_can_snapshot(bs->file);
1939 }
1940 return 0;
1941 }
1942
1943 return 1;
1944}
1945
199630b6
BS
1946int bdrv_is_snapshot(BlockDriverState *bs)
1947{
1948 return !!(bs->open_flags & BDRV_O_SNAPSHOT);
1949}
1950
f9092b10
MA
1951BlockDriverState *bdrv_snapshots(void)
1952{
1953 BlockDriverState *bs;
1954
3ac906f7 1955 if (bs_snapshots) {
f9092b10 1956 return bs_snapshots;
3ac906f7 1957 }
f9092b10
MA
1958
1959 bs = NULL;
1960 while ((bs = bdrv_next(bs))) {
1961 if (bdrv_can_snapshot(bs)) {
3ac906f7
MA
1962 bs_snapshots = bs;
1963 return bs;
f9092b10
MA
1964 }
1965 }
1966 return NULL;
f9092b10
MA
1967}
1968
5fafdf24 1969int bdrv_snapshot_create(BlockDriverState *bs,
faea38e7
FB
1970 QEMUSnapshotInfo *sn_info)
1971{
1972 BlockDriver *drv = bs->drv;
1973 if (!drv)
19cb3738 1974 return -ENOMEDIUM;
7cdb1f6d
MK
1975 if (drv->bdrv_snapshot_create)
1976 return drv->bdrv_snapshot_create(bs, sn_info);
1977 if (bs->file)
1978 return bdrv_snapshot_create(bs->file, sn_info);
1979 return -ENOTSUP;
faea38e7
FB
1980}
1981
5fafdf24 1982int bdrv_snapshot_goto(BlockDriverState *bs,
faea38e7
FB
1983 const char *snapshot_id)
1984{
1985 BlockDriver *drv = bs->drv;
7cdb1f6d
MK
1986 int ret, open_ret;
1987
faea38e7 1988 if (!drv)
19cb3738 1989 return -ENOMEDIUM;
7cdb1f6d
MK
1990 if (drv->bdrv_snapshot_goto)
1991 return drv->bdrv_snapshot_goto(bs, snapshot_id);
1992
1993 if (bs->file) {
1994 drv->bdrv_close(bs);
1995 ret = bdrv_snapshot_goto(bs->file, snapshot_id);
1996 open_ret = drv->bdrv_open(bs, bs->open_flags);
1997 if (open_ret < 0) {
1998 bdrv_delete(bs->file);
1999 bs->drv = NULL;
2000 return open_ret;
2001 }
2002 return ret;
2003 }
2004
2005 return -ENOTSUP;
faea38e7
FB
2006}
2007
2008int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
2009{
2010 BlockDriver *drv = bs->drv;
2011 if (!drv)
19cb3738 2012 return -ENOMEDIUM;
7cdb1f6d
MK
2013 if (drv->bdrv_snapshot_delete)
2014 return drv->bdrv_snapshot_delete(bs, snapshot_id);
2015 if (bs->file)
2016 return bdrv_snapshot_delete(bs->file, snapshot_id);
2017 return -ENOTSUP;
faea38e7
FB
2018}
2019
5fafdf24 2020int bdrv_snapshot_list(BlockDriverState *bs,
faea38e7
FB
2021 QEMUSnapshotInfo **psn_info)
2022{
2023 BlockDriver *drv = bs->drv;
2024 if (!drv)
19cb3738 2025 return -ENOMEDIUM;
7cdb1f6d
MK
2026 if (drv->bdrv_snapshot_list)
2027 return drv->bdrv_snapshot_list(bs, psn_info);
2028 if (bs->file)
2029 return bdrv_snapshot_list(bs->file, psn_info);
2030 return -ENOTSUP;
faea38e7
FB
2031}
2032
51ef6727 2033int bdrv_snapshot_load_tmp(BlockDriverState *bs,
2034 const char *snapshot_name)
2035{
2036 BlockDriver *drv = bs->drv;
2037 if (!drv) {
2038 return -ENOMEDIUM;
2039 }
2040 if (!bs->read_only) {
2041 return -EINVAL;
2042 }
2043 if (drv->bdrv_snapshot_load_tmp) {
2044 return drv->bdrv_snapshot_load_tmp(bs, snapshot_name);
2045 }
2046 return -ENOTSUP;
2047}
2048
faea38e7
FB
2049#define NB_SUFFIXES 4
2050
2051char *get_human_readable_size(char *buf, int buf_size, int64_t size)
2052{
2053 static const char suffixes[NB_SUFFIXES] = "KMGT";
2054 int64_t base;
2055 int i;
2056
2057 if (size <= 999) {
2058 snprintf(buf, buf_size, "%" PRId64, size);
2059 } else {
2060 base = 1024;
2061 for(i = 0; i < NB_SUFFIXES; i++) {
2062 if (size < (10 * base)) {
5fafdf24 2063 snprintf(buf, buf_size, "%0.1f%c",
faea38e7
FB
2064 (double)size / base,
2065 suffixes[i]);
2066 break;
2067 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
5fafdf24 2068 snprintf(buf, buf_size, "%" PRId64 "%c",
faea38e7
FB
2069 ((size + (base >> 1)) / base),
2070 suffixes[i]);
2071 break;
2072 }
2073 base = base * 1024;
2074 }
2075 }
2076 return buf;
2077}
2078
2079char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
2080{
2081 char buf1[128], date_buf[128], clock_buf[128];
3b9f94e1
FB
2082#ifdef _WIN32
2083 struct tm *ptm;
2084#else
faea38e7 2085 struct tm tm;
3b9f94e1 2086#endif
faea38e7
FB
2087 time_t ti;
2088 int64_t secs;
2089
2090 if (!sn) {
5fafdf24
TS
2091 snprintf(buf, buf_size,
2092 "%-10s%-20s%7s%20s%15s",
faea38e7
FB
2093 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
2094 } else {
2095 ti = sn->date_sec;
3b9f94e1
FB
2096#ifdef _WIN32
2097 ptm = localtime(&ti);
2098 strftime(date_buf, sizeof(date_buf),
2099 "%Y-%m-%d %H:%M:%S", ptm);
2100#else
faea38e7
FB
2101 localtime_r(&ti, &tm);
2102 strftime(date_buf, sizeof(date_buf),
2103 "%Y-%m-%d %H:%M:%S", &tm);
3b9f94e1 2104#endif
faea38e7
FB
2105 secs = sn->vm_clock_nsec / 1000000000;
2106 snprintf(clock_buf, sizeof(clock_buf),
2107 "%02d:%02d:%02d.%03d",
2108 (int)(secs / 3600),
2109 (int)((secs / 60) % 60),
5fafdf24 2110 (int)(secs % 60),
faea38e7
FB
2111 (int)((sn->vm_clock_nsec / 1000000) % 1000));
2112 snprintf(buf, buf_size,
5fafdf24 2113 "%-10s%-20s%7s%20s%15s",
faea38e7
FB
2114 sn->id_str, sn->name,
2115 get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
2116 date_buf,
2117 clock_buf);
2118 }
2119 return buf;
2120}
2121
83f64091 2122
ea2384d3 2123/**************************************************************/
83f64091 2124/* async I/Os */
ea2384d3 2125
3b69e4b9 2126BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
f141eafe 2127 QEMUIOVector *qiov, int nb_sectors,
3b69e4b9 2128 BlockDriverCompletionFunc *cb, void *opaque)
83f64091
FB
2129{
2130 BlockDriver *drv = bs->drv;
a36e69dd 2131 BlockDriverAIOCB *ret;
83f64091 2132
bbf0a440
SH
2133 trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque);
2134
19cb3738 2135 if (!drv)
ce1a14dc 2136 return NULL;
71d0770c
AL
2137 if (bdrv_check_request(bs, sector_num, nb_sectors))
2138 return NULL;
3b46e624 2139
f141eafe
AL
2140 ret = drv->bdrv_aio_readv(bs, sector_num, qiov, nb_sectors,
2141 cb, opaque);
a36e69dd
TS
2142
2143 if (ret) {
2144 /* Update stats even though technically transfer has not happened. */
6ea44308 2145 bs->rd_bytes += (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
a36e69dd
TS
2146 bs->rd_ops ++;
2147 }
2148
2149 return ret;
ea2384d3
FB
2150}
2151
4dcafbb1
MT
2152typedef struct BlockCompleteData {
2153 BlockDriverCompletionFunc *cb;
2154 void *opaque;
2155 BlockDriverState *bs;
2156 int64_t sector_num;
2157 int nb_sectors;
2158} BlockCompleteData;
2159
2160static void block_complete_cb(void *opaque, int ret)
2161{
2162 BlockCompleteData *b = opaque;
2163
2164 if (b->bs->dirty_bitmap) {
2165 set_dirty_bitmap(b->bs, b->sector_num, b->nb_sectors, 1);
2166 }
2167 b->cb(b->opaque, ret);
2168 qemu_free(b);
2169}
2170
2171static BlockCompleteData *blk_dirty_cb_alloc(BlockDriverState *bs,
2172 int64_t sector_num,
2173 int nb_sectors,
2174 BlockDriverCompletionFunc *cb,
2175 void *opaque)
2176{
2177 BlockCompleteData *blkdata = qemu_mallocz(sizeof(BlockCompleteData));
2178
2179 blkdata->bs = bs;
2180 blkdata->cb = cb;
2181 blkdata->opaque = opaque;
2182 blkdata->sector_num = sector_num;
2183 blkdata->nb_sectors = nb_sectors;
2184
2185 return blkdata;
2186}
2187
f141eafe
AL
2188BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
2189 QEMUIOVector *qiov, int nb_sectors,
2190 BlockDriverCompletionFunc *cb, void *opaque)
ea2384d3 2191{
83f64091 2192 BlockDriver *drv = bs->drv;
a36e69dd 2193 BlockDriverAIOCB *ret;
4dcafbb1 2194 BlockCompleteData *blk_cb_data;
ea2384d3 2195
bbf0a440
SH
2196 trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque);
2197
19cb3738 2198 if (!drv)
ce1a14dc 2199 return NULL;
83f64091 2200 if (bs->read_only)
ce1a14dc 2201 return NULL;
71d0770c
AL
2202 if (bdrv_check_request(bs, sector_num, nb_sectors))
2203 return NULL;
83f64091 2204
c6d22830 2205 if (bs->dirty_bitmap) {
4dcafbb1
MT
2206 blk_cb_data = blk_dirty_cb_alloc(bs, sector_num, nb_sectors, cb,
2207 opaque);
2208 cb = &block_complete_cb;
2209 opaque = blk_cb_data;
7cd1e32a 2210 }
a55eb92c 2211
f141eafe
AL
2212 ret = drv->bdrv_aio_writev(bs, sector_num, qiov, nb_sectors,
2213 cb, opaque);
a36e69dd
TS
2214
2215 if (ret) {
294cc35f
KW
2216 /* Update stats even though technically transfer has not happened. */
2217 bs->wr_bytes += (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
2218 bs->wr_ops ++;
2219 if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
2220 bs->wr_highest_sector = sector_num + nb_sectors - 1;
2221 }
a36e69dd
TS
2222 }
2223
2224 return ret;
83f64091
FB
2225}
2226
40b4f539
KW
2227
2228typedef struct MultiwriteCB {
2229 int error;
2230 int num_requests;
2231 int num_callbacks;
2232 struct {
2233 BlockDriverCompletionFunc *cb;
2234 void *opaque;
2235 QEMUIOVector *free_qiov;
2236 void *free_buf;
2237 } callbacks[];
2238} MultiwriteCB;
2239
2240static void multiwrite_user_cb(MultiwriteCB *mcb)
2241{
2242 int i;
2243
2244 for (i = 0; i < mcb->num_callbacks; i++) {
2245 mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
1e1ea48d
SH
2246 if (mcb->callbacks[i].free_qiov) {
2247 qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
2248 }
40b4f539 2249 qemu_free(mcb->callbacks[i].free_qiov);
f8a83245 2250 qemu_vfree(mcb->callbacks[i].free_buf);
40b4f539
KW
2251 }
2252}
2253
2254static void multiwrite_cb(void *opaque, int ret)
2255{
2256 MultiwriteCB *mcb = opaque;
2257
6d519a5f
SH
2258 trace_multiwrite_cb(mcb, ret);
2259
cb6d3ca0 2260 if (ret < 0 && !mcb->error) {
40b4f539 2261 mcb->error = ret;
40b4f539
KW
2262 }
2263
2264 mcb->num_requests--;
2265 if (mcb->num_requests == 0) {
de189a1b 2266 multiwrite_user_cb(mcb);
40b4f539
KW
2267 qemu_free(mcb);
2268 }
2269}
2270
2271static int multiwrite_req_compare(const void *a, const void *b)
2272{
77be4366
CH
2273 const BlockRequest *req1 = a, *req2 = b;
2274
2275 /*
2276 * Note that we can't simply subtract req2->sector from req1->sector
2277 * here as that could overflow the return value.
2278 */
2279 if (req1->sector > req2->sector) {
2280 return 1;
2281 } else if (req1->sector < req2->sector) {
2282 return -1;
2283 } else {
2284 return 0;
2285 }
40b4f539
KW
2286}
2287
2288/*
2289 * Takes a bunch of requests and tries to merge them. Returns the number of
2290 * requests that remain after merging.
2291 */
2292static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
2293 int num_reqs, MultiwriteCB *mcb)
2294{
2295 int i, outidx;
2296
2297 // Sort requests by start sector
2298 qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
2299
2300 // Check if adjacent requests touch the same clusters. If so, combine them,
2301 // filling up gaps with zero sectors.
2302 outidx = 0;
2303 for (i = 1; i < num_reqs; i++) {
2304 int merge = 0;
2305 int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
2306
2307 // This handles the cases that are valid for all block drivers, namely
2308 // exactly sequential writes and overlapping writes.
2309 if (reqs[i].sector <= oldreq_last) {
2310 merge = 1;
2311 }
2312
2313 // The block driver may decide that it makes sense to combine requests
2314 // even if there is a gap of some sectors between them. In this case,
2315 // the gap is filled with zeros (therefore only applicable for yet
2316 // unused space in format like qcow2).
2317 if (!merge && bs->drv->bdrv_merge_requests) {
2318 merge = bs->drv->bdrv_merge_requests(bs, &reqs[outidx], &reqs[i]);
2319 }
2320
e2a305fb
CH
2321 if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
2322 merge = 0;
2323 }
2324
40b4f539
KW
2325 if (merge) {
2326 size_t size;
2327 QEMUIOVector *qiov = qemu_mallocz(sizeof(*qiov));
2328 qemu_iovec_init(qiov,
2329 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
2330
2331 // Add the first request to the merged one. If the requests are
2332 // overlapping, drop the last sectors of the first request.
2333 size = (reqs[i].sector - reqs[outidx].sector) << 9;
2334 qemu_iovec_concat(qiov, reqs[outidx].qiov, size);
2335
2336 // We might need to add some zeros between the two requests
2337 if (reqs[i].sector > oldreq_last) {
2338 size_t zero_bytes = (reqs[i].sector - oldreq_last) << 9;
2339 uint8_t *buf = qemu_blockalign(bs, zero_bytes);
2340 memset(buf, 0, zero_bytes);
2341 qemu_iovec_add(qiov, buf, zero_bytes);
2342 mcb->callbacks[i].free_buf = buf;
2343 }
2344
2345 // Add the second request
2346 qemu_iovec_concat(qiov, reqs[i].qiov, reqs[i].qiov->size);
2347
cbf1dff2 2348 reqs[outidx].nb_sectors = qiov->size >> 9;
40b4f539
KW
2349 reqs[outidx].qiov = qiov;
2350
2351 mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
2352 } else {
2353 outidx++;
2354 reqs[outidx].sector = reqs[i].sector;
2355 reqs[outidx].nb_sectors = reqs[i].nb_sectors;
2356 reqs[outidx].qiov = reqs[i].qiov;
2357 }
2358 }
2359
2360 return outidx + 1;
2361}
2362
2363/*
2364 * Submit multiple AIO write requests at once.
2365 *
2366 * On success, the function returns 0 and all requests in the reqs array have
2367 * been submitted. In error case this function returns -1, and any of the
2368 * requests may or may not be submitted yet. In particular, this means that the
2369 * callback will be called for some of the requests, for others it won't. The
2370 * caller must check the error field of the BlockRequest to wait for the right
2371 * callbacks (if error != 0, no callback will be called).
2372 *
2373 * The implementation may modify the contents of the reqs array, e.g. to merge
2374 * requests. However, the fields opaque and error are left unmodified as they
2375 * are used to signal failure for a single request to the caller.
2376 */
2377int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
2378{
2379 BlockDriverAIOCB *acb;
2380 MultiwriteCB *mcb;
2381 int i;
2382
301db7c2
RH
2383 /* don't submit writes if we don't have a medium */
2384 if (bs->drv == NULL) {
2385 for (i = 0; i < num_reqs; i++) {
2386 reqs[i].error = -ENOMEDIUM;
2387 }
2388 return -1;
2389 }
2390
40b4f539
KW
2391 if (num_reqs == 0) {
2392 return 0;
2393 }
2394
2395 // Create MultiwriteCB structure
2396 mcb = qemu_mallocz(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
2397 mcb->num_requests = 0;
2398 mcb->num_callbacks = num_reqs;
2399
2400 for (i = 0; i < num_reqs; i++) {
2401 mcb->callbacks[i].cb = reqs[i].cb;
2402 mcb->callbacks[i].opaque = reqs[i].opaque;
2403 }
2404
2405 // Check for mergable requests
2406 num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
2407
6d519a5f
SH
2408 trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs);
2409
453f9a16
KW
2410 /*
2411 * Run the aio requests. As soon as one request can't be submitted
2412 * successfully, fail all requests that are not yet submitted (we must
2413 * return failure for all requests anyway)
2414 *
2415 * num_requests cannot be set to the right value immediately: If
2416 * bdrv_aio_writev fails for some request, num_requests would be too high
2417 * and therefore multiwrite_cb() would never recognize the multiwrite
2418 * request as completed. We also cannot use the loop variable i to set it
2419 * when the first request fails because the callback may already have been
2420 * called for previously submitted requests. Thus, num_requests must be
2421 * incremented for each request that is submitted.
2422 *
2423 * The problem that callbacks may be called early also means that we need
2424 * to take care that num_requests doesn't become 0 before all requests are
2425 * submitted - multiwrite_cb() would consider the multiwrite request
2426 * completed. A dummy request that is "completed" by a manual call to
2427 * multiwrite_cb() takes care of this.
2428 */
2429 mcb->num_requests = 1;
2430
6d519a5f 2431 // Run the aio requests
40b4f539 2432 for (i = 0; i < num_reqs; i++) {
453f9a16 2433 mcb->num_requests++;
40b4f539
KW
2434 acb = bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
2435 reqs[i].nb_sectors, multiwrite_cb, mcb);
2436
2437 if (acb == NULL) {
2438 // We can only fail the whole thing if no request has been
2439 // submitted yet. Otherwise we'll wait for the submitted AIOs to
2440 // complete and report the error in the callback.
453f9a16 2441 if (i == 0) {
6d519a5f 2442 trace_bdrv_aio_multiwrite_earlyfail(mcb);
40b4f539
KW
2443 goto fail;
2444 } else {
6d519a5f 2445 trace_bdrv_aio_multiwrite_latefail(mcb, i);
7eb58a6c 2446 multiwrite_cb(mcb, -EIO);
40b4f539
KW
2447 break;
2448 }
40b4f539
KW
2449 }
2450 }
2451
453f9a16
KW
2452 /* Complete the dummy request */
2453 multiwrite_cb(mcb, 0);
2454
40b4f539
KW
2455 return 0;
2456
2457fail:
453f9a16
KW
2458 for (i = 0; i < mcb->num_callbacks; i++) {
2459 reqs[i].error = -EIO;
2460 }
af474591 2461 qemu_free(mcb);
40b4f539
KW
2462 return -1;
2463}
2464
b2e12bc6
CH
2465BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
2466 BlockDriverCompletionFunc *cb, void *opaque)
2467{
2468 BlockDriver *drv = bs->drv;
2469
a13aac04
SH
2470 trace_bdrv_aio_flush(bs, opaque);
2471
016f5cf6
AG
2472 if (bs->open_flags & BDRV_O_NO_FLUSH) {
2473 return bdrv_aio_noop_em(bs, cb, opaque);
2474 }
2475
b2e12bc6
CH
2476 if (!drv)
2477 return NULL;
b2e12bc6
CH
2478 return drv->bdrv_aio_flush(bs, cb, opaque);
2479}
2480
83f64091 2481void bdrv_aio_cancel(BlockDriverAIOCB *acb)
83f64091 2482{
6bbff9a0 2483 acb->pool->cancel(acb);
83f64091
FB
2484}
2485
ce1a14dc 2486
83f64091
FB
2487/**************************************************************/
2488/* async block device emulation */
2489
c16b5a2c
CH
2490typedef struct BlockDriverAIOCBSync {
2491 BlockDriverAIOCB common;
2492 QEMUBH *bh;
2493 int ret;
2494 /* vector translation state */
2495 QEMUIOVector *qiov;
2496 uint8_t *bounce;
2497 int is_write;
2498} BlockDriverAIOCBSync;
2499
2500static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
2501{
b666d239
KW
2502 BlockDriverAIOCBSync *acb =
2503 container_of(blockacb, BlockDriverAIOCBSync, common);
6a7ad299 2504 qemu_bh_delete(acb->bh);
36afc451 2505 acb->bh = NULL;
c16b5a2c
CH
2506 qemu_aio_release(acb);
2507}
2508
2509static AIOPool bdrv_em_aio_pool = {
2510 .aiocb_size = sizeof(BlockDriverAIOCBSync),
2511 .cancel = bdrv_aio_cancel_em,
2512};
2513
ce1a14dc 2514static void bdrv_aio_bh_cb(void *opaque)
83f64091 2515{
ce1a14dc 2516 BlockDriverAIOCBSync *acb = opaque;
f141eafe 2517
f141eafe
AL
2518 if (!acb->is_write)
2519 qemu_iovec_from_buffer(acb->qiov, acb->bounce, acb->qiov->size);
ceb42de8 2520 qemu_vfree(acb->bounce);
ce1a14dc 2521 acb->common.cb(acb->common.opaque, acb->ret);
6a7ad299 2522 qemu_bh_delete(acb->bh);
36afc451 2523 acb->bh = NULL;
ce1a14dc 2524 qemu_aio_release(acb);
83f64091 2525}
beac80cd 2526
f141eafe
AL
2527static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
2528 int64_t sector_num,
2529 QEMUIOVector *qiov,
2530 int nb_sectors,
2531 BlockDriverCompletionFunc *cb,
2532 void *opaque,
2533 int is_write)
2534
83f64091 2535{
ce1a14dc 2536 BlockDriverAIOCBSync *acb;
ce1a14dc 2537
c16b5a2c 2538 acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
f141eafe
AL
2539 acb->is_write = is_write;
2540 acb->qiov = qiov;
e268ca52 2541 acb->bounce = qemu_blockalign(bs, qiov->size);
f141eafe 2542
ce1a14dc
PB
2543 if (!acb->bh)
2544 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
f141eafe
AL
2545
2546 if (is_write) {
2547 qemu_iovec_to_buffer(acb->qiov, acb->bounce);
2548 acb->ret = bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
2549 } else {
2550 acb->ret = bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
2551 }
2552
ce1a14dc 2553 qemu_bh_schedule(acb->bh);
f141eafe 2554
ce1a14dc 2555 return &acb->common;
beac80cd
FB
2556}
2557
f141eafe
AL
2558static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
2559 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 2560 BlockDriverCompletionFunc *cb, void *opaque)
beac80cd 2561{
f141eafe
AL
2562 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
2563}
83f64091 2564
f141eafe
AL
2565static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
2566 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
2567 BlockDriverCompletionFunc *cb, void *opaque)
2568{
2569 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
beac80cd 2570}
beac80cd 2571
b2e12bc6
CH
2572static BlockDriverAIOCB *bdrv_aio_flush_em(BlockDriverState *bs,
2573 BlockDriverCompletionFunc *cb, void *opaque)
2574{
2575 BlockDriverAIOCBSync *acb;
2576
2577 acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
2578 acb->is_write = 1; /* don't bounce in the completion hadler */
2579 acb->qiov = NULL;
2580 acb->bounce = NULL;
2581 acb->ret = 0;
2582
2583 if (!acb->bh)
2584 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
2585
2586 bdrv_flush(bs);
2587 qemu_bh_schedule(acb->bh);
2588 return &acb->common;
2589}
2590
016f5cf6
AG
2591static BlockDriverAIOCB *bdrv_aio_noop_em(BlockDriverState *bs,
2592 BlockDriverCompletionFunc *cb, void *opaque)
2593{
2594 BlockDriverAIOCBSync *acb;
2595
2596 acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
2597 acb->is_write = 1; /* don't bounce in the completion handler */
2598 acb->qiov = NULL;
2599 acb->bounce = NULL;
2600 acb->ret = 0;
2601
2602 if (!acb->bh) {
2603 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
2604 }
2605
2606 qemu_bh_schedule(acb->bh);
2607 return &acb->common;
2608}
2609
83f64091
FB
2610/**************************************************************/
2611/* sync block device emulation */
ea2384d3 2612
83f64091
FB
2613static void bdrv_rw_em_cb(void *opaque, int ret)
2614{
2615 *(int *)opaque = ret;
ea2384d3
FB
2616}
2617
83f64091
FB
2618#define NOT_DONE 0x7fffffff
2619
5fafdf24 2620static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
83f64091 2621 uint8_t *buf, int nb_sectors)
7a6cba61 2622{
ce1a14dc
PB
2623 int async_ret;
2624 BlockDriverAIOCB *acb;
f141eafe
AL
2625 struct iovec iov;
2626 QEMUIOVector qiov;
83f64091 2627
65d6b3d8
KW
2628 async_context_push();
2629
83f64091 2630 async_ret = NOT_DONE;
3f4cb3d3 2631 iov.iov_base = (void *)buf;
eb5a3165 2632 iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE;
f141eafe
AL
2633 qemu_iovec_init_external(&qiov, &iov, 1);
2634 acb = bdrv_aio_readv(bs, sector_num, &qiov, nb_sectors,
2635 bdrv_rw_em_cb, &async_ret);
65d6b3d8
KW
2636 if (acb == NULL) {
2637 async_ret = -1;
2638 goto fail;
2639 }
baf35cb9 2640
83f64091
FB
2641 while (async_ret == NOT_DONE) {
2642 qemu_aio_wait();
2643 }
baf35cb9 2644
65d6b3d8
KW
2645
2646fail:
2647 async_context_pop();
83f64091 2648 return async_ret;
7a6cba61
PB
2649}
2650
83f64091
FB
2651static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
2652 const uint8_t *buf, int nb_sectors)
2653{
ce1a14dc
PB
2654 int async_ret;
2655 BlockDriverAIOCB *acb;
f141eafe
AL
2656 struct iovec iov;
2657 QEMUIOVector qiov;
83f64091 2658
65d6b3d8
KW
2659 async_context_push();
2660
83f64091 2661 async_ret = NOT_DONE;
f141eafe 2662 iov.iov_base = (void *)buf;
eb5a3165 2663 iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE;
f141eafe
AL
2664 qemu_iovec_init_external(&qiov, &iov, 1);
2665 acb = bdrv_aio_writev(bs, sector_num, &qiov, nb_sectors,
2666 bdrv_rw_em_cb, &async_ret);
65d6b3d8
KW
2667 if (acb == NULL) {
2668 async_ret = -1;
2669 goto fail;
2670 }
83f64091
FB
2671 while (async_ret == NOT_DONE) {
2672 qemu_aio_wait();
2673 }
65d6b3d8
KW
2674
2675fail:
2676 async_context_pop();
83f64091
FB
2677 return async_ret;
2678}
ea2384d3
FB
2679
2680void bdrv_init(void)
2681{
5efa9d5a 2682 module_call_init(MODULE_INIT_BLOCK);
ea2384d3 2683}
ce1a14dc 2684
eb852011
MA
2685void bdrv_init_with_whitelist(void)
2686{
2687 use_bdrv_whitelist = 1;
2688 bdrv_init();
2689}
2690
c16b5a2c
CH
2691void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
2692 BlockDriverCompletionFunc *cb, void *opaque)
ce1a14dc 2693{
ce1a14dc
PB
2694 BlockDriverAIOCB *acb;
2695
6bbff9a0
AL
2696 if (pool->free_aiocb) {
2697 acb = pool->free_aiocb;
2698 pool->free_aiocb = acb->next;
ce1a14dc 2699 } else {
6bbff9a0
AL
2700 acb = qemu_mallocz(pool->aiocb_size);
2701 acb->pool = pool;
ce1a14dc
PB
2702 }
2703 acb->bs = bs;
2704 acb->cb = cb;
2705 acb->opaque = opaque;
2706 return acb;
2707}
2708
2709void qemu_aio_release(void *p)
2710{
6bbff9a0
AL
2711 BlockDriverAIOCB *acb = (BlockDriverAIOCB *)p;
2712 AIOPool *pool = acb->pool;
2713 acb->next = pool->free_aiocb;
2714 pool->free_aiocb = acb;
ce1a14dc 2715}
19cb3738
FB
2716
2717/**************************************************************/
2718/* removable device support */
2719
2720/**
2721 * Return TRUE if the media is present
2722 */
2723int bdrv_is_inserted(BlockDriverState *bs)
2724{
2725 BlockDriver *drv = bs->drv;
2726 int ret;
2727 if (!drv)
2728 return 0;
2729 if (!drv->bdrv_is_inserted)
4be9762a 2730 return !bs->tray_open;
19cb3738
FB
2731 ret = drv->bdrv_is_inserted(bs);
2732 return ret;
2733}
2734
2735/**
2736 * Return TRUE if the media changed since the last call to this
5fafdf24 2737 * function. It is currently only used for floppy disks
19cb3738
FB
2738 */
2739int bdrv_media_changed(BlockDriverState *bs)
2740{
2741 BlockDriver *drv = bs->drv;
2742 int ret;
2743
2744 if (!drv || !drv->bdrv_media_changed)
2745 ret = -ENOTSUP;
2746 else
2747 ret = drv->bdrv_media_changed(bs);
2748 if (ret == -ENOTSUP)
2749 ret = bs->media_changed;
2750 bs->media_changed = 0;
2751 return ret;
2752}
2753
2754/**
2755 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
2756 */
aea2a33c 2757int bdrv_eject(BlockDriverState *bs, int eject_flag)
19cb3738
FB
2758{
2759 BlockDriver *drv = bs->drv;
19cb3738 2760
49aa46bb 2761 if (eject_flag && bs->locked) {
aea2a33c
MM
2762 return -EBUSY;
2763 }
2764
822e1cd1
MA
2765 if (drv && drv->bdrv_eject) {
2766 drv->bdrv_eject(bs, eject_flag);
19cb3738 2767 }
822e1cd1
MA
2768 bs->tray_open = eject_flag;
2769 return 0;
19cb3738
FB
2770}
2771
2772int bdrv_is_locked(BlockDriverState *bs)
2773{
2774 return bs->locked;
2775}
2776
2777/**
2778 * Lock or unlock the media (if it is locked, the user won't be able
2779 * to eject it manually).
2780 */
2781void bdrv_set_locked(BlockDriverState *bs, int locked)
2782{
2783 BlockDriver *drv = bs->drv;
2784
b8c6d095
SH
2785 trace_bdrv_set_locked(bs, locked);
2786
19cb3738
FB
2787 bs->locked = locked;
2788 if (drv && drv->bdrv_set_locked) {
2789 drv->bdrv_set_locked(bs, locked);
2790 }
2791}
985a03b0
TS
2792
2793/* needed for generic scsi interface */
2794
2795int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
2796{
2797 BlockDriver *drv = bs->drv;
2798
2799 if (drv && drv->bdrv_ioctl)
2800 return drv->bdrv_ioctl(bs, req, buf);
2801 return -ENOTSUP;
2802}
7d780669 2803
221f715d
AL
2804BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
2805 unsigned long int req, void *buf,
2806 BlockDriverCompletionFunc *cb, void *opaque)
7d780669 2807{
221f715d 2808 BlockDriver *drv = bs->drv;
7d780669 2809
221f715d
AL
2810 if (drv && drv->bdrv_aio_ioctl)
2811 return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
2812 return NULL;
7d780669 2813}
e268ca52 2814
7cd1e32a
LS
2815
2816
e268ca52
AL
2817void *qemu_blockalign(BlockDriverState *bs, size_t size)
2818{
2819 return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
2820}
7cd1e32a
LS
2821
2822void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable)
2823{
2824 int64_t bitmap_size;
a55eb92c 2825
aaa0eb75 2826 bs->dirty_count = 0;
a55eb92c 2827 if (enable) {
c6d22830
JK
2828 if (!bs->dirty_bitmap) {
2829 bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS) +
2830 BDRV_SECTORS_PER_DIRTY_CHUNK * 8 - 1;
2831 bitmap_size /= BDRV_SECTORS_PER_DIRTY_CHUNK * 8;
a55eb92c 2832
7cd1e32a 2833 bs->dirty_bitmap = qemu_mallocz(bitmap_size);
a55eb92c 2834 }
7cd1e32a 2835 } else {
c6d22830 2836 if (bs->dirty_bitmap) {
7cd1e32a 2837 qemu_free(bs->dirty_bitmap);
c6d22830 2838 bs->dirty_bitmap = NULL;
a55eb92c 2839 }
7cd1e32a
LS
2840 }
2841}
2842
2843int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
2844{
6ea44308 2845 int64_t chunk = sector / (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK;
a55eb92c 2846
c6d22830
JK
2847 if (bs->dirty_bitmap &&
2848 (sector << BDRV_SECTOR_BITS) < bdrv_getlength(bs)) {
6d59fec1
MT
2849 return !!(bs->dirty_bitmap[chunk / (sizeof(unsigned long) * 8)] &
2850 (1UL << (chunk % (sizeof(unsigned long) * 8))));
7cd1e32a
LS
2851 } else {
2852 return 0;
2853 }
2854}
2855
a55eb92c
JK
2856void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
2857 int nr_sectors)
7cd1e32a
LS
2858{
2859 set_dirty_bitmap(bs, cur_sector, nr_sectors, 0);
2860}
aaa0eb75
LS
2861
2862int64_t bdrv_get_dirty_count(BlockDriverState *bs)
2863{
2864 return bs->dirty_count;
2865}
f88e1a42 2866
db593f25
MT
2867void bdrv_set_in_use(BlockDriverState *bs, int in_use)
2868{
2869 assert(bs->in_use != in_use);
2870 bs->in_use = in_use;
2871}
2872
2873int bdrv_in_use(BlockDriverState *bs)
2874{
2875 return bs->in_use;
2876}
2877
f88e1a42
JS
2878int bdrv_img_create(const char *filename, const char *fmt,
2879 const char *base_filename, const char *base_fmt,
2880 char *options, uint64_t img_size, int flags)
2881{
2882 QEMUOptionParameter *param = NULL, *create_options = NULL;
d220894e 2883 QEMUOptionParameter *backing_fmt, *backing_file, *size;
f88e1a42
JS
2884 BlockDriverState *bs = NULL;
2885 BlockDriver *drv, *proto_drv;
96df67d1 2886 BlockDriver *backing_drv = NULL;
f88e1a42
JS
2887 int ret = 0;
2888
2889 /* Find driver and parse its options */
2890 drv = bdrv_find_format(fmt);
2891 if (!drv) {
2892 error_report("Unknown file format '%s'", fmt);
4f70f249 2893 ret = -EINVAL;
f88e1a42
JS
2894 goto out;
2895 }
2896
2897 proto_drv = bdrv_find_protocol(filename);
2898 if (!proto_drv) {
2899 error_report("Unknown protocol '%s'", filename);
4f70f249 2900 ret = -EINVAL;
f88e1a42
JS
2901 goto out;
2902 }
2903
2904 create_options = append_option_parameters(create_options,
2905 drv->create_options);
2906 create_options = append_option_parameters(create_options,
2907 proto_drv->create_options);
2908
2909 /* Create parameter list with default values */
2910 param = parse_option_parameters("", create_options, param);
2911
2912 set_option_parameter_int(param, BLOCK_OPT_SIZE, img_size);
2913
2914 /* Parse -o options */
2915 if (options) {
2916 param = parse_option_parameters(options, create_options, param);
2917 if (param == NULL) {
2918 error_report("Invalid options for file format '%s'.", fmt);
4f70f249 2919 ret = -EINVAL;
f88e1a42
JS
2920 goto out;
2921 }
2922 }
2923
2924 if (base_filename) {
2925 if (set_option_parameter(param, BLOCK_OPT_BACKING_FILE,
2926 base_filename)) {
2927 error_report("Backing file not supported for file format '%s'",
2928 fmt);
4f70f249 2929 ret = -EINVAL;
f88e1a42
JS
2930 goto out;
2931 }
2932 }
2933
2934 if (base_fmt) {
2935 if (set_option_parameter(param, BLOCK_OPT_BACKING_FMT, base_fmt)) {
2936 error_report("Backing file format not supported for file "
2937 "format '%s'", fmt);
4f70f249 2938 ret = -EINVAL;
f88e1a42
JS
2939 goto out;
2940 }
2941 }
2942
792da93a
JS
2943 backing_file = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
2944 if (backing_file && backing_file->value.s) {
2945 if (!strcmp(filename, backing_file->value.s)) {
2946 error_report("Error: Trying to create an image with the "
2947 "same filename as the backing file");
4f70f249 2948 ret = -EINVAL;
792da93a
JS
2949 goto out;
2950 }
2951 }
2952
f88e1a42
JS
2953 backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
2954 if (backing_fmt && backing_fmt->value.s) {
96df67d1
SH
2955 backing_drv = bdrv_find_format(backing_fmt->value.s);
2956 if (!backing_drv) {
f88e1a42
JS
2957 error_report("Unknown backing file format '%s'",
2958 backing_fmt->value.s);
4f70f249 2959 ret = -EINVAL;
f88e1a42
JS
2960 goto out;
2961 }
2962 }
2963
2964 // The size for the image must always be specified, with one exception:
2965 // If we are using a backing file, we can obtain the size from there
d220894e
KW
2966 size = get_option_parameter(param, BLOCK_OPT_SIZE);
2967 if (size && size->value.n == -1) {
f88e1a42
JS
2968 if (backing_file && backing_file->value.s) {
2969 uint64_t size;
f88e1a42
JS
2970 char buf[32];
2971
f88e1a42
JS
2972 bs = bdrv_new("");
2973
96df67d1 2974 ret = bdrv_open(bs, backing_file->value.s, flags, backing_drv);
f88e1a42 2975 if (ret < 0) {
96df67d1 2976 error_report("Could not open '%s'", backing_file->value.s);
f88e1a42
JS
2977 goto out;
2978 }
2979 bdrv_get_geometry(bs, &size);
2980 size *= 512;
2981
2982 snprintf(buf, sizeof(buf), "%" PRId64, size);
2983 set_option_parameter(param, BLOCK_OPT_SIZE, buf);
2984 } else {
2985 error_report("Image creation needs a size parameter");
4f70f249 2986 ret = -EINVAL;
f88e1a42
JS
2987 goto out;
2988 }
2989 }
2990
2991 printf("Formatting '%s', fmt=%s ", filename, fmt);
2992 print_option_parameters(param);
2993 puts("");
2994
2995 ret = bdrv_create(drv, filename, param);
2996
2997 if (ret < 0) {
2998 if (ret == -ENOTSUP) {
2999 error_report("Formatting or formatting option not supported for "
3000 "file format '%s'", fmt);
3001 } else if (ret == -EFBIG) {
3002 error_report("The image size is too large for file format '%s'",
3003 fmt);
3004 } else {
3005 error_report("%s: error while creating %s: %s", filename, fmt,
3006 strerror(-ret));
3007 }
3008 }
3009
3010out:
3011 free_option_parameters(create_options);
3012 free_option_parameters(param);
3013
3014 if (bs) {
3015 bdrv_delete(bs);
3016 }
4f70f249
JS
3017
3018 return ret;
f88e1a42 3019}