]> git.proxmox.com Git - mirror_qemu.git/blame - block.c
vvfat: Use bdrv_open options instead of filename
[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"
83c9089e 27#include "monitor/monitor.h"
737e150e
PB
28#include "block/block_int.h"
29#include "block/blockjob.h"
1de7afc9 30#include "qemu/module.h"
7b1b5d19 31#include "qapi/qmp/qjson.h"
9c17d615 32#include "sysemu/sysemu.h"
1de7afc9 33#include "qemu/notify.h"
737e150e 34#include "block/coroutine.h"
b2023818 35#include "qmp-commands.h"
1de7afc9 36#include "qemu/timer.h"
fc01f7e7 37
71e72a19 38#ifdef CONFIG_BSD
7674e7bf
FB
39#include <sys/types.h>
40#include <sys/stat.h>
41#include <sys/ioctl.h>
72cf2d4f 42#include <sys/queue.h>
c5e97233 43#ifndef __DragonFly__
7674e7bf
FB
44#include <sys/disk.h>
45#endif
c5e97233 46#endif
7674e7bf 47
49dc768d
AL
48#ifdef _WIN32
49#include <windows.h>
50#endif
51
1c9805a3
SH
52#define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
53
470c0504
SH
54typedef enum {
55 BDRV_REQ_COPY_ON_READ = 0x1,
f08f2dda 56 BDRV_REQ_ZERO_WRITE = 0x2,
470c0504
SH
57} BdrvRequestFlags;
58
7d4b4ba5 59static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load);
f141eafe
AL
60static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
61 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
c87c0672 62 BlockDriverCompletionFunc *cb, void *opaque);
f141eafe
AL
63static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
64 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 65 BlockDriverCompletionFunc *cb, void *opaque);
f9f05dc5
KW
66static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
67 int64_t sector_num, int nb_sectors,
68 QEMUIOVector *iov);
69static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
70 int64_t sector_num, int nb_sectors,
71 QEMUIOVector *iov);
c5fbe571 72static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
470c0504
SH
73 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
74 BdrvRequestFlags flags);
1c9805a3 75static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
f08f2dda
SH
76 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
77 BdrvRequestFlags flags);
b2a61371
SH
78static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
79 int64_t sector_num,
80 QEMUIOVector *qiov,
81 int nb_sectors,
82 BlockDriverCompletionFunc *cb,
83 void *opaque,
8c5873d6 84 bool is_write);
b2a61371 85static void coroutine_fn bdrv_co_do_rw(void *opaque);
621f0589
KW
86static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
87 int64_t sector_num, int nb_sectors);
ec530c81 88
98f90dba
ZYW
89static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
90 bool is_write, double elapsed_time, uint64_t *wait);
91static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
92 double elapsed_time, uint64_t *wait);
93static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
94 bool is_write, int64_t *wait);
95
1b7bdbc1
SH
96static QTAILQ_HEAD(, BlockDriverState) bdrv_states =
97 QTAILQ_HEAD_INITIALIZER(bdrv_states);
7ee930d0 98
8a22f02a
SH
99static QLIST_HEAD(, BlockDriver) bdrv_drivers =
100 QLIST_HEAD_INITIALIZER(bdrv_drivers);
ea2384d3 101
f9092b10
MA
102/* The device to use for VM snapshots */
103static BlockDriverState *bs_snapshots;
104
eb852011
MA
105/* If non-zero, use only whitelisted block drivers */
106static int use_bdrv_whitelist;
107
9e0b22f4
SH
108#ifdef _WIN32
109static int is_windows_drive_prefix(const char *filename)
110{
111 return (((filename[0] >= 'a' && filename[0] <= 'z') ||
112 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
113 filename[1] == ':');
114}
115
116int is_windows_drive(const char *filename)
117{
118 if (is_windows_drive_prefix(filename) &&
119 filename[2] == '\0')
120 return 1;
121 if (strstart(filename, "\\\\.\\", NULL) ||
122 strstart(filename, "//./", NULL))
123 return 1;
124 return 0;
125}
126#endif
127
0563e191 128/* throttling disk I/O limits */
98f90dba
ZYW
129void bdrv_io_limits_disable(BlockDriverState *bs)
130{
131 bs->io_limits_enabled = false;
132
133 while (qemu_co_queue_next(&bs->throttled_reqs));
134
135 if (bs->block_timer) {
136 qemu_del_timer(bs->block_timer);
137 qemu_free_timer(bs->block_timer);
138 bs->block_timer = NULL;
139 }
140
141 bs->slice_start = 0;
142 bs->slice_end = 0;
98f90dba
ZYW
143}
144
0563e191
ZYW
145static void bdrv_block_timer(void *opaque)
146{
147 BlockDriverState *bs = opaque;
148
149 qemu_co_queue_next(&bs->throttled_reqs);
150}
151
152void bdrv_io_limits_enable(BlockDriverState *bs)
153{
154 qemu_co_queue_init(&bs->throttled_reqs);
155 bs->block_timer = qemu_new_timer_ns(vm_clock, bdrv_block_timer, bs);
0563e191
ZYW
156 bs->io_limits_enabled = true;
157}
158
159bool bdrv_io_limits_enabled(BlockDriverState *bs)
160{
161 BlockIOLimit *io_limits = &bs->io_limits;
162 return io_limits->bps[BLOCK_IO_LIMIT_READ]
163 || io_limits->bps[BLOCK_IO_LIMIT_WRITE]
164 || io_limits->bps[BLOCK_IO_LIMIT_TOTAL]
165 || io_limits->iops[BLOCK_IO_LIMIT_READ]
166 || io_limits->iops[BLOCK_IO_LIMIT_WRITE]
167 || io_limits->iops[BLOCK_IO_LIMIT_TOTAL];
168}
169
98f90dba
ZYW
170static void bdrv_io_limits_intercept(BlockDriverState *bs,
171 bool is_write, int nb_sectors)
172{
173 int64_t wait_time = -1;
174
175 if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
176 qemu_co_queue_wait(&bs->throttled_reqs);
177 }
178
179 /* In fact, we hope to keep each request's timing, in FIFO mode. The next
180 * throttled requests will not be dequeued until the current request is
181 * allowed to be serviced. So if the current request still exceeds the
182 * limits, it will be inserted to the head. All requests followed it will
183 * be still in throttled_reqs queue.
184 */
185
186 while (bdrv_exceed_io_limits(bs, nb_sectors, is_write, &wait_time)) {
187 qemu_mod_timer(bs->block_timer,
188 wait_time + qemu_get_clock_ns(vm_clock));
189 qemu_co_queue_wait_insert_head(&bs->throttled_reqs);
190 }
191
192 qemu_co_queue_next(&bs->throttled_reqs);
193}
194
9e0b22f4
SH
195/* check if the path starts with "<protocol>:" */
196static int path_has_protocol(const char *path)
197{
947995c0
PB
198 const char *p;
199
9e0b22f4
SH
200#ifdef _WIN32
201 if (is_windows_drive(path) ||
202 is_windows_drive_prefix(path)) {
203 return 0;
204 }
947995c0
PB
205 p = path + strcspn(path, ":/\\");
206#else
207 p = path + strcspn(path, ":/");
9e0b22f4
SH
208#endif
209
947995c0 210 return *p == ':';
9e0b22f4
SH
211}
212
83f64091 213int path_is_absolute(const char *path)
3b0d4f61 214{
21664424
FB
215#ifdef _WIN32
216 /* specific case for names like: "\\.\d:" */
f53f4da9 217 if (is_windows_drive(path) || is_windows_drive_prefix(path)) {
21664424 218 return 1;
f53f4da9
PB
219 }
220 return (*path == '/' || *path == '\\');
3b9f94e1 221#else
f53f4da9 222 return (*path == '/');
3b9f94e1 223#endif
3b0d4f61
FB
224}
225
83f64091
FB
226/* if filename is absolute, just copy it to dest. Otherwise, build a
227 path to it by considering it is relative to base_path. URL are
228 supported. */
229void path_combine(char *dest, int dest_size,
230 const char *base_path,
231 const char *filename)
3b0d4f61 232{
83f64091
FB
233 const char *p, *p1;
234 int len;
235
236 if (dest_size <= 0)
237 return;
238 if (path_is_absolute(filename)) {
239 pstrcpy(dest, dest_size, filename);
240 } else {
241 p = strchr(base_path, ':');
242 if (p)
243 p++;
244 else
245 p = base_path;
3b9f94e1
FB
246 p1 = strrchr(base_path, '/');
247#ifdef _WIN32
248 {
249 const char *p2;
250 p2 = strrchr(base_path, '\\');
251 if (!p1 || p2 > p1)
252 p1 = p2;
253 }
254#endif
83f64091
FB
255 if (p1)
256 p1++;
257 else
258 p1 = base_path;
259 if (p1 > p)
260 p = p1;
261 len = p - base_path;
262 if (len > dest_size - 1)
263 len = dest_size - 1;
264 memcpy(dest, base_path, len);
265 dest[len] = '\0';
266 pstrcat(dest, dest_size, filename);
3b0d4f61 267 }
3b0d4f61
FB
268}
269
dc5a1371
PB
270void bdrv_get_full_backing_filename(BlockDriverState *bs, char *dest, size_t sz)
271{
272 if (bs->backing_file[0] == '\0' || path_has_protocol(bs->backing_file)) {
273 pstrcpy(dest, sz, bs->backing_file);
274 } else {
275 path_combine(dest, sz, bs->filename, bs->backing_file);
276 }
277}
278
5efa9d5a 279void bdrv_register(BlockDriver *bdrv)
ea2384d3 280{
8c5873d6
SH
281 /* Block drivers without coroutine functions need emulation */
282 if (!bdrv->bdrv_co_readv) {
f9f05dc5
KW
283 bdrv->bdrv_co_readv = bdrv_co_readv_em;
284 bdrv->bdrv_co_writev = bdrv_co_writev_em;
285
f8c35c1d
SH
286 /* bdrv_co_readv_em()/brdv_co_writev_em() work in terms of aio, so if
287 * the block driver lacks aio we need to emulate that too.
288 */
f9f05dc5
KW
289 if (!bdrv->bdrv_aio_readv) {
290 /* add AIO emulation layer */
291 bdrv->bdrv_aio_readv = bdrv_aio_readv_em;
292 bdrv->bdrv_aio_writev = bdrv_aio_writev_em;
f9f05dc5 293 }
83f64091 294 }
b2e12bc6 295
8a22f02a 296 QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list);
ea2384d3 297}
b338082b
FB
298
299/* create a new block device (by default it is empty) */
300BlockDriverState *bdrv_new(const char *device_name)
301{
1b7bdbc1 302 BlockDriverState *bs;
b338082b 303
7267c094 304 bs = g_malloc0(sizeof(BlockDriverState));
b338082b 305 pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
ea2384d3 306 if (device_name[0] != '\0') {
1b7bdbc1 307 QTAILQ_INSERT_TAIL(&bdrv_states, bs, list);
ea2384d3 308 }
28a7282a 309 bdrv_iostatus_disable(bs);
d7d512f6
PB
310 notifier_list_init(&bs->close_notifiers);
311
b338082b
FB
312 return bs;
313}
314
d7d512f6
PB
315void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify)
316{
317 notifier_list_add(&bs->close_notifiers, notify);
318}
319
ea2384d3
FB
320BlockDriver *bdrv_find_format(const char *format_name)
321{
322 BlockDriver *drv1;
8a22f02a
SH
323 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
324 if (!strcmp(drv1->format_name, format_name)) {
ea2384d3 325 return drv1;
8a22f02a 326 }
ea2384d3
FB
327 }
328 return NULL;
329}
330
eb852011
MA
331static int bdrv_is_whitelisted(BlockDriver *drv)
332{
333 static const char *whitelist[] = {
334 CONFIG_BDRV_WHITELIST
335 };
336 const char **p;
337
338 if (!whitelist[0])
339 return 1; /* no whitelist, anything goes */
340
341 for (p = whitelist; *p; p++) {
342 if (!strcmp(drv->format_name, *p)) {
343 return 1;
344 }
345 }
346 return 0;
347}
348
349BlockDriver *bdrv_find_whitelisted_format(const char *format_name)
350{
351 BlockDriver *drv = bdrv_find_format(format_name);
352 return drv && bdrv_is_whitelisted(drv) ? drv : NULL;
353}
354
5b7e1542
ZYW
355typedef struct CreateCo {
356 BlockDriver *drv;
357 char *filename;
358 QEMUOptionParameter *options;
359 int ret;
360} CreateCo;
361
362static void coroutine_fn bdrv_create_co_entry(void *opaque)
363{
364 CreateCo *cco = opaque;
365 assert(cco->drv);
366
367 cco->ret = cco->drv->bdrv_create(cco->filename, cco->options);
368}
369
0e7e1989
KW
370int bdrv_create(BlockDriver *drv, const char* filename,
371 QEMUOptionParameter *options)
ea2384d3 372{
5b7e1542
ZYW
373 int ret;
374
375 Coroutine *co;
376 CreateCo cco = {
377 .drv = drv,
378 .filename = g_strdup(filename),
379 .options = options,
380 .ret = NOT_DONE,
381 };
382
383 if (!drv->bdrv_create) {
80168bff
LC
384 ret = -ENOTSUP;
385 goto out;
5b7e1542
ZYW
386 }
387
388 if (qemu_in_coroutine()) {
389 /* Fast-path if already in coroutine context */
390 bdrv_create_co_entry(&cco);
391 } else {
392 co = qemu_coroutine_create(bdrv_create_co_entry);
393 qemu_coroutine_enter(co, &cco);
394 while (cco.ret == NOT_DONE) {
395 qemu_aio_wait();
396 }
397 }
398
399 ret = cco.ret;
0e7e1989 400
80168bff
LC
401out:
402 g_free(cco.filename);
5b7e1542 403 return ret;
ea2384d3
FB
404}
405
84a12e66
CH
406int bdrv_create_file(const char* filename, QEMUOptionParameter *options)
407{
408 BlockDriver *drv;
409
b50cbabc 410 drv = bdrv_find_protocol(filename);
84a12e66 411 if (drv == NULL) {
16905d71 412 return -ENOENT;
84a12e66
CH
413 }
414
415 return bdrv_create(drv, filename, options);
416}
417
eba25057
JM
418/*
419 * Create a uniquely-named empty temporary file.
420 * Return 0 upon success, otherwise a negative errno value.
421 */
422int get_tmp_filename(char *filename, int size)
d5249393 423{
eba25057 424#ifdef _WIN32
3b9f94e1 425 char temp_dir[MAX_PATH];
eba25057
JM
426 /* GetTempFileName requires that its output buffer (4th param)
427 have length MAX_PATH or greater. */
428 assert(size >= MAX_PATH);
429 return (GetTempPath(MAX_PATH, temp_dir)
430 && GetTempFileName(temp_dir, "qem", 0, filename)
431 ? 0 : -GetLastError());
d5249393 432#else
67b915a5 433 int fd;
7ccfb2eb 434 const char *tmpdir;
0badc1ee
AJ
435 tmpdir = getenv("TMPDIR");
436 if (!tmpdir)
437 tmpdir = "/tmp";
eba25057
JM
438 if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) {
439 return -EOVERFLOW;
440 }
ea2384d3 441 fd = mkstemp(filename);
fe235a06
DH
442 if (fd < 0) {
443 return -errno;
444 }
445 if (close(fd) != 0) {
446 unlink(filename);
eba25057
JM
447 return -errno;
448 }
449 return 0;
d5249393 450#endif
eba25057 451}
fc01f7e7 452
84a12e66
CH
453/*
454 * Detect host devices. By convention, /dev/cdrom[N] is always
455 * recognized as a host CDROM.
456 */
457static BlockDriver *find_hdev_driver(const char *filename)
458{
459 int score_max = 0, score;
460 BlockDriver *drv = NULL, *d;
461
462 QLIST_FOREACH(d, &bdrv_drivers, list) {
463 if (d->bdrv_probe_device) {
464 score = d->bdrv_probe_device(filename);
465 if (score > score_max) {
466 score_max = score;
467 drv = d;
468 }
469 }
470 }
471
472 return drv;
473}
474
b50cbabc 475BlockDriver *bdrv_find_protocol(const char *filename)
83f64091
FB
476{
477 BlockDriver *drv1;
478 char protocol[128];
1cec71e3 479 int len;
83f64091 480 const char *p;
19cb3738 481
66f82cee
KW
482 /* TODO Drivers without bdrv_file_open must be specified explicitly */
483
39508e7a
CH
484 /*
485 * XXX(hch): we really should not let host device detection
486 * override an explicit protocol specification, but moving this
487 * later breaks access to device names with colons in them.
488 * Thanks to the brain-dead persistent naming schemes on udev-
489 * based Linux systems those actually are quite common.
490 */
491 drv1 = find_hdev_driver(filename);
492 if (drv1) {
493 return drv1;
494 }
495
9e0b22f4 496 if (!path_has_protocol(filename)) {
39508e7a 497 return bdrv_find_format("file");
84a12e66 498 }
9e0b22f4
SH
499 p = strchr(filename, ':');
500 assert(p != NULL);
1cec71e3
AL
501 len = p - filename;
502 if (len > sizeof(protocol) - 1)
503 len = sizeof(protocol) - 1;
504 memcpy(protocol, filename, len);
505 protocol[len] = '\0';
8a22f02a 506 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
5fafdf24 507 if (drv1->protocol_name &&
8a22f02a 508 !strcmp(drv1->protocol_name, protocol)) {
83f64091 509 return drv1;
8a22f02a 510 }
83f64091
FB
511 }
512 return NULL;
513}
514
f500a6d3
KW
515static int find_image_format(BlockDriverState *bs, const char *filename,
516 BlockDriver **pdrv)
f3a5d3f8 517{
f500a6d3 518 int score, score_max;
f3a5d3f8
CH
519 BlockDriver *drv1, *drv;
520 uint8_t buf[2048];
f500a6d3 521 int ret = 0;
f8ea0b00 522
08a00559 523 /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
8e895599 524 if (bs->sg || !bdrv_is_inserted(bs) || bdrv_getlength(bs) == 0) {
c98ac35d
SW
525 drv = bdrv_find_format("raw");
526 if (!drv) {
527 ret = -ENOENT;
528 }
529 *pdrv = drv;
530 return ret;
1a396859 531 }
f8ea0b00 532
83f64091 533 ret = bdrv_pread(bs, 0, buf, sizeof(buf));
83f64091 534 if (ret < 0) {
c98ac35d
SW
535 *pdrv = NULL;
536 return ret;
83f64091
FB
537 }
538
ea2384d3 539 score_max = 0;
84a12e66 540 drv = NULL;
8a22f02a 541 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
83f64091
FB
542 if (drv1->bdrv_probe) {
543 score = drv1->bdrv_probe(buf, ret, filename);
544 if (score > score_max) {
545 score_max = score;
546 drv = drv1;
547 }
0849bf08 548 }
fc01f7e7 549 }
c98ac35d
SW
550 if (!drv) {
551 ret = -ENOENT;
552 }
553 *pdrv = drv;
554 return ret;
ea2384d3
FB
555}
556
51762288
SH
557/**
558 * Set the current 'total_sectors' value
559 */
560static int refresh_total_sectors(BlockDriverState *bs, int64_t hint)
561{
562 BlockDriver *drv = bs->drv;
563
396759ad
NB
564 /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
565 if (bs->sg)
566 return 0;
567
51762288
SH
568 /* query actual device if possible, otherwise just trust the hint */
569 if (drv->bdrv_getlength) {
570 int64_t length = drv->bdrv_getlength(bs);
571 if (length < 0) {
572 return length;
573 }
574 hint = length >> BDRV_SECTOR_BITS;
575 }
576
577 bs->total_sectors = hint;
578 return 0;
579}
580
9e8f1835
PB
581/**
582 * Set open flags for a given discard mode
583 *
584 * Return 0 on success, -1 if the discard mode was invalid.
585 */
586int bdrv_parse_discard_flags(const char *mode, int *flags)
587{
588 *flags &= ~BDRV_O_UNMAP;
589
590 if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) {
591 /* do nothing */
592 } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) {
593 *flags |= BDRV_O_UNMAP;
594 } else {
595 return -1;
596 }
597
598 return 0;
599}
600
c3993cdc
SH
601/**
602 * Set open flags for a given cache mode
603 *
604 * Return 0 on success, -1 if the cache mode was invalid.
605 */
606int bdrv_parse_cache_flags(const char *mode, int *flags)
607{
608 *flags &= ~BDRV_O_CACHE_MASK;
609
610 if (!strcmp(mode, "off") || !strcmp(mode, "none")) {
611 *flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB;
92196b2f
SH
612 } else if (!strcmp(mode, "directsync")) {
613 *flags |= BDRV_O_NOCACHE;
c3993cdc
SH
614 } else if (!strcmp(mode, "writeback")) {
615 *flags |= BDRV_O_CACHE_WB;
616 } else if (!strcmp(mode, "unsafe")) {
617 *flags |= BDRV_O_CACHE_WB;
618 *flags |= BDRV_O_NO_FLUSH;
619 } else if (!strcmp(mode, "writethrough")) {
620 /* this is the default */
621 } else {
622 return -1;
623 }
624
625 return 0;
626}
627
53fec9d3
SH
628/**
629 * The copy-on-read flag is actually a reference count so multiple users may
630 * use the feature without worrying about clobbering its previous state.
631 * Copy-on-read stays enabled until all users have called to disable it.
632 */
633void bdrv_enable_copy_on_read(BlockDriverState *bs)
634{
635 bs->copy_on_read++;
636}
637
638void bdrv_disable_copy_on_read(BlockDriverState *bs)
639{
640 assert(bs->copy_on_read > 0);
641 bs->copy_on_read--;
642}
643
7b272452
KW
644static int bdrv_open_flags(BlockDriverState *bs, int flags)
645{
646 int open_flags = flags | BDRV_O_CACHE_WB;
647
648 /*
649 * Clear flags that are internal to the block layer before opening the
650 * image.
651 */
652 open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
653
654 /*
655 * Snapshots should be writable.
656 */
657 if (bs->is_temporary) {
658 open_flags |= BDRV_O_RDWR;
659 }
660
661 return open_flags;
662}
663
57915332
KW
664/*
665 * Common part for opening disk images and files
b6ad491a
KW
666 *
667 * Removes all processed options from *options.
57915332 668 */
f500a6d3 669static int bdrv_open_common(BlockDriverState *bs, BlockDriverState *file,
035fccdf 670 QDict *options, int flags, BlockDriver *drv)
57915332
KW
671{
672 int ret, open_flags;
035fccdf 673 const char *filename;
57915332
KW
674
675 assert(drv != NULL);
6405875c 676 assert(bs->file == NULL);
707ff828 677 assert(options != NULL && bs->options != options);
57915332 678
28dcee10
SH
679 trace_bdrv_open_common(bs, filename, flags, drv->format_name);
680
5d186eb0
KW
681 if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv)) {
682 return -ENOTSUP;
683 }
684
685 /* bdrv_open() with directly using a protocol as drv. This layer is already
686 * opened, so assign it to bs (while file becomes a closed BlockDriverState)
687 * and return immediately. */
688 if (file != NULL && drv->bdrv_file_open) {
689 bdrv_swap(file, bs);
690 return 0;
691 }
692
57915332 693 bs->open_flags = flags;
57915332
KW
694 bs->buffer_alignment = 512;
695
53fec9d3
SH
696 assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */
697 if ((flags & BDRV_O_RDWR) && (flags & BDRV_O_COPY_ON_READ)) {
698 bdrv_enable_copy_on_read(bs);
699 }
700
035fccdf
KW
701 if (file != NULL) {
702 filename = file->filename;
703 } else {
704 filename = qdict_get_try_str(options, "filename");
705 }
706
c2ad1b0c
KW
707 if (filename != NULL) {
708 pstrcpy(bs->filename, sizeof(bs->filename), filename);
709 } else {
710 bs->filename[0] = '\0';
711 }
57915332 712
57915332 713 bs->drv = drv;
7267c094 714 bs->opaque = g_malloc0(drv->instance_size);
57915332 715
03f541bd 716 bs->enable_write_cache = !!(flags & BDRV_O_CACHE_WB);
7b272452 717 open_flags = bdrv_open_flags(bs, flags);
57915332 718
be028adc 719 bs->read_only = !(open_flags & BDRV_O_RDWR);
e7c63796 720
66f82cee
KW
721 /* Open the image, either directly or using a protocol */
722 if (drv->bdrv_file_open) {
5d186eb0
KW
723 assert(file == NULL);
724 assert(drv->bdrv_parse_filename || filename != NULL);
725 ret = drv->bdrv_file_open(bs, filename, options, open_flags);
f500a6d3 726 } else {
2af5ef70
KW
727 if (file == NULL) {
728 qerror_report(ERROR_CLASS_GENERIC_ERROR, "Can't use '%s' as a "
729 "block driver for the protocol level",
730 drv->format_name);
731 ret = -EINVAL;
732 goto free_and_fail;
733 }
f500a6d3
KW
734 assert(file != NULL);
735 bs->file = file;
b6ad491a 736 ret = drv->bdrv_open(bs, options, open_flags);
66f82cee
KW
737 }
738
57915332
KW
739 if (ret < 0) {
740 goto free_and_fail;
741 }
742
51762288
SH
743 ret = refresh_total_sectors(bs, bs->total_sectors);
744 if (ret < 0) {
745 goto free_and_fail;
57915332 746 }
51762288 747
57915332
KW
748#ifndef _WIN32
749 if (bs->is_temporary) {
c2ad1b0c 750 assert(filename != NULL);
57915332
KW
751 unlink(filename);
752 }
753#endif
754 return 0;
755
756free_and_fail:
f500a6d3 757 bs->file = NULL;
7267c094 758 g_free(bs->opaque);
57915332
KW
759 bs->opaque = NULL;
760 bs->drv = NULL;
761 return ret;
762}
763
b6ce07aa
KW
764/*
765 * Opens a file using a protocol (file, host_device, nbd, ...)
787e4a85
KW
766 *
767 * options is a QDict of options to pass to the block drivers, or NULL for an
768 * empty set of options. The reference to the QDict belongs to the block layer
769 * after the call (even on failure), so if the caller intends to reuse the
770 * dictionary, it needs to use QINCREF() before calling bdrv_file_open.
b6ce07aa 771 */
787e4a85
KW
772int bdrv_file_open(BlockDriverState **pbs, const char *filename,
773 QDict *options, int flags)
ea2384d3 774{
83f64091 775 BlockDriverState *bs;
6db95603 776 BlockDriver *drv;
c2ad1b0c 777 const char *drvname;
83f64091
FB
778 int ret;
779
707ff828
KW
780 /* NULL means an empty set of options */
781 if (options == NULL) {
782 options = qdict_new();
783 }
784
83f64091 785 bs = bdrv_new("");
707ff828
KW
786 bs->options = options;
787 options = qdict_clone_shallow(options);
788
035fccdf
KW
789 /* Fetch the file name from the options QDict if necessary */
790 if (!filename) {
791 filename = qdict_get_try_str(options, "filename");
792 } else if (filename && !qdict_haskey(options, "filename")) {
793 qdict_put(options, "filename", qstring_from_str(filename));
794 } else {
795 qerror_report(ERROR_CLASS_GENERIC_ERROR, "Can't specify 'file' and "
796 "'filename' options at the same time");
797 ret = -EINVAL;
798 goto fail;
799 }
800
c2ad1b0c
KW
801 /* Find the right block driver */
802 drvname = qdict_get_try_str(options, "driver");
803 if (drvname) {
804 drv = bdrv_find_whitelisted_format(drvname);
805 qdict_del(options, "driver");
806 } else if (filename) {
807 drv = bdrv_find_protocol(filename);
808 } else {
809 qerror_report(ERROR_CLASS_GENERIC_ERROR,
810 "Must specify either driver or file");
811 drv = NULL;
812 }
813
814 if (!drv) {
815 ret = -ENOENT;
816 goto fail;
817 }
818
819 /* Parse the filename and open it */
820 if (drv->bdrv_parse_filename && filename) {
6963a30d
KW
821 Error *local_err = NULL;
822 drv->bdrv_parse_filename(filename, options, &local_err);
823 if (error_is_set(&local_err)) {
824 qerror_report_err(local_err);
825 error_free(local_err);
826 ret = -EINVAL;
827 goto fail;
828 }
c2ad1b0c
KW
829 } else if (!drv->bdrv_parse_filename && !filename) {
830 qerror_report(ERROR_CLASS_GENERIC_ERROR,
831 "The '%s' block driver requires a file name",
832 drv->format_name);
833 ret = -EINVAL;
834 goto fail;
6963a30d
KW
835 }
836
035fccdf 837 ret = bdrv_open_common(bs, NULL, options, flags, drv);
83f64091 838 if (ret < 0) {
707ff828
KW
839 goto fail;
840 }
841
035fccdf
KW
842 /* TODO Remove once all protocols know the filename option */
843 if (qdict_haskey(options, "filename")) {
844 qdict_del(options, "filename");
845 }
846
707ff828
KW
847 /* Check if any unknown options were used */
848 if (qdict_size(options) != 0) {
849 const QDictEntry *entry = qdict_first(options);
850 qerror_report(ERROR_CLASS_GENERIC_ERROR, "Block protocol '%s' doesn't "
851 "support the option '%s'",
852 drv->format_name, entry->key);
853 ret = -EINVAL;
854 goto fail;
3b0d4f61 855 }
707ff828
KW
856 QDECREF(options);
857
71d0770c 858 bs->growable = 1;
83f64091
FB
859 *pbs = bs;
860 return 0;
707ff828
KW
861
862fail:
863 QDECREF(options);
864 if (!bs->drv) {
865 QDECREF(bs->options);
866 }
867 bdrv_delete(bs);
868 return ret;
83f64091
FB
869}
870
31ca6d07
KW
871/*
872 * Opens the backing file for a BlockDriverState if not yet open
873 *
874 * options is a QDict of options to pass to the block drivers, or NULL for an
875 * empty set of options. The reference to the QDict is transferred to this
876 * function (even on failure), so if the caller intends to reuse the dictionary,
877 * it needs to use QINCREF() before calling bdrv_file_open.
878 */
879int bdrv_open_backing_file(BlockDriverState *bs, QDict *options)
9156df12
PB
880{
881 char backing_filename[PATH_MAX];
882 int back_flags, ret;
883 BlockDriver *back_drv = NULL;
884
885 if (bs->backing_hd != NULL) {
31ca6d07 886 QDECREF(options);
9156df12
PB
887 return 0;
888 }
889
31ca6d07
KW
890 /* NULL means an empty set of options */
891 if (options == NULL) {
892 options = qdict_new();
893 }
894
9156df12 895 bs->open_flags &= ~BDRV_O_NO_BACKING;
31ca6d07
KW
896 if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) {
897 QDECREF(options);
9156df12
PB
898 return 0;
899 }
900
901 bs->backing_hd = bdrv_new("");
902 bdrv_get_full_backing_filename(bs, backing_filename,
903 sizeof(backing_filename));
904
905 if (bs->backing_format[0] != '\0') {
906 back_drv = bdrv_find_format(bs->backing_format);
907 }
908
909 /* backing files always opened read-only */
910 back_flags = bs->open_flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT);
911
31ca6d07
KW
912 ret = bdrv_open(bs->backing_hd,
913 *backing_filename ? backing_filename : NULL, options,
de9c0cec 914 back_flags, back_drv);
9156df12
PB
915 if (ret < 0) {
916 bdrv_delete(bs->backing_hd);
917 bs->backing_hd = NULL;
918 bs->open_flags |= BDRV_O_NO_BACKING;
919 return ret;
920 }
921 return 0;
922}
923
707ff828
KW
924static void extract_subqdict(QDict *src, QDict **dst, const char *start)
925{
926 const QDictEntry *entry, *next;
927 const char *p;
928
929 *dst = qdict_new();
930 entry = qdict_first(src);
931
932 while (entry != NULL) {
933 next = qdict_next(src, entry);
934 if (strstart(entry->key, start, &p)) {
935 qobject_incref(entry->value);
936 qdict_put_obj(*dst, p, entry->value);
937 qdict_del(src, entry->key);
938 }
939 entry = next;
940 }
941}
942
b6ce07aa
KW
943/*
944 * Opens a disk image (raw, qcow2, vmdk, ...)
de9c0cec
KW
945 *
946 * options is a QDict of options to pass to the block drivers, or NULL for an
947 * empty set of options. The reference to the QDict belongs to the block layer
948 * after the call (even on failure), so if the caller intends to reuse the
949 * dictionary, it needs to use QINCREF() before calling bdrv_open.
b6ce07aa 950 */
de9c0cec
KW
951int bdrv_open(BlockDriverState *bs, const char *filename, QDict *options,
952 int flags, BlockDriver *drv)
ea2384d3 953{
b6ce07aa 954 int ret;
89c9bc3d
SW
955 /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */
956 char tmp_filename[PATH_MAX + 1];
f500a6d3 957 BlockDriverState *file = NULL;
707ff828 958 QDict *file_options = NULL;
712e7874 959
de9c0cec
KW
960 /* NULL means an empty set of options */
961 if (options == NULL) {
962 options = qdict_new();
963 }
964
965 bs->options = options;
b6ad491a 966 options = qdict_clone_shallow(options);
de9c0cec
KW
967
968 /* For snapshot=on, create a temporary qcow2 overlay */
83f64091 969 if (flags & BDRV_O_SNAPSHOT) {
ea2384d3
FB
970 BlockDriverState *bs1;
971 int64_t total_size;
91a073a9 972 BlockDriver *bdrv_qcow2;
08b392e1 973 QEMUOptionParameter *create_options;
b6ce07aa 974 char backing_filename[PATH_MAX];
3b46e624 975
c2ad1b0c
KW
976 if (qdict_size(options) != 0) {
977 error_report("Can't use snapshot=on with driver-specific options");
978 ret = -EINVAL;
979 goto fail;
980 }
981 assert(filename != NULL);
982
ea2384d3
FB
983 /* if snapshot, we create a temporary backing file and open it
984 instead of opening 'filename' directly */
33e3963e 985
ea2384d3
FB
986 /* if there is a backing file, use it */
987 bs1 = bdrv_new("");
de9c0cec 988 ret = bdrv_open(bs1, filename, NULL, 0, drv);
51d7c00c 989 if (ret < 0) {
ea2384d3 990 bdrv_delete(bs1);
de9c0cec 991 goto fail;
ea2384d3 992 }
3e82990b 993 total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
7c96d46e 994
ea2384d3 995 bdrv_delete(bs1);
3b46e624 996
eba25057
JM
997 ret = get_tmp_filename(tmp_filename, sizeof(tmp_filename));
998 if (ret < 0) {
de9c0cec 999 goto fail;
eba25057 1000 }
7c96d46e
AL
1001
1002 /* Real path is meaningless for protocols */
4d70655b 1003 if (path_has_protocol(filename)) {
7c96d46e
AL
1004 snprintf(backing_filename, sizeof(backing_filename),
1005 "%s", filename);
de9c0cec
KW
1006 } else if (!realpath(filename, backing_filename)) {
1007 ret = -errno;
1008 goto fail;
1009 }
7c96d46e 1010
91a073a9 1011 bdrv_qcow2 = bdrv_find_format("qcow2");
08b392e1
KW
1012 create_options = parse_option_parameters("", bdrv_qcow2->create_options,
1013 NULL);
91a073a9 1014
08b392e1
KW
1015 set_option_parameter_int(create_options, BLOCK_OPT_SIZE, total_size);
1016 set_option_parameter(create_options, BLOCK_OPT_BACKING_FILE,
1017 backing_filename);
91a073a9 1018 if (drv) {
08b392e1 1019 set_option_parameter(create_options, BLOCK_OPT_BACKING_FMT,
91a073a9
KW
1020 drv->format_name);
1021 }
1022
08b392e1
KW
1023 ret = bdrv_create(bdrv_qcow2, tmp_filename, create_options);
1024 free_option_parameters(create_options);
51d7c00c 1025 if (ret < 0) {
de9c0cec 1026 goto fail;
ea2384d3 1027 }
91a073a9 1028
ea2384d3 1029 filename = tmp_filename;
91a073a9 1030 drv = bdrv_qcow2;
ea2384d3
FB
1031 bs->is_temporary = 1;
1032 }
712e7874 1033
f500a6d3
KW
1034 /* Open image file without format layer */
1035 if (flags & BDRV_O_RDWR) {
1036 flags |= BDRV_O_ALLOW_RDWR;
1037 }
1038
707ff828
KW
1039 extract_subqdict(options, &file_options, "file.");
1040
1041 ret = bdrv_file_open(&file, filename, file_options,
1042 bdrv_open_flags(bs, flags));
f500a6d3 1043 if (ret < 0) {
de9c0cec 1044 goto fail;
f500a6d3
KW
1045 }
1046
b6ce07aa 1047 /* Find the right image format driver */
6db95603 1048 if (!drv) {
f500a6d3 1049 ret = find_image_format(file, filename, &drv);
51d7c00c 1050 }
6987307c 1051
51d7c00c 1052 if (!drv) {
51d7c00c 1053 goto unlink_and_fail;
ea2384d3 1054 }
b6ce07aa
KW
1055
1056 /* Open the image */
035fccdf 1057 ret = bdrv_open_common(bs, file, options, flags, drv);
b6ce07aa 1058 if (ret < 0) {
6987307c
CH
1059 goto unlink_and_fail;
1060 }
1061
f500a6d3
KW
1062 if (bs->file != file) {
1063 bdrv_delete(file);
1064 file = NULL;
1065 }
1066
b6ce07aa 1067 /* If there is a backing file, use it */
9156df12 1068 if ((flags & BDRV_O_NO_BACKING) == 0) {
31ca6d07
KW
1069 QDict *backing_options;
1070
1071 extract_subqdict(options, &backing_options, "backing.");
1072 ret = bdrv_open_backing_file(bs, backing_options);
b6ce07aa 1073 if (ret < 0) {
b6ad491a 1074 goto close_and_fail;
b6ce07aa 1075 }
b6ce07aa
KW
1076 }
1077
b6ad491a
KW
1078 /* Check if any unknown options were used */
1079 if (qdict_size(options) != 0) {
1080 const QDictEntry *entry = qdict_first(options);
1081 qerror_report(ERROR_CLASS_GENERIC_ERROR, "Block format '%s' used by "
1082 "device '%s' doesn't support the option '%s'",
1083 drv->format_name, bs->device_name, entry->key);
1084
1085 ret = -EINVAL;
1086 goto close_and_fail;
1087 }
1088 QDECREF(options);
1089
b6ce07aa 1090 if (!bdrv_key_required(bs)) {
7d4b4ba5 1091 bdrv_dev_change_media_cb(bs, true);
b6ce07aa
KW
1092 }
1093
98f90dba
ZYW
1094 /* throttling disk I/O limits */
1095 if (bs->io_limits_enabled) {
1096 bdrv_io_limits_enable(bs);
1097 }
1098
b6ce07aa
KW
1099 return 0;
1100
1101unlink_and_fail:
f500a6d3
KW
1102 if (file != NULL) {
1103 bdrv_delete(file);
1104 }
b6ce07aa
KW
1105 if (bs->is_temporary) {
1106 unlink(filename);
1107 }
de9c0cec
KW
1108fail:
1109 QDECREF(bs->options);
b6ad491a 1110 QDECREF(options);
de9c0cec 1111 bs->options = NULL;
b6ad491a 1112 return ret;
de9c0cec 1113
b6ad491a
KW
1114close_and_fail:
1115 bdrv_close(bs);
1116 QDECREF(options);
b6ce07aa
KW
1117 return ret;
1118}
1119
e971aa12
JC
1120typedef struct BlockReopenQueueEntry {
1121 bool prepared;
1122 BDRVReopenState state;
1123 QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry;
1124} BlockReopenQueueEntry;
1125
1126/*
1127 * Adds a BlockDriverState to a simple queue for an atomic, transactional
1128 * reopen of multiple devices.
1129 *
1130 * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT
1131 * already performed, or alternatively may be NULL a new BlockReopenQueue will
1132 * be created and initialized. This newly created BlockReopenQueue should be
1133 * passed back in for subsequent calls that are intended to be of the same
1134 * atomic 'set'.
1135 *
1136 * bs is the BlockDriverState to add to the reopen queue.
1137 *
1138 * flags contains the open flags for the associated bs
1139 *
1140 * returns a pointer to bs_queue, which is either the newly allocated
1141 * bs_queue, or the existing bs_queue being used.
1142 *
1143 */
1144BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
1145 BlockDriverState *bs, int flags)
1146{
1147 assert(bs != NULL);
1148
1149 BlockReopenQueueEntry *bs_entry;
1150 if (bs_queue == NULL) {
1151 bs_queue = g_new0(BlockReopenQueue, 1);
1152 QSIMPLEQ_INIT(bs_queue);
1153 }
1154
1155 if (bs->file) {
1156 bdrv_reopen_queue(bs_queue, bs->file, flags);
1157 }
1158
1159 bs_entry = g_new0(BlockReopenQueueEntry, 1);
1160 QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry);
1161
1162 bs_entry->state.bs = bs;
1163 bs_entry->state.flags = flags;
1164
1165 return bs_queue;
1166}
1167
1168/*
1169 * Reopen multiple BlockDriverStates atomically & transactionally.
1170 *
1171 * The queue passed in (bs_queue) must have been built up previous
1172 * via bdrv_reopen_queue().
1173 *
1174 * Reopens all BDS specified in the queue, with the appropriate
1175 * flags. All devices are prepared for reopen, and failure of any
1176 * device will cause all device changes to be abandonded, and intermediate
1177 * data cleaned up.
1178 *
1179 * If all devices prepare successfully, then the changes are committed
1180 * to all devices.
1181 *
1182 */
1183int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp)
1184{
1185 int ret = -1;
1186 BlockReopenQueueEntry *bs_entry, *next;
1187 Error *local_err = NULL;
1188
1189 assert(bs_queue != NULL);
1190
1191 bdrv_drain_all();
1192
1193 QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1194 if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) {
1195 error_propagate(errp, local_err);
1196 goto cleanup;
1197 }
1198 bs_entry->prepared = true;
1199 }
1200
1201 /* If we reach this point, we have success and just need to apply the
1202 * changes
1203 */
1204 QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
1205 bdrv_reopen_commit(&bs_entry->state);
1206 }
1207
1208 ret = 0;
1209
1210cleanup:
1211 QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) {
1212 if (ret && bs_entry->prepared) {
1213 bdrv_reopen_abort(&bs_entry->state);
1214 }
1215 g_free(bs_entry);
1216 }
1217 g_free(bs_queue);
1218 return ret;
1219}
1220
1221
1222/* Reopen a single BlockDriverState with the specified flags. */
1223int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp)
1224{
1225 int ret = -1;
1226 Error *local_err = NULL;
1227 BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, bdrv_flags);
1228
1229 ret = bdrv_reopen_multiple(queue, &local_err);
1230 if (local_err != NULL) {
1231 error_propagate(errp, local_err);
1232 }
1233 return ret;
1234}
1235
1236
1237/*
1238 * Prepares a BlockDriverState for reopen. All changes are staged in the
1239 * 'opaque' field of the BDRVReopenState, which is used and allocated by
1240 * the block driver layer .bdrv_reopen_prepare()
1241 *
1242 * bs is the BlockDriverState to reopen
1243 * flags are the new open flags
1244 * queue is the reopen queue
1245 *
1246 * Returns 0 on success, non-zero on error. On error errp will be set
1247 * as well.
1248 *
1249 * On failure, bdrv_reopen_abort() will be called to clean up any data.
1250 * It is the responsibility of the caller to then call the abort() or
1251 * commit() for any other BDS that have been left in a prepare() state
1252 *
1253 */
1254int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue,
1255 Error **errp)
1256{
1257 int ret = -1;
1258 Error *local_err = NULL;
1259 BlockDriver *drv;
1260
1261 assert(reopen_state != NULL);
1262 assert(reopen_state->bs->drv != NULL);
1263 drv = reopen_state->bs->drv;
1264
1265 /* if we are to stay read-only, do not allow permission change
1266 * to r/w */
1267 if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) &&
1268 reopen_state->flags & BDRV_O_RDWR) {
1269 error_set(errp, QERR_DEVICE_IS_READ_ONLY,
1270 reopen_state->bs->device_name);
1271 goto error;
1272 }
1273
1274
1275 ret = bdrv_flush(reopen_state->bs);
1276 if (ret) {
1277 error_set(errp, ERROR_CLASS_GENERIC_ERROR, "Error (%s) flushing drive",
1278 strerror(-ret));
1279 goto error;
1280 }
1281
1282 if (drv->bdrv_reopen_prepare) {
1283 ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err);
1284 if (ret) {
1285 if (local_err != NULL) {
1286 error_propagate(errp, local_err);
1287 } else {
1288 error_set(errp, QERR_OPEN_FILE_FAILED,
1289 reopen_state->bs->filename);
1290 }
1291 goto error;
1292 }
1293 } else {
1294 /* It is currently mandatory to have a bdrv_reopen_prepare()
1295 * handler for each supported drv. */
1296 error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
1297 drv->format_name, reopen_state->bs->device_name,
1298 "reopening of file");
1299 ret = -1;
1300 goto error;
1301 }
1302
1303 ret = 0;
1304
1305error:
1306 return ret;
1307}
1308
1309/*
1310 * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and
1311 * makes them final by swapping the staging BlockDriverState contents into
1312 * the active BlockDriverState contents.
1313 */
1314void bdrv_reopen_commit(BDRVReopenState *reopen_state)
1315{
1316 BlockDriver *drv;
1317
1318 assert(reopen_state != NULL);
1319 drv = reopen_state->bs->drv;
1320 assert(drv != NULL);
1321
1322 /* If there are any driver level actions to take */
1323 if (drv->bdrv_reopen_commit) {
1324 drv->bdrv_reopen_commit(reopen_state);
1325 }
1326
1327 /* set BDS specific flags now */
1328 reopen_state->bs->open_flags = reopen_state->flags;
1329 reopen_state->bs->enable_write_cache = !!(reopen_state->flags &
1330 BDRV_O_CACHE_WB);
1331 reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR);
1332}
1333
1334/*
1335 * Abort the reopen, and delete and free the staged changes in
1336 * reopen_state
1337 */
1338void bdrv_reopen_abort(BDRVReopenState *reopen_state)
1339{
1340 BlockDriver *drv;
1341
1342 assert(reopen_state != NULL);
1343 drv = reopen_state->bs->drv;
1344 assert(drv != NULL);
1345
1346 if (drv->bdrv_reopen_abort) {
1347 drv->bdrv_reopen_abort(reopen_state);
1348 }
1349}
1350
1351
fc01f7e7
FB
1352void bdrv_close(BlockDriverState *bs)
1353{
80ccf93b 1354 bdrv_flush(bs);
3cbc002c
PB
1355 if (bs->job) {
1356 block_job_cancel_sync(bs->job);
1357 }
1358 bdrv_drain_all();
d7d512f6 1359 notifier_list_notify(&bs->close_notifiers, bs);
7094f12f 1360
3cbc002c 1361 if (bs->drv) {
f9092b10
MA
1362 if (bs == bs_snapshots) {
1363 bs_snapshots = NULL;
1364 }
557df6ac 1365 if (bs->backing_hd) {
ea2384d3 1366 bdrv_delete(bs->backing_hd);
557df6ac
SH
1367 bs->backing_hd = NULL;
1368 }
ea2384d3 1369 bs->drv->bdrv_close(bs);
7267c094 1370 g_free(bs->opaque);
ea2384d3
FB
1371#ifdef _WIN32
1372 if (bs->is_temporary) {
1373 unlink(bs->filename);
1374 }
67b915a5 1375#endif
ea2384d3
FB
1376 bs->opaque = NULL;
1377 bs->drv = NULL;
53fec9d3 1378 bs->copy_on_read = 0;
a275fa42
PB
1379 bs->backing_file[0] = '\0';
1380 bs->backing_format[0] = '\0';
6405875c
PB
1381 bs->total_sectors = 0;
1382 bs->encrypted = 0;
1383 bs->valid_key = 0;
1384 bs->sg = 0;
1385 bs->growable = 0;
de9c0cec
KW
1386 QDECREF(bs->options);
1387 bs->options = NULL;
b338082b 1388
66f82cee 1389 if (bs->file != NULL) {
0ac9377d
PB
1390 bdrv_delete(bs->file);
1391 bs->file = NULL;
66f82cee 1392 }
b338082b 1393 }
98f90dba 1394
9ca11154
PH
1395 bdrv_dev_change_media_cb(bs, false);
1396
98f90dba
ZYW
1397 /*throttling disk I/O limits*/
1398 if (bs->io_limits_enabled) {
1399 bdrv_io_limits_disable(bs);
1400 }
b338082b
FB
1401}
1402
2bc93fed
MK
1403void bdrv_close_all(void)
1404{
1405 BlockDriverState *bs;
1406
1407 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1408 bdrv_close(bs);
1409 }
1410}
1411
922453bc
SH
1412/*
1413 * Wait for pending requests to complete across all BlockDriverStates
1414 *
1415 * This function does not flush data to disk, use bdrv_flush_all() for that
1416 * after calling this function.
4c355d53
ZYW
1417 *
1418 * Note that completion of an asynchronous I/O operation can trigger any
1419 * number of other I/O operations on other devices---for example a coroutine
1420 * can be arbitrarily complex and a constant flow of I/O can come until the
1421 * coroutine is complete. Because of this, it is not possible to have a
1422 * function to drain a single device's I/O queue.
922453bc
SH
1423 */
1424void bdrv_drain_all(void)
1425{
1426 BlockDriverState *bs;
4c355d53
ZYW
1427 bool busy;
1428
1429 do {
1430 busy = qemu_aio_wait();
922453bc 1431
4c355d53
ZYW
1432 /* FIXME: We do not have timer support here, so this is effectively
1433 * a busy wait.
1434 */
1435 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1436 if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
1437 qemu_co_queue_restart_all(&bs->throttled_reqs);
1438 busy = true;
1439 }
1440 }
1441 } while (busy);
922453bc
SH
1442
1443 /* If requests are still pending there is a bug somewhere */
1444 QTAILQ_FOREACH(bs, &bdrv_states, list) {
1445 assert(QLIST_EMPTY(&bs->tracked_requests));
1446 assert(qemu_co_queue_empty(&bs->throttled_reqs));
1447 }
1448}
1449
d22b2f41
RH
1450/* make a BlockDriverState anonymous by removing from bdrv_state list.
1451 Also, NULL terminate the device_name to prevent double remove */
1452void bdrv_make_anon(BlockDriverState *bs)
1453{
1454 if (bs->device_name[0] != '\0') {
1455 QTAILQ_REMOVE(&bdrv_states, bs, list);
1456 }
1457 bs->device_name[0] = '\0';
1458}
1459
e023b2e2
PB
1460static void bdrv_rebind(BlockDriverState *bs)
1461{
1462 if (bs->drv && bs->drv->bdrv_rebind) {
1463 bs->drv->bdrv_rebind(bs);
1464 }
1465}
1466
4ddc07ca
PB
1467static void bdrv_move_feature_fields(BlockDriverState *bs_dest,
1468 BlockDriverState *bs_src)
8802d1fd 1469{
4ddc07ca
PB
1470 /* move some fields that need to stay attached to the device */
1471 bs_dest->open_flags = bs_src->open_flags;
8802d1fd
JC
1472
1473 /* dev info */
4ddc07ca
PB
1474 bs_dest->dev_ops = bs_src->dev_ops;
1475 bs_dest->dev_opaque = bs_src->dev_opaque;
1476 bs_dest->dev = bs_src->dev;
1477 bs_dest->buffer_alignment = bs_src->buffer_alignment;
1478 bs_dest->copy_on_read = bs_src->copy_on_read;
8802d1fd 1479
4ddc07ca 1480 bs_dest->enable_write_cache = bs_src->enable_write_cache;
c4a248a1 1481
8802d1fd 1482 /* i/o timing parameters */
4ddc07ca
PB
1483 bs_dest->slice_start = bs_src->slice_start;
1484 bs_dest->slice_end = bs_src->slice_end;
5905fbc9 1485 bs_dest->slice_submitted = bs_src->slice_submitted;
4ddc07ca 1486 bs_dest->io_limits = bs_src->io_limits;
4ddc07ca
PB
1487 bs_dest->throttled_reqs = bs_src->throttled_reqs;
1488 bs_dest->block_timer = bs_src->block_timer;
1489 bs_dest->io_limits_enabled = bs_src->io_limits_enabled;
8802d1fd 1490
8802d1fd 1491 /* r/w error */
4ddc07ca
PB
1492 bs_dest->on_read_error = bs_src->on_read_error;
1493 bs_dest->on_write_error = bs_src->on_write_error;
8802d1fd
JC
1494
1495 /* i/o status */
4ddc07ca
PB
1496 bs_dest->iostatus_enabled = bs_src->iostatus_enabled;
1497 bs_dest->iostatus = bs_src->iostatus;
8802d1fd 1498
a9fc4408 1499 /* dirty bitmap */
4ddc07ca 1500 bs_dest->dirty_bitmap = bs_src->dirty_bitmap;
a9fc4408
PB
1501
1502 /* job */
4ddc07ca
PB
1503 bs_dest->in_use = bs_src->in_use;
1504 bs_dest->job = bs_src->job;
a9fc4408 1505
8802d1fd 1506 /* keep the same entry in bdrv_states */
4ddc07ca
PB
1507 pstrcpy(bs_dest->device_name, sizeof(bs_dest->device_name),
1508 bs_src->device_name);
1509 bs_dest->list = bs_src->list;
1510}
8802d1fd 1511
4ddc07ca
PB
1512/*
1513 * Swap bs contents for two image chains while they are live,
1514 * while keeping required fields on the BlockDriverState that is
1515 * actually attached to a device.
1516 *
1517 * This will modify the BlockDriverState fields, and swap contents
1518 * between bs_new and bs_old. Both bs_new and bs_old are modified.
1519 *
1520 * bs_new is required to be anonymous.
1521 *
1522 * This function does not create any image files.
1523 */
1524void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old)
1525{
1526 BlockDriverState tmp;
f6801b83 1527
4ddc07ca
PB
1528 /* bs_new must be anonymous and shouldn't have anything fancy enabled */
1529 assert(bs_new->device_name[0] == '\0');
1530 assert(bs_new->dirty_bitmap == NULL);
1531 assert(bs_new->job == NULL);
1532 assert(bs_new->dev == NULL);
1533 assert(bs_new->in_use == 0);
1534 assert(bs_new->io_limits_enabled == false);
1535 assert(bs_new->block_timer == NULL);
8802d1fd 1536
4ddc07ca
PB
1537 tmp = *bs_new;
1538 *bs_new = *bs_old;
1539 *bs_old = tmp;
a9fc4408 1540
4ddc07ca
PB
1541 /* there are some fields that should not be swapped, move them back */
1542 bdrv_move_feature_fields(&tmp, bs_old);
1543 bdrv_move_feature_fields(bs_old, bs_new);
1544 bdrv_move_feature_fields(bs_new, &tmp);
8802d1fd 1545
4ddc07ca
PB
1546 /* bs_new shouldn't be in bdrv_states even after the swap! */
1547 assert(bs_new->device_name[0] == '\0');
1548
1549 /* Check a few fields that should remain attached to the device */
1550 assert(bs_new->dev == NULL);
1551 assert(bs_new->job == NULL);
1552 assert(bs_new->in_use == 0);
1553 assert(bs_new->io_limits_enabled == false);
1554 assert(bs_new->block_timer == NULL);
e023b2e2
PB
1555
1556 bdrv_rebind(bs_new);
4ddc07ca
PB
1557 bdrv_rebind(bs_old);
1558}
1559
1560/*
1561 * Add new bs contents at the top of an image chain while the chain is
1562 * live, while keeping required fields on the top layer.
1563 *
1564 * This will modify the BlockDriverState fields, and swap contents
1565 * between bs_new and bs_top. Both bs_new and bs_top are modified.
1566 *
1567 * bs_new is required to be anonymous.
1568 *
1569 * This function does not create any image files.
1570 */
1571void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top)
1572{
1573 bdrv_swap(bs_new, bs_top);
1574
1575 /* The contents of 'tmp' will become bs_top, as we are
1576 * swapping bs_new and bs_top contents. */
1577 bs_top->backing_hd = bs_new;
1578 bs_top->open_flags &= ~BDRV_O_NO_BACKING;
1579 pstrcpy(bs_top->backing_file, sizeof(bs_top->backing_file),
1580 bs_new->filename);
1581 pstrcpy(bs_top->backing_format, sizeof(bs_top->backing_format),
1582 bs_new->drv ? bs_new->drv->format_name : "");
8802d1fd
JC
1583}
1584
b338082b
FB
1585void bdrv_delete(BlockDriverState *bs)
1586{
fa879d62 1587 assert(!bs->dev);
3e914655
PB
1588 assert(!bs->job);
1589 assert(!bs->in_use);
18846dee 1590
1b7bdbc1 1591 /* remove from list, if necessary */
d22b2f41 1592 bdrv_make_anon(bs);
34c6f050 1593
b338082b 1594 bdrv_close(bs);
66f82cee 1595
f9092b10 1596 assert(bs != bs_snapshots);
7267c094 1597 g_free(bs);
fc01f7e7
FB
1598}
1599
fa879d62
MA
1600int bdrv_attach_dev(BlockDriverState *bs, void *dev)
1601/* TODO change to DeviceState *dev when all users are qdevified */
18846dee 1602{
fa879d62 1603 if (bs->dev) {
18846dee
MA
1604 return -EBUSY;
1605 }
fa879d62 1606 bs->dev = dev;
28a7282a 1607 bdrv_iostatus_reset(bs);
18846dee
MA
1608 return 0;
1609}
1610
fa879d62
MA
1611/* TODO qdevified devices don't use this, remove when devices are qdevified */
1612void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev)
18846dee 1613{
fa879d62
MA
1614 if (bdrv_attach_dev(bs, dev) < 0) {
1615 abort();
1616 }
1617}
1618
1619void bdrv_detach_dev(BlockDriverState *bs, void *dev)
1620/* TODO change to DeviceState *dev when all users are qdevified */
1621{
1622 assert(bs->dev == dev);
1623 bs->dev = NULL;
0e49de52
MA
1624 bs->dev_ops = NULL;
1625 bs->dev_opaque = NULL;
29e05f20 1626 bs->buffer_alignment = 512;
18846dee
MA
1627}
1628
fa879d62
MA
1629/* TODO change to return DeviceState * when all users are qdevified */
1630void *bdrv_get_attached_dev(BlockDriverState *bs)
18846dee 1631{
fa879d62 1632 return bs->dev;
18846dee
MA
1633}
1634
0e49de52
MA
1635void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
1636 void *opaque)
1637{
1638 bs->dev_ops = ops;
1639 bs->dev_opaque = opaque;
2c6942fa
MA
1640 if (bdrv_dev_has_removable_media(bs) && bs == bs_snapshots) {
1641 bs_snapshots = NULL;
1642 }
0e49de52
MA
1643}
1644
32c81a4a
PB
1645void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
1646 enum MonitorEvent ev,
1647 BlockErrorAction action, bool is_read)
329c0a48
LC
1648{
1649 QObject *data;
1650 const char *action_str;
1651
1652 switch (action) {
1653 case BDRV_ACTION_REPORT:
1654 action_str = "report";
1655 break;
1656 case BDRV_ACTION_IGNORE:
1657 action_str = "ignore";
1658 break;
1659 case BDRV_ACTION_STOP:
1660 action_str = "stop";
1661 break;
1662 default:
1663 abort();
1664 }
1665
1666 data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
1667 bdrv->device_name,
1668 action_str,
1669 is_read ? "read" : "write");
32c81a4a 1670 monitor_protocol_event(ev, data);
329c0a48
LC
1671
1672 qobject_decref(data);
1673}
1674
6f382ed2
LC
1675static void bdrv_emit_qmp_eject_event(BlockDriverState *bs, bool ejected)
1676{
1677 QObject *data;
1678
1679 data = qobject_from_jsonf("{ 'device': %s, 'tray-open': %i }",
1680 bdrv_get_device_name(bs), ejected);
1681 monitor_protocol_event(QEVENT_DEVICE_TRAY_MOVED, data);
1682
1683 qobject_decref(data);
1684}
1685
7d4b4ba5 1686static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load)
0e49de52 1687{
145feb17 1688 if (bs->dev_ops && bs->dev_ops->change_media_cb) {
6f382ed2 1689 bool tray_was_closed = !bdrv_dev_is_tray_open(bs);
7d4b4ba5 1690 bs->dev_ops->change_media_cb(bs->dev_opaque, load);
6f382ed2
LC
1691 if (tray_was_closed) {
1692 /* tray open */
1693 bdrv_emit_qmp_eject_event(bs, true);
1694 }
1695 if (load) {
1696 /* tray close */
1697 bdrv_emit_qmp_eject_event(bs, false);
1698 }
145feb17
MA
1699 }
1700}
1701
2c6942fa
MA
1702bool bdrv_dev_has_removable_media(BlockDriverState *bs)
1703{
1704 return !bs->dev || (bs->dev_ops && bs->dev_ops->change_media_cb);
1705}
1706
025ccaa7
PB
1707void bdrv_dev_eject_request(BlockDriverState *bs, bool force)
1708{
1709 if (bs->dev_ops && bs->dev_ops->eject_request_cb) {
1710 bs->dev_ops->eject_request_cb(bs->dev_opaque, force);
1711 }
1712}
1713
e4def80b
MA
1714bool bdrv_dev_is_tray_open(BlockDriverState *bs)
1715{
1716 if (bs->dev_ops && bs->dev_ops->is_tray_open) {
1717 return bs->dev_ops->is_tray_open(bs->dev_opaque);
1718 }
1719 return false;
1720}
1721
145feb17
MA
1722static void bdrv_dev_resize_cb(BlockDriverState *bs)
1723{
1724 if (bs->dev_ops && bs->dev_ops->resize_cb) {
1725 bs->dev_ops->resize_cb(bs->dev_opaque);
0e49de52
MA
1726 }
1727}
1728
f107639a
MA
1729bool bdrv_dev_is_medium_locked(BlockDriverState *bs)
1730{
1731 if (bs->dev_ops && bs->dev_ops->is_medium_locked) {
1732 return bs->dev_ops->is_medium_locked(bs->dev_opaque);
1733 }
1734 return false;
1735}
1736
e97fc193
AL
1737/*
1738 * Run consistency checks on an image
1739 *
e076f338 1740 * Returns 0 if the check could be completed (it doesn't mean that the image is
a1c7273b 1741 * free of errors) or -errno when an internal error occurred. The results of the
e076f338 1742 * check are stored in res.
e97fc193 1743 */
4534ff54 1744int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix)
e97fc193
AL
1745{
1746 if (bs->drv->bdrv_check == NULL) {
1747 return -ENOTSUP;
1748 }
1749
e076f338 1750 memset(res, 0, sizeof(*res));
4534ff54 1751 return bs->drv->bdrv_check(bs, res, fix);
e97fc193
AL
1752}
1753
8a426614
KW
1754#define COMMIT_BUF_SECTORS 2048
1755
33e3963e
FB
1756/* commit COW file into the raw image */
1757int bdrv_commit(BlockDriverState *bs)
1758{
19cb3738 1759 BlockDriver *drv = bs->drv;
8a426614
KW
1760 int64_t sector, total_sectors;
1761 int n, ro, open_flags;
0bce597d 1762 int ret = 0;
8a426614 1763 uint8_t *buf;
c2cba3d9 1764 char filename[PATH_MAX];
33e3963e 1765
19cb3738
FB
1766 if (!drv)
1767 return -ENOMEDIUM;
4dca4b63
NS
1768
1769 if (!bs->backing_hd) {
1770 return -ENOTSUP;
33e3963e
FB
1771 }
1772
2d3735d3
SH
1773 if (bdrv_in_use(bs) || bdrv_in_use(bs->backing_hd)) {
1774 return -EBUSY;
1775 }
1776
4dca4b63 1777 ro = bs->backing_hd->read_only;
c2cba3d9
JM
1778 /* Use pstrcpy (not strncpy): filename must be NUL-terminated. */
1779 pstrcpy(filename, sizeof(filename), bs->backing_hd->filename);
4dca4b63
NS
1780 open_flags = bs->backing_hd->open_flags;
1781
1782 if (ro) {
0bce597d
JC
1783 if (bdrv_reopen(bs->backing_hd, open_flags | BDRV_O_RDWR, NULL)) {
1784 return -EACCES;
4dca4b63 1785 }
ea2384d3 1786 }
33e3963e 1787
6ea44308 1788 total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
7267c094 1789 buf = g_malloc(COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE);
8a426614
KW
1790
1791 for (sector = 0; sector < total_sectors; sector += n) {
05c4af54 1792 if (bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n)) {
8a426614
KW
1793
1794 if (bdrv_read(bs, sector, buf, n) != 0) {
1795 ret = -EIO;
1796 goto ro_cleanup;
1797 }
1798
1799 if (bdrv_write(bs->backing_hd, sector, buf, n) != 0) {
1800 ret = -EIO;
1801 goto ro_cleanup;
1802 }
ea2384d3 1803 }
33e3963e 1804 }
95389c86 1805
1d44952f
CH
1806 if (drv->bdrv_make_empty) {
1807 ret = drv->bdrv_make_empty(bs);
1808 bdrv_flush(bs);
1809 }
95389c86 1810
3f5075ae
CH
1811 /*
1812 * Make sure all data we wrote to the backing device is actually
1813 * stable on disk.
1814 */
1815 if (bs->backing_hd)
1816 bdrv_flush(bs->backing_hd);
4dca4b63
NS
1817
1818ro_cleanup:
7267c094 1819 g_free(buf);
4dca4b63
NS
1820
1821 if (ro) {
0bce597d
JC
1822 /* ignoring error return here */
1823 bdrv_reopen(bs->backing_hd, open_flags & ~BDRV_O_RDWR, NULL);
4dca4b63
NS
1824 }
1825
1d44952f 1826 return ret;
33e3963e
FB
1827}
1828
e8877497 1829int bdrv_commit_all(void)
6ab4b5ab
MA
1830{
1831 BlockDriverState *bs;
1832
1833 QTAILQ_FOREACH(bs, &bdrv_states, list) {
272d2d8e
JC
1834 if (bs->drv && bs->backing_hd) {
1835 int ret = bdrv_commit(bs);
1836 if (ret < 0) {
1837 return ret;
1838 }
e8877497 1839 }
6ab4b5ab 1840 }
e8877497 1841 return 0;
6ab4b5ab
MA
1842}
1843
dbffbdcf
SH
1844struct BdrvTrackedRequest {
1845 BlockDriverState *bs;
1846 int64_t sector_num;
1847 int nb_sectors;
1848 bool is_write;
1849 QLIST_ENTRY(BdrvTrackedRequest) list;
5f8b6491 1850 Coroutine *co; /* owner, used for deadlock detection */
f4658285 1851 CoQueue wait_queue; /* coroutines blocked on this request */
dbffbdcf
SH
1852};
1853
1854/**
1855 * Remove an active request from the tracked requests list
1856 *
1857 * This function should be called when a tracked request is completing.
1858 */
1859static void tracked_request_end(BdrvTrackedRequest *req)
1860{
1861 QLIST_REMOVE(req, list);
f4658285 1862 qemu_co_queue_restart_all(&req->wait_queue);
dbffbdcf
SH
1863}
1864
1865/**
1866 * Add an active request to the tracked requests list
1867 */
1868static void tracked_request_begin(BdrvTrackedRequest *req,
1869 BlockDriverState *bs,
1870 int64_t sector_num,
1871 int nb_sectors, bool is_write)
1872{
1873 *req = (BdrvTrackedRequest){
1874 .bs = bs,
1875 .sector_num = sector_num,
1876 .nb_sectors = nb_sectors,
1877 .is_write = is_write,
5f8b6491 1878 .co = qemu_coroutine_self(),
dbffbdcf
SH
1879 };
1880
f4658285
SH
1881 qemu_co_queue_init(&req->wait_queue);
1882
dbffbdcf
SH
1883 QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
1884}
1885
d83947ac
SH
1886/**
1887 * Round a region to cluster boundaries
1888 */
343bded4
PB
1889void bdrv_round_to_clusters(BlockDriverState *bs,
1890 int64_t sector_num, int nb_sectors,
1891 int64_t *cluster_sector_num,
1892 int *cluster_nb_sectors)
d83947ac
SH
1893{
1894 BlockDriverInfo bdi;
1895
1896 if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
1897 *cluster_sector_num = sector_num;
1898 *cluster_nb_sectors = nb_sectors;
1899 } else {
1900 int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE;
1901 *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c);
1902 *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num +
1903 nb_sectors, c);
1904 }
1905}
1906
f4658285
SH
1907static bool tracked_request_overlaps(BdrvTrackedRequest *req,
1908 int64_t sector_num, int nb_sectors) {
d83947ac
SH
1909 /* aaaa bbbb */
1910 if (sector_num >= req->sector_num + req->nb_sectors) {
1911 return false;
1912 }
1913 /* bbbb aaaa */
1914 if (req->sector_num >= sector_num + nb_sectors) {
1915 return false;
1916 }
1917 return true;
f4658285
SH
1918}
1919
1920static void coroutine_fn wait_for_overlapping_requests(BlockDriverState *bs,
1921 int64_t sector_num, int nb_sectors)
1922{
1923 BdrvTrackedRequest *req;
d83947ac
SH
1924 int64_t cluster_sector_num;
1925 int cluster_nb_sectors;
f4658285
SH
1926 bool retry;
1927
d83947ac
SH
1928 /* If we touch the same cluster it counts as an overlap. This guarantees
1929 * that allocating writes will be serialized and not race with each other
1930 * for the same cluster. For example, in copy-on-read it ensures that the
1931 * CoR read and write operations are atomic and guest writes cannot
1932 * interleave between them.
1933 */
343bded4
PB
1934 bdrv_round_to_clusters(bs, sector_num, nb_sectors,
1935 &cluster_sector_num, &cluster_nb_sectors);
d83947ac 1936
f4658285
SH
1937 do {
1938 retry = false;
1939 QLIST_FOREACH(req, &bs->tracked_requests, list) {
d83947ac
SH
1940 if (tracked_request_overlaps(req, cluster_sector_num,
1941 cluster_nb_sectors)) {
5f8b6491
SH
1942 /* Hitting this means there was a reentrant request, for
1943 * example, a block driver issuing nested requests. This must
1944 * never happen since it means deadlock.
1945 */
1946 assert(qemu_coroutine_self() != req->co);
1947
f4658285
SH
1948 qemu_co_queue_wait(&req->wait_queue);
1949 retry = true;
1950 break;
1951 }
1952 }
1953 } while (retry);
1954}
1955
756e6736
KW
1956/*
1957 * Return values:
1958 * 0 - success
1959 * -EINVAL - backing format specified, but no file
1960 * -ENOSPC - can't update the backing file because no space is left in the
1961 * image file header
1962 * -ENOTSUP - format driver doesn't support changing the backing file
1963 */
1964int bdrv_change_backing_file(BlockDriverState *bs,
1965 const char *backing_file, const char *backing_fmt)
1966{
1967 BlockDriver *drv = bs->drv;
469ef350 1968 int ret;
756e6736 1969
5f377794
PB
1970 /* Backing file format doesn't make sense without a backing file */
1971 if (backing_fmt && !backing_file) {
1972 return -EINVAL;
1973 }
1974
756e6736 1975 if (drv->bdrv_change_backing_file != NULL) {
469ef350 1976 ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
756e6736 1977 } else {
469ef350 1978 ret = -ENOTSUP;
756e6736 1979 }
469ef350
PB
1980
1981 if (ret == 0) {
1982 pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1983 pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1984 }
1985 return ret;
756e6736
KW
1986}
1987
6ebdcee2
JC
1988/*
1989 * Finds the image layer in the chain that has 'bs' as its backing file.
1990 *
1991 * active is the current topmost image.
1992 *
1993 * Returns NULL if bs is not found in active's image chain,
1994 * or if active == bs.
1995 */
1996BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
1997 BlockDriverState *bs)
1998{
1999 BlockDriverState *overlay = NULL;
2000 BlockDriverState *intermediate;
2001
2002 assert(active != NULL);
2003 assert(bs != NULL);
2004
2005 /* if bs is the same as active, then by definition it has no overlay
2006 */
2007 if (active == bs) {
2008 return NULL;
2009 }
2010
2011 intermediate = active;
2012 while (intermediate->backing_hd) {
2013 if (intermediate->backing_hd == bs) {
2014 overlay = intermediate;
2015 break;
2016 }
2017 intermediate = intermediate->backing_hd;
2018 }
2019
2020 return overlay;
2021}
2022
2023typedef struct BlkIntermediateStates {
2024 BlockDriverState *bs;
2025 QSIMPLEQ_ENTRY(BlkIntermediateStates) entry;
2026} BlkIntermediateStates;
2027
2028
2029/*
2030 * Drops images above 'base' up to and including 'top', and sets the image
2031 * above 'top' to have base as its backing file.
2032 *
2033 * Requires that the overlay to 'top' is opened r/w, so that the backing file
2034 * information in 'bs' can be properly updated.
2035 *
2036 * E.g., this will convert the following chain:
2037 * bottom <- base <- intermediate <- top <- active
2038 *
2039 * to
2040 *
2041 * bottom <- base <- active
2042 *
2043 * It is allowed for bottom==base, in which case it converts:
2044 *
2045 * base <- intermediate <- top <- active
2046 *
2047 * to
2048 *
2049 * base <- active
2050 *
2051 * Error conditions:
2052 * if active == top, that is considered an error
2053 *
2054 */
2055int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
2056 BlockDriverState *base)
2057{
2058 BlockDriverState *intermediate;
2059 BlockDriverState *base_bs = NULL;
2060 BlockDriverState *new_top_bs = NULL;
2061 BlkIntermediateStates *intermediate_state, *next;
2062 int ret = -EIO;
2063
2064 QSIMPLEQ_HEAD(states_to_delete, BlkIntermediateStates) states_to_delete;
2065 QSIMPLEQ_INIT(&states_to_delete);
2066
2067 if (!top->drv || !base->drv) {
2068 goto exit;
2069 }
2070
2071 new_top_bs = bdrv_find_overlay(active, top);
2072
2073 if (new_top_bs == NULL) {
2074 /* we could not find the image above 'top', this is an error */
2075 goto exit;
2076 }
2077
2078 /* special case of new_top_bs->backing_hd already pointing to base - nothing
2079 * to do, no intermediate images */
2080 if (new_top_bs->backing_hd == base) {
2081 ret = 0;
2082 goto exit;
2083 }
2084
2085 intermediate = top;
2086
2087 /* now we will go down through the list, and add each BDS we find
2088 * into our deletion queue, until we hit the 'base'
2089 */
2090 while (intermediate) {
2091 intermediate_state = g_malloc0(sizeof(BlkIntermediateStates));
2092 intermediate_state->bs = intermediate;
2093 QSIMPLEQ_INSERT_TAIL(&states_to_delete, intermediate_state, entry);
2094
2095 if (intermediate->backing_hd == base) {
2096 base_bs = intermediate->backing_hd;
2097 break;
2098 }
2099 intermediate = intermediate->backing_hd;
2100 }
2101 if (base_bs == NULL) {
2102 /* something went wrong, we did not end at the base. safely
2103 * unravel everything, and exit with error */
2104 goto exit;
2105 }
2106
2107 /* success - we can delete the intermediate states, and link top->base */
2108 ret = bdrv_change_backing_file(new_top_bs, base_bs->filename,
2109 base_bs->drv ? base_bs->drv->format_name : "");
2110 if (ret) {
2111 goto exit;
2112 }
2113 new_top_bs->backing_hd = base_bs;
2114
2115
2116 QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
2117 /* so that bdrv_close() does not recursively close the chain */
2118 intermediate_state->bs->backing_hd = NULL;
2119 bdrv_delete(intermediate_state->bs);
2120 }
2121 ret = 0;
2122
2123exit:
2124 QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) {
2125 g_free(intermediate_state);
2126 }
2127 return ret;
2128}
2129
2130
71d0770c
AL
2131static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
2132 size_t size)
2133{
2134 int64_t len;
2135
2136 if (!bdrv_is_inserted(bs))
2137 return -ENOMEDIUM;
2138
2139 if (bs->growable)
2140 return 0;
2141
2142 len = bdrv_getlength(bs);
2143
fbb7b4e0
KW
2144 if (offset < 0)
2145 return -EIO;
2146
2147 if ((offset > len) || (len - offset < size))
71d0770c
AL
2148 return -EIO;
2149
2150 return 0;
2151}
2152
2153static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
2154 int nb_sectors)
2155{
eb5a3165
JS
2156 return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
2157 nb_sectors * BDRV_SECTOR_SIZE);
71d0770c
AL
2158}
2159
1c9805a3
SH
2160typedef struct RwCo {
2161 BlockDriverState *bs;
2162 int64_t sector_num;
2163 int nb_sectors;
2164 QEMUIOVector *qiov;
2165 bool is_write;
2166 int ret;
2167} RwCo;
2168
2169static void coroutine_fn bdrv_rw_co_entry(void *opaque)
fc01f7e7 2170{
1c9805a3 2171 RwCo *rwco = opaque;
ea2384d3 2172
1c9805a3
SH
2173 if (!rwco->is_write) {
2174 rwco->ret = bdrv_co_do_readv(rwco->bs, rwco->sector_num,
470c0504 2175 rwco->nb_sectors, rwco->qiov, 0);
1c9805a3
SH
2176 } else {
2177 rwco->ret = bdrv_co_do_writev(rwco->bs, rwco->sector_num,
f08f2dda 2178 rwco->nb_sectors, rwco->qiov, 0);
1c9805a3
SH
2179 }
2180}
e7a8a783 2181
1c9805a3 2182/*
8d3b1a2d 2183 * Process a vectored synchronous request using coroutines
1c9805a3 2184 */
8d3b1a2d
KW
2185static int bdrv_rwv_co(BlockDriverState *bs, int64_t sector_num,
2186 QEMUIOVector *qiov, bool is_write)
1c9805a3 2187{
1c9805a3
SH
2188 Coroutine *co;
2189 RwCo rwco = {
2190 .bs = bs,
2191 .sector_num = sector_num,
8d3b1a2d
KW
2192 .nb_sectors = qiov->size >> BDRV_SECTOR_BITS,
2193 .qiov = qiov,
1c9805a3
SH
2194 .is_write = is_write,
2195 .ret = NOT_DONE,
2196 };
8d3b1a2d 2197 assert((qiov->size & (BDRV_SECTOR_SIZE - 1)) == 0);
e7a8a783 2198
498e386c
ZYW
2199 /**
2200 * In sync call context, when the vcpu is blocked, this throttling timer
2201 * will not fire; so the I/O throttling function has to be disabled here
2202 * if it has been enabled.
2203 */
2204 if (bs->io_limits_enabled) {
2205 fprintf(stderr, "Disabling I/O throttling on '%s' due "
2206 "to synchronous I/O.\n", bdrv_get_device_name(bs));
2207 bdrv_io_limits_disable(bs);
2208 }
2209
1c9805a3
SH
2210 if (qemu_in_coroutine()) {
2211 /* Fast-path if already in coroutine context */
2212 bdrv_rw_co_entry(&rwco);
2213 } else {
2214 co = qemu_coroutine_create(bdrv_rw_co_entry);
2215 qemu_coroutine_enter(co, &rwco);
2216 while (rwco.ret == NOT_DONE) {
2217 qemu_aio_wait();
2218 }
2219 }
2220 return rwco.ret;
2221}
b338082b 2222
8d3b1a2d
KW
2223/*
2224 * Process a synchronous request using coroutines
2225 */
2226static int bdrv_rw_co(BlockDriverState *bs, int64_t sector_num, uint8_t *buf,
2227 int nb_sectors, bool is_write)
2228{
2229 QEMUIOVector qiov;
2230 struct iovec iov = {
2231 .iov_base = (void *)buf,
2232 .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
2233 };
2234
2235 qemu_iovec_init_external(&qiov, &iov, 1);
2236 return bdrv_rwv_co(bs, sector_num, &qiov, is_write);
2237}
2238
1c9805a3
SH
2239/* return < 0 if error. See bdrv_write() for the return codes */
2240int bdrv_read(BlockDriverState *bs, int64_t sector_num,
2241 uint8_t *buf, int nb_sectors)
2242{
2243 return bdrv_rw_co(bs, sector_num, buf, nb_sectors, false);
fc01f7e7
FB
2244}
2245
07d27a44
MA
2246/* Just like bdrv_read(), but with I/O throttling temporarily disabled */
2247int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num,
2248 uint8_t *buf, int nb_sectors)
2249{
2250 bool enabled;
2251 int ret;
2252
2253 enabled = bs->io_limits_enabled;
2254 bs->io_limits_enabled = false;
2255 ret = bdrv_read(bs, 0, buf, 1);
2256 bs->io_limits_enabled = enabled;
2257 return ret;
2258}
2259
5fafdf24 2260/* Return < 0 if error. Important errors are:
19cb3738
FB
2261 -EIO generic I/O error (may happen for all errors)
2262 -ENOMEDIUM No media inserted.
2263 -EINVAL Invalid sector number or nb_sectors
2264 -EACCES Trying to write a read-only device
2265*/
5fafdf24 2266int bdrv_write(BlockDriverState *bs, int64_t sector_num,
fc01f7e7
FB
2267 const uint8_t *buf, int nb_sectors)
2268{
1c9805a3 2269 return bdrv_rw_co(bs, sector_num, (uint8_t *)buf, nb_sectors, true);
83f64091
FB
2270}
2271
8d3b1a2d
KW
2272int bdrv_writev(BlockDriverState *bs, int64_t sector_num, QEMUIOVector *qiov)
2273{
2274 return bdrv_rwv_co(bs, sector_num, qiov, true);
2275}
2276
eda578e5
AL
2277int bdrv_pread(BlockDriverState *bs, int64_t offset,
2278 void *buf, int count1)
83f64091 2279{
6ea44308 2280 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
83f64091
FB
2281 int len, nb_sectors, count;
2282 int64_t sector_num;
9a8c4cce 2283 int ret;
83f64091
FB
2284
2285 count = count1;
2286 /* first read to align to sector start */
6ea44308 2287 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
83f64091
FB
2288 if (len > count)
2289 len = count;
6ea44308 2290 sector_num = offset >> BDRV_SECTOR_BITS;
83f64091 2291 if (len > 0) {
9a8c4cce
KW
2292 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
2293 return ret;
6ea44308 2294 memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
83f64091
FB
2295 count -= len;
2296 if (count == 0)
2297 return count1;
2298 sector_num++;
2299 buf += len;
2300 }
2301
2302 /* read the sectors "in place" */
6ea44308 2303 nb_sectors = count >> BDRV_SECTOR_BITS;
83f64091 2304 if (nb_sectors > 0) {
9a8c4cce
KW
2305 if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
2306 return ret;
83f64091 2307 sector_num += nb_sectors;
6ea44308 2308 len = nb_sectors << BDRV_SECTOR_BITS;
83f64091
FB
2309 buf += len;
2310 count -= len;
2311 }
2312
2313 /* add data from the last sector */
2314 if (count > 0) {
9a8c4cce
KW
2315 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
2316 return ret;
83f64091
FB
2317 memcpy(buf, tmp_buf, count);
2318 }
2319 return count1;
2320}
2321
8d3b1a2d 2322int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov)
83f64091 2323{
6ea44308 2324 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
83f64091
FB
2325 int len, nb_sectors, count;
2326 int64_t sector_num;
9a8c4cce 2327 int ret;
83f64091 2328
8d3b1a2d
KW
2329 count = qiov->size;
2330
83f64091 2331 /* first write to align to sector start */
6ea44308 2332 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
83f64091
FB
2333 if (len > count)
2334 len = count;
6ea44308 2335 sector_num = offset >> BDRV_SECTOR_BITS;
83f64091 2336 if (len > 0) {
9a8c4cce
KW
2337 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
2338 return ret;
8d3b1a2d
KW
2339 qemu_iovec_to_buf(qiov, 0, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)),
2340 len);
9a8c4cce
KW
2341 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
2342 return ret;
83f64091
FB
2343 count -= len;
2344 if (count == 0)
8d3b1a2d 2345 return qiov->size;
83f64091 2346 sector_num++;
83f64091
FB
2347 }
2348
2349 /* write the sectors "in place" */
6ea44308 2350 nb_sectors = count >> BDRV_SECTOR_BITS;
83f64091 2351 if (nb_sectors > 0) {
8d3b1a2d
KW
2352 QEMUIOVector qiov_inplace;
2353
2354 qemu_iovec_init(&qiov_inplace, qiov->niov);
2355 qemu_iovec_concat(&qiov_inplace, qiov, len,
2356 nb_sectors << BDRV_SECTOR_BITS);
2357 ret = bdrv_writev(bs, sector_num, &qiov_inplace);
2358 qemu_iovec_destroy(&qiov_inplace);
2359 if (ret < 0) {
9a8c4cce 2360 return ret;
8d3b1a2d
KW
2361 }
2362
83f64091 2363 sector_num += nb_sectors;
6ea44308 2364 len = nb_sectors << BDRV_SECTOR_BITS;
83f64091
FB
2365 count -= len;
2366 }
2367
2368 /* add data from the last sector */
2369 if (count > 0) {
9a8c4cce
KW
2370 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
2371 return ret;
8d3b1a2d 2372 qemu_iovec_to_buf(qiov, qiov->size - count, tmp_buf, count);
9a8c4cce
KW
2373 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
2374 return ret;
83f64091 2375 }
8d3b1a2d
KW
2376 return qiov->size;
2377}
2378
2379int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
2380 const void *buf, int count1)
2381{
2382 QEMUIOVector qiov;
2383 struct iovec iov = {
2384 .iov_base = (void *) buf,
2385 .iov_len = count1,
2386 };
2387
2388 qemu_iovec_init_external(&qiov, &iov, 1);
2389 return bdrv_pwritev(bs, offset, &qiov);
83f64091 2390}
83f64091 2391
f08145fe
KW
2392/*
2393 * Writes to the file and ensures that no writes are reordered across this
2394 * request (acts as a barrier)
2395 *
2396 * Returns 0 on success, -errno in error cases.
2397 */
2398int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
2399 const void *buf, int count)
2400{
2401 int ret;
2402
2403 ret = bdrv_pwrite(bs, offset, buf, count);
2404 if (ret < 0) {
2405 return ret;
2406 }
2407
f05fa4ad
PB
2408 /* No flush needed for cache modes that already do it */
2409 if (bs->enable_write_cache) {
f08145fe
KW
2410 bdrv_flush(bs);
2411 }
2412
2413 return 0;
2414}
2415
470c0504 2416static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs,
ab185921
SH
2417 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2418{
2419 /* Perform I/O through a temporary buffer so that users who scribble over
2420 * their read buffer while the operation is in progress do not end up
2421 * modifying the image file. This is critical for zero-copy guest I/O
2422 * where anything might happen inside guest memory.
2423 */
2424 void *bounce_buffer;
2425
79c053bd 2426 BlockDriver *drv = bs->drv;
ab185921
SH
2427 struct iovec iov;
2428 QEMUIOVector bounce_qiov;
2429 int64_t cluster_sector_num;
2430 int cluster_nb_sectors;
2431 size_t skip_bytes;
2432 int ret;
2433
2434 /* Cover entire cluster so no additional backing file I/O is required when
2435 * allocating cluster in the image file.
2436 */
343bded4
PB
2437 bdrv_round_to_clusters(bs, sector_num, nb_sectors,
2438 &cluster_sector_num, &cluster_nb_sectors);
ab185921 2439
470c0504
SH
2440 trace_bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors,
2441 cluster_sector_num, cluster_nb_sectors);
ab185921
SH
2442
2443 iov.iov_len = cluster_nb_sectors * BDRV_SECTOR_SIZE;
2444 iov.iov_base = bounce_buffer = qemu_blockalign(bs, iov.iov_len);
2445 qemu_iovec_init_external(&bounce_qiov, &iov, 1);
2446
79c053bd
SH
2447 ret = drv->bdrv_co_readv(bs, cluster_sector_num, cluster_nb_sectors,
2448 &bounce_qiov);
ab185921
SH
2449 if (ret < 0) {
2450 goto err;
2451 }
2452
79c053bd
SH
2453 if (drv->bdrv_co_write_zeroes &&
2454 buffer_is_zero(bounce_buffer, iov.iov_len)) {
621f0589
KW
2455 ret = bdrv_co_do_write_zeroes(bs, cluster_sector_num,
2456 cluster_nb_sectors);
79c053bd 2457 } else {
f05fa4ad
PB
2458 /* This does not change the data on the disk, it is not necessary
2459 * to flush even in cache=writethrough mode.
2460 */
79c053bd 2461 ret = drv->bdrv_co_writev(bs, cluster_sector_num, cluster_nb_sectors,
ab185921 2462 &bounce_qiov);
79c053bd
SH
2463 }
2464
ab185921
SH
2465 if (ret < 0) {
2466 /* It might be okay to ignore write errors for guest requests. If this
2467 * is a deliberate copy-on-read then we don't want to ignore the error.
2468 * Simply report it in all cases.
2469 */
2470 goto err;
2471 }
2472
2473 skip_bytes = (sector_num - cluster_sector_num) * BDRV_SECTOR_SIZE;
03396148
MT
2474 qemu_iovec_from_buf(qiov, 0, bounce_buffer + skip_bytes,
2475 nb_sectors * BDRV_SECTOR_SIZE);
ab185921
SH
2476
2477err:
2478 qemu_vfree(bounce_buffer);
2479 return ret;
2480}
2481
c5fbe571
SH
2482/*
2483 * Handle a read request in coroutine context
2484 */
2485static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
470c0504
SH
2486 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2487 BdrvRequestFlags flags)
da1fa91d
KW
2488{
2489 BlockDriver *drv = bs->drv;
dbffbdcf
SH
2490 BdrvTrackedRequest req;
2491 int ret;
da1fa91d 2492
da1fa91d
KW
2493 if (!drv) {
2494 return -ENOMEDIUM;
2495 }
2496 if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2497 return -EIO;
2498 }
2499
98f90dba
ZYW
2500 /* throttling disk read I/O */
2501 if (bs->io_limits_enabled) {
2502 bdrv_io_limits_intercept(bs, false, nb_sectors);
2503 }
2504
f4658285 2505 if (bs->copy_on_read) {
470c0504
SH
2506 flags |= BDRV_REQ_COPY_ON_READ;
2507 }
2508 if (flags & BDRV_REQ_COPY_ON_READ) {
2509 bs->copy_on_read_in_flight++;
2510 }
2511
2512 if (bs->copy_on_read_in_flight) {
f4658285
SH
2513 wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2514 }
2515
dbffbdcf 2516 tracked_request_begin(&req, bs, sector_num, nb_sectors, false);
ab185921 2517
470c0504 2518 if (flags & BDRV_REQ_COPY_ON_READ) {
ab185921
SH
2519 int pnum;
2520
2521 ret = bdrv_co_is_allocated(bs, sector_num, nb_sectors, &pnum);
2522 if (ret < 0) {
2523 goto out;
2524 }
2525
2526 if (!ret || pnum != nb_sectors) {
470c0504 2527 ret = bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, qiov);
ab185921
SH
2528 goto out;
2529 }
2530 }
2531
dbffbdcf 2532 ret = drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
ab185921
SH
2533
2534out:
dbffbdcf 2535 tracked_request_end(&req);
470c0504
SH
2536
2537 if (flags & BDRV_REQ_COPY_ON_READ) {
2538 bs->copy_on_read_in_flight--;
2539 }
2540
dbffbdcf 2541 return ret;
da1fa91d
KW
2542}
2543
c5fbe571 2544int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
da1fa91d
KW
2545 int nb_sectors, QEMUIOVector *qiov)
2546{
c5fbe571 2547 trace_bdrv_co_readv(bs, sector_num, nb_sectors);
da1fa91d 2548
470c0504
SH
2549 return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, 0);
2550}
2551
2552int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
2553 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
2554{
2555 trace_bdrv_co_copy_on_readv(bs, sector_num, nb_sectors);
2556
2557 return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov,
2558 BDRV_REQ_COPY_ON_READ);
c5fbe571
SH
2559}
2560
f08f2dda
SH
2561static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
2562 int64_t sector_num, int nb_sectors)
2563{
2564 BlockDriver *drv = bs->drv;
2565 QEMUIOVector qiov;
2566 struct iovec iov;
2567 int ret;
2568
621f0589
KW
2569 /* TODO Emulate only part of misaligned requests instead of letting block
2570 * drivers return -ENOTSUP and emulate everything */
2571
f08f2dda
SH
2572 /* First try the efficient write zeroes operation */
2573 if (drv->bdrv_co_write_zeroes) {
621f0589
KW
2574 ret = drv->bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2575 if (ret != -ENOTSUP) {
2576 return ret;
2577 }
f08f2dda
SH
2578 }
2579
2580 /* Fall back to bounce buffer if write zeroes is unsupported */
2581 iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE;
2582 iov.iov_base = qemu_blockalign(bs, iov.iov_len);
2583 memset(iov.iov_base, 0, iov.iov_len);
2584 qemu_iovec_init_external(&qiov, &iov, 1);
2585
2586 ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, &qiov);
2587
2588 qemu_vfree(iov.iov_base);
2589 return ret;
2590}
2591
c5fbe571
SH
2592/*
2593 * Handle a write request in coroutine context
2594 */
2595static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
f08f2dda
SH
2596 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
2597 BdrvRequestFlags flags)
c5fbe571
SH
2598{
2599 BlockDriver *drv = bs->drv;
dbffbdcf 2600 BdrvTrackedRequest req;
6b7cb247 2601 int ret;
da1fa91d
KW
2602
2603 if (!bs->drv) {
2604 return -ENOMEDIUM;
2605 }
2606 if (bs->read_only) {
2607 return -EACCES;
2608 }
2609 if (bdrv_check_request(bs, sector_num, nb_sectors)) {
2610 return -EIO;
2611 }
2612
98f90dba
ZYW
2613 /* throttling disk write I/O */
2614 if (bs->io_limits_enabled) {
2615 bdrv_io_limits_intercept(bs, true, nb_sectors);
2616 }
2617
470c0504 2618 if (bs->copy_on_read_in_flight) {
f4658285
SH
2619 wait_for_overlapping_requests(bs, sector_num, nb_sectors);
2620 }
2621
dbffbdcf
SH
2622 tracked_request_begin(&req, bs, sector_num, nb_sectors, true);
2623
f08f2dda
SH
2624 if (flags & BDRV_REQ_ZERO_WRITE) {
2625 ret = bdrv_co_do_write_zeroes(bs, sector_num, nb_sectors);
2626 } else {
2627 ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
2628 }
6b7cb247 2629
f05fa4ad
PB
2630 if (ret == 0 && !bs->enable_write_cache) {
2631 ret = bdrv_co_flush(bs);
2632 }
2633
da1fa91d 2634 if (bs->dirty_bitmap) {
1755da16 2635 bdrv_set_dirty(bs, sector_num, nb_sectors);
da1fa91d
KW
2636 }
2637
2638 if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
2639 bs->wr_highest_sector = sector_num + nb_sectors - 1;
2640 }
2641
dbffbdcf
SH
2642 tracked_request_end(&req);
2643
6b7cb247 2644 return ret;
da1fa91d
KW
2645}
2646
c5fbe571
SH
2647int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
2648 int nb_sectors, QEMUIOVector *qiov)
2649{
2650 trace_bdrv_co_writev(bs, sector_num, nb_sectors);
2651
f08f2dda
SH
2652 return bdrv_co_do_writev(bs, sector_num, nb_sectors, qiov, 0);
2653}
2654
2655int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs,
2656 int64_t sector_num, int nb_sectors)
2657{
2658 trace_bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
2659
2660 return bdrv_co_do_writev(bs, sector_num, nb_sectors, NULL,
2661 BDRV_REQ_ZERO_WRITE);
c5fbe571
SH
2662}
2663
83f64091
FB
2664/**
2665 * Truncate file to 'offset' bytes (needed only for file protocols)
2666 */
2667int bdrv_truncate(BlockDriverState *bs, int64_t offset)
2668{
2669 BlockDriver *drv = bs->drv;
51762288 2670 int ret;
83f64091 2671 if (!drv)
19cb3738 2672 return -ENOMEDIUM;
83f64091
FB
2673 if (!drv->bdrv_truncate)
2674 return -ENOTSUP;
59f2689d
NS
2675 if (bs->read_only)
2676 return -EACCES;
8591675f
MT
2677 if (bdrv_in_use(bs))
2678 return -EBUSY;
51762288
SH
2679 ret = drv->bdrv_truncate(bs, offset);
2680 if (ret == 0) {
2681 ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
145feb17 2682 bdrv_dev_resize_cb(bs);
51762288
SH
2683 }
2684 return ret;
83f64091
FB
2685}
2686
4a1d5e1f
FZ
2687/**
2688 * Length of a allocated file in bytes. Sparse files are counted by actual
2689 * allocated space. Return < 0 if error or unknown.
2690 */
2691int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
2692{
2693 BlockDriver *drv = bs->drv;
2694 if (!drv) {
2695 return -ENOMEDIUM;
2696 }
2697 if (drv->bdrv_get_allocated_file_size) {
2698 return drv->bdrv_get_allocated_file_size(bs);
2699 }
2700 if (bs->file) {
2701 return bdrv_get_allocated_file_size(bs->file);
2702 }
2703 return -ENOTSUP;
2704}
2705
83f64091
FB
2706/**
2707 * Length of a file in bytes. Return < 0 if error or unknown.
2708 */
2709int64_t bdrv_getlength(BlockDriverState *bs)
2710{
2711 BlockDriver *drv = bs->drv;
2712 if (!drv)
19cb3738 2713 return -ENOMEDIUM;
51762288 2714
2c6942fa 2715 if (bs->growable || bdrv_dev_has_removable_media(bs)) {
46a4e4e6
SH
2716 if (drv->bdrv_getlength) {
2717 return drv->bdrv_getlength(bs);
2718 }
83f64091 2719 }
46a4e4e6 2720 return bs->total_sectors * BDRV_SECTOR_SIZE;
fc01f7e7
FB
2721}
2722
19cb3738 2723/* return 0 as number of sectors if no device present or error */
96b8f136 2724void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
fc01f7e7 2725{
19cb3738
FB
2726 int64_t length;
2727 length = bdrv_getlength(bs);
2728 if (length < 0)
2729 length = 0;
2730 else
6ea44308 2731 length = length >> BDRV_SECTOR_BITS;
19cb3738 2732 *nb_sectors_ptr = length;
fc01f7e7 2733}
cf98951b 2734
0563e191
ZYW
2735/* throttling disk io limits */
2736void bdrv_set_io_limits(BlockDriverState *bs,
2737 BlockIOLimit *io_limits)
2738{
2739 bs->io_limits = *io_limits;
2740 bs->io_limits_enabled = bdrv_io_limits_enabled(bs);
2741}
2742
ff06f5f3
PB
2743void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
2744 BlockdevOnError on_write_error)
abd7f68d
MA
2745{
2746 bs->on_read_error = on_read_error;
2747 bs->on_write_error = on_write_error;
2748}
2749
1ceee0d5 2750BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read)
abd7f68d
MA
2751{
2752 return is_read ? bs->on_read_error : bs->on_write_error;
2753}
2754
3e1caa5f
PB
2755BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error)
2756{
2757 BlockdevOnError on_err = is_read ? bs->on_read_error : bs->on_write_error;
2758
2759 switch (on_err) {
2760 case BLOCKDEV_ON_ERROR_ENOSPC:
2761 return (error == ENOSPC) ? BDRV_ACTION_STOP : BDRV_ACTION_REPORT;
2762 case BLOCKDEV_ON_ERROR_STOP:
2763 return BDRV_ACTION_STOP;
2764 case BLOCKDEV_ON_ERROR_REPORT:
2765 return BDRV_ACTION_REPORT;
2766 case BLOCKDEV_ON_ERROR_IGNORE:
2767 return BDRV_ACTION_IGNORE;
2768 default:
2769 abort();
2770 }
2771}
2772
2773/* This is done by device models because, while the block layer knows
2774 * about the error, it does not know whether an operation comes from
2775 * the device or the block layer (from a job, for example).
2776 */
2777void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
2778 bool is_read, int error)
2779{
2780 assert(error >= 0);
32c81a4a 2781 bdrv_emit_qmp_error_event(bs, QEVENT_BLOCK_IO_ERROR, action, is_read);
3e1caa5f
PB
2782 if (action == BDRV_ACTION_STOP) {
2783 vm_stop(RUN_STATE_IO_ERROR);
2784 bdrv_iostatus_set_err(bs, error);
2785 }
2786}
2787
b338082b
FB
2788int bdrv_is_read_only(BlockDriverState *bs)
2789{
2790 return bs->read_only;
2791}
2792
985a03b0
TS
2793int bdrv_is_sg(BlockDriverState *bs)
2794{
2795 return bs->sg;
2796}
2797
e900a7b7
CH
2798int bdrv_enable_write_cache(BlockDriverState *bs)
2799{
2800 return bs->enable_write_cache;
2801}
2802
425b0148
PB
2803void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce)
2804{
2805 bs->enable_write_cache = wce;
55b110f2
JC
2806
2807 /* so a reopen() will preserve wce */
2808 if (wce) {
2809 bs->open_flags |= BDRV_O_CACHE_WB;
2810 } else {
2811 bs->open_flags &= ~BDRV_O_CACHE_WB;
2812 }
425b0148
PB
2813}
2814
ea2384d3
FB
2815int bdrv_is_encrypted(BlockDriverState *bs)
2816{
2817 if (bs->backing_hd && bs->backing_hd->encrypted)
2818 return 1;
2819 return bs->encrypted;
2820}
2821
c0f4ce77
AL
2822int bdrv_key_required(BlockDriverState *bs)
2823{
2824 BlockDriverState *backing_hd = bs->backing_hd;
2825
2826 if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
2827 return 1;
2828 return (bs->encrypted && !bs->valid_key);
2829}
2830
ea2384d3
FB
2831int bdrv_set_key(BlockDriverState *bs, const char *key)
2832{
2833 int ret;
2834 if (bs->backing_hd && bs->backing_hd->encrypted) {
2835 ret = bdrv_set_key(bs->backing_hd, key);
2836 if (ret < 0)
2837 return ret;
2838 if (!bs->encrypted)
2839 return 0;
2840 }
fd04a2ae
SH
2841 if (!bs->encrypted) {
2842 return -EINVAL;
2843 } else if (!bs->drv || !bs->drv->bdrv_set_key) {
2844 return -ENOMEDIUM;
2845 }
c0f4ce77 2846 ret = bs->drv->bdrv_set_key(bs, key);
bb5fc20f
AL
2847 if (ret < 0) {
2848 bs->valid_key = 0;
2849 } else if (!bs->valid_key) {
2850 bs->valid_key = 1;
2851 /* call the change callback now, we skipped it on open */
7d4b4ba5 2852 bdrv_dev_change_media_cb(bs, true);
bb5fc20f 2853 }
c0f4ce77 2854 return ret;
ea2384d3
FB
2855}
2856
f8d6bba1 2857const char *bdrv_get_format_name(BlockDriverState *bs)
ea2384d3 2858{
f8d6bba1 2859 return bs->drv ? bs->drv->format_name : NULL;
ea2384d3
FB
2860}
2861
5fafdf24 2862void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
ea2384d3
FB
2863 void *opaque)
2864{
2865 BlockDriver *drv;
2866
8a22f02a 2867 QLIST_FOREACH(drv, &bdrv_drivers, list) {
ea2384d3
FB
2868 it(opaque, drv->format_name);
2869 }
2870}
2871
b338082b
FB
2872BlockDriverState *bdrv_find(const char *name)
2873{
2874 BlockDriverState *bs;
2875
1b7bdbc1
SH
2876 QTAILQ_FOREACH(bs, &bdrv_states, list) {
2877 if (!strcmp(name, bs->device_name)) {
b338082b 2878 return bs;
1b7bdbc1 2879 }
b338082b
FB
2880 }
2881 return NULL;
2882}
2883
2f399b0a
MA
2884BlockDriverState *bdrv_next(BlockDriverState *bs)
2885{
2886 if (!bs) {
2887 return QTAILQ_FIRST(&bdrv_states);
2888 }
2889 return QTAILQ_NEXT(bs, list);
2890}
2891
51de9760 2892void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
81d0912d
FB
2893{
2894 BlockDriverState *bs;
2895
1b7bdbc1 2896 QTAILQ_FOREACH(bs, &bdrv_states, list) {
51de9760 2897 it(opaque, bs);
81d0912d
FB
2898 }
2899}
2900
ea2384d3
FB
2901const char *bdrv_get_device_name(BlockDriverState *bs)
2902{
2903 return bs->device_name;
2904}
2905
c8433287
MA
2906int bdrv_get_flags(BlockDriverState *bs)
2907{
2908 return bs->open_flags;
2909}
2910
c6ca28d6
AL
2911void bdrv_flush_all(void)
2912{
2913 BlockDriverState *bs;
2914
1b7bdbc1 2915 QTAILQ_FOREACH(bs, &bdrv_states, list) {
29cdb251 2916 bdrv_flush(bs);
1b7bdbc1 2917 }
c6ca28d6
AL
2918}
2919
f2feebbd
KW
2920int bdrv_has_zero_init(BlockDriverState *bs)
2921{
2922 assert(bs->drv);
2923
336c1c12
KW
2924 if (bs->drv->bdrv_has_zero_init) {
2925 return bs->drv->bdrv_has_zero_init(bs);
f2feebbd
KW
2926 }
2927
2928 return 1;
2929}
2930
376ae3f1
SH
2931typedef struct BdrvCoIsAllocatedData {
2932 BlockDriverState *bs;
b35b2bba 2933 BlockDriverState *base;
376ae3f1
SH
2934 int64_t sector_num;
2935 int nb_sectors;
2936 int *pnum;
2937 int ret;
2938 bool done;
2939} BdrvCoIsAllocatedData;
2940
f58c7b35
TS
2941/*
2942 * Returns true iff the specified sector is present in the disk image. Drivers
2943 * not implementing the functionality are assumed to not support backing files,
2944 * hence all their sectors are reported as allocated.
2945 *
bd9533e3
SH
2946 * If 'sector_num' is beyond the end of the disk image the return value is 0
2947 * and 'pnum' is set to 0.
2948 *
f58c7b35
TS
2949 * 'pnum' is set to the number of sectors (including and immediately following
2950 * the specified sector) that are known to be in the same
2951 * allocated/unallocated state.
2952 *
bd9533e3
SH
2953 * 'nb_sectors' is the max value 'pnum' should be set to. If nb_sectors goes
2954 * beyond the end of the disk image it will be clamped.
f58c7b35 2955 */
060f51c9
SH
2956int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
2957 int nb_sectors, int *pnum)
f58c7b35 2958{
bd9533e3
SH
2959 int64_t n;
2960
2961 if (sector_num >= bs->total_sectors) {
2962 *pnum = 0;
2963 return 0;
2964 }
2965
2966 n = bs->total_sectors - sector_num;
2967 if (n < nb_sectors) {
2968 nb_sectors = n;
2969 }
2970
6aebab14 2971 if (!bs->drv->bdrv_co_is_allocated) {
bd9533e3 2972 *pnum = nb_sectors;
f58c7b35
TS
2973 return 1;
2974 }
6aebab14 2975
060f51c9
SH
2976 return bs->drv->bdrv_co_is_allocated(bs, sector_num, nb_sectors, pnum);
2977}
2978
2979/* Coroutine wrapper for bdrv_is_allocated() */
2980static void coroutine_fn bdrv_is_allocated_co_entry(void *opaque)
2981{
2982 BdrvCoIsAllocatedData *data = opaque;
2983 BlockDriverState *bs = data->bs;
2984
2985 data->ret = bdrv_co_is_allocated(bs, data->sector_num, data->nb_sectors,
2986 data->pnum);
2987 data->done = true;
2988}
2989
2990/*
2991 * Synchronous wrapper around bdrv_co_is_allocated().
2992 *
2993 * See bdrv_co_is_allocated() for details.
2994 */
2995int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
2996 int *pnum)
2997{
6aebab14
SH
2998 Coroutine *co;
2999 BdrvCoIsAllocatedData data = {
3000 .bs = bs,
3001 .sector_num = sector_num,
3002 .nb_sectors = nb_sectors,
3003 .pnum = pnum,
3004 .done = false,
3005 };
3006
3007 co = qemu_coroutine_create(bdrv_is_allocated_co_entry);
3008 qemu_coroutine_enter(co, &data);
3009 while (!data.done) {
3010 qemu_aio_wait();
3011 }
3012 return data.ret;
f58c7b35
TS
3013}
3014
188a7bbf
PB
3015/*
3016 * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP]
3017 *
3018 * Return true if the given sector is allocated in any image between
3019 * BASE and TOP (inclusive). BASE can be NULL to check if the given
3020 * sector is allocated in any image of the chain. Return false otherwise.
3021 *
3022 * 'pnum' is set to the number of sectors (including and immediately following
3023 * the specified sector) that are known to be in the same
3024 * allocated/unallocated state.
3025 *
3026 */
3027int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
3028 BlockDriverState *base,
3029 int64_t sector_num,
3030 int nb_sectors, int *pnum)
3031{
3032 BlockDriverState *intermediate;
3033 int ret, n = nb_sectors;
3034
3035 intermediate = top;
3036 while (intermediate && intermediate != base) {
3037 int pnum_inter;
3038 ret = bdrv_co_is_allocated(intermediate, sector_num, nb_sectors,
3039 &pnum_inter);
3040 if (ret < 0) {
3041 return ret;
3042 } else if (ret) {
3043 *pnum = pnum_inter;
3044 return 1;
3045 }
3046
3047 /*
3048 * [sector_num, nb_sectors] is unallocated on top but intermediate
3049 * might have
3050 *
3051 * [sector_num+x, nr_sectors] allocated.
3052 */
63ba17d3
VI
3053 if (n > pnum_inter &&
3054 (intermediate == top ||
3055 sector_num + pnum_inter < intermediate->total_sectors)) {
188a7bbf
PB
3056 n = pnum_inter;
3057 }
3058
3059 intermediate = intermediate->backing_hd;
3060 }
3061
3062 *pnum = n;
3063 return 0;
3064}
3065
b35b2bba
MR
3066/* Coroutine wrapper for bdrv_is_allocated_above() */
3067static void coroutine_fn bdrv_is_allocated_above_co_entry(void *opaque)
3068{
3069 BdrvCoIsAllocatedData *data = opaque;
3070 BlockDriverState *top = data->bs;
3071 BlockDriverState *base = data->base;
3072
3073 data->ret = bdrv_co_is_allocated_above(top, base, data->sector_num,
3074 data->nb_sectors, data->pnum);
3075 data->done = true;
3076}
3077
3078/*
3079 * Synchronous wrapper around bdrv_co_is_allocated_above().
3080 *
3081 * See bdrv_co_is_allocated_above() for details.
3082 */
3083int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
3084 int64_t sector_num, int nb_sectors, int *pnum)
3085{
3086 Coroutine *co;
3087 BdrvCoIsAllocatedData data = {
3088 .bs = top,
3089 .base = base,
3090 .sector_num = sector_num,
3091 .nb_sectors = nb_sectors,
3092 .pnum = pnum,
3093 .done = false,
3094 };
3095
3096 co = qemu_coroutine_create(bdrv_is_allocated_above_co_entry);
3097 qemu_coroutine_enter(co, &data);
3098 while (!data.done) {
3099 qemu_aio_wait();
3100 }
3101 return data.ret;
3102}
3103
ac84adac 3104BlockInfo *bdrv_query_info(BlockDriverState *bs)
b338082b 3105{
ac84adac
PB
3106 BlockInfo *info = g_malloc0(sizeof(*info));
3107 info->device = g_strdup(bs->device_name);
3108 info->type = g_strdup("unknown");
3109 info->locked = bdrv_dev_is_medium_locked(bs);
3110 info->removable = bdrv_dev_has_removable_media(bs);
b338082b 3111
ac84adac
PB
3112 if (bdrv_dev_has_removable_media(bs)) {
3113 info->has_tray_open = true;
3114 info->tray_open = bdrv_dev_is_tray_open(bs);
3115 }
d15e5465 3116
ac84adac
PB
3117 if (bdrv_iostatus_is_enabled(bs)) {
3118 info->has_io_status = true;
3119 info->io_status = bs->iostatus;
3120 }
d15e5465 3121
b9a9b3a4
PB
3122 if (bs->dirty_bitmap) {
3123 info->has_dirty = true;
3124 info->dirty = g_malloc0(sizeof(*info->dirty));
acc906c6 3125 info->dirty->count = bdrv_get_dirty_count(bs) * BDRV_SECTOR_SIZE;
50717e94
PB
3126 info->dirty->granularity =
3127 ((int64_t) BDRV_SECTOR_SIZE << hbitmap_granularity(bs->dirty_bitmap));
b9a9b3a4 3128 }
d15e5465 3129
ac84adac
PB
3130 if (bs->drv) {
3131 info->has_inserted = true;
3132 info->inserted = g_malloc0(sizeof(*info->inserted));
3133 info->inserted->file = g_strdup(bs->filename);
3134 info->inserted->ro = bs->read_only;
3135 info->inserted->drv = g_strdup(bs->drv->format_name);
3136 info->inserted->encrypted = bs->encrypted;
3137 info->inserted->encryption_key_missing = bdrv_key_required(bs);
3138
3139 if (bs->backing_file[0]) {
3140 info->inserted->has_backing_file = true;
3141 info->inserted->backing_file = g_strdup(bs->backing_file);
e4def80b 3142 }
f04ef601 3143
ac84adac
PB
3144 info->inserted->backing_file_depth = bdrv_get_backing_file_depth(bs);
3145
3146 if (bs->io_limits_enabled) {
3147 info->inserted->bps =
3148 bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
3149 info->inserted->bps_rd =
3150 bs->io_limits.bps[BLOCK_IO_LIMIT_READ];
3151 info->inserted->bps_wr =
3152 bs->io_limits.bps[BLOCK_IO_LIMIT_WRITE];
3153 info->inserted->iops =
3154 bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
3155 info->inserted->iops_rd =
3156 bs->io_limits.iops[BLOCK_IO_LIMIT_READ];
3157 info->inserted->iops_wr =
3158 bs->io_limits.iops[BLOCK_IO_LIMIT_WRITE];
f04ef601 3159 }
ac84adac
PB
3160 }
3161 return info;
3162}
f04ef601 3163
ac84adac
PB
3164BlockInfoList *qmp_query_block(Error **errp)
3165{
3166 BlockInfoList *head = NULL, **p_next = &head;
3167 BlockDriverState *bs;
727f005e 3168
ac84adac
PB
3169 QTAILQ_FOREACH(bs, &bdrv_states, list) {
3170 BlockInfoList *info = g_malloc0(sizeof(*info));
3171 info->value = bdrv_query_info(bs);
d15e5465 3172
ac84adac
PB
3173 *p_next = info;
3174 p_next = &info->next;
b338082b 3175 }
d15e5465 3176
b2023818 3177 return head;
b338082b 3178}
a36e69dd 3179
9887b616 3180BlockStats *bdrv_query_stats(const BlockDriverState *bs)
f11f57e4
LC
3181{
3182 BlockStats *s;
3183
3184 s = g_malloc0(sizeof(*s));
3185
3186 if (bs->device_name[0]) {
3187 s->has_device = true;
3188 s->device = g_strdup(bs->device_name);
294cc35f
KW
3189 }
3190
f11f57e4
LC
3191 s->stats = g_malloc0(sizeof(*s->stats));
3192 s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
3193 s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
3194 s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
3195 s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
3196 s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
3197 s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
3198 s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
3199 s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
3200 s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
3201
294cc35f 3202 if (bs->file) {
f11f57e4 3203 s->has_parent = true;
9887b616 3204 s->parent = bdrv_query_stats(bs->file);
294cc35f
KW
3205 }
3206
f11f57e4 3207 return s;
294cc35f
KW
3208}
3209
f11f57e4 3210BlockStatsList *qmp_query_blockstats(Error **errp)
218a536a 3211{
9887b616 3212 BlockStatsList *head = NULL, **p_next = &head;
a36e69dd
TS
3213 BlockDriverState *bs;
3214
1b7bdbc1 3215 QTAILQ_FOREACH(bs, &bdrv_states, list) {
f11f57e4 3216 BlockStatsList *info = g_malloc0(sizeof(*info));
9887b616 3217 info->value = bdrv_query_stats(bs);
f11f57e4 3218
9887b616
PB
3219 *p_next = info;
3220 p_next = &info->next;
a36e69dd 3221 }
218a536a 3222
f11f57e4 3223 return head;
a36e69dd 3224}
ea2384d3 3225
045df330
AL
3226const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
3227{
3228 if (bs->backing_hd && bs->backing_hd->encrypted)
3229 return bs->backing_file;
3230 else if (bs->encrypted)
3231 return bs->filename;
3232 else
3233 return NULL;
3234}
3235
5fafdf24 3236void bdrv_get_backing_filename(BlockDriverState *bs,
83f64091
FB
3237 char *filename, int filename_size)
3238{
3574c608 3239 pstrcpy(filename, filename_size, bs->backing_file);
83f64091
FB
3240}
3241
5fafdf24 3242int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
faea38e7
FB
3243 const uint8_t *buf, int nb_sectors)
3244{
3245 BlockDriver *drv = bs->drv;
3246 if (!drv)
19cb3738 3247 return -ENOMEDIUM;
faea38e7
FB
3248 if (!drv->bdrv_write_compressed)
3249 return -ENOTSUP;
fbb7b4e0
KW
3250 if (bdrv_check_request(bs, sector_num, nb_sectors))
3251 return -EIO;
a55eb92c 3252
1755da16 3253 assert(!bs->dirty_bitmap);
a55eb92c 3254
faea38e7
FB
3255 return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
3256}
3b46e624 3257
faea38e7
FB
3258int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3259{
3260 BlockDriver *drv = bs->drv;
3261 if (!drv)
19cb3738 3262 return -ENOMEDIUM;
faea38e7
FB
3263 if (!drv->bdrv_get_info)
3264 return -ENOTSUP;
3265 memset(bdi, 0, sizeof(*bdi));
3266 return drv->bdrv_get_info(bs, bdi);
3267}
3268
45566e9c
CH
3269int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
3270 int64_t pos, int size)
cf8074b3
KW
3271{
3272 QEMUIOVector qiov;
3273 struct iovec iov = {
3274 .iov_base = (void *) buf,
3275 .iov_len = size,
3276 };
3277
3278 qemu_iovec_init_external(&qiov, &iov, 1);
3279 return bdrv_writev_vmstate(bs, &qiov, pos);
3280}
3281
3282int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos)
178e08a5
AL
3283{
3284 BlockDriver *drv = bs->drv;
cf8074b3
KW
3285
3286 if (!drv) {
178e08a5 3287 return -ENOMEDIUM;
cf8074b3
KW
3288 } else if (drv->bdrv_save_vmstate) {
3289 return drv->bdrv_save_vmstate(bs, qiov, pos);
3290 } else if (bs->file) {
3291 return bdrv_writev_vmstate(bs->file, qiov, pos);
3292 }
3293
7cdb1f6d 3294 return -ENOTSUP;
178e08a5
AL
3295}
3296
45566e9c
CH
3297int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
3298 int64_t pos, int size)
178e08a5
AL
3299{
3300 BlockDriver *drv = bs->drv;
3301 if (!drv)
3302 return -ENOMEDIUM;
7cdb1f6d
MK
3303 if (drv->bdrv_load_vmstate)
3304 return drv->bdrv_load_vmstate(bs, buf, pos, size);
3305 if (bs->file)
3306 return bdrv_load_vmstate(bs->file, buf, pos, size);
3307 return -ENOTSUP;
178e08a5
AL
3308}
3309
8b9b0cc2
KW
3310void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
3311{
3312 BlockDriver *drv = bs->drv;
3313
3314 if (!drv || !drv->bdrv_debug_event) {
3315 return;
3316 }
3317
0ed8b6f6 3318 drv->bdrv_debug_event(bs, event);
41c695c7
KW
3319}
3320
3321int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
3322 const char *tag)
3323{
3324 while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) {
3325 bs = bs->file;
3326 }
3327
3328 if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) {
3329 return bs->drv->bdrv_debug_breakpoint(bs, event, tag);
3330 }
3331
3332 return -ENOTSUP;
3333}
3334
3335int bdrv_debug_resume(BlockDriverState *bs, const char *tag)
3336{
3337 while (bs && bs->drv && !bs->drv->bdrv_debug_resume) {
3338 bs = bs->file;
3339 }
8b9b0cc2 3340
41c695c7
KW
3341 if (bs && bs->drv && bs->drv->bdrv_debug_resume) {
3342 return bs->drv->bdrv_debug_resume(bs, tag);
3343 }
3344
3345 return -ENOTSUP;
3346}
3347
3348bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag)
3349{
3350 while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) {
3351 bs = bs->file;
3352 }
3353
3354 if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) {
3355 return bs->drv->bdrv_debug_is_suspended(bs, tag);
3356 }
3357
3358 return false;
8b9b0cc2
KW
3359}
3360
faea38e7
FB
3361/**************************************************************/
3362/* handling of snapshots */
3363
feeee5ac
MDCF
3364int bdrv_can_snapshot(BlockDriverState *bs)
3365{
3366 BlockDriver *drv = bs->drv;
07b70bfb 3367 if (!drv || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
feeee5ac
MDCF
3368 return 0;
3369 }
3370
3371 if (!drv->bdrv_snapshot_create) {
3372 if (bs->file != NULL) {
3373 return bdrv_can_snapshot(bs->file);
3374 }
3375 return 0;
3376 }
3377
3378 return 1;
3379}
3380
199630b6
BS
3381int bdrv_is_snapshot(BlockDriverState *bs)
3382{
3383 return !!(bs->open_flags & BDRV_O_SNAPSHOT);
3384}
3385
f9092b10
MA
3386BlockDriverState *bdrv_snapshots(void)
3387{
3388 BlockDriverState *bs;
3389
3ac906f7 3390 if (bs_snapshots) {
f9092b10 3391 return bs_snapshots;
3ac906f7 3392 }
f9092b10
MA
3393
3394 bs = NULL;
3395 while ((bs = bdrv_next(bs))) {
3396 if (bdrv_can_snapshot(bs)) {
3ac906f7
MA
3397 bs_snapshots = bs;
3398 return bs;
f9092b10
MA
3399 }
3400 }
3401 return NULL;
f9092b10
MA
3402}
3403
5fafdf24 3404int bdrv_snapshot_create(BlockDriverState *bs,
faea38e7
FB
3405 QEMUSnapshotInfo *sn_info)
3406{
3407 BlockDriver *drv = bs->drv;
3408 if (!drv)
19cb3738 3409 return -ENOMEDIUM;
7cdb1f6d
MK
3410 if (drv->bdrv_snapshot_create)
3411 return drv->bdrv_snapshot_create(bs, sn_info);
3412 if (bs->file)
3413 return bdrv_snapshot_create(bs->file, sn_info);
3414 return -ENOTSUP;
faea38e7
FB
3415}
3416
5fafdf24 3417int bdrv_snapshot_goto(BlockDriverState *bs,
faea38e7
FB
3418 const char *snapshot_id)
3419{
3420 BlockDriver *drv = bs->drv;
7cdb1f6d
MK
3421 int ret, open_ret;
3422
faea38e7 3423 if (!drv)
19cb3738 3424 return -ENOMEDIUM;
7cdb1f6d
MK
3425 if (drv->bdrv_snapshot_goto)
3426 return drv->bdrv_snapshot_goto(bs, snapshot_id);
3427
3428 if (bs->file) {
3429 drv->bdrv_close(bs);
3430 ret = bdrv_snapshot_goto(bs->file, snapshot_id);
1a86938f 3431 open_ret = drv->bdrv_open(bs, NULL, bs->open_flags);
7cdb1f6d
MK
3432 if (open_ret < 0) {
3433 bdrv_delete(bs->file);
3434 bs->drv = NULL;
3435 return open_ret;
3436 }
3437 return ret;
3438 }
3439
3440 return -ENOTSUP;
faea38e7
FB
3441}
3442
3443int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
3444{
3445 BlockDriver *drv = bs->drv;
3446 if (!drv)
19cb3738 3447 return -ENOMEDIUM;
7cdb1f6d
MK
3448 if (drv->bdrv_snapshot_delete)
3449 return drv->bdrv_snapshot_delete(bs, snapshot_id);
3450 if (bs->file)
3451 return bdrv_snapshot_delete(bs->file, snapshot_id);
3452 return -ENOTSUP;
faea38e7
FB
3453}
3454
5fafdf24 3455int bdrv_snapshot_list(BlockDriverState *bs,
faea38e7
FB
3456 QEMUSnapshotInfo **psn_info)
3457{
3458 BlockDriver *drv = bs->drv;
3459 if (!drv)
19cb3738 3460 return -ENOMEDIUM;
7cdb1f6d
MK
3461 if (drv->bdrv_snapshot_list)
3462 return drv->bdrv_snapshot_list(bs, psn_info);
3463 if (bs->file)
3464 return bdrv_snapshot_list(bs->file, psn_info);
3465 return -ENOTSUP;
faea38e7
FB
3466}
3467
51ef6727 3468int bdrv_snapshot_load_tmp(BlockDriverState *bs,
3469 const char *snapshot_name)
3470{
3471 BlockDriver *drv = bs->drv;
3472 if (!drv) {
3473 return -ENOMEDIUM;
3474 }
3475 if (!bs->read_only) {
3476 return -EINVAL;
3477 }
3478 if (drv->bdrv_snapshot_load_tmp) {
3479 return drv->bdrv_snapshot_load_tmp(bs, snapshot_name);
3480 }
3481 return -ENOTSUP;
3482}
3483
b1b1d783
JC
3484/* backing_file can either be relative, or absolute, or a protocol. If it is
3485 * relative, it must be relative to the chain. So, passing in bs->filename
3486 * from a BDS as backing_file should not be done, as that may be relative to
3487 * the CWD rather than the chain. */
e8a6bb9c
MT
3488BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
3489 const char *backing_file)
3490{
b1b1d783
JC
3491 char *filename_full = NULL;
3492 char *backing_file_full = NULL;
3493 char *filename_tmp = NULL;
3494 int is_protocol = 0;
3495 BlockDriverState *curr_bs = NULL;
3496 BlockDriverState *retval = NULL;
3497
3498 if (!bs || !bs->drv || !backing_file) {
e8a6bb9c
MT
3499 return NULL;
3500 }
3501
b1b1d783
JC
3502 filename_full = g_malloc(PATH_MAX);
3503 backing_file_full = g_malloc(PATH_MAX);
3504 filename_tmp = g_malloc(PATH_MAX);
3505
3506 is_protocol = path_has_protocol(backing_file);
3507
3508 for (curr_bs = bs; curr_bs->backing_hd; curr_bs = curr_bs->backing_hd) {
3509
3510 /* If either of the filename paths is actually a protocol, then
3511 * compare unmodified paths; otherwise make paths relative */
3512 if (is_protocol || path_has_protocol(curr_bs->backing_file)) {
3513 if (strcmp(backing_file, curr_bs->backing_file) == 0) {
3514 retval = curr_bs->backing_hd;
3515 break;
3516 }
e8a6bb9c 3517 } else {
b1b1d783
JC
3518 /* If not an absolute filename path, make it relative to the current
3519 * image's filename path */
3520 path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3521 backing_file);
3522
3523 /* We are going to compare absolute pathnames */
3524 if (!realpath(filename_tmp, filename_full)) {
3525 continue;
3526 }
3527
3528 /* We need to make sure the backing filename we are comparing against
3529 * is relative to the current image filename (or absolute) */
3530 path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3531 curr_bs->backing_file);
3532
3533 if (!realpath(filename_tmp, backing_file_full)) {
3534 continue;
3535 }
3536
3537 if (strcmp(backing_file_full, filename_full) == 0) {
3538 retval = curr_bs->backing_hd;
3539 break;
3540 }
e8a6bb9c
MT
3541 }
3542 }
3543
b1b1d783
JC
3544 g_free(filename_full);
3545 g_free(backing_file_full);
3546 g_free(filename_tmp);
3547 return retval;
e8a6bb9c
MT
3548}
3549
f198fd1c
BC
3550int bdrv_get_backing_file_depth(BlockDriverState *bs)
3551{
3552 if (!bs->drv) {
3553 return 0;
3554 }
3555
3556 if (!bs->backing_hd) {
3557 return 0;
3558 }
3559
3560 return 1 + bdrv_get_backing_file_depth(bs->backing_hd);
3561}
3562
79fac568
JC
3563BlockDriverState *bdrv_find_base(BlockDriverState *bs)
3564{
3565 BlockDriverState *curr_bs = NULL;
3566
3567 if (!bs) {
3568 return NULL;
3569 }
3570
3571 curr_bs = bs;
3572
3573 while (curr_bs->backing_hd) {
3574 curr_bs = curr_bs->backing_hd;
3575 }
3576 return curr_bs;
3577}
3578
faea38e7
FB
3579#define NB_SUFFIXES 4
3580
3581char *get_human_readable_size(char *buf, int buf_size, int64_t size)
3582{
3583 static const char suffixes[NB_SUFFIXES] = "KMGT";
3584 int64_t base;
3585 int i;
3586
3587 if (size <= 999) {
3588 snprintf(buf, buf_size, "%" PRId64, size);
3589 } else {
3590 base = 1024;
3591 for(i = 0; i < NB_SUFFIXES; i++) {
3592 if (size < (10 * base)) {
5fafdf24 3593 snprintf(buf, buf_size, "%0.1f%c",
faea38e7
FB
3594 (double)size / base,
3595 suffixes[i]);
3596 break;
3597 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
5fafdf24 3598 snprintf(buf, buf_size, "%" PRId64 "%c",
faea38e7
FB
3599 ((size + (base >> 1)) / base),
3600 suffixes[i]);
3601 break;
3602 }
3603 base = base * 1024;
3604 }
3605 }
3606 return buf;
3607}
3608
3609char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
3610{
3611 char buf1[128], date_buf[128], clock_buf[128];
3612 struct tm tm;
3613 time_t ti;
3614 int64_t secs;
3615
3616 if (!sn) {
5fafdf24
TS
3617 snprintf(buf, buf_size,
3618 "%-10s%-20s%7s%20s%15s",
faea38e7
FB
3619 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
3620 } else {
3621 ti = sn->date_sec;
3622 localtime_r(&ti, &tm);
3623 strftime(date_buf, sizeof(date_buf),
3624 "%Y-%m-%d %H:%M:%S", &tm);
3625 secs = sn->vm_clock_nsec / 1000000000;
3626 snprintf(clock_buf, sizeof(clock_buf),
3627 "%02d:%02d:%02d.%03d",
3628 (int)(secs / 3600),
3629 (int)((secs / 60) % 60),
5fafdf24 3630 (int)(secs % 60),
faea38e7
FB
3631 (int)((sn->vm_clock_nsec / 1000000) % 1000));
3632 snprintf(buf, buf_size,
5fafdf24 3633 "%-10s%-20s%7s%20s%15s",
faea38e7
FB
3634 sn->id_str, sn->name,
3635 get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
3636 date_buf,
3637 clock_buf);
3638 }
3639 return buf;
3640}
3641
ea2384d3 3642/**************************************************************/
83f64091 3643/* async I/Os */
ea2384d3 3644
3b69e4b9 3645BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
f141eafe 3646 QEMUIOVector *qiov, int nb_sectors,
3b69e4b9 3647 BlockDriverCompletionFunc *cb, void *opaque)
83f64091 3648{
bbf0a440
SH
3649 trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque);
3650
b2a61371 3651 return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
8c5873d6 3652 cb, opaque, false);
ea2384d3
FB
3653}
3654
f141eafe
AL
3655BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
3656 QEMUIOVector *qiov, int nb_sectors,
3657 BlockDriverCompletionFunc *cb, void *opaque)
ea2384d3 3658{
bbf0a440
SH
3659 trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque);
3660
1a6e115b 3661 return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
8c5873d6 3662 cb, opaque, true);
83f64091
FB
3663}
3664
40b4f539
KW
3665
3666typedef struct MultiwriteCB {
3667 int error;
3668 int num_requests;
3669 int num_callbacks;
3670 struct {
3671 BlockDriverCompletionFunc *cb;
3672 void *opaque;
3673 QEMUIOVector *free_qiov;
40b4f539
KW
3674 } callbacks[];
3675} MultiwriteCB;
3676
3677static void multiwrite_user_cb(MultiwriteCB *mcb)
3678{
3679 int i;
3680
3681 for (i = 0; i < mcb->num_callbacks; i++) {
3682 mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
1e1ea48d
SH
3683 if (mcb->callbacks[i].free_qiov) {
3684 qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
3685 }
7267c094 3686 g_free(mcb->callbacks[i].free_qiov);
40b4f539
KW
3687 }
3688}
3689
3690static void multiwrite_cb(void *opaque, int ret)
3691{
3692 MultiwriteCB *mcb = opaque;
3693
6d519a5f
SH
3694 trace_multiwrite_cb(mcb, ret);
3695
cb6d3ca0 3696 if (ret < 0 && !mcb->error) {
40b4f539 3697 mcb->error = ret;
40b4f539
KW
3698 }
3699
3700 mcb->num_requests--;
3701 if (mcb->num_requests == 0) {
de189a1b 3702 multiwrite_user_cb(mcb);
7267c094 3703 g_free(mcb);
40b4f539
KW
3704 }
3705}
3706
3707static int multiwrite_req_compare(const void *a, const void *b)
3708{
77be4366
CH
3709 const BlockRequest *req1 = a, *req2 = b;
3710
3711 /*
3712 * Note that we can't simply subtract req2->sector from req1->sector
3713 * here as that could overflow the return value.
3714 */
3715 if (req1->sector > req2->sector) {
3716 return 1;
3717 } else if (req1->sector < req2->sector) {
3718 return -1;
3719 } else {
3720 return 0;
3721 }
40b4f539
KW
3722}
3723
3724/*
3725 * Takes a bunch of requests and tries to merge them. Returns the number of
3726 * requests that remain after merging.
3727 */
3728static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
3729 int num_reqs, MultiwriteCB *mcb)
3730{
3731 int i, outidx;
3732
3733 // Sort requests by start sector
3734 qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
3735
3736 // Check if adjacent requests touch the same clusters. If so, combine them,
3737 // filling up gaps with zero sectors.
3738 outidx = 0;
3739 for (i = 1; i < num_reqs; i++) {
3740 int merge = 0;
3741 int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
3742
b6a127a1 3743 // Handle exactly sequential writes and overlapping writes.
40b4f539
KW
3744 if (reqs[i].sector <= oldreq_last) {
3745 merge = 1;
3746 }
3747
e2a305fb
CH
3748 if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
3749 merge = 0;
3750 }
3751
40b4f539
KW
3752 if (merge) {
3753 size_t size;
7267c094 3754 QEMUIOVector *qiov = g_malloc0(sizeof(*qiov));
40b4f539
KW
3755 qemu_iovec_init(qiov,
3756 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
3757
3758 // Add the first request to the merged one. If the requests are
3759 // overlapping, drop the last sectors of the first request.
3760 size = (reqs[i].sector - reqs[outidx].sector) << 9;
1b093c48 3761 qemu_iovec_concat(qiov, reqs[outidx].qiov, 0, size);
40b4f539 3762
b6a127a1
PB
3763 // We should need to add any zeros between the two requests
3764 assert (reqs[i].sector <= oldreq_last);
40b4f539
KW
3765
3766 // Add the second request
1b093c48 3767 qemu_iovec_concat(qiov, reqs[i].qiov, 0, reqs[i].qiov->size);
40b4f539 3768
cbf1dff2 3769 reqs[outidx].nb_sectors = qiov->size >> 9;
40b4f539
KW
3770 reqs[outidx].qiov = qiov;
3771
3772 mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
3773 } else {
3774 outidx++;
3775 reqs[outidx].sector = reqs[i].sector;
3776 reqs[outidx].nb_sectors = reqs[i].nb_sectors;
3777 reqs[outidx].qiov = reqs[i].qiov;
3778 }
3779 }
3780
3781 return outidx + 1;
3782}
3783
3784/*
3785 * Submit multiple AIO write requests at once.
3786 *
3787 * On success, the function returns 0 and all requests in the reqs array have
3788 * been submitted. In error case this function returns -1, and any of the
3789 * requests may or may not be submitted yet. In particular, this means that the
3790 * callback will be called for some of the requests, for others it won't. The
3791 * caller must check the error field of the BlockRequest to wait for the right
3792 * callbacks (if error != 0, no callback will be called).
3793 *
3794 * The implementation may modify the contents of the reqs array, e.g. to merge
3795 * requests. However, the fields opaque and error are left unmodified as they
3796 * are used to signal failure for a single request to the caller.
3797 */
3798int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
3799{
40b4f539
KW
3800 MultiwriteCB *mcb;
3801 int i;
3802
301db7c2
RH
3803 /* don't submit writes if we don't have a medium */
3804 if (bs->drv == NULL) {
3805 for (i = 0; i < num_reqs; i++) {
3806 reqs[i].error = -ENOMEDIUM;
3807 }
3808 return -1;
3809 }
3810
40b4f539
KW
3811 if (num_reqs == 0) {
3812 return 0;
3813 }
3814
3815 // Create MultiwriteCB structure
7267c094 3816 mcb = g_malloc0(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
40b4f539
KW
3817 mcb->num_requests = 0;
3818 mcb->num_callbacks = num_reqs;
3819
3820 for (i = 0; i < num_reqs; i++) {
3821 mcb->callbacks[i].cb = reqs[i].cb;
3822 mcb->callbacks[i].opaque = reqs[i].opaque;
3823 }
3824
3825 // Check for mergable requests
3826 num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
3827
6d519a5f
SH
3828 trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs);
3829
df9309fb
PB
3830 /* Run the aio requests. */
3831 mcb->num_requests = num_reqs;
40b4f539 3832 for (i = 0; i < num_reqs; i++) {
ad54ae80 3833 bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
40b4f539 3834 reqs[i].nb_sectors, multiwrite_cb, mcb);
40b4f539
KW
3835 }
3836
3837 return 0;
40b4f539
KW
3838}
3839
83f64091 3840void bdrv_aio_cancel(BlockDriverAIOCB *acb)
83f64091 3841{
d7331bed 3842 acb->aiocb_info->cancel(acb);
83f64091
FB
3843}
3844
98f90dba
ZYW
3845/* block I/O throttling */
3846static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
3847 bool is_write, double elapsed_time, uint64_t *wait)
3848{
3849 uint64_t bps_limit = 0;
ae29d6c6 3850 uint64_t extension;
98f90dba
ZYW
3851 double bytes_limit, bytes_base, bytes_res;
3852 double slice_time, wait_time;
3853
3854 if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
3855 bps_limit = bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
3856 } else if (bs->io_limits.bps[is_write]) {
3857 bps_limit = bs->io_limits.bps[is_write];
3858 } else {
3859 if (wait) {
3860 *wait = 0;
3861 }
3862
3863 return false;
3864 }
3865
3866 slice_time = bs->slice_end - bs->slice_start;
3867 slice_time /= (NANOSECONDS_PER_SECOND);
3868 bytes_limit = bps_limit * slice_time;
5905fbc9 3869 bytes_base = bs->slice_submitted.bytes[is_write];
98f90dba 3870 if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
5905fbc9 3871 bytes_base += bs->slice_submitted.bytes[!is_write];
98f90dba
ZYW
3872 }
3873
3874 /* bytes_base: the bytes of data which have been read/written; and
3875 * it is obtained from the history statistic info.
3876 * bytes_res: the remaining bytes of data which need to be read/written.
3877 * (bytes_base + bytes_res) / bps_limit: used to calcuate
3878 * the total time for completing reading/writting all data.
3879 */
3880 bytes_res = (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
3881
3882 if (bytes_base + bytes_res <= bytes_limit) {
3883 if (wait) {
3884 *wait = 0;
3885 }
3886
3887 return false;
3888 }
3889
3890 /* Calc approx time to dispatch */
3891 wait_time = (bytes_base + bytes_res) / bps_limit - elapsed_time;
3892
3893 /* When the I/O rate at runtime exceeds the limits,
3894 * bs->slice_end need to be extended in order that the current statistic
3895 * info can be kept until the timer fire, so it is increased and tuned
3896 * based on the result of experiment.
3897 */
ae29d6c6
SH
3898 extension = wait_time * NANOSECONDS_PER_SECOND;
3899 extension = DIV_ROUND_UP(extension, BLOCK_IO_SLICE_TIME) *
3900 BLOCK_IO_SLICE_TIME;
3901 bs->slice_end += extension;
98f90dba 3902 if (wait) {
0775437f 3903 *wait = wait_time * NANOSECONDS_PER_SECOND;
98f90dba
ZYW
3904 }
3905
3906 return true;
3907}
3908
3909static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
3910 double elapsed_time, uint64_t *wait)
3911{
3912 uint64_t iops_limit = 0;
3913 double ios_limit, ios_base;
3914 double slice_time, wait_time;
3915
3916 if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
3917 iops_limit = bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
3918 } else if (bs->io_limits.iops[is_write]) {
3919 iops_limit = bs->io_limits.iops[is_write];
3920 } else {
3921 if (wait) {
3922 *wait = 0;
3923 }
3924
3925 return false;
3926 }
3927
3928 slice_time = bs->slice_end - bs->slice_start;
3929 slice_time /= (NANOSECONDS_PER_SECOND);
3930 ios_limit = iops_limit * slice_time;
5905fbc9 3931 ios_base = bs->slice_submitted.ios[is_write];
98f90dba 3932 if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
5905fbc9 3933 ios_base += bs->slice_submitted.ios[!is_write];
98f90dba
ZYW
3934 }
3935
3936 if (ios_base + 1 <= ios_limit) {
3937 if (wait) {
3938 *wait = 0;
3939 }
3940
3941 return false;
3942 }
3943
0775437f 3944 /* Calc approx time to dispatch, in seconds */
98f90dba
ZYW
3945 wait_time = (ios_base + 1) / iops_limit;
3946 if (wait_time > elapsed_time) {
3947 wait_time = wait_time - elapsed_time;
3948 } else {
3949 wait_time = 0;
3950 }
3951
ae29d6c6
SH
3952 /* Exceeded current slice, extend it by another slice time */
3953 bs->slice_end += BLOCK_IO_SLICE_TIME;
98f90dba 3954 if (wait) {
0775437f 3955 *wait = wait_time * NANOSECONDS_PER_SECOND;
98f90dba
ZYW
3956 }
3957
3958 return true;
3959}
3960
3961static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
3962 bool is_write, int64_t *wait)
3963{
3964 int64_t now, max_wait;
3965 uint64_t bps_wait = 0, iops_wait = 0;
3966 double elapsed_time;
3967 int bps_ret, iops_ret;
3968
3969 now = qemu_get_clock_ns(vm_clock);
e660fb8b 3970 if (now > bs->slice_end) {
98f90dba 3971 bs->slice_start = now;
ae29d6c6 3972 bs->slice_end = now + BLOCK_IO_SLICE_TIME;
5905fbc9 3973 memset(&bs->slice_submitted, 0, sizeof(bs->slice_submitted));
98f90dba
ZYW
3974 }
3975
3976 elapsed_time = now - bs->slice_start;
3977 elapsed_time /= (NANOSECONDS_PER_SECOND);
3978
3979 bps_ret = bdrv_exceed_bps_limits(bs, nb_sectors,
3980 is_write, elapsed_time, &bps_wait);
3981 iops_ret = bdrv_exceed_iops_limits(bs, is_write,
3982 elapsed_time, &iops_wait);
3983 if (bps_ret || iops_ret) {
3984 max_wait = bps_wait > iops_wait ? bps_wait : iops_wait;
3985 if (wait) {
3986 *wait = max_wait;
3987 }
3988
3989 now = qemu_get_clock_ns(vm_clock);
3990 if (bs->slice_end < now + max_wait) {
3991 bs->slice_end = now + max_wait;
3992 }
3993
3994 return true;
3995 }
3996
3997 if (wait) {
3998 *wait = 0;
3999 }
4000
5905fbc9
SH
4001 bs->slice_submitted.bytes[is_write] += (int64_t)nb_sectors *
4002 BDRV_SECTOR_SIZE;
4003 bs->slice_submitted.ios[is_write]++;
4004
98f90dba
ZYW
4005 return false;
4006}
ce1a14dc 4007
83f64091
FB
4008/**************************************************************/
4009/* async block device emulation */
4010
c16b5a2c
CH
4011typedef struct BlockDriverAIOCBSync {
4012 BlockDriverAIOCB common;
4013 QEMUBH *bh;
4014 int ret;
4015 /* vector translation state */
4016 QEMUIOVector *qiov;
4017 uint8_t *bounce;
4018 int is_write;
4019} BlockDriverAIOCBSync;
4020
4021static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
4022{
b666d239
KW
4023 BlockDriverAIOCBSync *acb =
4024 container_of(blockacb, BlockDriverAIOCBSync, common);
6a7ad299 4025 qemu_bh_delete(acb->bh);
36afc451 4026 acb->bh = NULL;
c16b5a2c
CH
4027 qemu_aio_release(acb);
4028}
4029
d7331bed 4030static const AIOCBInfo bdrv_em_aiocb_info = {
c16b5a2c
CH
4031 .aiocb_size = sizeof(BlockDriverAIOCBSync),
4032 .cancel = bdrv_aio_cancel_em,
4033};
4034
ce1a14dc 4035static void bdrv_aio_bh_cb(void *opaque)
83f64091 4036{
ce1a14dc 4037 BlockDriverAIOCBSync *acb = opaque;
f141eafe 4038
f141eafe 4039 if (!acb->is_write)
03396148 4040 qemu_iovec_from_buf(acb->qiov, 0, acb->bounce, acb->qiov->size);
ceb42de8 4041 qemu_vfree(acb->bounce);
ce1a14dc 4042 acb->common.cb(acb->common.opaque, acb->ret);
6a7ad299 4043 qemu_bh_delete(acb->bh);
36afc451 4044 acb->bh = NULL;
ce1a14dc 4045 qemu_aio_release(acb);
83f64091 4046}
beac80cd 4047
f141eafe
AL
4048static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
4049 int64_t sector_num,
4050 QEMUIOVector *qiov,
4051 int nb_sectors,
4052 BlockDriverCompletionFunc *cb,
4053 void *opaque,
4054 int is_write)
4055
83f64091 4056{
ce1a14dc 4057 BlockDriverAIOCBSync *acb;
ce1a14dc 4058
d7331bed 4059 acb = qemu_aio_get(&bdrv_em_aiocb_info, bs, cb, opaque);
f141eafe
AL
4060 acb->is_write = is_write;
4061 acb->qiov = qiov;
e268ca52 4062 acb->bounce = qemu_blockalign(bs, qiov->size);
3f3aace8 4063 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
f141eafe
AL
4064
4065 if (is_write) {
d5e6b161 4066 qemu_iovec_to_buf(acb->qiov, 0, acb->bounce, qiov->size);
1ed20acf 4067 acb->ret = bs->drv->bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
f141eafe 4068 } else {
1ed20acf 4069 acb->ret = bs->drv->bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
f141eafe
AL
4070 }
4071
ce1a14dc 4072 qemu_bh_schedule(acb->bh);
f141eafe 4073
ce1a14dc 4074 return &acb->common;
beac80cd
FB
4075}
4076
f141eafe
AL
4077static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
4078 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 4079 BlockDriverCompletionFunc *cb, void *opaque)
beac80cd 4080{
f141eafe
AL
4081 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
4082}
83f64091 4083
f141eafe
AL
4084static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
4085 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
4086 BlockDriverCompletionFunc *cb, void *opaque)
4087{
4088 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
beac80cd 4089}
beac80cd 4090
68485420
KW
4091
4092typedef struct BlockDriverAIOCBCoroutine {
4093 BlockDriverAIOCB common;
4094 BlockRequest req;
4095 bool is_write;
d318aea9 4096 bool *done;
68485420
KW
4097 QEMUBH* bh;
4098} BlockDriverAIOCBCoroutine;
4099
4100static void bdrv_aio_co_cancel_em(BlockDriverAIOCB *blockacb)
4101{
d318aea9
KW
4102 BlockDriverAIOCBCoroutine *acb =
4103 container_of(blockacb, BlockDriverAIOCBCoroutine, common);
4104 bool done = false;
4105
4106 acb->done = &done;
4107 while (!done) {
4108 qemu_aio_wait();
4109 }
68485420
KW
4110}
4111
d7331bed 4112static const AIOCBInfo bdrv_em_co_aiocb_info = {
68485420
KW
4113 .aiocb_size = sizeof(BlockDriverAIOCBCoroutine),
4114 .cancel = bdrv_aio_co_cancel_em,
4115};
4116
35246a68 4117static void bdrv_co_em_bh(void *opaque)
68485420
KW
4118{
4119 BlockDriverAIOCBCoroutine *acb = opaque;
4120
4121 acb->common.cb(acb->common.opaque, acb->req.error);
d318aea9
KW
4122
4123 if (acb->done) {
4124 *acb->done = true;
4125 }
4126
68485420
KW
4127 qemu_bh_delete(acb->bh);
4128 qemu_aio_release(acb);
4129}
4130
b2a61371
SH
4131/* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
4132static void coroutine_fn bdrv_co_do_rw(void *opaque)
4133{
4134 BlockDriverAIOCBCoroutine *acb = opaque;
4135 BlockDriverState *bs = acb->common.bs;
4136
4137 if (!acb->is_write) {
4138 acb->req.error = bdrv_co_do_readv(bs, acb->req.sector,
470c0504 4139 acb->req.nb_sectors, acb->req.qiov, 0);
b2a61371
SH
4140 } else {
4141 acb->req.error = bdrv_co_do_writev(bs, acb->req.sector,
f08f2dda 4142 acb->req.nb_sectors, acb->req.qiov, 0);
b2a61371
SH
4143 }
4144
35246a68 4145 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
b2a61371
SH
4146 qemu_bh_schedule(acb->bh);
4147}
4148
68485420
KW
4149static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
4150 int64_t sector_num,
4151 QEMUIOVector *qiov,
4152 int nb_sectors,
4153 BlockDriverCompletionFunc *cb,
4154 void *opaque,
8c5873d6 4155 bool is_write)
68485420
KW
4156{
4157 Coroutine *co;
4158 BlockDriverAIOCBCoroutine *acb;
4159
d7331bed 4160 acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
68485420
KW
4161 acb->req.sector = sector_num;
4162 acb->req.nb_sectors = nb_sectors;
4163 acb->req.qiov = qiov;
4164 acb->is_write = is_write;
d318aea9 4165 acb->done = NULL;
68485420 4166
8c5873d6 4167 co = qemu_coroutine_create(bdrv_co_do_rw);
68485420
KW
4168 qemu_coroutine_enter(co, acb);
4169
4170 return &acb->common;
4171}
4172
07f07615 4173static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque)
b2e12bc6 4174{
07f07615
PB
4175 BlockDriverAIOCBCoroutine *acb = opaque;
4176 BlockDriverState *bs = acb->common.bs;
b2e12bc6 4177
07f07615
PB
4178 acb->req.error = bdrv_co_flush(bs);
4179 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
b2e12bc6 4180 qemu_bh_schedule(acb->bh);
b2e12bc6
CH
4181}
4182
07f07615 4183BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
016f5cf6
AG
4184 BlockDriverCompletionFunc *cb, void *opaque)
4185{
07f07615 4186 trace_bdrv_aio_flush(bs, opaque);
016f5cf6 4187
07f07615
PB
4188 Coroutine *co;
4189 BlockDriverAIOCBCoroutine *acb;
016f5cf6 4190
d7331bed 4191 acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
d318aea9
KW
4192 acb->done = NULL;
4193
07f07615
PB
4194 co = qemu_coroutine_create(bdrv_aio_flush_co_entry);
4195 qemu_coroutine_enter(co, acb);
016f5cf6 4196
016f5cf6
AG
4197 return &acb->common;
4198}
4199
4265d620
PB
4200static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque)
4201{
4202 BlockDriverAIOCBCoroutine *acb = opaque;
4203 BlockDriverState *bs = acb->common.bs;
4204
4205 acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors);
4206 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
4207 qemu_bh_schedule(acb->bh);
4208}
4209
4210BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
4211 int64_t sector_num, int nb_sectors,
4212 BlockDriverCompletionFunc *cb, void *opaque)
4213{
4214 Coroutine *co;
4215 BlockDriverAIOCBCoroutine *acb;
4216
4217 trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque);
4218
d7331bed 4219 acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque);
4265d620
PB
4220 acb->req.sector = sector_num;
4221 acb->req.nb_sectors = nb_sectors;
d318aea9 4222 acb->done = NULL;
4265d620
PB
4223 co = qemu_coroutine_create(bdrv_aio_discard_co_entry);
4224 qemu_coroutine_enter(co, acb);
4225
4226 return &acb->common;
4227}
4228
ea2384d3
FB
4229void bdrv_init(void)
4230{
5efa9d5a 4231 module_call_init(MODULE_INIT_BLOCK);
ea2384d3 4232}
ce1a14dc 4233
eb852011
MA
4234void bdrv_init_with_whitelist(void)
4235{
4236 use_bdrv_whitelist = 1;
4237 bdrv_init();
4238}
4239
d7331bed 4240void *qemu_aio_get(const AIOCBInfo *aiocb_info, BlockDriverState *bs,
c16b5a2c 4241 BlockDriverCompletionFunc *cb, void *opaque)
ce1a14dc 4242{
ce1a14dc
PB
4243 BlockDriverAIOCB *acb;
4244
d7331bed
SH
4245 acb = g_slice_alloc(aiocb_info->aiocb_size);
4246 acb->aiocb_info = aiocb_info;
ce1a14dc
PB
4247 acb->bs = bs;
4248 acb->cb = cb;
4249 acb->opaque = opaque;
4250 return acb;
4251}
4252
4253void qemu_aio_release(void *p)
4254{
d37c975f 4255 BlockDriverAIOCB *acb = p;
d7331bed 4256 g_slice_free1(acb->aiocb_info->aiocb_size, acb);
ce1a14dc 4257}
19cb3738 4258
f9f05dc5
KW
4259/**************************************************************/
4260/* Coroutine block device emulation */
4261
4262typedef struct CoroutineIOCompletion {
4263 Coroutine *coroutine;
4264 int ret;
4265} CoroutineIOCompletion;
4266
4267static void bdrv_co_io_em_complete(void *opaque, int ret)
4268{
4269 CoroutineIOCompletion *co = opaque;
4270
4271 co->ret = ret;
4272 qemu_coroutine_enter(co->coroutine, NULL);
4273}
4274
4275static int coroutine_fn bdrv_co_io_em(BlockDriverState *bs, int64_t sector_num,
4276 int nb_sectors, QEMUIOVector *iov,
4277 bool is_write)
4278{
4279 CoroutineIOCompletion co = {
4280 .coroutine = qemu_coroutine_self(),
4281 };
4282 BlockDriverAIOCB *acb;
4283
4284 if (is_write) {
a652d160
SH
4285 acb = bs->drv->bdrv_aio_writev(bs, sector_num, iov, nb_sectors,
4286 bdrv_co_io_em_complete, &co);
f9f05dc5 4287 } else {
a652d160
SH
4288 acb = bs->drv->bdrv_aio_readv(bs, sector_num, iov, nb_sectors,
4289 bdrv_co_io_em_complete, &co);
f9f05dc5
KW
4290 }
4291
59370aaa 4292 trace_bdrv_co_io_em(bs, sector_num, nb_sectors, is_write, acb);
f9f05dc5
KW
4293 if (!acb) {
4294 return -EIO;
4295 }
4296 qemu_coroutine_yield();
4297
4298 return co.ret;
4299}
4300
4301static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
4302 int64_t sector_num, int nb_sectors,
4303 QEMUIOVector *iov)
4304{
4305 return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, false);
4306}
4307
4308static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
4309 int64_t sector_num, int nb_sectors,
4310 QEMUIOVector *iov)
4311{
4312 return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, true);
4313}
4314
07f07615 4315static void coroutine_fn bdrv_flush_co_entry(void *opaque)
e7a8a783 4316{
07f07615
PB
4317 RwCo *rwco = opaque;
4318
4319 rwco->ret = bdrv_co_flush(rwco->bs);
4320}
4321
4322int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
4323{
eb489bb1
KW
4324 int ret;
4325
29cdb251 4326 if (!bs || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
07f07615 4327 return 0;
eb489bb1
KW
4328 }
4329
ca716364 4330 /* Write back cached data to the OS even with cache=unsafe */
eb489bb1
KW
4331 if (bs->drv->bdrv_co_flush_to_os) {
4332 ret = bs->drv->bdrv_co_flush_to_os(bs);
4333 if (ret < 0) {
4334 return ret;
4335 }
4336 }
4337
ca716364
KW
4338 /* But don't actually force it to the disk with cache=unsafe */
4339 if (bs->open_flags & BDRV_O_NO_FLUSH) {
d4c82329 4340 goto flush_parent;
ca716364
KW
4341 }
4342
eb489bb1 4343 if (bs->drv->bdrv_co_flush_to_disk) {
29cdb251 4344 ret = bs->drv->bdrv_co_flush_to_disk(bs);
07f07615
PB
4345 } else if (bs->drv->bdrv_aio_flush) {
4346 BlockDriverAIOCB *acb;
4347 CoroutineIOCompletion co = {
4348 .coroutine = qemu_coroutine_self(),
4349 };
4350
4351 acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
4352 if (acb == NULL) {
29cdb251 4353 ret = -EIO;
07f07615
PB
4354 } else {
4355 qemu_coroutine_yield();
29cdb251 4356 ret = co.ret;
07f07615 4357 }
07f07615
PB
4358 } else {
4359 /*
4360 * Some block drivers always operate in either writethrough or unsafe
4361 * mode and don't support bdrv_flush therefore. Usually qemu doesn't
4362 * know how the server works (because the behaviour is hardcoded or
4363 * depends on server-side configuration), so we can't ensure that
4364 * everything is safe on disk. Returning an error doesn't work because
4365 * that would break guests even if the server operates in writethrough
4366 * mode.
4367 *
4368 * Let's hope the user knows what he's doing.
4369 */
29cdb251 4370 ret = 0;
07f07615 4371 }
29cdb251
PB
4372 if (ret < 0) {
4373 return ret;
4374 }
4375
4376 /* Now flush the underlying protocol. It will also have BDRV_O_NO_FLUSH
4377 * in the case of cache=unsafe, so there are no useless flushes.
4378 */
d4c82329 4379flush_parent:
29cdb251 4380 return bdrv_co_flush(bs->file);
07f07615
PB
4381}
4382
0f15423c
AL
4383void bdrv_invalidate_cache(BlockDriverState *bs)
4384{
4385 if (bs->drv && bs->drv->bdrv_invalidate_cache) {
4386 bs->drv->bdrv_invalidate_cache(bs);
4387 }
4388}
4389
4390void bdrv_invalidate_cache_all(void)
4391{
4392 BlockDriverState *bs;
4393
4394 QTAILQ_FOREACH(bs, &bdrv_states, list) {
4395 bdrv_invalidate_cache(bs);
4396 }
4397}
4398
07789269
BC
4399void bdrv_clear_incoming_migration_all(void)
4400{
4401 BlockDriverState *bs;
4402
4403 QTAILQ_FOREACH(bs, &bdrv_states, list) {
4404 bs->open_flags = bs->open_flags & ~(BDRV_O_INCOMING);
4405 }
4406}
4407
07f07615
PB
4408int bdrv_flush(BlockDriverState *bs)
4409{
4410 Coroutine *co;
4411 RwCo rwco = {
4412 .bs = bs,
4413 .ret = NOT_DONE,
e7a8a783 4414 };
e7a8a783 4415
07f07615
PB
4416 if (qemu_in_coroutine()) {
4417 /* Fast-path if already in coroutine context */
4418 bdrv_flush_co_entry(&rwco);
4419 } else {
4420 co = qemu_coroutine_create(bdrv_flush_co_entry);
4421 qemu_coroutine_enter(co, &rwco);
4422 while (rwco.ret == NOT_DONE) {
4423 qemu_aio_wait();
4424 }
e7a8a783 4425 }
07f07615
PB
4426
4427 return rwco.ret;
e7a8a783
KW
4428}
4429
4265d620
PB
4430static void coroutine_fn bdrv_discard_co_entry(void *opaque)
4431{
4432 RwCo *rwco = opaque;
4433
4434 rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors);
4435}
4436
4437int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num,
4438 int nb_sectors)
4439{
4440 if (!bs->drv) {
4441 return -ENOMEDIUM;
4442 } else if (bdrv_check_request(bs, sector_num, nb_sectors)) {
4443 return -EIO;
4444 } else if (bs->read_only) {
4445 return -EROFS;
df702c9b
PB
4446 }
4447
4448 if (bs->dirty_bitmap) {
8f0720ec 4449 bdrv_reset_dirty(bs, sector_num, nb_sectors);
df702c9b
PB
4450 }
4451
9e8f1835
PB
4452 /* Do nothing if disabled. */
4453 if (!(bs->open_flags & BDRV_O_UNMAP)) {
4454 return 0;
4455 }
4456
df702c9b 4457 if (bs->drv->bdrv_co_discard) {
4265d620
PB
4458 return bs->drv->bdrv_co_discard(bs, sector_num, nb_sectors);
4459 } else if (bs->drv->bdrv_aio_discard) {
4460 BlockDriverAIOCB *acb;
4461 CoroutineIOCompletion co = {
4462 .coroutine = qemu_coroutine_self(),
4463 };
4464
4465 acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors,
4466 bdrv_co_io_em_complete, &co);
4467 if (acb == NULL) {
4468 return -EIO;
4469 } else {
4470 qemu_coroutine_yield();
4471 return co.ret;
4472 }
4265d620
PB
4473 } else {
4474 return 0;
4475 }
4476}
4477
4478int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
4479{
4480 Coroutine *co;
4481 RwCo rwco = {
4482 .bs = bs,
4483 .sector_num = sector_num,
4484 .nb_sectors = nb_sectors,
4485 .ret = NOT_DONE,
4486 };
4487
4488 if (qemu_in_coroutine()) {
4489 /* Fast-path if already in coroutine context */
4490 bdrv_discard_co_entry(&rwco);
4491 } else {
4492 co = qemu_coroutine_create(bdrv_discard_co_entry);
4493 qemu_coroutine_enter(co, &rwco);
4494 while (rwco.ret == NOT_DONE) {
4495 qemu_aio_wait();
4496 }
4497 }
4498
4499 return rwco.ret;
4500}
4501
19cb3738
FB
4502/**************************************************************/
4503/* removable device support */
4504
4505/**
4506 * Return TRUE if the media is present
4507 */
4508int bdrv_is_inserted(BlockDriverState *bs)
4509{
4510 BlockDriver *drv = bs->drv;
a1aff5bf 4511
19cb3738
FB
4512 if (!drv)
4513 return 0;
4514 if (!drv->bdrv_is_inserted)
a1aff5bf
MA
4515 return 1;
4516 return drv->bdrv_is_inserted(bs);
19cb3738
FB
4517}
4518
4519/**
8e49ca46
MA
4520 * Return whether the media changed since the last call to this
4521 * function, or -ENOTSUP if we don't know. Most drivers don't know.
19cb3738
FB
4522 */
4523int bdrv_media_changed(BlockDriverState *bs)
4524{
4525 BlockDriver *drv = bs->drv;
19cb3738 4526
8e49ca46
MA
4527 if (drv && drv->bdrv_media_changed) {
4528 return drv->bdrv_media_changed(bs);
4529 }
4530 return -ENOTSUP;
19cb3738
FB
4531}
4532
4533/**
4534 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
4535 */
f36f3949 4536void bdrv_eject(BlockDriverState *bs, bool eject_flag)
19cb3738
FB
4537{
4538 BlockDriver *drv = bs->drv;
19cb3738 4539
822e1cd1
MA
4540 if (drv && drv->bdrv_eject) {
4541 drv->bdrv_eject(bs, eject_flag);
19cb3738 4542 }
6f382ed2
LC
4543
4544 if (bs->device_name[0] != '\0') {
4545 bdrv_emit_qmp_eject_event(bs, eject_flag);
4546 }
19cb3738
FB
4547}
4548
19cb3738
FB
4549/**
4550 * Lock or unlock the media (if it is locked, the user won't be able
4551 * to eject it manually).
4552 */
025e849a 4553void bdrv_lock_medium(BlockDriverState *bs, bool locked)
19cb3738
FB
4554{
4555 BlockDriver *drv = bs->drv;
4556
025e849a 4557 trace_bdrv_lock_medium(bs, locked);
b8c6d095 4558
025e849a
MA
4559 if (drv && drv->bdrv_lock_medium) {
4560 drv->bdrv_lock_medium(bs, locked);
19cb3738
FB
4561 }
4562}
985a03b0
TS
4563
4564/* needed for generic scsi interface */
4565
4566int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
4567{
4568 BlockDriver *drv = bs->drv;
4569
4570 if (drv && drv->bdrv_ioctl)
4571 return drv->bdrv_ioctl(bs, req, buf);
4572 return -ENOTSUP;
4573}
7d780669 4574
221f715d
AL
4575BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
4576 unsigned long int req, void *buf,
4577 BlockDriverCompletionFunc *cb, void *opaque)
7d780669 4578{
221f715d 4579 BlockDriver *drv = bs->drv;
7d780669 4580
221f715d
AL
4581 if (drv && drv->bdrv_aio_ioctl)
4582 return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
4583 return NULL;
7d780669 4584}
e268ca52 4585
7b6f9300
MA
4586void bdrv_set_buffer_alignment(BlockDriverState *bs, int align)
4587{
4588 bs->buffer_alignment = align;
4589}
7cd1e32a 4590
e268ca52
AL
4591void *qemu_blockalign(BlockDriverState *bs, size_t size)
4592{
4593 return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
4594}
7cd1e32a 4595
c53b1c51
SH
4596/*
4597 * Check if all memory in this vector is sector aligned.
4598 */
4599bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov)
4600{
4601 int i;
4602
4603 for (i = 0; i < qiov->niov; i++) {
4604 if ((uintptr_t) qiov->iov[i].iov_base % bs->buffer_alignment) {
4605 return false;
4606 }
4607 }
4608
4609 return true;
4610}
4611
50717e94 4612void bdrv_set_dirty_tracking(BlockDriverState *bs, int granularity)
7cd1e32a
LS
4613{
4614 int64_t bitmap_size;
a55eb92c 4615
50717e94
PB
4616 assert((granularity & (granularity - 1)) == 0);
4617
4618 if (granularity) {
4619 granularity >>= BDRV_SECTOR_BITS;
4620 assert(!bs->dirty_bitmap);
4621 bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS);
4622 bs->dirty_bitmap = hbitmap_alloc(bitmap_size, ffs(granularity) - 1);
7cd1e32a 4623 } else {
c6d22830 4624 if (bs->dirty_bitmap) {
8f0720ec 4625 hbitmap_free(bs->dirty_bitmap);
c6d22830 4626 bs->dirty_bitmap = NULL;
a55eb92c 4627 }
7cd1e32a
LS
4628 }
4629}
4630
4631int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
4632{
8f0720ec
PB
4633 if (bs->dirty_bitmap) {
4634 return hbitmap_get(bs->dirty_bitmap, sector);
7cd1e32a
LS
4635 } else {
4636 return 0;
4637 }
4638}
4639
8f0720ec 4640void bdrv_dirty_iter_init(BlockDriverState *bs, HBitmapIter *hbi)
1755da16 4641{
8f0720ec 4642 hbitmap_iter_init(hbi, bs->dirty_bitmap, 0);
1755da16
PB
4643}
4644
4645void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector,
4646 int nr_sectors)
4647{
8f0720ec 4648 hbitmap_set(bs->dirty_bitmap, cur_sector, nr_sectors);
1755da16
PB
4649}
4650
a55eb92c
JK
4651void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
4652 int nr_sectors)
7cd1e32a 4653{
8f0720ec 4654 hbitmap_reset(bs->dirty_bitmap, cur_sector, nr_sectors);
7cd1e32a 4655}
aaa0eb75
LS
4656
4657int64_t bdrv_get_dirty_count(BlockDriverState *bs)
4658{
8f0720ec 4659 if (bs->dirty_bitmap) {
acc906c6 4660 return hbitmap_count(bs->dirty_bitmap);
8f0720ec
PB
4661 } else {
4662 return 0;
4663 }
aaa0eb75 4664}
f88e1a42 4665
db593f25
MT
4666void bdrv_set_in_use(BlockDriverState *bs, int in_use)
4667{
4668 assert(bs->in_use != in_use);
4669 bs->in_use = in_use;
4670}
4671
4672int bdrv_in_use(BlockDriverState *bs)
4673{
4674 return bs->in_use;
4675}
4676
28a7282a
LC
4677void bdrv_iostatus_enable(BlockDriverState *bs)
4678{
d6bf279e 4679 bs->iostatus_enabled = true;
58e21ef5 4680 bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
28a7282a
LC
4681}
4682
4683/* The I/O status is only enabled if the drive explicitly
4684 * enables it _and_ the VM is configured to stop on errors */
4685bool bdrv_iostatus_is_enabled(const BlockDriverState *bs)
4686{
d6bf279e 4687 return (bs->iostatus_enabled &&
92aa5c6d
PB
4688 (bs->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
4689 bs->on_write_error == BLOCKDEV_ON_ERROR_STOP ||
4690 bs->on_read_error == BLOCKDEV_ON_ERROR_STOP));
28a7282a
LC
4691}
4692
4693void bdrv_iostatus_disable(BlockDriverState *bs)
4694{
d6bf279e 4695 bs->iostatus_enabled = false;
28a7282a
LC
4696}
4697
4698void bdrv_iostatus_reset(BlockDriverState *bs)
4699{
4700 if (bdrv_iostatus_is_enabled(bs)) {
58e21ef5 4701 bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
3bd293c3
PB
4702 if (bs->job) {
4703 block_job_iostatus_reset(bs->job);
4704 }
28a7282a
LC
4705 }
4706}
4707
28a7282a
LC
4708void bdrv_iostatus_set_err(BlockDriverState *bs, int error)
4709{
3e1caa5f
PB
4710 assert(bdrv_iostatus_is_enabled(bs));
4711 if (bs->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
58e21ef5
LC
4712 bs->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
4713 BLOCK_DEVICE_IO_STATUS_FAILED;
28a7282a
LC
4714 }
4715}
4716
a597e79c
CH
4717void
4718bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, int64_t bytes,
4719 enum BlockAcctType type)
4720{
4721 assert(type < BDRV_MAX_IOTYPE);
4722
4723 cookie->bytes = bytes;
c488c7f6 4724 cookie->start_time_ns = get_clock();
a597e79c
CH
4725 cookie->type = type;
4726}
4727
4728void
4729bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie)
4730{
4731 assert(cookie->type < BDRV_MAX_IOTYPE);
4732
4733 bs->nr_bytes[cookie->type] += cookie->bytes;
4734 bs->nr_ops[cookie->type]++;
c488c7f6 4735 bs->total_time_ns[cookie->type] += get_clock() - cookie->start_time_ns;
a597e79c
CH
4736}
4737
d92ada22
LC
4738void bdrv_img_create(const char *filename, const char *fmt,
4739 const char *base_filename, const char *base_fmt,
f382d43a
MR
4740 char *options, uint64_t img_size, int flags,
4741 Error **errp, bool quiet)
f88e1a42
JS
4742{
4743 QEMUOptionParameter *param = NULL, *create_options = NULL;
d220894e 4744 QEMUOptionParameter *backing_fmt, *backing_file, *size;
f88e1a42
JS
4745 BlockDriverState *bs = NULL;
4746 BlockDriver *drv, *proto_drv;
96df67d1 4747 BlockDriver *backing_drv = NULL;
f88e1a42
JS
4748 int ret = 0;
4749
4750 /* Find driver and parse its options */
4751 drv = bdrv_find_format(fmt);
4752 if (!drv) {
71c79813 4753 error_setg(errp, "Unknown file format '%s'", fmt);
d92ada22 4754 return;
f88e1a42
JS
4755 }
4756
4757 proto_drv = bdrv_find_protocol(filename);
4758 if (!proto_drv) {
71c79813 4759 error_setg(errp, "Unknown protocol '%s'", filename);
d92ada22 4760 return;
f88e1a42
JS
4761 }
4762
4763 create_options = append_option_parameters(create_options,
4764 drv->create_options);
4765 create_options = append_option_parameters(create_options,
4766 proto_drv->create_options);
4767
4768 /* Create parameter list with default values */
4769 param = parse_option_parameters("", create_options, param);
4770
4771 set_option_parameter_int(param, BLOCK_OPT_SIZE, img_size);
4772
4773 /* Parse -o options */
4774 if (options) {
4775 param = parse_option_parameters(options, create_options, param);
4776 if (param == NULL) {
71c79813 4777 error_setg(errp, "Invalid options for file format '%s'.", fmt);
f88e1a42
JS
4778 goto out;
4779 }
4780 }
4781
4782 if (base_filename) {
4783 if (set_option_parameter(param, BLOCK_OPT_BACKING_FILE,
4784 base_filename)) {
71c79813
LC
4785 error_setg(errp, "Backing file not supported for file format '%s'",
4786 fmt);
f88e1a42
JS
4787 goto out;
4788 }
4789 }
4790
4791 if (base_fmt) {
4792 if (set_option_parameter(param, BLOCK_OPT_BACKING_FMT, base_fmt)) {
71c79813
LC
4793 error_setg(errp, "Backing file format not supported for file "
4794 "format '%s'", fmt);
f88e1a42
JS
4795 goto out;
4796 }
4797 }
4798
792da93a
JS
4799 backing_file = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
4800 if (backing_file && backing_file->value.s) {
4801 if (!strcmp(filename, backing_file->value.s)) {
71c79813
LC
4802 error_setg(errp, "Error: Trying to create an image with the "
4803 "same filename as the backing file");
792da93a
JS
4804 goto out;
4805 }
4806 }
4807
f88e1a42
JS
4808 backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
4809 if (backing_fmt && backing_fmt->value.s) {
96df67d1
SH
4810 backing_drv = bdrv_find_format(backing_fmt->value.s);
4811 if (!backing_drv) {
71c79813
LC
4812 error_setg(errp, "Unknown backing file format '%s'",
4813 backing_fmt->value.s);
f88e1a42
JS
4814 goto out;
4815 }
4816 }
4817
4818 // The size for the image must always be specified, with one exception:
4819 // If we are using a backing file, we can obtain the size from there
d220894e
KW
4820 size = get_option_parameter(param, BLOCK_OPT_SIZE);
4821 if (size && size->value.n == -1) {
f88e1a42
JS
4822 if (backing_file && backing_file->value.s) {
4823 uint64_t size;
f88e1a42 4824 char buf[32];
63090dac
PB
4825 int back_flags;
4826
4827 /* backing files always opened read-only */
4828 back_flags =
4829 flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
f88e1a42 4830
f88e1a42
JS
4831 bs = bdrv_new("");
4832
de9c0cec
KW
4833 ret = bdrv_open(bs, backing_file->value.s, NULL, back_flags,
4834 backing_drv);
f88e1a42 4835 if (ret < 0) {
71c79813
LC
4836 error_setg_errno(errp, -ret, "Could not open '%s'",
4837 backing_file->value.s);
f88e1a42
JS
4838 goto out;
4839 }
4840 bdrv_get_geometry(bs, &size);
4841 size *= 512;
4842
4843 snprintf(buf, sizeof(buf), "%" PRId64, size);
4844 set_option_parameter(param, BLOCK_OPT_SIZE, buf);
4845 } else {
71c79813 4846 error_setg(errp, "Image creation needs a size parameter");
f88e1a42
JS
4847 goto out;
4848 }
4849 }
4850
f382d43a
MR
4851 if (!quiet) {
4852 printf("Formatting '%s', fmt=%s ", filename, fmt);
4853 print_option_parameters(param);
4854 puts("");
4855 }
f88e1a42 4856 ret = bdrv_create(drv, filename, param);
f88e1a42
JS
4857 if (ret < 0) {
4858 if (ret == -ENOTSUP) {
71c79813
LC
4859 error_setg(errp,"Formatting or formatting option not supported for "
4860 "file format '%s'", fmt);
f88e1a42 4861 } else if (ret == -EFBIG) {
71c79813
LC
4862 error_setg(errp, "The image size is too large for file format '%s'",
4863 fmt);
f88e1a42 4864 } else {
71c79813
LC
4865 error_setg(errp, "%s: error while creating %s: %s", filename, fmt,
4866 strerror(-ret));
f88e1a42
JS
4867 }
4868 }
4869
4870out:
4871 free_option_parameters(create_options);
4872 free_option_parameters(param);
4873
4874 if (bs) {
4875 bdrv_delete(bs);
4876 }
f88e1a42 4877}
85d126f3
SH
4878
4879AioContext *bdrv_get_aio_context(BlockDriverState *bs)
4880{
4881 /* Currently BlockDriverState always uses the main loop AioContext */
4882 return qemu_get_aio_context();
4883}