]> git.proxmox.com Git - qemu.git/blame - block.c
block: cancel jobs when a device is ready to go away
[qemu.git] / block.c
CommitLineData
fc01f7e7
FB
1/*
2 * QEMU System Emulator block driver
5fafdf24 3 *
fc01f7e7 4 * Copyright (c) 2003 Fabrice Bellard
5fafdf24 5 *
fc01f7e7
FB
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
3990d09a 24#include "config-host.h"
faf07963 25#include "qemu-common.h"
6d519a5f 26#include "trace.h"
376253ec 27#include "monitor.h"
ea2384d3 28#include "block_int.h"
5efa9d5a 29#include "module.h"
f795e743 30#include "qjson.h"
68485420 31#include "qemu-coroutine.h"
b2023818 32#include "qmp-commands.h"
0563e191 33#include "qemu-timer.h"
fc01f7e7 34
71e72a19 35#ifdef CONFIG_BSD
7674e7bf
FB
36#include <sys/types.h>
37#include <sys/stat.h>
38#include <sys/ioctl.h>
72cf2d4f 39#include <sys/queue.h>
c5e97233 40#ifndef __DragonFly__
7674e7bf
FB
41#include <sys/disk.h>
42#endif
c5e97233 43#endif
7674e7bf 44
49dc768d
AL
45#ifdef _WIN32
46#include <windows.h>
47#endif
48
1c9805a3
SH
49#define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
50
470c0504
SH
51typedef enum {
52 BDRV_REQ_COPY_ON_READ = 0x1,
f08f2dda 53 BDRV_REQ_ZERO_WRITE = 0x2,
470c0504
SH
54} BdrvRequestFlags;
55
7d4b4ba5 56static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load);
f141eafe
AL
57static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
58 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
c87c0672 59 BlockDriverCompletionFunc *cb, void *opaque);
f141eafe
AL
60static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
61 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 62 BlockDriverCompletionFunc *cb, void *opaque);
f9f05dc5
KW
63static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
64 int64_t sector_num, int nb_sectors,
65 QEMUIOVector *iov);
66static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
67 int64_t sector_num, int nb_sectors,
68 QEMUIOVector *iov);
c5fbe571 69static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
470c0504
SH
70 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
71 BdrvRequestFlags flags);
1c9805a3 72static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
f08f2dda
SH
73 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
74 BdrvRequestFlags flags);
b2a61371
SH
75static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
76 int64_t sector_num,
77 QEMUIOVector *qiov,
78 int nb_sectors,
79 BlockDriverCompletionFunc *cb,
80 void *opaque,
8c5873d6 81 bool is_write);
b2a61371 82static void coroutine_fn bdrv_co_do_rw(void *opaque);
ec530c81 83
98f90dba
ZYW
84static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
85 bool is_write, double elapsed_time, uint64_t *wait);
86static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
87 double elapsed_time, uint64_t *wait);
88static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
89 bool is_write, int64_t *wait);
90
1b7bdbc1
SH
91static QTAILQ_HEAD(, BlockDriverState) bdrv_states =
92 QTAILQ_HEAD_INITIALIZER(bdrv_states);
7ee930d0 93
8a22f02a
SH
94static QLIST_HEAD(, BlockDriver) bdrv_drivers =
95 QLIST_HEAD_INITIALIZER(bdrv_drivers);
ea2384d3 96
f9092b10
MA
97/* The device to use for VM snapshots */
98static BlockDriverState *bs_snapshots;
99
eb852011
MA
100/* If non-zero, use only whitelisted block drivers */
101static int use_bdrv_whitelist;
102
9e0b22f4
SH
103#ifdef _WIN32
104static int is_windows_drive_prefix(const char *filename)
105{
106 return (((filename[0] >= 'a' && filename[0] <= 'z') ||
107 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
108 filename[1] == ':');
109}
110
111int is_windows_drive(const char *filename)
112{
113 if (is_windows_drive_prefix(filename) &&
114 filename[2] == '\0')
115 return 1;
116 if (strstart(filename, "\\\\.\\", NULL) ||
117 strstart(filename, "//./", NULL))
118 return 1;
119 return 0;
120}
121#endif
122
0563e191 123/* throttling disk I/O limits */
98f90dba
ZYW
124void bdrv_io_limits_disable(BlockDriverState *bs)
125{
126 bs->io_limits_enabled = false;
127
128 while (qemu_co_queue_next(&bs->throttled_reqs));
129
130 if (bs->block_timer) {
131 qemu_del_timer(bs->block_timer);
132 qemu_free_timer(bs->block_timer);
133 bs->block_timer = NULL;
134 }
135
136 bs->slice_start = 0;
137 bs->slice_end = 0;
138 bs->slice_time = 0;
139 memset(&bs->io_base, 0, sizeof(bs->io_base));
140}
141
0563e191
ZYW
142static void bdrv_block_timer(void *opaque)
143{
144 BlockDriverState *bs = opaque;
145
146 qemu_co_queue_next(&bs->throttled_reqs);
147}
148
149void bdrv_io_limits_enable(BlockDriverState *bs)
150{
151 qemu_co_queue_init(&bs->throttled_reqs);
152 bs->block_timer = qemu_new_timer_ns(vm_clock, bdrv_block_timer, bs);
153 bs->slice_time = 5 * BLOCK_IO_SLICE_TIME;
154 bs->slice_start = qemu_get_clock_ns(vm_clock);
155 bs->slice_end = bs->slice_start + bs->slice_time;
156 memset(&bs->io_base, 0, sizeof(bs->io_base));
157 bs->io_limits_enabled = true;
158}
159
160bool bdrv_io_limits_enabled(BlockDriverState *bs)
161{
162 BlockIOLimit *io_limits = &bs->io_limits;
163 return io_limits->bps[BLOCK_IO_LIMIT_READ]
164 || io_limits->bps[BLOCK_IO_LIMIT_WRITE]
165 || io_limits->bps[BLOCK_IO_LIMIT_TOTAL]
166 || io_limits->iops[BLOCK_IO_LIMIT_READ]
167 || io_limits->iops[BLOCK_IO_LIMIT_WRITE]
168 || io_limits->iops[BLOCK_IO_LIMIT_TOTAL];
169}
170
98f90dba
ZYW
171static void bdrv_io_limits_intercept(BlockDriverState *bs,
172 bool is_write, int nb_sectors)
173{
174 int64_t wait_time = -1;
175
176 if (!qemu_co_queue_empty(&bs->throttled_reqs)) {
177 qemu_co_queue_wait(&bs->throttled_reqs);
178 }
179
180 /* In fact, we hope to keep each request's timing, in FIFO mode. The next
181 * throttled requests will not be dequeued until the current request is
182 * allowed to be serviced. So if the current request still exceeds the
183 * limits, it will be inserted to the head. All requests followed it will
184 * be still in throttled_reqs queue.
185 */
186
187 while (bdrv_exceed_io_limits(bs, nb_sectors, is_write, &wait_time)) {
188 qemu_mod_timer(bs->block_timer,
189 wait_time + qemu_get_clock_ns(vm_clock));
190 qemu_co_queue_wait_insert_head(&bs->throttled_reqs);
191 }
192
193 qemu_co_queue_next(&bs->throttled_reqs);
194}
195
9e0b22f4
SH
196/* check if the path starts with "<protocol>:" */
197static int path_has_protocol(const char *path)
198{
199#ifdef _WIN32
200 if (is_windows_drive(path) ||
201 is_windows_drive_prefix(path)) {
202 return 0;
203 }
204#endif
205
206 return strchr(path, ':') != NULL;
207}
208
83f64091 209int path_is_absolute(const char *path)
3b0d4f61 210{
83f64091 211 const char *p;
21664424
FB
212#ifdef _WIN32
213 /* specific case for names like: "\\.\d:" */
214 if (*path == '/' || *path == '\\')
215 return 1;
216#endif
83f64091
FB
217 p = strchr(path, ':');
218 if (p)
219 p++;
220 else
221 p = path;
3b9f94e1
FB
222#ifdef _WIN32
223 return (*p == '/' || *p == '\\');
224#else
225 return (*p == '/');
226#endif
3b0d4f61
FB
227}
228
83f64091
FB
229/* if filename is absolute, just copy it to dest. Otherwise, build a
230 path to it by considering it is relative to base_path. URL are
231 supported. */
232void path_combine(char *dest, int dest_size,
233 const char *base_path,
234 const char *filename)
3b0d4f61 235{
83f64091
FB
236 const char *p, *p1;
237 int len;
238
239 if (dest_size <= 0)
240 return;
241 if (path_is_absolute(filename)) {
242 pstrcpy(dest, dest_size, filename);
243 } else {
244 p = strchr(base_path, ':');
245 if (p)
246 p++;
247 else
248 p = base_path;
3b9f94e1
FB
249 p1 = strrchr(base_path, '/');
250#ifdef _WIN32
251 {
252 const char *p2;
253 p2 = strrchr(base_path, '\\');
254 if (!p1 || p2 > p1)
255 p1 = p2;
256 }
257#endif
83f64091
FB
258 if (p1)
259 p1++;
260 else
261 p1 = base_path;
262 if (p1 > p)
263 p = p1;
264 len = p - base_path;
265 if (len > dest_size - 1)
266 len = dest_size - 1;
267 memcpy(dest, base_path, len);
268 dest[len] = '\0';
269 pstrcat(dest, dest_size, filename);
3b0d4f61 270 }
3b0d4f61
FB
271}
272
5efa9d5a 273void bdrv_register(BlockDriver *bdrv)
ea2384d3 274{
8c5873d6
SH
275 /* Block drivers without coroutine functions need emulation */
276 if (!bdrv->bdrv_co_readv) {
f9f05dc5
KW
277 bdrv->bdrv_co_readv = bdrv_co_readv_em;
278 bdrv->bdrv_co_writev = bdrv_co_writev_em;
279
f8c35c1d
SH
280 /* bdrv_co_readv_em()/brdv_co_writev_em() work in terms of aio, so if
281 * the block driver lacks aio we need to emulate that too.
282 */
f9f05dc5
KW
283 if (!bdrv->bdrv_aio_readv) {
284 /* add AIO emulation layer */
285 bdrv->bdrv_aio_readv = bdrv_aio_readv_em;
286 bdrv->bdrv_aio_writev = bdrv_aio_writev_em;
f9f05dc5 287 }
83f64091 288 }
b2e12bc6 289
8a22f02a 290 QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list);
ea2384d3 291}
b338082b
FB
292
293/* create a new block device (by default it is empty) */
294BlockDriverState *bdrv_new(const char *device_name)
295{
1b7bdbc1 296 BlockDriverState *bs;
b338082b 297
7267c094 298 bs = g_malloc0(sizeof(BlockDriverState));
b338082b 299 pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
ea2384d3 300 if (device_name[0] != '\0') {
1b7bdbc1 301 QTAILQ_INSERT_TAIL(&bdrv_states, bs, list);
ea2384d3 302 }
28a7282a 303 bdrv_iostatus_disable(bs);
b338082b
FB
304 return bs;
305}
306
ea2384d3
FB
307BlockDriver *bdrv_find_format(const char *format_name)
308{
309 BlockDriver *drv1;
8a22f02a
SH
310 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
311 if (!strcmp(drv1->format_name, format_name)) {
ea2384d3 312 return drv1;
8a22f02a 313 }
ea2384d3
FB
314 }
315 return NULL;
316}
317
eb852011
MA
318static int bdrv_is_whitelisted(BlockDriver *drv)
319{
320 static const char *whitelist[] = {
321 CONFIG_BDRV_WHITELIST
322 };
323 const char **p;
324
325 if (!whitelist[0])
326 return 1; /* no whitelist, anything goes */
327
328 for (p = whitelist; *p; p++) {
329 if (!strcmp(drv->format_name, *p)) {
330 return 1;
331 }
332 }
333 return 0;
334}
335
336BlockDriver *bdrv_find_whitelisted_format(const char *format_name)
337{
338 BlockDriver *drv = bdrv_find_format(format_name);
339 return drv && bdrv_is_whitelisted(drv) ? drv : NULL;
340}
341
0e7e1989
KW
342int bdrv_create(BlockDriver *drv, const char* filename,
343 QEMUOptionParameter *options)
ea2384d3
FB
344{
345 if (!drv->bdrv_create)
346 return -ENOTSUP;
0e7e1989
KW
347
348 return drv->bdrv_create(filename, options);
ea2384d3
FB
349}
350
84a12e66
CH
351int bdrv_create_file(const char* filename, QEMUOptionParameter *options)
352{
353 BlockDriver *drv;
354
b50cbabc 355 drv = bdrv_find_protocol(filename);
84a12e66 356 if (drv == NULL) {
16905d71 357 return -ENOENT;
84a12e66
CH
358 }
359
360 return bdrv_create(drv, filename, options);
361}
362
d5249393 363#ifdef _WIN32
95389c86 364void get_tmp_filename(char *filename, int size)
d5249393 365{
3b9f94e1 366 char temp_dir[MAX_PATH];
3b46e624 367
3b9f94e1
FB
368 GetTempPath(MAX_PATH, temp_dir);
369 GetTempFileName(temp_dir, "qem", 0, filename);
d5249393
FB
370}
371#else
95389c86 372void get_tmp_filename(char *filename, int size)
fc01f7e7 373{
67b915a5 374 int fd;
7ccfb2eb 375 const char *tmpdir;
d5249393 376 /* XXX: race condition possible */
0badc1ee
AJ
377 tmpdir = getenv("TMPDIR");
378 if (!tmpdir)
379 tmpdir = "/tmp";
380 snprintf(filename, size, "%s/vl.XXXXXX", tmpdir);
ea2384d3
FB
381 fd = mkstemp(filename);
382 close(fd);
383}
d5249393 384#endif
fc01f7e7 385
84a12e66
CH
386/*
387 * Detect host devices. By convention, /dev/cdrom[N] is always
388 * recognized as a host CDROM.
389 */
390static BlockDriver *find_hdev_driver(const char *filename)
391{
392 int score_max = 0, score;
393 BlockDriver *drv = NULL, *d;
394
395 QLIST_FOREACH(d, &bdrv_drivers, list) {
396 if (d->bdrv_probe_device) {
397 score = d->bdrv_probe_device(filename);
398 if (score > score_max) {
399 score_max = score;
400 drv = d;
401 }
402 }
403 }
404
405 return drv;
406}
407
b50cbabc 408BlockDriver *bdrv_find_protocol(const char *filename)
83f64091
FB
409{
410 BlockDriver *drv1;
411 char protocol[128];
1cec71e3 412 int len;
83f64091 413 const char *p;
19cb3738 414
66f82cee
KW
415 /* TODO Drivers without bdrv_file_open must be specified explicitly */
416
39508e7a
CH
417 /*
418 * XXX(hch): we really should not let host device detection
419 * override an explicit protocol specification, but moving this
420 * later breaks access to device names with colons in them.
421 * Thanks to the brain-dead persistent naming schemes on udev-
422 * based Linux systems those actually are quite common.
423 */
424 drv1 = find_hdev_driver(filename);
425 if (drv1) {
426 return drv1;
427 }
428
9e0b22f4 429 if (!path_has_protocol(filename)) {
39508e7a 430 return bdrv_find_format("file");
84a12e66 431 }
9e0b22f4
SH
432 p = strchr(filename, ':');
433 assert(p != NULL);
1cec71e3
AL
434 len = p - filename;
435 if (len > sizeof(protocol) - 1)
436 len = sizeof(protocol) - 1;
437 memcpy(protocol, filename, len);
438 protocol[len] = '\0';
8a22f02a 439 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
5fafdf24 440 if (drv1->protocol_name &&
8a22f02a 441 !strcmp(drv1->protocol_name, protocol)) {
83f64091 442 return drv1;
8a22f02a 443 }
83f64091
FB
444 }
445 return NULL;
446}
447
c98ac35d 448static int find_image_format(const char *filename, BlockDriver **pdrv)
f3a5d3f8
CH
449{
450 int ret, score, score_max;
451 BlockDriver *drv1, *drv;
452 uint8_t buf[2048];
453 BlockDriverState *bs;
454
f5edb014 455 ret = bdrv_file_open(&bs, filename, 0);
c98ac35d
SW
456 if (ret < 0) {
457 *pdrv = NULL;
458 return ret;
459 }
f8ea0b00 460
08a00559
KW
461 /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
462 if (bs->sg || !bdrv_is_inserted(bs)) {
1a396859 463 bdrv_delete(bs);
c98ac35d
SW
464 drv = bdrv_find_format("raw");
465 if (!drv) {
466 ret = -ENOENT;
467 }
468 *pdrv = drv;
469 return ret;
1a396859 470 }
f8ea0b00 471
83f64091
FB
472 ret = bdrv_pread(bs, 0, buf, sizeof(buf));
473 bdrv_delete(bs);
474 if (ret < 0) {
c98ac35d
SW
475 *pdrv = NULL;
476 return ret;
83f64091
FB
477 }
478
ea2384d3 479 score_max = 0;
84a12e66 480 drv = NULL;
8a22f02a 481 QLIST_FOREACH(drv1, &bdrv_drivers, list) {
83f64091
FB
482 if (drv1->bdrv_probe) {
483 score = drv1->bdrv_probe(buf, ret, filename);
484 if (score > score_max) {
485 score_max = score;
486 drv = drv1;
487 }
0849bf08 488 }
fc01f7e7 489 }
c98ac35d
SW
490 if (!drv) {
491 ret = -ENOENT;
492 }
493 *pdrv = drv;
494 return ret;
ea2384d3
FB
495}
496
51762288
SH
497/**
498 * Set the current 'total_sectors' value
499 */
500static int refresh_total_sectors(BlockDriverState *bs, int64_t hint)
501{
502 BlockDriver *drv = bs->drv;
503
396759ad
NB
504 /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
505 if (bs->sg)
506 return 0;
507
51762288
SH
508 /* query actual device if possible, otherwise just trust the hint */
509 if (drv->bdrv_getlength) {
510 int64_t length = drv->bdrv_getlength(bs);
511 if (length < 0) {
512 return length;
513 }
514 hint = length >> BDRV_SECTOR_BITS;
515 }
516
517 bs->total_sectors = hint;
518 return 0;
519}
520
c3993cdc
SH
521/**
522 * Set open flags for a given cache mode
523 *
524 * Return 0 on success, -1 if the cache mode was invalid.
525 */
526int bdrv_parse_cache_flags(const char *mode, int *flags)
527{
528 *flags &= ~BDRV_O_CACHE_MASK;
529
530 if (!strcmp(mode, "off") || !strcmp(mode, "none")) {
531 *flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB;
92196b2f
SH
532 } else if (!strcmp(mode, "directsync")) {
533 *flags |= BDRV_O_NOCACHE;
c3993cdc
SH
534 } else if (!strcmp(mode, "writeback")) {
535 *flags |= BDRV_O_CACHE_WB;
536 } else if (!strcmp(mode, "unsafe")) {
537 *flags |= BDRV_O_CACHE_WB;
538 *flags |= BDRV_O_NO_FLUSH;
539 } else if (!strcmp(mode, "writethrough")) {
540 /* this is the default */
541 } else {
542 return -1;
543 }
544
545 return 0;
546}
547
53fec9d3
SH
548/**
549 * The copy-on-read flag is actually a reference count so multiple users may
550 * use the feature without worrying about clobbering its previous state.
551 * Copy-on-read stays enabled until all users have called to disable it.
552 */
553void bdrv_enable_copy_on_read(BlockDriverState *bs)
554{
555 bs->copy_on_read++;
556}
557
558void bdrv_disable_copy_on_read(BlockDriverState *bs)
559{
560 assert(bs->copy_on_read > 0);
561 bs->copy_on_read--;
562}
563
57915332
KW
564/*
565 * Common part for opening disk images and files
566 */
567static int bdrv_open_common(BlockDriverState *bs, const char *filename,
568 int flags, BlockDriver *drv)
569{
570 int ret, open_flags;
571
572 assert(drv != NULL);
573
28dcee10
SH
574 trace_bdrv_open_common(bs, filename, flags, drv->format_name);
575
66f82cee 576 bs->file = NULL;
51762288 577 bs->total_sectors = 0;
57915332
KW
578 bs->encrypted = 0;
579 bs->valid_key = 0;
03f541bd 580 bs->sg = 0;
57915332 581 bs->open_flags = flags;
03f541bd 582 bs->growable = 0;
57915332
KW
583 bs->buffer_alignment = 512;
584
53fec9d3
SH
585 assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */
586 if ((flags & BDRV_O_RDWR) && (flags & BDRV_O_COPY_ON_READ)) {
587 bdrv_enable_copy_on_read(bs);
588 }
589
57915332 590 pstrcpy(bs->filename, sizeof(bs->filename), filename);
03f541bd 591 bs->backing_file[0] = '\0';
57915332
KW
592
593 if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv)) {
594 return -ENOTSUP;
595 }
596
597 bs->drv = drv;
7267c094 598 bs->opaque = g_malloc0(drv->instance_size);
57915332 599
03f541bd 600 bs->enable_write_cache = !!(flags & BDRV_O_CACHE_WB);
57915332
KW
601
602 /*
603 * Clear flags that are internal to the block layer before opening the
604 * image.
605 */
606 open_flags = flags & ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
607
608 /*
ebabb67a 609 * Snapshots should be writable.
57915332
KW
610 */
611 if (bs->is_temporary) {
612 open_flags |= BDRV_O_RDWR;
613 }
614
e7c63796
SH
615 bs->keep_read_only = bs->read_only = !(open_flags & BDRV_O_RDWR);
616
66f82cee
KW
617 /* Open the image, either directly or using a protocol */
618 if (drv->bdrv_file_open) {
619 ret = drv->bdrv_file_open(bs, filename, open_flags);
620 } else {
621 ret = bdrv_file_open(&bs->file, filename, open_flags);
622 if (ret >= 0) {
623 ret = drv->bdrv_open(bs, open_flags);
624 }
625 }
626
57915332
KW
627 if (ret < 0) {
628 goto free_and_fail;
629 }
630
51762288
SH
631 ret = refresh_total_sectors(bs, bs->total_sectors);
632 if (ret < 0) {
633 goto free_and_fail;
57915332 634 }
51762288 635
57915332
KW
636#ifndef _WIN32
637 if (bs->is_temporary) {
638 unlink(filename);
639 }
640#endif
641 return 0;
642
643free_and_fail:
66f82cee
KW
644 if (bs->file) {
645 bdrv_delete(bs->file);
646 bs->file = NULL;
647 }
7267c094 648 g_free(bs->opaque);
57915332
KW
649 bs->opaque = NULL;
650 bs->drv = NULL;
651 return ret;
652}
653
b6ce07aa
KW
654/*
655 * Opens a file using a protocol (file, host_device, nbd, ...)
656 */
83f64091 657int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags)
ea2384d3 658{
83f64091 659 BlockDriverState *bs;
6db95603 660 BlockDriver *drv;
83f64091
FB
661 int ret;
662
b50cbabc 663 drv = bdrv_find_protocol(filename);
6db95603
CH
664 if (!drv) {
665 return -ENOENT;
666 }
667
83f64091 668 bs = bdrv_new("");
b6ce07aa 669 ret = bdrv_open_common(bs, filename, flags, drv);
83f64091
FB
670 if (ret < 0) {
671 bdrv_delete(bs);
672 return ret;
3b0d4f61 673 }
71d0770c 674 bs->growable = 1;
83f64091
FB
675 *pbs = bs;
676 return 0;
677}
678
b6ce07aa
KW
679/*
680 * Opens a disk image (raw, qcow2, vmdk, ...)
681 */
d6e9098e
KW
682int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
683 BlockDriver *drv)
ea2384d3 684{
b6ce07aa 685 int ret;
2b572816 686 char tmp_filename[PATH_MAX];
712e7874 687
83f64091 688 if (flags & BDRV_O_SNAPSHOT) {
ea2384d3
FB
689 BlockDriverState *bs1;
690 int64_t total_size;
7c96d46e 691 int is_protocol = 0;
91a073a9
KW
692 BlockDriver *bdrv_qcow2;
693 QEMUOptionParameter *options;
b6ce07aa 694 char backing_filename[PATH_MAX];
3b46e624 695
ea2384d3
FB
696 /* if snapshot, we create a temporary backing file and open it
697 instead of opening 'filename' directly */
33e3963e 698
ea2384d3
FB
699 /* if there is a backing file, use it */
700 bs1 = bdrv_new("");
d6e9098e 701 ret = bdrv_open(bs1, filename, 0, drv);
51d7c00c 702 if (ret < 0) {
ea2384d3 703 bdrv_delete(bs1);
51d7c00c 704 return ret;
ea2384d3 705 }
3e82990b 706 total_size = bdrv_getlength(bs1) & BDRV_SECTOR_MASK;
7c96d46e
AL
707
708 if (bs1->drv && bs1->drv->protocol_name)
709 is_protocol = 1;
710
ea2384d3 711 bdrv_delete(bs1);
3b46e624 712
ea2384d3 713 get_tmp_filename(tmp_filename, sizeof(tmp_filename));
7c96d46e
AL
714
715 /* Real path is meaningless for protocols */
716 if (is_protocol)
717 snprintf(backing_filename, sizeof(backing_filename),
718 "%s", filename);
114cdfa9
KS
719 else if (!realpath(filename, backing_filename))
720 return -errno;
7c96d46e 721
91a073a9
KW
722 bdrv_qcow2 = bdrv_find_format("qcow2");
723 options = parse_option_parameters("", bdrv_qcow2->create_options, NULL);
724
3e82990b 725 set_option_parameter_int(options, BLOCK_OPT_SIZE, total_size);
91a073a9
KW
726 set_option_parameter(options, BLOCK_OPT_BACKING_FILE, backing_filename);
727 if (drv) {
728 set_option_parameter(options, BLOCK_OPT_BACKING_FMT,
729 drv->format_name);
730 }
731
732 ret = bdrv_create(bdrv_qcow2, tmp_filename, options);
d748768c 733 free_option_parameters(options);
51d7c00c
AL
734 if (ret < 0) {
735 return ret;
ea2384d3 736 }
91a073a9 737
ea2384d3 738 filename = tmp_filename;
91a073a9 739 drv = bdrv_qcow2;
ea2384d3
FB
740 bs->is_temporary = 1;
741 }
712e7874 742
b6ce07aa 743 /* Find the right image format driver */
6db95603 744 if (!drv) {
c98ac35d 745 ret = find_image_format(filename, &drv);
51d7c00c 746 }
6987307c 747
51d7c00c 748 if (!drv) {
51d7c00c 749 goto unlink_and_fail;
ea2384d3 750 }
b6ce07aa
KW
751
752 /* Open the image */
753 ret = bdrv_open_common(bs, filename, flags, drv);
754 if (ret < 0) {
6987307c
CH
755 goto unlink_and_fail;
756 }
757
b6ce07aa
KW
758 /* If there is a backing file, use it */
759 if ((flags & BDRV_O_NO_BACKING) == 0 && bs->backing_file[0] != '\0') {
760 char backing_filename[PATH_MAX];
761 int back_flags;
762 BlockDriver *back_drv = NULL;
763
764 bs->backing_hd = bdrv_new("");
df2dbb4a
SH
765
766 if (path_has_protocol(bs->backing_file)) {
767 pstrcpy(backing_filename, sizeof(backing_filename),
768 bs->backing_file);
769 } else {
770 path_combine(backing_filename, sizeof(backing_filename),
771 filename, bs->backing_file);
772 }
773
774 if (bs->backing_format[0] != '\0') {
b6ce07aa 775 back_drv = bdrv_find_format(bs->backing_format);
df2dbb4a 776 }
b6ce07aa
KW
777
778 /* backing files always opened read-only */
779 back_flags =
780 flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
781
782 ret = bdrv_open(bs->backing_hd, backing_filename, back_flags, back_drv);
783 if (ret < 0) {
784 bdrv_close(bs);
785 return ret;
786 }
787 if (bs->is_temporary) {
788 bs->backing_hd->keep_read_only = !(flags & BDRV_O_RDWR);
789 } else {
790 /* base image inherits from "parent" */
791 bs->backing_hd->keep_read_only = bs->keep_read_only;
792 }
793 }
794
795 if (!bdrv_key_required(bs)) {
7d4b4ba5 796 bdrv_dev_change_media_cb(bs, true);
b6ce07aa
KW
797 }
798
98f90dba
ZYW
799 /* throttling disk I/O limits */
800 if (bs->io_limits_enabled) {
801 bdrv_io_limits_enable(bs);
802 }
803
b6ce07aa
KW
804 return 0;
805
806unlink_and_fail:
807 if (bs->is_temporary) {
808 unlink(filename);
809 }
810 return ret;
811}
812
fc01f7e7
FB
813void bdrv_close(BlockDriverState *bs)
814{
19cb3738 815 if (bs->drv) {
f9092b10
MA
816 if (bs == bs_snapshots) {
817 bs_snapshots = NULL;
818 }
557df6ac 819 if (bs->backing_hd) {
ea2384d3 820 bdrv_delete(bs->backing_hd);
557df6ac
SH
821 bs->backing_hd = NULL;
822 }
ea2384d3 823 bs->drv->bdrv_close(bs);
7267c094 824 g_free(bs->opaque);
ea2384d3
FB
825#ifdef _WIN32
826 if (bs->is_temporary) {
827 unlink(bs->filename);
828 }
67b915a5 829#endif
ea2384d3
FB
830 bs->opaque = NULL;
831 bs->drv = NULL;
53fec9d3 832 bs->copy_on_read = 0;
b338082b 833
66f82cee
KW
834 if (bs->file != NULL) {
835 bdrv_close(bs->file);
836 }
837
7d4b4ba5 838 bdrv_dev_change_media_cb(bs, false);
b338082b 839 }
98f90dba
ZYW
840
841 /*throttling disk I/O limits*/
842 if (bs->io_limits_enabled) {
843 bdrv_io_limits_disable(bs);
844 }
b338082b
FB
845}
846
2bc93fed
MK
847void bdrv_close_all(void)
848{
849 BlockDriverState *bs;
850
851 QTAILQ_FOREACH(bs, &bdrv_states, list) {
852 bdrv_close(bs);
853 }
854}
855
922453bc
SH
856/*
857 * Wait for pending requests to complete across all BlockDriverStates
858 *
859 * This function does not flush data to disk, use bdrv_flush_all() for that
860 * after calling this function.
861 */
862void bdrv_drain_all(void)
863{
864 BlockDriverState *bs;
865
866 qemu_aio_flush();
867
868 /* If requests are still pending there is a bug somewhere */
869 QTAILQ_FOREACH(bs, &bdrv_states, list) {
870 assert(QLIST_EMPTY(&bs->tracked_requests));
871 assert(qemu_co_queue_empty(&bs->throttled_reqs));
872 }
873}
874
d22b2f41
RH
875/* make a BlockDriverState anonymous by removing from bdrv_state list.
876 Also, NULL terminate the device_name to prevent double remove */
877void bdrv_make_anon(BlockDriverState *bs)
878{
879 if (bs->device_name[0] != '\0') {
880 QTAILQ_REMOVE(&bdrv_states, bs, list);
881 }
882 bs->device_name[0] = '\0';
883}
884
8802d1fd
JC
885/*
886 * Add new bs contents at the top of an image chain while the chain is
887 * live, while keeping required fields on the top layer.
888 *
889 * This will modify the BlockDriverState fields, and swap contents
890 * between bs_new and bs_top. Both bs_new and bs_top are modified.
891 *
892 * This function does not create any image files.
893 */
894void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top)
895{
896 BlockDriverState tmp;
897
898 /* the new bs must not be in bdrv_states */
899 bdrv_make_anon(bs_new);
900
901 tmp = *bs_new;
902
903 /* there are some fields that need to stay on the top layer: */
904
905 /* dev info */
906 tmp.dev_ops = bs_top->dev_ops;
907 tmp.dev_opaque = bs_top->dev_opaque;
908 tmp.dev = bs_top->dev;
909 tmp.buffer_alignment = bs_top->buffer_alignment;
910 tmp.copy_on_read = bs_top->copy_on_read;
911
912 /* i/o timing parameters */
913 tmp.slice_time = bs_top->slice_time;
914 tmp.slice_start = bs_top->slice_start;
915 tmp.slice_end = bs_top->slice_end;
916 tmp.io_limits = bs_top->io_limits;
917 tmp.io_base = bs_top->io_base;
918 tmp.throttled_reqs = bs_top->throttled_reqs;
919 tmp.block_timer = bs_top->block_timer;
920 tmp.io_limits_enabled = bs_top->io_limits_enabled;
921
922 /* geometry */
923 tmp.cyls = bs_top->cyls;
924 tmp.heads = bs_top->heads;
925 tmp.secs = bs_top->secs;
926 tmp.translation = bs_top->translation;
927
928 /* r/w error */
929 tmp.on_read_error = bs_top->on_read_error;
930 tmp.on_write_error = bs_top->on_write_error;
931
932 /* i/o status */
933 tmp.iostatus_enabled = bs_top->iostatus_enabled;
934 tmp.iostatus = bs_top->iostatus;
935
936 /* keep the same entry in bdrv_states */
937 pstrcpy(tmp.device_name, sizeof(tmp.device_name), bs_top->device_name);
938 tmp.list = bs_top->list;
939
940 /* The contents of 'tmp' will become bs_top, as we are
941 * swapping bs_new and bs_top contents. */
942 tmp.backing_hd = bs_new;
943 pstrcpy(tmp.backing_file, sizeof(tmp.backing_file), bs_top->filename);
944
945 /* swap contents of the fixed new bs and the current top */
946 *bs_new = *bs_top;
947 *bs_top = tmp;
948
949 /* clear the copied fields in the new backing file */
950 bdrv_detach_dev(bs_new, bs_new->dev);
951
952 qemu_co_queue_init(&bs_new->throttled_reqs);
953 memset(&bs_new->io_base, 0, sizeof(bs_new->io_base));
954 memset(&bs_new->io_limits, 0, sizeof(bs_new->io_limits));
955 bdrv_iostatus_disable(bs_new);
956
957 /* we don't use bdrv_io_limits_disable() for this, because we don't want
958 * to affect or delete the block_timer, as it has been moved to bs_top */
959 bs_new->io_limits_enabled = false;
960 bs_new->block_timer = NULL;
961 bs_new->slice_time = 0;
962 bs_new->slice_start = 0;
963 bs_new->slice_end = 0;
964}
965
b338082b
FB
966void bdrv_delete(BlockDriverState *bs)
967{
fa879d62 968 assert(!bs->dev);
18846dee 969
1b7bdbc1 970 /* remove from list, if necessary */
d22b2f41 971 bdrv_make_anon(bs);
34c6f050 972
b338082b 973 bdrv_close(bs);
66f82cee
KW
974 if (bs->file != NULL) {
975 bdrv_delete(bs->file);
976 }
977
f9092b10 978 assert(bs != bs_snapshots);
7267c094 979 g_free(bs);
fc01f7e7
FB
980}
981
fa879d62
MA
982int bdrv_attach_dev(BlockDriverState *bs, void *dev)
983/* TODO change to DeviceState *dev when all users are qdevified */
18846dee 984{
fa879d62 985 if (bs->dev) {
18846dee
MA
986 return -EBUSY;
987 }
fa879d62 988 bs->dev = dev;
28a7282a 989 bdrv_iostatus_reset(bs);
18846dee
MA
990 return 0;
991}
992
fa879d62
MA
993/* TODO qdevified devices don't use this, remove when devices are qdevified */
994void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev)
18846dee 995{
fa879d62
MA
996 if (bdrv_attach_dev(bs, dev) < 0) {
997 abort();
998 }
999}
1000
1001void bdrv_detach_dev(BlockDriverState *bs, void *dev)
1002/* TODO change to DeviceState *dev when all users are qdevified */
1003{
1004 assert(bs->dev == dev);
1005 bs->dev = NULL;
0e49de52
MA
1006 bs->dev_ops = NULL;
1007 bs->dev_opaque = NULL;
29e05f20 1008 bs->buffer_alignment = 512;
18846dee
MA
1009}
1010
fa879d62
MA
1011/* TODO change to return DeviceState * when all users are qdevified */
1012void *bdrv_get_attached_dev(BlockDriverState *bs)
18846dee 1013{
fa879d62 1014 return bs->dev;
18846dee
MA
1015}
1016
0e49de52
MA
1017void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
1018 void *opaque)
1019{
1020 bs->dev_ops = ops;
1021 bs->dev_opaque = opaque;
2c6942fa
MA
1022 if (bdrv_dev_has_removable_media(bs) && bs == bs_snapshots) {
1023 bs_snapshots = NULL;
1024 }
0e49de52
MA
1025}
1026
329c0a48
LC
1027void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
1028 BlockQMPEventAction action, int is_read)
1029{
1030 QObject *data;
1031 const char *action_str;
1032
1033 switch (action) {
1034 case BDRV_ACTION_REPORT:
1035 action_str = "report";
1036 break;
1037 case BDRV_ACTION_IGNORE:
1038 action_str = "ignore";
1039 break;
1040 case BDRV_ACTION_STOP:
1041 action_str = "stop";
1042 break;
1043 default:
1044 abort();
1045 }
1046
1047 data = qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
1048 bdrv->device_name,
1049 action_str,
1050 is_read ? "read" : "write");
1051 monitor_protocol_event(QEVENT_BLOCK_IO_ERROR, data);
1052
1053 qobject_decref(data);
1054}
1055
6f382ed2
LC
1056static void bdrv_emit_qmp_eject_event(BlockDriverState *bs, bool ejected)
1057{
1058 QObject *data;
1059
1060 data = qobject_from_jsonf("{ 'device': %s, 'tray-open': %i }",
1061 bdrv_get_device_name(bs), ejected);
1062 monitor_protocol_event(QEVENT_DEVICE_TRAY_MOVED, data);
1063
1064 qobject_decref(data);
1065}
1066
7d4b4ba5 1067static void bdrv_dev_change_media_cb(BlockDriverState *bs, bool load)
0e49de52 1068{
145feb17 1069 if (bs->dev_ops && bs->dev_ops->change_media_cb) {
6f382ed2 1070 bool tray_was_closed = !bdrv_dev_is_tray_open(bs);
7d4b4ba5 1071 bs->dev_ops->change_media_cb(bs->dev_opaque, load);
6f382ed2
LC
1072 if (tray_was_closed) {
1073 /* tray open */
1074 bdrv_emit_qmp_eject_event(bs, true);
1075 }
1076 if (load) {
1077 /* tray close */
1078 bdrv_emit_qmp_eject_event(bs, false);
1079 }
145feb17
MA
1080 }
1081}
1082
2c6942fa
MA
1083bool bdrv_dev_has_removable_media(BlockDriverState *bs)
1084{
1085 return !bs->dev || (bs->dev_ops && bs->dev_ops->change_media_cb);
1086}
1087
025ccaa7
PB
1088void bdrv_dev_eject_request(BlockDriverState *bs, bool force)
1089{
1090 if (bs->dev_ops && bs->dev_ops->eject_request_cb) {
1091 bs->dev_ops->eject_request_cb(bs->dev_opaque, force);
1092 }
1093}
1094
e4def80b
MA
1095bool bdrv_dev_is_tray_open(BlockDriverState *bs)
1096{
1097 if (bs->dev_ops && bs->dev_ops->is_tray_open) {
1098 return bs->dev_ops->is_tray_open(bs->dev_opaque);
1099 }
1100 return false;
1101}
1102
145feb17
MA
1103static void bdrv_dev_resize_cb(BlockDriverState *bs)
1104{
1105 if (bs->dev_ops && bs->dev_ops->resize_cb) {
1106 bs->dev_ops->resize_cb(bs->dev_opaque);
0e49de52
MA
1107 }
1108}
1109
f107639a
MA
1110bool bdrv_dev_is_medium_locked(BlockDriverState *bs)
1111{
1112 if (bs->dev_ops && bs->dev_ops->is_medium_locked) {
1113 return bs->dev_ops->is_medium_locked(bs->dev_opaque);
1114 }
1115 return false;
1116}
1117
e97fc193
AL
1118/*
1119 * Run consistency checks on an image
1120 *
e076f338 1121 * Returns 0 if the check could be completed (it doesn't mean that the image is
a1c7273b 1122 * free of errors) or -errno when an internal error occurred. The results of the
e076f338 1123 * check are stored in res.
e97fc193 1124 */
e076f338 1125int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res)
e97fc193
AL
1126{
1127 if (bs->drv->bdrv_check == NULL) {
1128 return -ENOTSUP;
1129 }
1130
e076f338 1131 memset(res, 0, sizeof(*res));
9ac228e0 1132 return bs->drv->bdrv_check(bs, res);
e97fc193
AL
1133}
1134
8a426614
KW
1135#define COMMIT_BUF_SECTORS 2048
1136
33e3963e
FB
1137/* commit COW file into the raw image */
1138int bdrv_commit(BlockDriverState *bs)
1139{
19cb3738 1140 BlockDriver *drv = bs->drv;
ee181196 1141 BlockDriver *backing_drv;
8a426614
KW
1142 int64_t sector, total_sectors;
1143 int n, ro, open_flags;
4dca4b63 1144 int ret = 0, rw_ret = 0;
8a426614 1145 uint8_t *buf;
4dca4b63
NS
1146 char filename[1024];
1147 BlockDriverState *bs_rw, *bs_ro;
33e3963e 1148
19cb3738
FB
1149 if (!drv)
1150 return -ENOMEDIUM;
4dca4b63
NS
1151
1152 if (!bs->backing_hd) {
1153 return -ENOTSUP;
33e3963e
FB
1154 }
1155
4dca4b63
NS
1156 if (bs->backing_hd->keep_read_only) {
1157 return -EACCES;
1158 }
ee181196 1159
2d3735d3
SH
1160 if (bdrv_in_use(bs) || bdrv_in_use(bs->backing_hd)) {
1161 return -EBUSY;
1162 }
1163
ee181196 1164 backing_drv = bs->backing_hd->drv;
4dca4b63
NS
1165 ro = bs->backing_hd->read_only;
1166 strncpy(filename, bs->backing_hd->filename, sizeof(filename));
1167 open_flags = bs->backing_hd->open_flags;
1168
1169 if (ro) {
1170 /* re-open as RW */
1171 bdrv_delete(bs->backing_hd);
1172 bs->backing_hd = NULL;
1173 bs_rw = bdrv_new("");
ee181196
KW
1174 rw_ret = bdrv_open(bs_rw, filename, open_flags | BDRV_O_RDWR,
1175 backing_drv);
4dca4b63
NS
1176 if (rw_ret < 0) {
1177 bdrv_delete(bs_rw);
1178 /* try to re-open read-only */
1179 bs_ro = bdrv_new("");
ee181196
KW
1180 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR,
1181 backing_drv);
4dca4b63
NS
1182 if (ret < 0) {
1183 bdrv_delete(bs_ro);
1184 /* drive not functional anymore */
1185 bs->drv = NULL;
1186 return ret;
1187 }
1188 bs->backing_hd = bs_ro;
1189 return rw_ret;
1190 }
1191 bs->backing_hd = bs_rw;
ea2384d3 1192 }
33e3963e 1193
6ea44308 1194 total_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
7267c094 1195 buf = g_malloc(COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE);
8a426614
KW
1196
1197 for (sector = 0; sector < total_sectors; sector += n) {
05c4af54 1198 if (bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n)) {
8a426614
KW
1199
1200 if (bdrv_read(bs, sector, buf, n) != 0) {
1201 ret = -EIO;
1202 goto ro_cleanup;
1203 }
1204
1205 if (bdrv_write(bs->backing_hd, sector, buf, n) != 0) {
1206 ret = -EIO;
1207 goto ro_cleanup;
1208 }
ea2384d3 1209 }
33e3963e 1210 }
95389c86 1211
1d44952f
CH
1212 if (drv->bdrv_make_empty) {
1213 ret = drv->bdrv_make_empty(bs);
1214 bdrv_flush(bs);
1215 }
95389c86 1216
3f5075ae
CH
1217 /*
1218 * Make sure all data we wrote to the backing device is actually
1219 * stable on disk.
1220 */
1221 if (bs->backing_hd)
1222 bdrv_flush(bs->backing_hd);
4dca4b63
NS
1223
1224ro_cleanup:
7267c094 1225 g_free(buf);
4dca4b63
NS
1226
1227 if (ro) {
1228 /* re-open as RO */
1229 bdrv_delete(bs->backing_hd);
1230 bs->backing_hd = NULL;
1231 bs_ro = bdrv_new("");
ee181196
KW
1232 ret = bdrv_open(bs_ro, filename, open_flags & ~BDRV_O_RDWR,
1233 backing_drv);
4dca4b63
NS
1234 if (ret < 0) {
1235 bdrv_delete(bs_ro);
1236 /* drive not functional anymore */
1237 bs->drv = NULL;
1238 return ret;
1239 }
1240 bs->backing_hd = bs_ro;
1241 bs->backing_hd->keep_read_only = 0;
1242 }
1243
1d44952f 1244 return ret;
33e3963e
FB
1245}
1246
e8877497 1247int bdrv_commit_all(void)
6ab4b5ab
MA
1248{
1249 BlockDriverState *bs;
1250
1251 QTAILQ_FOREACH(bs, &bdrv_states, list) {
e8877497
SH
1252 int ret = bdrv_commit(bs);
1253 if (ret < 0) {
1254 return ret;
1255 }
6ab4b5ab 1256 }
e8877497 1257 return 0;
6ab4b5ab
MA
1258}
1259
dbffbdcf
SH
1260struct BdrvTrackedRequest {
1261 BlockDriverState *bs;
1262 int64_t sector_num;
1263 int nb_sectors;
1264 bool is_write;
1265 QLIST_ENTRY(BdrvTrackedRequest) list;
5f8b6491 1266 Coroutine *co; /* owner, used for deadlock detection */
f4658285 1267 CoQueue wait_queue; /* coroutines blocked on this request */
dbffbdcf
SH
1268};
1269
1270/**
1271 * Remove an active request from the tracked requests list
1272 *
1273 * This function should be called when a tracked request is completing.
1274 */
1275static void tracked_request_end(BdrvTrackedRequest *req)
1276{
1277 QLIST_REMOVE(req, list);
f4658285 1278 qemu_co_queue_restart_all(&req->wait_queue);
dbffbdcf
SH
1279}
1280
1281/**
1282 * Add an active request to the tracked requests list
1283 */
1284static void tracked_request_begin(BdrvTrackedRequest *req,
1285 BlockDriverState *bs,
1286 int64_t sector_num,
1287 int nb_sectors, bool is_write)
1288{
1289 *req = (BdrvTrackedRequest){
1290 .bs = bs,
1291 .sector_num = sector_num,
1292 .nb_sectors = nb_sectors,
1293 .is_write = is_write,
5f8b6491 1294 .co = qemu_coroutine_self(),
dbffbdcf
SH
1295 };
1296
f4658285
SH
1297 qemu_co_queue_init(&req->wait_queue);
1298
dbffbdcf
SH
1299 QLIST_INSERT_HEAD(&bs->tracked_requests, req, list);
1300}
1301
d83947ac
SH
1302/**
1303 * Round a region to cluster boundaries
1304 */
1305static void round_to_clusters(BlockDriverState *bs,
1306 int64_t sector_num, int nb_sectors,
1307 int64_t *cluster_sector_num,
1308 int *cluster_nb_sectors)
1309{
1310 BlockDriverInfo bdi;
1311
1312 if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) {
1313 *cluster_sector_num = sector_num;
1314 *cluster_nb_sectors = nb_sectors;
1315 } else {
1316 int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE;
1317 *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c);
1318 *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num +
1319 nb_sectors, c);
1320 }
1321}
1322
f4658285
SH
1323static bool tracked_request_overlaps(BdrvTrackedRequest *req,
1324 int64_t sector_num, int nb_sectors) {
d83947ac
SH
1325 /* aaaa bbbb */
1326 if (sector_num >= req->sector_num + req->nb_sectors) {
1327 return false;
1328 }
1329 /* bbbb aaaa */
1330 if (req->sector_num >= sector_num + nb_sectors) {
1331 return false;
1332 }
1333 return true;
f4658285
SH
1334}
1335
1336static void coroutine_fn wait_for_overlapping_requests(BlockDriverState *bs,
1337 int64_t sector_num, int nb_sectors)
1338{
1339 BdrvTrackedRequest *req;
d83947ac
SH
1340 int64_t cluster_sector_num;
1341 int cluster_nb_sectors;
f4658285
SH
1342 bool retry;
1343
d83947ac
SH
1344 /* If we touch the same cluster it counts as an overlap. This guarantees
1345 * that allocating writes will be serialized and not race with each other
1346 * for the same cluster. For example, in copy-on-read it ensures that the
1347 * CoR read and write operations are atomic and guest writes cannot
1348 * interleave between them.
1349 */
1350 round_to_clusters(bs, sector_num, nb_sectors,
1351 &cluster_sector_num, &cluster_nb_sectors);
1352
f4658285
SH
1353 do {
1354 retry = false;
1355 QLIST_FOREACH(req, &bs->tracked_requests, list) {
d83947ac
SH
1356 if (tracked_request_overlaps(req, cluster_sector_num,
1357 cluster_nb_sectors)) {
5f8b6491
SH
1358 /* Hitting this means there was a reentrant request, for
1359 * example, a block driver issuing nested requests. This must
1360 * never happen since it means deadlock.
1361 */
1362 assert(qemu_coroutine_self() != req->co);
1363
f4658285
SH
1364 qemu_co_queue_wait(&req->wait_queue);
1365 retry = true;
1366 break;
1367 }
1368 }
1369 } while (retry);
1370}
1371
756e6736
KW
1372/*
1373 * Return values:
1374 * 0 - success
1375 * -EINVAL - backing format specified, but no file
1376 * -ENOSPC - can't update the backing file because no space is left in the
1377 * image file header
1378 * -ENOTSUP - format driver doesn't support changing the backing file
1379 */
1380int bdrv_change_backing_file(BlockDriverState *bs,
1381 const char *backing_file, const char *backing_fmt)
1382{
1383 BlockDriver *drv = bs->drv;
1384
1385 if (drv->bdrv_change_backing_file != NULL) {
1386 return drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
1387 } else {
1388 return -ENOTSUP;
1389 }
1390}
1391
71d0770c
AL
1392static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
1393 size_t size)
1394{
1395 int64_t len;
1396
1397 if (!bdrv_is_inserted(bs))
1398 return -ENOMEDIUM;
1399
1400 if (bs->growable)
1401 return 0;
1402
1403 len = bdrv_getlength(bs);
1404
fbb7b4e0
KW
1405 if (offset < 0)
1406 return -EIO;
1407
1408 if ((offset > len) || (len - offset < size))
71d0770c
AL
1409 return -EIO;
1410
1411 return 0;
1412}
1413
1414static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
1415 int nb_sectors)
1416{
eb5a3165
JS
1417 return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE,
1418 nb_sectors * BDRV_SECTOR_SIZE);
71d0770c
AL
1419}
1420
1c9805a3
SH
1421typedef struct RwCo {
1422 BlockDriverState *bs;
1423 int64_t sector_num;
1424 int nb_sectors;
1425 QEMUIOVector *qiov;
1426 bool is_write;
1427 int ret;
1428} RwCo;
1429
1430static void coroutine_fn bdrv_rw_co_entry(void *opaque)
fc01f7e7 1431{
1c9805a3 1432 RwCo *rwco = opaque;
ea2384d3 1433
1c9805a3
SH
1434 if (!rwco->is_write) {
1435 rwco->ret = bdrv_co_do_readv(rwco->bs, rwco->sector_num,
470c0504 1436 rwco->nb_sectors, rwco->qiov, 0);
1c9805a3
SH
1437 } else {
1438 rwco->ret = bdrv_co_do_writev(rwco->bs, rwco->sector_num,
f08f2dda 1439 rwco->nb_sectors, rwco->qiov, 0);
1c9805a3
SH
1440 }
1441}
e7a8a783 1442
1c9805a3
SH
1443/*
1444 * Process a synchronous request using coroutines
1445 */
1446static int bdrv_rw_co(BlockDriverState *bs, int64_t sector_num, uint8_t *buf,
1447 int nb_sectors, bool is_write)
1448{
1449 QEMUIOVector qiov;
1450 struct iovec iov = {
1451 .iov_base = (void *)buf,
1452 .iov_len = nb_sectors * BDRV_SECTOR_SIZE,
1453 };
1454 Coroutine *co;
1455 RwCo rwco = {
1456 .bs = bs,
1457 .sector_num = sector_num,
1458 .nb_sectors = nb_sectors,
1459 .qiov = &qiov,
1460 .is_write = is_write,
1461 .ret = NOT_DONE,
1462 };
e7a8a783 1463
1c9805a3 1464 qemu_iovec_init_external(&qiov, &iov, 1);
e7a8a783 1465
498e386c
ZYW
1466 /**
1467 * In sync call context, when the vcpu is blocked, this throttling timer
1468 * will not fire; so the I/O throttling function has to be disabled here
1469 * if it has been enabled.
1470 */
1471 if (bs->io_limits_enabled) {
1472 fprintf(stderr, "Disabling I/O throttling on '%s' due "
1473 "to synchronous I/O.\n", bdrv_get_device_name(bs));
1474 bdrv_io_limits_disable(bs);
1475 }
1476
1c9805a3
SH
1477 if (qemu_in_coroutine()) {
1478 /* Fast-path if already in coroutine context */
1479 bdrv_rw_co_entry(&rwco);
1480 } else {
1481 co = qemu_coroutine_create(bdrv_rw_co_entry);
1482 qemu_coroutine_enter(co, &rwco);
1483 while (rwco.ret == NOT_DONE) {
1484 qemu_aio_wait();
1485 }
1486 }
1487 return rwco.ret;
1488}
b338082b 1489
1c9805a3
SH
1490/* return < 0 if error. See bdrv_write() for the return codes */
1491int bdrv_read(BlockDriverState *bs, int64_t sector_num,
1492 uint8_t *buf, int nb_sectors)
1493{
1494 return bdrv_rw_co(bs, sector_num, buf, nb_sectors, false);
fc01f7e7
FB
1495}
1496
7cd1e32a 1497static void set_dirty_bitmap(BlockDriverState *bs, int64_t sector_num,
a55eb92c 1498 int nb_sectors, int dirty)
7cd1e32a 1499{
1500 int64_t start, end;
c6d22830 1501 unsigned long val, idx, bit;
a55eb92c 1502
6ea44308 1503 start = sector_num / BDRV_SECTORS_PER_DIRTY_CHUNK;
c6d22830 1504 end = (sector_num + nb_sectors - 1) / BDRV_SECTORS_PER_DIRTY_CHUNK;
a55eb92c
JK
1505
1506 for (; start <= end; start++) {
c6d22830
JK
1507 idx = start / (sizeof(unsigned long) * 8);
1508 bit = start % (sizeof(unsigned long) * 8);
1509 val = bs->dirty_bitmap[idx];
1510 if (dirty) {
6d59fec1 1511 if (!(val & (1UL << bit))) {
aaa0eb75 1512 bs->dirty_count++;
6d59fec1 1513 val |= 1UL << bit;
aaa0eb75 1514 }
c6d22830 1515 } else {
6d59fec1 1516 if (val & (1UL << bit)) {
aaa0eb75 1517 bs->dirty_count--;
6d59fec1 1518 val &= ~(1UL << bit);
aaa0eb75 1519 }
c6d22830
JK
1520 }
1521 bs->dirty_bitmap[idx] = val;
7cd1e32a 1522 }
1523}
1524
5fafdf24 1525/* Return < 0 if error. Important errors are:
19cb3738
FB
1526 -EIO generic I/O error (may happen for all errors)
1527 -ENOMEDIUM No media inserted.
1528 -EINVAL Invalid sector number or nb_sectors
1529 -EACCES Trying to write a read-only device
1530*/
5fafdf24 1531int bdrv_write(BlockDriverState *bs, int64_t sector_num,
fc01f7e7
FB
1532 const uint8_t *buf, int nb_sectors)
1533{
1c9805a3 1534 return bdrv_rw_co(bs, sector_num, (uint8_t *)buf, nb_sectors, true);
83f64091
FB
1535}
1536
eda578e5
AL
1537int bdrv_pread(BlockDriverState *bs, int64_t offset,
1538 void *buf, int count1)
83f64091 1539{
6ea44308 1540 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
83f64091
FB
1541 int len, nb_sectors, count;
1542 int64_t sector_num;
9a8c4cce 1543 int ret;
83f64091
FB
1544
1545 count = count1;
1546 /* first read to align to sector start */
6ea44308 1547 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
83f64091
FB
1548 if (len > count)
1549 len = count;
6ea44308 1550 sector_num = offset >> BDRV_SECTOR_BITS;
83f64091 1551 if (len > 0) {
9a8c4cce
KW
1552 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1553 return ret;
6ea44308 1554 memcpy(buf, tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), len);
83f64091
FB
1555 count -= len;
1556 if (count == 0)
1557 return count1;
1558 sector_num++;
1559 buf += len;
1560 }
1561
1562 /* read the sectors "in place" */
6ea44308 1563 nb_sectors = count >> BDRV_SECTOR_BITS;
83f64091 1564 if (nb_sectors > 0) {
9a8c4cce
KW
1565 if ((ret = bdrv_read(bs, sector_num, buf, nb_sectors)) < 0)
1566 return ret;
83f64091 1567 sector_num += nb_sectors;
6ea44308 1568 len = nb_sectors << BDRV_SECTOR_BITS;
83f64091
FB
1569 buf += len;
1570 count -= len;
1571 }
1572
1573 /* add data from the last sector */
1574 if (count > 0) {
9a8c4cce
KW
1575 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1576 return ret;
83f64091
FB
1577 memcpy(buf, tmp_buf, count);
1578 }
1579 return count1;
1580}
1581
eda578e5
AL
1582int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
1583 const void *buf, int count1)
83f64091 1584{
6ea44308 1585 uint8_t tmp_buf[BDRV_SECTOR_SIZE];
83f64091
FB
1586 int len, nb_sectors, count;
1587 int64_t sector_num;
9a8c4cce 1588 int ret;
83f64091
FB
1589
1590 count = count1;
1591 /* first write to align to sector start */
6ea44308 1592 len = (BDRV_SECTOR_SIZE - offset) & (BDRV_SECTOR_SIZE - 1);
83f64091
FB
1593 if (len > count)
1594 len = count;
6ea44308 1595 sector_num = offset >> BDRV_SECTOR_BITS;
83f64091 1596 if (len > 0) {
9a8c4cce
KW
1597 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1598 return ret;
6ea44308 1599 memcpy(tmp_buf + (offset & (BDRV_SECTOR_SIZE - 1)), buf, len);
9a8c4cce
KW
1600 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
1601 return ret;
83f64091
FB
1602 count -= len;
1603 if (count == 0)
1604 return count1;
1605 sector_num++;
1606 buf += len;
1607 }
1608
1609 /* write the sectors "in place" */
6ea44308 1610 nb_sectors = count >> BDRV_SECTOR_BITS;
83f64091 1611 if (nb_sectors > 0) {
9a8c4cce
KW
1612 if ((ret = bdrv_write(bs, sector_num, buf, nb_sectors)) < 0)
1613 return ret;
83f64091 1614 sector_num += nb_sectors;
6ea44308 1615 len = nb_sectors << BDRV_SECTOR_BITS;
83f64091
FB
1616 buf += len;
1617 count -= len;
1618 }
1619
1620 /* add data from the last sector */
1621 if (count > 0) {
9a8c4cce
KW
1622 if ((ret = bdrv_read(bs, sector_num, tmp_buf, 1)) < 0)
1623 return ret;
83f64091 1624 memcpy(tmp_buf, buf, count);
9a8c4cce
KW
1625 if ((ret = bdrv_write(bs, sector_num, tmp_buf, 1)) < 0)
1626 return ret;
83f64091
FB
1627 }
1628 return count1;
1629}
83f64091 1630
f08145fe
KW
1631/*
1632 * Writes to the file and ensures that no writes are reordered across this
1633 * request (acts as a barrier)
1634 *
1635 * Returns 0 on success, -errno in error cases.
1636 */
1637int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
1638 const void *buf, int count)
1639{
1640 int ret;
1641
1642 ret = bdrv_pwrite(bs, offset, buf, count);
1643 if (ret < 0) {
1644 return ret;
1645 }
1646
92196b2f
SH
1647 /* No flush needed for cache modes that use O_DSYNC */
1648 if ((bs->open_flags & BDRV_O_CACHE_WB) != 0) {
f08145fe
KW
1649 bdrv_flush(bs);
1650 }
1651
1652 return 0;
1653}
1654
470c0504 1655static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs,
ab185921
SH
1656 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
1657{
1658 /* Perform I/O through a temporary buffer so that users who scribble over
1659 * their read buffer while the operation is in progress do not end up
1660 * modifying the image file. This is critical for zero-copy guest I/O
1661 * where anything might happen inside guest memory.
1662 */
1663 void *bounce_buffer;
1664
79c053bd 1665 BlockDriver *drv = bs->drv;
ab185921
SH
1666 struct iovec iov;
1667 QEMUIOVector bounce_qiov;
1668 int64_t cluster_sector_num;
1669 int cluster_nb_sectors;
1670 size_t skip_bytes;
1671 int ret;
1672
1673 /* Cover entire cluster so no additional backing file I/O is required when
1674 * allocating cluster in the image file.
1675 */
1676 round_to_clusters(bs, sector_num, nb_sectors,
1677 &cluster_sector_num, &cluster_nb_sectors);
1678
470c0504
SH
1679 trace_bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors,
1680 cluster_sector_num, cluster_nb_sectors);
ab185921
SH
1681
1682 iov.iov_len = cluster_nb_sectors * BDRV_SECTOR_SIZE;
1683 iov.iov_base = bounce_buffer = qemu_blockalign(bs, iov.iov_len);
1684 qemu_iovec_init_external(&bounce_qiov, &iov, 1);
1685
79c053bd
SH
1686 ret = drv->bdrv_co_readv(bs, cluster_sector_num, cluster_nb_sectors,
1687 &bounce_qiov);
ab185921
SH
1688 if (ret < 0) {
1689 goto err;
1690 }
1691
79c053bd
SH
1692 if (drv->bdrv_co_write_zeroes &&
1693 buffer_is_zero(bounce_buffer, iov.iov_len)) {
1694 ret = drv->bdrv_co_write_zeroes(bs, cluster_sector_num,
1695 cluster_nb_sectors);
1696 } else {
1697 ret = drv->bdrv_co_writev(bs, cluster_sector_num, cluster_nb_sectors,
ab185921 1698 &bounce_qiov);
79c053bd
SH
1699 }
1700
ab185921
SH
1701 if (ret < 0) {
1702 /* It might be okay to ignore write errors for guest requests. If this
1703 * is a deliberate copy-on-read then we don't want to ignore the error.
1704 * Simply report it in all cases.
1705 */
1706 goto err;
1707 }
1708
1709 skip_bytes = (sector_num - cluster_sector_num) * BDRV_SECTOR_SIZE;
1710 qemu_iovec_from_buffer(qiov, bounce_buffer + skip_bytes,
1711 nb_sectors * BDRV_SECTOR_SIZE);
1712
1713err:
1714 qemu_vfree(bounce_buffer);
1715 return ret;
1716}
1717
c5fbe571
SH
1718/*
1719 * Handle a read request in coroutine context
1720 */
1721static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs,
470c0504
SH
1722 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
1723 BdrvRequestFlags flags)
da1fa91d
KW
1724{
1725 BlockDriver *drv = bs->drv;
dbffbdcf
SH
1726 BdrvTrackedRequest req;
1727 int ret;
da1fa91d 1728
da1fa91d
KW
1729 if (!drv) {
1730 return -ENOMEDIUM;
1731 }
1732 if (bdrv_check_request(bs, sector_num, nb_sectors)) {
1733 return -EIO;
1734 }
1735
98f90dba
ZYW
1736 /* throttling disk read I/O */
1737 if (bs->io_limits_enabled) {
1738 bdrv_io_limits_intercept(bs, false, nb_sectors);
1739 }
1740
f4658285 1741 if (bs->copy_on_read) {
470c0504
SH
1742 flags |= BDRV_REQ_COPY_ON_READ;
1743 }
1744 if (flags & BDRV_REQ_COPY_ON_READ) {
1745 bs->copy_on_read_in_flight++;
1746 }
1747
1748 if (bs->copy_on_read_in_flight) {
f4658285
SH
1749 wait_for_overlapping_requests(bs, sector_num, nb_sectors);
1750 }
1751
dbffbdcf 1752 tracked_request_begin(&req, bs, sector_num, nb_sectors, false);
ab185921 1753
470c0504 1754 if (flags & BDRV_REQ_COPY_ON_READ) {
ab185921
SH
1755 int pnum;
1756
1757 ret = bdrv_co_is_allocated(bs, sector_num, nb_sectors, &pnum);
1758 if (ret < 0) {
1759 goto out;
1760 }
1761
1762 if (!ret || pnum != nb_sectors) {
470c0504 1763 ret = bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, qiov);
ab185921
SH
1764 goto out;
1765 }
1766 }
1767
dbffbdcf 1768 ret = drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov);
ab185921
SH
1769
1770out:
dbffbdcf 1771 tracked_request_end(&req);
470c0504
SH
1772
1773 if (flags & BDRV_REQ_COPY_ON_READ) {
1774 bs->copy_on_read_in_flight--;
1775 }
1776
dbffbdcf 1777 return ret;
da1fa91d
KW
1778}
1779
c5fbe571 1780int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
da1fa91d
KW
1781 int nb_sectors, QEMUIOVector *qiov)
1782{
c5fbe571 1783 trace_bdrv_co_readv(bs, sector_num, nb_sectors);
da1fa91d 1784
470c0504
SH
1785 return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, 0);
1786}
1787
1788int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
1789 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov)
1790{
1791 trace_bdrv_co_copy_on_readv(bs, sector_num, nb_sectors);
1792
1793 return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov,
1794 BDRV_REQ_COPY_ON_READ);
c5fbe571
SH
1795}
1796
f08f2dda
SH
1797static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs,
1798 int64_t sector_num, int nb_sectors)
1799{
1800 BlockDriver *drv = bs->drv;
1801 QEMUIOVector qiov;
1802 struct iovec iov;
1803 int ret;
1804
1805 /* First try the efficient write zeroes operation */
1806 if (drv->bdrv_co_write_zeroes) {
1807 return drv->bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
1808 }
1809
1810 /* Fall back to bounce buffer if write zeroes is unsupported */
1811 iov.iov_len = nb_sectors * BDRV_SECTOR_SIZE;
1812 iov.iov_base = qemu_blockalign(bs, iov.iov_len);
1813 memset(iov.iov_base, 0, iov.iov_len);
1814 qemu_iovec_init_external(&qiov, &iov, 1);
1815
1816 ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, &qiov);
1817
1818 qemu_vfree(iov.iov_base);
1819 return ret;
1820}
1821
c5fbe571
SH
1822/*
1823 * Handle a write request in coroutine context
1824 */
1825static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs,
f08f2dda
SH
1826 int64_t sector_num, int nb_sectors, QEMUIOVector *qiov,
1827 BdrvRequestFlags flags)
c5fbe571
SH
1828{
1829 BlockDriver *drv = bs->drv;
dbffbdcf 1830 BdrvTrackedRequest req;
6b7cb247 1831 int ret;
da1fa91d
KW
1832
1833 if (!bs->drv) {
1834 return -ENOMEDIUM;
1835 }
1836 if (bs->read_only) {
1837 return -EACCES;
1838 }
1839 if (bdrv_check_request(bs, sector_num, nb_sectors)) {
1840 return -EIO;
1841 }
1842
98f90dba
ZYW
1843 /* throttling disk write I/O */
1844 if (bs->io_limits_enabled) {
1845 bdrv_io_limits_intercept(bs, true, nb_sectors);
1846 }
1847
470c0504 1848 if (bs->copy_on_read_in_flight) {
f4658285
SH
1849 wait_for_overlapping_requests(bs, sector_num, nb_sectors);
1850 }
1851
dbffbdcf
SH
1852 tracked_request_begin(&req, bs, sector_num, nb_sectors, true);
1853
f08f2dda
SH
1854 if (flags & BDRV_REQ_ZERO_WRITE) {
1855 ret = bdrv_co_do_write_zeroes(bs, sector_num, nb_sectors);
1856 } else {
1857 ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov);
1858 }
6b7cb247 1859
da1fa91d
KW
1860 if (bs->dirty_bitmap) {
1861 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
1862 }
1863
1864 if (bs->wr_highest_sector < sector_num + nb_sectors - 1) {
1865 bs->wr_highest_sector = sector_num + nb_sectors - 1;
1866 }
1867
dbffbdcf
SH
1868 tracked_request_end(&req);
1869
6b7cb247 1870 return ret;
da1fa91d
KW
1871}
1872
c5fbe571
SH
1873int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
1874 int nb_sectors, QEMUIOVector *qiov)
1875{
1876 trace_bdrv_co_writev(bs, sector_num, nb_sectors);
1877
f08f2dda
SH
1878 return bdrv_co_do_writev(bs, sector_num, nb_sectors, qiov, 0);
1879}
1880
1881int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs,
1882 int64_t sector_num, int nb_sectors)
1883{
1884 trace_bdrv_co_write_zeroes(bs, sector_num, nb_sectors);
1885
1886 return bdrv_co_do_writev(bs, sector_num, nb_sectors, NULL,
1887 BDRV_REQ_ZERO_WRITE);
c5fbe571
SH
1888}
1889
83f64091
FB
1890/**
1891 * Truncate file to 'offset' bytes (needed only for file protocols)
1892 */
1893int bdrv_truncate(BlockDriverState *bs, int64_t offset)
1894{
1895 BlockDriver *drv = bs->drv;
51762288 1896 int ret;
83f64091 1897 if (!drv)
19cb3738 1898 return -ENOMEDIUM;
83f64091
FB
1899 if (!drv->bdrv_truncate)
1900 return -ENOTSUP;
59f2689d
NS
1901 if (bs->read_only)
1902 return -EACCES;
8591675f
MT
1903 if (bdrv_in_use(bs))
1904 return -EBUSY;
51762288
SH
1905 ret = drv->bdrv_truncate(bs, offset);
1906 if (ret == 0) {
1907 ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
145feb17 1908 bdrv_dev_resize_cb(bs);
51762288
SH
1909 }
1910 return ret;
83f64091
FB
1911}
1912
4a1d5e1f
FZ
1913/**
1914 * Length of a allocated file in bytes. Sparse files are counted by actual
1915 * allocated space. Return < 0 if error or unknown.
1916 */
1917int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
1918{
1919 BlockDriver *drv = bs->drv;
1920 if (!drv) {
1921 return -ENOMEDIUM;
1922 }
1923 if (drv->bdrv_get_allocated_file_size) {
1924 return drv->bdrv_get_allocated_file_size(bs);
1925 }
1926 if (bs->file) {
1927 return bdrv_get_allocated_file_size(bs->file);
1928 }
1929 return -ENOTSUP;
1930}
1931
83f64091
FB
1932/**
1933 * Length of a file in bytes. Return < 0 if error or unknown.
1934 */
1935int64_t bdrv_getlength(BlockDriverState *bs)
1936{
1937 BlockDriver *drv = bs->drv;
1938 if (!drv)
19cb3738 1939 return -ENOMEDIUM;
51762288 1940
2c6942fa 1941 if (bs->growable || bdrv_dev_has_removable_media(bs)) {
46a4e4e6
SH
1942 if (drv->bdrv_getlength) {
1943 return drv->bdrv_getlength(bs);
1944 }
83f64091 1945 }
46a4e4e6 1946 return bs->total_sectors * BDRV_SECTOR_SIZE;
fc01f7e7
FB
1947}
1948
19cb3738 1949/* return 0 as number of sectors if no device present or error */
96b8f136 1950void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
fc01f7e7 1951{
19cb3738
FB
1952 int64_t length;
1953 length = bdrv_getlength(bs);
1954 if (length < 0)
1955 length = 0;
1956 else
6ea44308 1957 length = length >> BDRV_SECTOR_BITS;
19cb3738 1958 *nb_sectors_ptr = length;
fc01f7e7 1959}
cf98951b 1960
f3d54fc4
AL
1961struct partition {
1962 uint8_t boot_ind; /* 0x80 - active */
1963 uint8_t head; /* starting head */
1964 uint8_t sector; /* starting sector */
1965 uint8_t cyl; /* starting cylinder */
1966 uint8_t sys_ind; /* What partition type */
1967 uint8_t end_head; /* end head */
1968 uint8_t end_sector; /* end sector */
1969 uint8_t end_cyl; /* end cylinder */
1970 uint32_t start_sect; /* starting sector counting from 0 */
1971 uint32_t nr_sects; /* nr of sectors in partition */
541dc0d4 1972} QEMU_PACKED;
f3d54fc4
AL
1973
1974/* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
1975static int guess_disk_lchs(BlockDriverState *bs,
1976 int *pcylinders, int *pheads, int *psectors)
1977{
eb5a3165 1978 uint8_t buf[BDRV_SECTOR_SIZE];
f3d54fc4
AL
1979 int ret, i, heads, sectors, cylinders;
1980 struct partition *p;
1981 uint32_t nr_sects;
a38131b6 1982 uint64_t nb_sectors;
498e386c 1983 bool enabled;
f3d54fc4
AL
1984
1985 bdrv_get_geometry(bs, &nb_sectors);
1986
498e386c
ZYW
1987 /**
1988 * The function will be invoked during startup not only in sync I/O mode,
1989 * but also in async I/O mode. So the I/O throttling function has to
1990 * be disabled temporarily here, not permanently.
1991 */
1992 enabled = bs->io_limits_enabled;
1993 bs->io_limits_enabled = false;
f3d54fc4 1994 ret = bdrv_read(bs, 0, buf, 1);
498e386c 1995 bs->io_limits_enabled = enabled;
f3d54fc4
AL
1996 if (ret < 0)
1997 return -1;
1998 /* test msdos magic */
1999 if (buf[510] != 0x55 || buf[511] != 0xaa)
2000 return -1;
2001 for(i = 0; i < 4; i++) {
2002 p = ((struct partition *)(buf + 0x1be)) + i;
2003 nr_sects = le32_to_cpu(p->nr_sects);
2004 if (nr_sects && p->end_head) {
2005 /* We make the assumption that the partition terminates on
2006 a cylinder boundary */
2007 heads = p->end_head + 1;
2008 sectors = p->end_sector & 63;
2009 if (sectors == 0)
2010 continue;
2011 cylinders = nb_sectors / (heads * sectors);
2012 if (cylinders < 1 || cylinders > 16383)
2013 continue;
2014 *pheads = heads;
2015 *psectors = sectors;
2016 *pcylinders = cylinders;
2017#if 0
2018 printf("guessed geometry: LCHS=%d %d %d\n",
2019 cylinders, heads, sectors);
2020#endif
2021 return 0;
2022 }
2023 }
2024 return -1;
2025}
2026
2027void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs)
2028{
2029 int translation, lba_detected = 0;
2030 int cylinders, heads, secs;
a38131b6 2031 uint64_t nb_sectors;
f3d54fc4
AL
2032
2033 /* if a geometry hint is available, use it */
2034 bdrv_get_geometry(bs, &nb_sectors);
2035 bdrv_get_geometry_hint(bs, &cylinders, &heads, &secs);
2036 translation = bdrv_get_translation_hint(bs);
2037 if (cylinders != 0) {
2038 *pcyls = cylinders;
2039 *pheads = heads;
2040 *psecs = secs;
2041 } else {
2042 if (guess_disk_lchs(bs, &cylinders, &heads, &secs) == 0) {
2043 if (heads > 16) {
2044 /* if heads > 16, it means that a BIOS LBA
2045 translation was active, so the default
2046 hardware geometry is OK */
2047 lba_detected = 1;
2048 goto default_geometry;
2049 } else {
2050 *pcyls = cylinders;
2051 *pheads = heads;
2052 *psecs = secs;
2053 /* disable any translation to be in sync with
2054 the logical geometry */
2055 if (translation == BIOS_ATA_TRANSLATION_AUTO) {
2056 bdrv_set_translation_hint(bs,
2057 BIOS_ATA_TRANSLATION_NONE);
2058 }
2059 }
2060 } else {
2061 default_geometry:
2062 /* if no geometry, use a standard physical disk geometry */
2063 cylinders = nb_sectors / (16 * 63);
2064
2065 if (cylinders > 16383)
2066 cylinders = 16383;
2067 else if (cylinders < 2)
2068 cylinders = 2;
2069 *pcyls = cylinders;
2070 *pheads = 16;
2071 *psecs = 63;
2072 if ((lba_detected == 1) && (translation == BIOS_ATA_TRANSLATION_AUTO)) {
2073 if ((*pcyls * *pheads) <= 131072) {
2074 bdrv_set_translation_hint(bs,
2075 BIOS_ATA_TRANSLATION_LARGE);
2076 } else {
2077 bdrv_set_translation_hint(bs,
2078 BIOS_ATA_TRANSLATION_LBA);
2079 }
2080 }
2081 }
2082 bdrv_set_geometry_hint(bs, *pcyls, *pheads, *psecs);
2083 }
2084}
2085
5fafdf24 2086void bdrv_set_geometry_hint(BlockDriverState *bs,
b338082b
FB
2087 int cyls, int heads, int secs)
2088{
2089 bs->cyls = cyls;
2090 bs->heads = heads;
2091 bs->secs = secs;
2092}
2093
46d4767d
FB
2094void bdrv_set_translation_hint(BlockDriverState *bs, int translation)
2095{
2096 bs->translation = translation;
2097}
2098
5fafdf24 2099void bdrv_get_geometry_hint(BlockDriverState *bs,
b338082b
FB
2100 int *pcyls, int *pheads, int *psecs)
2101{
2102 *pcyls = bs->cyls;
2103 *pheads = bs->heads;
2104 *psecs = bs->secs;
2105}
2106
0563e191
ZYW
2107/* throttling disk io limits */
2108void bdrv_set_io_limits(BlockDriverState *bs,
2109 BlockIOLimit *io_limits)
2110{
2111 bs->io_limits = *io_limits;
2112 bs->io_limits_enabled = bdrv_io_limits_enabled(bs);
2113}
2114
5bbdbb46
BS
2115/* Recognize floppy formats */
2116typedef struct FDFormat {
2117 FDriveType drive;
2118 uint8_t last_sect;
2119 uint8_t max_track;
2120 uint8_t max_head;
f8d3d128 2121 FDriveRate rate;
5bbdbb46
BS
2122} FDFormat;
2123
2124static const FDFormat fd_formats[] = {
2125 /* First entry is default format */
2126 /* 1.44 MB 3"1/2 floppy disks */
f8d3d128
HP
2127 { FDRIVE_DRV_144, 18, 80, 1, FDRIVE_RATE_500K, },
2128 { FDRIVE_DRV_144, 20, 80, 1, FDRIVE_RATE_500K, },
2129 { FDRIVE_DRV_144, 21, 80, 1, FDRIVE_RATE_500K, },
2130 { FDRIVE_DRV_144, 21, 82, 1, FDRIVE_RATE_500K, },
2131 { FDRIVE_DRV_144, 21, 83, 1, FDRIVE_RATE_500K, },
2132 { FDRIVE_DRV_144, 22, 80, 1, FDRIVE_RATE_500K, },
2133 { FDRIVE_DRV_144, 23, 80, 1, FDRIVE_RATE_500K, },
2134 { FDRIVE_DRV_144, 24, 80, 1, FDRIVE_RATE_500K, },
5bbdbb46 2135 /* 2.88 MB 3"1/2 floppy disks */
f8d3d128
HP
2136 { FDRIVE_DRV_288, 36, 80, 1, FDRIVE_RATE_1M, },
2137 { FDRIVE_DRV_288, 39, 80, 1, FDRIVE_RATE_1M, },
2138 { FDRIVE_DRV_288, 40, 80, 1, FDRIVE_RATE_1M, },
2139 { FDRIVE_DRV_288, 44, 80, 1, FDRIVE_RATE_1M, },
2140 { FDRIVE_DRV_288, 48, 80, 1, FDRIVE_RATE_1M, },
5bbdbb46 2141 /* 720 kB 3"1/2 floppy disks */
f8d3d128
HP
2142 { FDRIVE_DRV_144, 9, 80, 1, FDRIVE_RATE_250K, },
2143 { FDRIVE_DRV_144, 10, 80, 1, FDRIVE_RATE_250K, },
2144 { FDRIVE_DRV_144, 10, 82, 1, FDRIVE_RATE_250K, },
2145 { FDRIVE_DRV_144, 10, 83, 1, FDRIVE_RATE_250K, },
2146 { FDRIVE_DRV_144, 13, 80, 1, FDRIVE_RATE_250K, },
2147 { FDRIVE_DRV_144, 14, 80, 1, FDRIVE_RATE_250K, },
5bbdbb46 2148 /* 1.2 MB 5"1/4 floppy disks */
f8d3d128
HP
2149 { FDRIVE_DRV_120, 15, 80, 1, FDRIVE_RATE_500K, },
2150 { FDRIVE_DRV_120, 18, 80, 1, FDRIVE_RATE_500K, },
2151 { FDRIVE_DRV_120, 18, 82, 1, FDRIVE_RATE_500K, },
2152 { FDRIVE_DRV_120, 18, 83, 1, FDRIVE_RATE_500K, },
2153 { FDRIVE_DRV_120, 20, 80, 1, FDRIVE_RATE_500K, },
5bbdbb46 2154 /* 720 kB 5"1/4 floppy disks */
f8d3d128
HP
2155 { FDRIVE_DRV_120, 9, 80, 1, FDRIVE_RATE_250K, },
2156 { FDRIVE_DRV_120, 11, 80, 1, FDRIVE_RATE_250K, },
5bbdbb46 2157 /* 360 kB 5"1/4 floppy disks */
f8d3d128
HP
2158 { FDRIVE_DRV_120, 9, 40, 1, FDRIVE_RATE_300K, },
2159 { FDRIVE_DRV_120, 9, 40, 0, FDRIVE_RATE_300K, },
2160 { FDRIVE_DRV_120, 10, 41, 1, FDRIVE_RATE_300K, },
2161 { FDRIVE_DRV_120, 10, 42, 1, FDRIVE_RATE_300K, },
5bbdbb46 2162 /* 320 kB 5"1/4 floppy disks */
f8d3d128
HP
2163 { FDRIVE_DRV_120, 8, 40, 1, FDRIVE_RATE_250K, },
2164 { FDRIVE_DRV_120, 8, 40, 0, FDRIVE_RATE_250K, },
5bbdbb46 2165 /* 360 kB must match 5"1/4 better than 3"1/2... */
f8d3d128 2166 { FDRIVE_DRV_144, 9, 80, 0, FDRIVE_RATE_250K, },
5bbdbb46 2167 /* end */
f8d3d128 2168 { FDRIVE_DRV_NONE, -1, -1, 0, 0, },
5bbdbb46
BS
2169};
2170
2171void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
2172 int *max_track, int *last_sect,
f8d3d128
HP
2173 FDriveType drive_in, FDriveType *drive,
2174 FDriveRate *rate)
5bbdbb46
BS
2175{
2176 const FDFormat *parse;
2177 uint64_t nb_sectors, size;
2178 int i, first_match, match;
2179
2180 bdrv_get_geometry_hint(bs, nb_heads, max_track, last_sect);
2181 if (*nb_heads != 0 && *max_track != 0 && *last_sect != 0) {
2182 /* User defined disk */
f8d3d128 2183 *rate = FDRIVE_RATE_500K;
5bbdbb46
BS
2184 } else {
2185 bdrv_get_geometry(bs, &nb_sectors);
2186 match = -1;
2187 first_match = -1;
2188 for (i = 0; ; i++) {
2189 parse = &fd_formats[i];
2190 if (parse->drive == FDRIVE_DRV_NONE) {
2191 break;
2192 }
2193 if (drive_in == parse->drive ||
2194 drive_in == FDRIVE_DRV_NONE) {
2195 size = (parse->max_head + 1) * parse->max_track *
2196 parse->last_sect;
2197 if (nb_sectors == size) {
2198 match = i;
2199 break;
2200 }
2201 if (first_match == -1) {
2202 first_match = i;
2203 }
2204 }
2205 }
2206 if (match == -1) {
2207 if (first_match == -1) {
2208 match = 1;
2209 } else {
2210 match = first_match;
2211 }
2212 parse = &fd_formats[match];
2213 }
2214 *nb_heads = parse->max_head + 1;
2215 *max_track = parse->max_track;
2216 *last_sect = parse->last_sect;
2217 *drive = parse->drive;
f8d3d128 2218 *rate = parse->rate;
5bbdbb46
BS
2219 }
2220}
2221
46d4767d
FB
2222int bdrv_get_translation_hint(BlockDriverState *bs)
2223{
2224 return bs->translation;
2225}
2226
abd7f68d
MA
2227void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
2228 BlockErrorAction on_write_error)
2229{
2230 bs->on_read_error = on_read_error;
2231 bs->on_write_error = on_write_error;
2232}
2233
2234BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read)
2235{
2236 return is_read ? bs->on_read_error : bs->on_write_error;
2237}
2238
b338082b
FB
2239int bdrv_is_read_only(BlockDriverState *bs)
2240{
2241 return bs->read_only;
2242}
2243
985a03b0
TS
2244int bdrv_is_sg(BlockDriverState *bs)
2245{
2246 return bs->sg;
2247}
2248
e900a7b7
CH
2249int bdrv_enable_write_cache(BlockDriverState *bs)
2250{
2251 return bs->enable_write_cache;
2252}
2253
ea2384d3
FB
2254int bdrv_is_encrypted(BlockDriverState *bs)
2255{
2256 if (bs->backing_hd && bs->backing_hd->encrypted)
2257 return 1;
2258 return bs->encrypted;
2259}
2260
c0f4ce77
AL
2261int bdrv_key_required(BlockDriverState *bs)
2262{
2263 BlockDriverState *backing_hd = bs->backing_hd;
2264
2265 if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
2266 return 1;
2267 return (bs->encrypted && !bs->valid_key);
2268}
2269
ea2384d3
FB
2270int bdrv_set_key(BlockDriverState *bs, const char *key)
2271{
2272 int ret;
2273 if (bs->backing_hd && bs->backing_hd->encrypted) {
2274 ret = bdrv_set_key(bs->backing_hd, key);
2275 if (ret < 0)
2276 return ret;
2277 if (!bs->encrypted)
2278 return 0;
2279 }
fd04a2ae
SH
2280 if (!bs->encrypted) {
2281 return -EINVAL;
2282 } else if (!bs->drv || !bs->drv->bdrv_set_key) {
2283 return -ENOMEDIUM;
2284 }
c0f4ce77 2285 ret = bs->drv->bdrv_set_key(bs, key);
bb5fc20f
AL
2286 if (ret < 0) {
2287 bs->valid_key = 0;
2288 } else if (!bs->valid_key) {
2289 bs->valid_key = 1;
2290 /* call the change callback now, we skipped it on open */
7d4b4ba5 2291 bdrv_dev_change_media_cb(bs, true);
bb5fc20f 2292 }
c0f4ce77 2293 return ret;
ea2384d3
FB
2294}
2295
2296void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size)
2297{
19cb3738 2298 if (!bs->drv) {
ea2384d3
FB
2299 buf[0] = '\0';
2300 } else {
2301 pstrcpy(buf, buf_size, bs->drv->format_name);
2302 }
2303}
2304
5fafdf24 2305void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
ea2384d3
FB
2306 void *opaque)
2307{
2308 BlockDriver *drv;
2309
8a22f02a 2310 QLIST_FOREACH(drv, &bdrv_drivers, list) {
ea2384d3
FB
2311 it(opaque, drv->format_name);
2312 }
2313}
2314
b338082b
FB
2315BlockDriverState *bdrv_find(const char *name)
2316{
2317 BlockDriverState *bs;
2318
1b7bdbc1
SH
2319 QTAILQ_FOREACH(bs, &bdrv_states, list) {
2320 if (!strcmp(name, bs->device_name)) {
b338082b 2321 return bs;
1b7bdbc1 2322 }
b338082b
FB
2323 }
2324 return NULL;
2325}
2326
2f399b0a
MA
2327BlockDriverState *bdrv_next(BlockDriverState *bs)
2328{
2329 if (!bs) {
2330 return QTAILQ_FIRST(&bdrv_states);
2331 }
2332 return QTAILQ_NEXT(bs, list);
2333}
2334
51de9760 2335void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
81d0912d
FB
2336{
2337 BlockDriverState *bs;
2338
1b7bdbc1 2339 QTAILQ_FOREACH(bs, &bdrv_states, list) {
51de9760 2340 it(opaque, bs);
81d0912d
FB
2341 }
2342}
2343
ea2384d3
FB
2344const char *bdrv_get_device_name(BlockDriverState *bs)
2345{
2346 return bs->device_name;
2347}
2348
c6ca28d6
AL
2349void bdrv_flush_all(void)
2350{
2351 BlockDriverState *bs;
2352
1b7bdbc1 2353 QTAILQ_FOREACH(bs, &bdrv_states, list) {
29cdb251 2354 bdrv_flush(bs);
1b7bdbc1 2355 }
c6ca28d6
AL
2356}
2357
f2feebbd
KW
2358int bdrv_has_zero_init(BlockDriverState *bs)
2359{
2360 assert(bs->drv);
2361
336c1c12
KW
2362 if (bs->drv->bdrv_has_zero_init) {
2363 return bs->drv->bdrv_has_zero_init(bs);
f2feebbd
KW
2364 }
2365
2366 return 1;
2367}
2368
376ae3f1
SH
2369typedef struct BdrvCoIsAllocatedData {
2370 BlockDriverState *bs;
2371 int64_t sector_num;
2372 int nb_sectors;
2373 int *pnum;
2374 int ret;
2375 bool done;
2376} BdrvCoIsAllocatedData;
2377
f58c7b35
TS
2378/*
2379 * Returns true iff the specified sector is present in the disk image. Drivers
2380 * not implementing the functionality are assumed to not support backing files,
2381 * hence all their sectors are reported as allocated.
2382 *
bd9533e3
SH
2383 * If 'sector_num' is beyond the end of the disk image the return value is 0
2384 * and 'pnum' is set to 0.
2385 *
f58c7b35
TS
2386 * 'pnum' is set to the number of sectors (including and immediately following
2387 * the specified sector) that are known to be in the same
2388 * allocated/unallocated state.
2389 *
bd9533e3
SH
2390 * 'nb_sectors' is the max value 'pnum' should be set to. If nb_sectors goes
2391 * beyond the end of the disk image it will be clamped.
f58c7b35 2392 */
060f51c9
SH
2393int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
2394 int nb_sectors, int *pnum)
f58c7b35 2395{
bd9533e3
SH
2396 int64_t n;
2397
2398 if (sector_num >= bs->total_sectors) {
2399 *pnum = 0;
2400 return 0;
2401 }
2402
2403 n = bs->total_sectors - sector_num;
2404 if (n < nb_sectors) {
2405 nb_sectors = n;
2406 }
2407
6aebab14 2408 if (!bs->drv->bdrv_co_is_allocated) {
bd9533e3 2409 *pnum = nb_sectors;
f58c7b35
TS
2410 return 1;
2411 }
6aebab14 2412
060f51c9
SH
2413 return bs->drv->bdrv_co_is_allocated(bs, sector_num, nb_sectors, pnum);
2414}
2415
2416/* Coroutine wrapper for bdrv_is_allocated() */
2417static void coroutine_fn bdrv_is_allocated_co_entry(void *opaque)
2418{
2419 BdrvCoIsAllocatedData *data = opaque;
2420 BlockDriverState *bs = data->bs;
2421
2422 data->ret = bdrv_co_is_allocated(bs, data->sector_num, data->nb_sectors,
2423 data->pnum);
2424 data->done = true;
2425}
2426
2427/*
2428 * Synchronous wrapper around bdrv_co_is_allocated().
2429 *
2430 * See bdrv_co_is_allocated() for details.
2431 */
2432int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
2433 int *pnum)
2434{
6aebab14
SH
2435 Coroutine *co;
2436 BdrvCoIsAllocatedData data = {
2437 .bs = bs,
2438 .sector_num = sector_num,
2439 .nb_sectors = nb_sectors,
2440 .pnum = pnum,
2441 .done = false,
2442 };
2443
2444 co = qemu_coroutine_create(bdrv_is_allocated_co_entry);
2445 qemu_coroutine_enter(co, &data);
2446 while (!data.done) {
2447 qemu_aio_wait();
2448 }
2449 return data.ret;
f58c7b35
TS
2450}
2451
b2023818 2452BlockInfoList *qmp_query_block(Error **errp)
b338082b 2453{
b2023818 2454 BlockInfoList *head = NULL, *cur_item = NULL;
b338082b
FB
2455 BlockDriverState *bs;
2456
1b7bdbc1 2457 QTAILQ_FOREACH(bs, &bdrv_states, list) {
b2023818 2458 BlockInfoList *info = g_malloc0(sizeof(*info));
d15e5465 2459
b2023818
LC
2460 info->value = g_malloc0(sizeof(*info->value));
2461 info->value->device = g_strdup(bs->device_name);
2462 info->value->type = g_strdup("unknown");
2463 info->value->locked = bdrv_dev_is_medium_locked(bs);
2464 info->value->removable = bdrv_dev_has_removable_media(bs);
d15e5465 2465
e4def80b 2466 if (bdrv_dev_has_removable_media(bs)) {
b2023818
LC
2467 info->value->has_tray_open = true;
2468 info->value->tray_open = bdrv_dev_is_tray_open(bs);
e4def80b 2469 }
f04ef601
LC
2470
2471 if (bdrv_iostatus_is_enabled(bs)) {
b2023818
LC
2472 info->value->has_io_status = true;
2473 info->value->io_status = bs->iostatus;
f04ef601
LC
2474 }
2475
19cb3738 2476 if (bs->drv) {
b2023818
LC
2477 info->value->has_inserted = true;
2478 info->value->inserted = g_malloc0(sizeof(*info->value->inserted));
2479 info->value->inserted->file = g_strdup(bs->filename);
2480 info->value->inserted->ro = bs->read_only;
2481 info->value->inserted->drv = g_strdup(bs->drv->format_name);
2482 info->value->inserted->encrypted = bs->encrypted;
2483 if (bs->backing_file[0]) {
2484 info->value->inserted->has_backing_file = true;
2485 info->value->inserted->backing_file = g_strdup(bs->backing_file);
376253ec 2486 }
727f005e
ZYW
2487
2488 if (bs->io_limits_enabled) {
2489 info->value->inserted->bps =
2490 bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
2491 info->value->inserted->bps_rd =
2492 bs->io_limits.bps[BLOCK_IO_LIMIT_READ];
2493 info->value->inserted->bps_wr =
2494 bs->io_limits.bps[BLOCK_IO_LIMIT_WRITE];
2495 info->value->inserted->iops =
2496 bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
2497 info->value->inserted->iops_rd =
2498 bs->io_limits.iops[BLOCK_IO_LIMIT_READ];
2499 info->value->inserted->iops_wr =
2500 bs->io_limits.iops[BLOCK_IO_LIMIT_WRITE];
2501 }
b2023818 2502 }
d15e5465 2503
b2023818
LC
2504 /* XXX: waiting for the qapi to support GSList */
2505 if (!cur_item) {
2506 head = cur_item = info;
2507 } else {
2508 cur_item->next = info;
2509 cur_item = info;
b338082b 2510 }
b338082b 2511 }
d15e5465 2512
b2023818 2513 return head;
b338082b 2514}
a36e69dd 2515
f11f57e4
LC
2516/* Consider exposing this as a full fledged QMP command */
2517static BlockStats *qmp_query_blockstat(const BlockDriverState *bs, Error **errp)
2518{
2519 BlockStats *s;
2520
2521 s = g_malloc0(sizeof(*s));
2522
2523 if (bs->device_name[0]) {
2524 s->has_device = true;
2525 s->device = g_strdup(bs->device_name);
294cc35f
KW
2526 }
2527
f11f57e4
LC
2528 s->stats = g_malloc0(sizeof(*s->stats));
2529 s->stats->rd_bytes = bs->nr_bytes[BDRV_ACCT_READ];
2530 s->stats->wr_bytes = bs->nr_bytes[BDRV_ACCT_WRITE];
2531 s->stats->rd_operations = bs->nr_ops[BDRV_ACCT_READ];
2532 s->stats->wr_operations = bs->nr_ops[BDRV_ACCT_WRITE];
2533 s->stats->wr_highest_offset = bs->wr_highest_sector * BDRV_SECTOR_SIZE;
2534 s->stats->flush_operations = bs->nr_ops[BDRV_ACCT_FLUSH];
2535 s->stats->wr_total_time_ns = bs->total_time_ns[BDRV_ACCT_WRITE];
2536 s->stats->rd_total_time_ns = bs->total_time_ns[BDRV_ACCT_READ];
2537 s->stats->flush_total_time_ns = bs->total_time_ns[BDRV_ACCT_FLUSH];
2538
294cc35f 2539 if (bs->file) {
f11f57e4
LC
2540 s->has_parent = true;
2541 s->parent = qmp_query_blockstat(bs->file, NULL);
294cc35f
KW
2542 }
2543
f11f57e4 2544 return s;
294cc35f
KW
2545}
2546
f11f57e4 2547BlockStatsList *qmp_query_blockstats(Error **errp)
218a536a 2548{
f11f57e4 2549 BlockStatsList *head = NULL, *cur_item = NULL;
a36e69dd
TS
2550 BlockDriverState *bs;
2551
1b7bdbc1 2552 QTAILQ_FOREACH(bs, &bdrv_states, list) {
f11f57e4
LC
2553 BlockStatsList *info = g_malloc0(sizeof(*info));
2554 info->value = qmp_query_blockstat(bs, NULL);
2555
2556 /* XXX: waiting for the qapi to support GSList */
2557 if (!cur_item) {
2558 head = cur_item = info;
2559 } else {
2560 cur_item->next = info;
2561 cur_item = info;
2562 }
a36e69dd 2563 }
218a536a 2564
f11f57e4 2565 return head;
a36e69dd 2566}
ea2384d3 2567
045df330
AL
2568const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
2569{
2570 if (bs->backing_hd && bs->backing_hd->encrypted)
2571 return bs->backing_file;
2572 else if (bs->encrypted)
2573 return bs->filename;
2574 else
2575 return NULL;
2576}
2577
5fafdf24 2578void bdrv_get_backing_filename(BlockDriverState *bs,
83f64091
FB
2579 char *filename, int filename_size)
2580{
3574c608 2581 pstrcpy(filename, filename_size, bs->backing_file);
83f64091
FB
2582}
2583
5fafdf24 2584int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
faea38e7
FB
2585 const uint8_t *buf, int nb_sectors)
2586{
2587 BlockDriver *drv = bs->drv;
2588 if (!drv)
19cb3738 2589 return -ENOMEDIUM;
faea38e7
FB
2590 if (!drv->bdrv_write_compressed)
2591 return -ENOTSUP;
fbb7b4e0
KW
2592 if (bdrv_check_request(bs, sector_num, nb_sectors))
2593 return -EIO;
a55eb92c 2594
c6d22830 2595 if (bs->dirty_bitmap) {
7cd1e32a 2596 set_dirty_bitmap(bs, sector_num, nb_sectors, 1);
2597 }
a55eb92c 2598
faea38e7
FB
2599 return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
2600}
3b46e624 2601
faea38e7
FB
2602int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2603{
2604 BlockDriver *drv = bs->drv;
2605 if (!drv)
19cb3738 2606 return -ENOMEDIUM;
faea38e7
FB
2607 if (!drv->bdrv_get_info)
2608 return -ENOTSUP;
2609 memset(bdi, 0, sizeof(*bdi));
2610 return drv->bdrv_get_info(bs, bdi);
2611}
2612
45566e9c
CH
2613int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
2614 int64_t pos, int size)
178e08a5
AL
2615{
2616 BlockDriver *drv = bs->drv;
2617 if (!drv)
2618 return -ENOMEDIUM;
7cdb1f6d
MK
2619 if (drv->bdrv_save_vmstate)
2620 return drv->bdrv_save_vmstate(bs, buf, pos, size);
2621 if (bs->file)
2622 return bdrv_save_vmstate(bs->file, buf, pos, size);
2623 return -ENOTSUP;
178e08a5
AL
2624}
2625
45566e9c
CH
2626int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
2627 int64_t pos, int size)
178e08a5
AL
2628{
2629 BlockDriver *drv = bs->drv;
2630 if (!drv)
2631 return -ENOMEDIUM;
7cdb1f6d
MK
2632 if (drv->bdrv_load_vmstate)
2633 return drv->bdrv_load_vmstate(bs, buf, pos, size);
2634 if (bs->file)
2635 return bdrv_load_vmstate(bs->file, buf, pos, size);
2636 return -ENOTSUP;
178e08a5
AL
2637}
2638
8b9b0cc2
KW
2639void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event)
2640{
2641 BlockDriver *drv = bs->drv;
2642
2643 if (!drv || !drv->bdrv_debug_event) {
2644 return;
2645 }
2646
2647 return drv->bdrv_debug_event(bs, event);
2648
2649}
2650
faea38e7
FB
2651/**************************************************************/
2652/* handling of snapshots */
2653
feeee5ac
MDCF
2654int bdrv_can_snapshot(BlockDriverState *bs)
2655{
2656 BlockDriver *drv = bs->drv;
07b70bfb 2657 if (!drv || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
feeee5ac
MDCF
2658 return 0;
2659 }
2660
2661 if (!drv->bdrv_snapshot_create) {
2662 if (bs->file != NULL) {
2663 return bdrv_can_snapshot(bs->file);
2664 }
2665 return 0;
2666 }
2667
2668 return 1;
2669}
2670
199630b6
BS
2671int bdrv_is_snapshot(BlockDriverState *bs)
2672{
2673 return !!(bs->open_flags & BDRV_O_SNAPSHOT);
2674}
2675
f9092b10
MA
2676BlockDriverState *bdrv_snapshots(void)
2677{
2678 BlockDriverState *bs;
2679
3ac906f7 2680 if (bs_snapshots) {
f9092b10 2681 return bs_snapshots;
3ac906f7 2682 }
f9092b10
MA
2683
2684 bs = NULL;
2685 while ((bs = bdrv_next(bs))) {
2686 if (bdrv_can_snapshot(bs)) {
3ac906f7
MA
2687 bs_snapshots = bs;
2688 return bs;
f9092b10
MA
2689 }
2690 }
2691 return NULL;
f9092b10
MA
2692}
2693
5fafdf24 2694int bdrv_snapshot_create(BlockDriverState *bs,
faea38e7
FB
2695 QEMUSnapshotInfo *sn_info)
2696{
2697 BlockDriver *drv = bs->drv;
2698 if (!drv)
19cb3738 2699 return -ENOMEDIUM;
7cdb1f6d
MK
2700 if (drv->bdrv_snapshot_create)
2701 return drv->bdrv_snapshot_create(bs, sn_info);
2702 if (bs->file)
2703 return bdrv_snapshot_create(bs->file, sn_info);
2704 return -ENOTSUP;
faea38e7
FB
2705}
2706
5fafdf24 2707int bdrv_snapshot_goto(BlockDriverState *bs,
faea38e7
FB
2708 const char *snapshot_id)
2709{
2710 BlockDriver *drv = bs->drv;
7cdb1f6d
MK
2711 int ret, open_ret;
2712
faea38e7 2713 if (!drv)
19cb3738 2714 return -ENOMEDIUM;
7cdb1f6d
MK
2715 if (drv->bdrv_snapshot_goto)
2716 return drv->bdrv_snapshot_goto(bs, snapshot_id);
2717
2718 if (bs->file) {
2719 drv->bdrv_close(bs);
2720 ret = bdrv_snapshot_goto(bs->file, snapshot_id);
2721 open_ret = drv->bdrv_open(bs, bs->open_flags);
2722 if (open_ret < 0) {
2723 bdrv_delete(bs->file);
2724 bs->drv = NULL;
2725 return open_ret;
2726 }
2727 return ret;
2728 }
2729
2730 return -ENOTSUP;
faea38e7
FB
2731}
2732
2733int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
2734{
2735 BlockDriver *drv = bs->drv;
2736 if (!drv)
19cb3738 2737 return -ENOMEDIUM;
7cdb1f6d
MK
2738 if (drv->bdrv_snapshot_delete)
2739 return drv->bdrv_snapshot_delete(bs, snapshot_id);
2740 if (bs->file)
2741 return bdrv_snapshot_delete(bs->file, snapshot_id);
2742 return -ENOTSUP;
faea38e7
FB
2743}
2744
5fafdf24 2745int bdrv_snapshot_list(BlockDriverState *bs,
faea38e7
FB
2746 QEMUSnapshotInfo **psn_info)
2747{
2748 BlockDriver *drv = bs->drv;
2749 if (!drv)
19cb3738 2750 return -ENOMEDIUM;
7cdb1f6d
MK
2751 if (drv->bdrv_snapshot_list)
2752 return drv->bdrv_snapshot_list(bs, psn_info);
2753 if (bs->file)
2754 return bdrv_snapshot_list(bs->file, psn_info);
2755 return -ENOTSUP;
faea38e7
FB
2756}
2757
51ef6727 2758int bdrv_snapshot_load_tmp(BlockDriverState *bs,
2759 const char *snapshot_name)
2760{
2761 BlockDriver *drv = bs->drv;
2762 if (!drv) {
2763 return -ENOMEDIUM;
2764 }
2765 if (!bs->read_only) {
2766 return -EINVAL;
2767 }
2768 if (drv->bdrv_snapshot_load_tmp) {
2769 return drv->bdrv_snapshot_load_tmp(bs, snapshot_name);
2770 }
2771 return -ENOTSUP;
2772}
2773
e8a6bb9c
MT
2774BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
2775 const char *backing_file)
2776{
2777 if (!bs->drv) {
2778 return NULL;
2779 }
2780
2781 if (bs->backing_hd) {
2782 if (strcmp(bs->backing_file, backing_file) == 0) {
2783 return bs->backing_hd;
2784 } else {
2785 return bdrv_find_backing_image(bs->backing_hd, backing_file);
2786 }
2787 }
2788
2789 return NULL;
2790}
2791
faea38e7
FB
2792#define NB_SUFFIXES 4
2793
2794char *get_human_readable_size(char *buf, int buf_size, int64_t size)
2795{
2796 static const char suffixes[NB_SUFFIXES] = "KMGT";
2797 int64_t base;
2798 int i;
2799
2800 if (size <= 999) {
2801 snprintf(buf, buf_size, "%" PRId64, size);
2802 } else {
2803 base = 1024;
2804 for(i = 0; i < NB_SUFFIXES; i++) {
2805 if (size < (10 * base)) {
5fafdf24 2806 snprintf(buf, buf_size, "%0.1f%c",
faea38e7
FB
2807 (double)size / base,
2808 suffixes[i]);
2809 break;
2810 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
5fafdf24 2811 snprintf(buf, buf_size, "%" PRId64 "%c",
faea38e7
FB
2812 ((size + (base >> 1)) / base),
2813 suffixes[i]);
2814 break;
2815 }
2816 base = base * 1024;
2817 }
2818 }
2819 return buf;
2820}
2821
2822char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
2823{
2824 char buf1[128], date_buf[128], clock_buf[128];
3b9f94e1
FB
2825#ifdef _WIN32
2826 struct tm *ptm;
2827#else
faea38e7 2828 struct tm tm;
3b9f94e1 2829#endif
faea38e7
FB
2830 time_t ti;
2831 int64_t secs;
2832
2833 if (!sn) {
5fafdf24
TS
2834 snprintf(buf, buf_size,
2835 "%-10s%-20s%7s%20s%15s",
faea38e7
FB
2836 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
2837 } else {
2838 ti = sn->date_sec;
3b9f94e1
FB
2839#ifdef _WIN32
2840 ptm = localtime(&ti);
2841 strftime(date_buf, sizeof(date_buf),
2842 "%Y-%m-%d %H:%M:%S", ptm);
2843#else
faea38e7
FB
2844 localtime_r(&ti, &tm);
2845 strftime(date_buf, sizeof(date_buf),
2846 "%Y-%m-%d %H:%M:%S", &tm);
3b9f94e1 2847#endif
faea38e7
FB
2848 secs = sn->vm_clock_nsec / 1000000000;
2849 snprintf(clock_buf, sizeof(clock_buf),
2850 "%02d:%02d:%02d.%03d",
2851 (int)(secs / 3600),
2852 (int)((secs / 60) % 60),
5fafdf24 2853 (int)(secs % 60),
faea38e7
FB
2854 (int)((sn->vm_clock_nsec / 1000000) % 1000));
2855 snprintf(buf, buf_size,
5fafdf24 2856 "%-10s%-20s%7s%20s%15s",
faea38e7
FB
2857 sn->id_str, sn->name,
2858 get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
2859 date_buf,
2860 clock_buf);
2861 }
2862 return buf;
2863}
2864
ea2384d3 2865/**************************************************************/
83f64091 2866/* async I/Os */
ea2384d3 2867
3b69e4b9 2868BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
f141eafe 2869 QEMUIOVector *qiov, int nb_sectors,
3b69e4b9 2870 BlockDriverCompletionFunc *cb, void *opaque)
83f64091 2871{
bbf0a440
SH
2872 trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque);
2873
b2a61371 2874 return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
8c5873d6 2875 cb, opaque, false);
ea2384d3
FB
2876}
2877
f141eafe
AL
2878BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
2879 QEMUIOVector *qiov, int nb_sectors,
2880 BlockDriverCompletionFunc *cb, void *opaque)
ea2384d3 2881{
bbf0a440
SH
2882 trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque);
2883
1a6e115b 2884 return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors,
8c5873d6 2885 cb, opaque, true);
83f64091
FB
2886}
2887
40b4f539
KW
2888
2889typedef struct MultiwriteCB {
2890 int error;
2891 int num_requests;
2892 int num_callbacks;
2893 struct {
2894 BlockDriverCompletionFunc *cb;
2895 void *opaque;
2896 QEMUIOVector *free_qiov;
40b4f539
KW
2897 } callbacks[];
2898} MultiwriteCB;
2899
2900static void multiwrite_user_cb(MultiwriteCB *mcb)
2901{
2902 int i;
2903
2904 for (i = 0; i < mcb->num_callbacks; i++) {
2905 mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error);
1e1ea48d
SH
2906 if (mcb->callbacks[i].free_qiov) {
2907 qemu_iovec_destroy(mcb->callbacks[i].free_qiov);
2908 }
7267c094 2909 g_free(mcb->callbacks[i].free_qiov);
40b4f539
KW
2910 }
2911}
2912
2913static void multiwrite_cb(void *opaque, int ret)
2914{
2915 MultiwriteCB *mcb = opaque;
2916
6d519a5f
SH
2917 trace_multiwrite_cb(mcb, ret);
2918
cb6d3ca0 2919 if (ret < 0 && !mcb->error) {
40b4f539 2920 mcb->error = ret;
40b4f539
KW
2921 }
2922
2923 mcb->num_requests--;
2924 if (mcb->num_requests == 0) {
de189a1b 2925 multiwrite_user_cb(mcb);
7267c094 2926 g_free(mcb);
40b4f539
KW
2927 }
2928}
2929
2930static int multiwrite_req_compare(const void *a, const void *b)
2931{
77be4366
CH
2932 const BlockRequest *req1 = a, *req2 = b;
2933
2934 /*
2935 * Note that we can't simply subtract req2->sector from req1->sector
2936 * here as that could overflow the return value.
2937 */
2938 if (req1->sector > req2->sector) {
2939 return 1;
2940 } else if (req1->sector < req2->sector) {
2941 return -1;
2942 } else {
2943 return 0;
2944 }
40b4f539
KW
2945}
2946
2947/*
2948 * Takes a bunch of requests and tries to merge them. Returns the number of
2949 * requests that remain after merging.
2950 */
2951static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs,
2952 int num_reqs, MultiwriteCB *mcb)
2953{
2954 int i, outidx;
2955
2956 // Sort requests by start sector
2957 qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare);
2958
2959 // Check if adjacent requests touch the same clusters. If so, combine them,
2960 // filling up gaps with zero sectors.
2961 outidx = 0;
2962 for (i = 1; i < num_reqs; i++) {
2963 int merge = 0;
2964 int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors;
2965
b6a127a1 2966 // Handle exactly sequential writes and overlapping writes.
40b4f539
KW
2967 if (reqs[i].sector <= oldreq_last) {
2968 merge = 1;
2969 }
2970
e2a305fb
CH
2971 if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) {
2972 merge = 0;
2973 }
2974
40b4f539
KW
2975 if (merge) {
2976 size_t size;
7267c094 2977 QEMUIOVector *qiov = g_malloc0(sizeof(*qiov));
40b4f539
KW
2978 qemu_iovec_init(qiov,
2979 reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1);
2980
2981 // Add the first request to the merged one. If the requests are
2982 // overlapping, drop the last sectors of the first request.
2983 size = (reqs[i].sector - reqs[outidx].sector) << 9;
2984 qemu_iovec_concat(qiov, reqs[outidx].qiov, size);
2985
b6a127a1
PB
2986 // We should need to add any zeros between the two requests
2987 assert (reqs[i].sector <= oldreq_last);
40b4f539
KW
2988
2989 // Add the second request
2990 qemu_iovec_concat(qiov, reqs[i].qiov, reqs[i].qiov->size);
2991
cbf1dff2 2992 reqs[outidx].nb_sectors = qiov->size >> 9;
40b4f539
KW
2993 reqs[outidx].qiov = qiov;
2994
2995 mcb->callbacks[i].free_qiov = reqs[outidx].qiov;
2996 } else {
2997 outidx++;
2998 reqs[outidx].sector = reqs[i].sector;
2999 reqs[outidx].nb_sectors = reqs[i].nb_sectors;
3000 reqs[outidx].qiov = reqs[i].qiov;
3001 }
3002 }
3003
3004 return outidx + 1;
3005}
3006
3007/*
3008 * Submit multiple AIO write requests at once.
3009 *
3010 * On success, the function returns 0 and all requests in the reqs array have
3011 * been submitted. In error case this function returns -1, and any of the
3012 * requests may or may not be submitted yet. In particular, this means that the
3013 * callback will be called for some of the requests, for others it won't. The
3014 * caller must check the error field of the BlockRequest to wait for the right
3015 * callbacks (if error != 0, no callback will be called).
3016 *
3017 * The implementation may modify the contents of the reqs array, e.g. to merge
3018 * requests. However, the fields opaque and error are left unmodified as they
3019 * are used to signal failure for a single request to the caller.
3020 */
3021int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs)
3022{
40b4f539
KW
3023 MultiwriteCB *mcb;
3024 int i;
3025
301db7c2
RH
3026 /* don't submit writes if we don't have a medium */
3027 if (bs->drv == NULL) {
3028 for (i = 0; i < num_reqs; i++) {
3029 reqs[i].error = -ENOMEDIUM;
3030 }
3031 return -1;
3032 }
3033
40b4f539
KW
3034 if (num_reqs == 0) {
3035 return 0;
3036 }
3037
3038 // Create MultiwriteCB structure
7267c094 3039 mcb = g_malloc0(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks));
40b4f539
KW
3040 mcb->num_requests = 0;
3041 mcb->num_callbacks = num_reqs;
3042
3043 for (i = 0; i < num_reqs; i++) {
3044 mcb->callbacks[i].cb = reqs[i].cb;
3045 mcb->callbacks[i].opaque = reqs[i].opaque;
3046 }
3047
3048 // Check for mergable requests
3049 num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb);
3050
6d519a5f
SH
3051 trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs);
3052
df9309fb
PB
3053 /* Run the aio requests. */
3054 mcb->num_requests = num_reqs;
40b4f539 3055 for (i = 0; i < num_reqs; i++) {
ad54ae80 3056 bdrv_aio_writev(bs, reqs[i].sector, reqs[i].qiov,
40b4f539 3057 reqs[i].nb_sectors, multiwrite_cb, mcb);
40b4f539
KW
3058 }
3059
3060 return 0;
40b4f539
KW
3061}
3062
83f64091 3063void bdrv_aio_cancel(BlockDriverAIOCB *acb)
83f64091 3064{
6bbff9a0 3065 acb->pool->cancel(acb);
83f64091
FB
3066}
3067
98f90dba
ZYW
3068/* block I/O throttling */
3069static bool bdrv_exceed_bps_limits(BlockDriverState *bs, int nb_sectors,
3070 bool is_write, double elapsed_time, uint64_t *wait)
3071{
3072 uint64_t bps_limit = 0;
3073 double bytes_limit, bytes_base, bytes_res;
3074 double slice_time, wait_time;
3075
3076 if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
3077 bps_limit = bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL];
3078 } else if (bs->io_limits.bps[is_write]) {
3079 bps_limit = bs->io_limits.bps[is_write];
3080 } else {
3081 if (wait) {
3082 *wait = 0;
3083 }
3084
3085 return false;
3086 }
3087
3088 slice_time = bs->slice_end - bs->slice_start;
3089 slice_time /= (NANOSECONDS_PER_SECOND);
3090 bytes_limit = bps_limit * slice_time;
3091 bytes_base = bs->nr_bytes[is_write] - bs->io_base.bytes[is_write];
3092 if (bs->io_limits.bps[BLOCK_IO_LIMIT_TOTAL]) {
3093 bytes_base += bs->nr_bytes[!is_write] - bs->io_base.bytes[!is_write];
3094 }
3095
3096 /* bytes_base: the bytes of data which have been read/written; and
3097 * it is obtained from the history statistic info.
3098 * bytes_res: the remaining bytes of data which need to be read/written.
3099 * (bytes_base + bytes_res) / bps_limit: used to calcuate
3100 * the total time for completing reading/writting all data.
3101 */
3102 bytes_res = (unsigned) nb_sectors * BDRV_SECTOR_SIZE;
3103
3104 if (bytes_base + bytes_res <= bytes_limit) {
3105 if (wait) {
3106 *wait = 0;
3107 }
3108
3109 return false;
3110 }
3111
3112 /* Calc approx time to dispatch */
3113 wait_time = (bytes_base + bytes_res) / bps_limit - elapsed_time;
3114
3115 /* When the I/O rate at runtime exceeds the limits,
3116 * bs->slice_end need to be extended in order that the current statistic
3117 * info can be kept until the timer fire, so it is increased and tuned
3118 * based on the result of experiment.
3119 */
3120 bs->slice_time = wait_time * BLOCK_IO_SLICE_TIME * 10;
3121 bs->slice_end += bs->slice_time - 3 * BLOCK_IO_SLICE_TIME;
3122 if (wait) {
3123 *wait = wait_time * BLOCK_IO_SLICE_TIME * 10;
3124 }
3125
3126 return true;
3127}
3128
3129static bool bdrv_exceed_iops_limits(BlockDriverState *bs, bool is_write,
3130 double elapsed_time, uint64_t *wait)
3131{
3132 uint64_t iops_limit = 0;
3133 double ios_limit, ios_base;
3134 double slice_time, wait_time;
3135
3136 if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
3137 iops_limit = bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL];
3138 } else if (bs->io_limits.iops[is_write]) {
3139 iops_limit = bs->io_limits.iops[is_write];
3140 } else {
3141 if (wait) {
3142 *wait = 0;
3143 }
3144
3145 return false;
3146 }
3147
3148 slice_time = bs->slice_end - bs->slice_start;
3149 slice_time /= (NANOSECONDS_PER_SECOND);
3150 ios_limit = iops_limit * slice_time;
3151 ios_base = bs->nr_ops[is_write] - bs->io_base.ios[is_write];
3152 if (bs->io_limits.iops[BLOCK_IO_LIMIT_TOTAL]) {
3153 ios_base += bs->nr_ops[!is_write] - bs->io_base.ios[!is_write];
3154 }
3155
3156 if (ios_base + 1 <= ios_limit) {
3157 if (wait) {
3158 *wait = 0;
3159 }
3160
3161 return false;
3162 }
3163
3164 /* Calc approx time to dispatch */
3165 wait_time = (ios_base + 1) / iops_limit;
3166 if (wait_time > elapsed_time) {
3167 wait_time = wait_time - elapsed_time;
3168 } else {
3169 wait_time = 0;
3170 }
3171
3172 bs->slice_time = wait_time * BLOCK_IO_SLICE_TIME * 10;
3173 bs->slice_end += bs->slice_time - 3 * BLOCK_IO_SLICE_TIME;
3174 if (wait) {
3175 *wait = wait_time * BLOCK_IO_SLICE_TIME * 10;
3176 }
3177
3178 return true;
3179}
3180
3181static bool bdrv_exceed_io_limits(BlockDriverState *bs, int nb_sectors,
3182 bool is_write, int64_t *wait)
3183{
3184 int64_t now, max_wait;
3185 uint64_t bps_wait = 0, iops_wait = 0;
3186 double elapsed_time;
3187 int bps_ret, iops_ret;
3188
3189 now = qemu_get_clock_ns(vm_clock);
3190 if ((bs->slice_start < now)
3191 && (bs->slice_end > now)) {
3192 bs->slice_end = now + bs->slice_time;
3193 } else {
3194 bs->slice_time = 5 * BLOCK_IO_SLICE_TIME;
3195 bs->slice_start = now;
3196 bs->slice_end = now + bs->slice_time;
3197
3198 bs->io_base.bytes[is_write] = bs->nr_bytes[is_write];
3199 bs->io_base.bytes[!is_write] = bs->nr_bytes[!is_write];
3200
3201 bs->io_base.ios[is_write] = bs->nr_ops[is_write];
3202 bs->io_base.ios[!is_write] = bs->nr_ops[!is_write];
3203 }
3204
3205 elapsed_time = now - bs->slice_start;
3206 elapsed_time /= (NANOSECONDS_PER_SECOND);
3207
3208 bps_ret = bdrv_exceed_bps_limits(bs, nb_sectors,
3209 is_write, elapsed_time, &bps_wait);
3210 iops_ret = bdrv_exceed_iops_limits(bs, is_write,
3211 elapsed_time, &iops_wait);
3212 if (bps_ret || iops_ret) {
3213 max_wait = bps_wait > iops_wait ? bps_wait : iops_wait;
3214 if (wait) {
3215 *wait = max_wait;
3216 }
3217
3218 now = qemu_get_clock_ns(vm_clock);
3219 if (bs->slice_end < now + max_wait) {
3220 bs->slice_end = now + max_wait;
3221 }
3222
3223 return true;
3224 }
3225
3226 if (wait) {
3227 *wait = 0;
3228 }
3229
3230 return false;
3231}
ce1a14dc 3232
83f64091
FB
3233/**************************************************************/
3234/* async block device emulation */
3235
c16b5a2c
CH
3236typedef struct BlockDriverAIOCBSync {
3237 BlockDriverAIOCB common;
3238 QEMUBH *bh;
3239 int ret;
3240 /* vector translation state */
3241 QEMUIOVector *qiov;
3242 uint8_t *bounce;
3243 int is_write;
3244} BlockDriverAIOCBSync;
3245
3246static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
3247{
b666d239
KW
3248 BlockDriverAIOCBSync *acb =
3249 container_of(blockacb, BlockDriverAIOCBSync, common);
6a7ad299 3250 qemu_bh_delete(acb->bh);
36afc451 3251 acb->bh = NULL;
c16b5a2c
CH
3252 qemu_aio_release(acb);
3253}
3254
3255static AIOPool bdrv_em_aio_pool = {
3256 .aiocb_size = sizeof(BlockDriverAIOCBSync),
3257 .cancel = bdrv_aio_cancel_em,
3258};
3259
ce1a14dc 3260static void bdrv_aio_bh_cb(void *opaque)
83f64091 3261{
ce1a14dc 3262 BlockDriverAIOCBSync *acb = opaque;
f141eafe 3263
f141eafe
AL
3264 if (!acb->is_write)
3265 qemu_iovec_from_buffer(acb->qiov, acb->bounce, acb->qiov->size);
ceb42de8 3266 qemu_vfree(acb->bounce);
ce1a14dc 3267 acb->common.cb(acb->common.opaque, acb->ret);
6a7ad299 3268 qemu_bh_delete(acb->bh);
36afc451 3269 acb->bh = NULL;
ce1a14dc 3270 qemu_aio_release(acb);
83f64091 3271}
beac80cd 3272
f141eafe
AL
3273static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
3274 int64_t sector_num,
3275 QEMUIOVector *qiov,
3276 int nb_sectors,
3277 BlockDriverCompletionFunc *cb,
3278 void *opaque,
3279 int is_write)
3280
83f64091 3281{
ce1a14dc 3282 BlockDriverAIOCBSync *acb;
ce1a14dc 3283
c16b5a2c 3284 acb = qemu_aio_get(&bdrv_em_aio_pool, bs, cb, opaque);
f141eafe
AL
3285 acb->is_write = is_write;
3286 acb->qiov = qiov;
e268ca52 3287 acb->bounce = qemu_blockalign(bs, qiov->size);
3f3aace8 3288 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
f141eafe
AL
3289
3290 if (is_write) {
3291 qemu_iovec_to_buffer(acb->qiov, acb->bounce);
1ed20acf 3292 acb->ret = bs->drv->bdrv_write(bs, sector_num, acb->bounce, nb_sectors);
f141eafe 3293 } else {
1ed20acf 3294 acb->ret = bs->drv->bdrv_read(bs, sector_num, acb->bounce, nb_sectors);
f141eafe
AL
3295 }
3296
ce1a14dc 3297 qemu_bh_schedule(acb->bh);
f141eafe 3298
ce1a14dc 3299 return &acb->common;
beac80cd
FB
3300}
3301
f141eafe
AL
3302static BlockDriverAIOCB *bdrv_aio_readv_em(BlockDriverState *bs,
3303 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
ce1a14dc 3304 BlockDriverCompletionFunc *cb, void *opaque)
beac80cd 3305{
f141eafe
AL
3306 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
3307}
83f64091 3308
f141eafe
AL
3309static BlockDriverAIOCB *bdrv_aio_writev_em(BlockDriverState *bs,
3310 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
3311 BlockDriverCompletionFunc *cb, void *opaque)
3312{
3313 return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
beac80cd 3314}
beac80cd 3315
68485420
KW
3316
3317typedef struct BlockDriverAIOCBCoroutine {
3318 BlockDriverAIOCB common;
3319 BlockRequest req;
3320 bool is_write;
3321 QEMUBH* bh;
3322} BlockDriverAIOCBCoroutine;
3323
3324static void bdrv_aio_co_cancel_em(BlockDriverAIOCB *blockacb)
3325{
3326 qemu_aio_flush();
3327}
3328
3329static AIOPool bdrv_em_co_aio_pool = {
3330 .aiocb_size = sizeof(BlockDriverAIOCBCoroutine),
3331 .cancel = bdrv_aio_co_cancel_em,
3332};
3333
35246a68 3334static void bdrv_co_em_bh(void *opaque)
68485420
KW
3335{
3336 BlockDriverAIOCBCoroutine *acb = opaque;
3337
3338 acb->common.cb(acb->common.opaque, acb->req.error);
3339 qemu_bh_delete(acb->bh);
3340 qemu_aio_release(acb);
3341}
3342
b2a61371
SH
3343/* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
3344static void coroutine_fn bdrv_co_do_rw(void *opaque)
3345{
3346 BlockDriverAIOCBCoroutine *acb = opaque;
3347 BlockDriverState *bs = acb->common.bs;
3348
3349 if (!acb->is_write) {
3350 acb->req.error = bdrv_co_do_readv(bs, acb->req.sector,
470c0504 3351 acb->req.nb_sectors, acb->req.qiov, 0);
b2a61371
SH
3352 } else {
3353 acb->req.error = bdrv_co_do_writev(bs, acb->req.sector,
f08f2dda 3354 acb->req.nb_sectors, acb->req.qiov, 0);
b2a61371
SH
3355 }
3356
35246a68 3357 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
b2a61371
SH
3358 qemu_bh_schedule(acb->bh);
3359}
3360
68485420
KW
3361static BlockDriverAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs,
3362 int64_t sector_num,
3363 QEMUIOVector *qiov,
3364 int nb_sectors,
3365 BlockDriverCompletionFunc *cb,
3366 void *opaque,
8c5873d6 3367 bool is_write)
68485420
KW
3368{
3369 Coroutine *co;
3370 BlockDriverAIOCBCoroutine *acb;
3371
3372 acb = qemu_aio_get(&bdrv_em_co_aio_pool, bs, cb, opaque);
3373 acb->req.sector = sector_num;
3374 acb->req.nb_sectors = nb_sectors;
3375 acb->req.qiov = qiov;
3376 acb->is_write = is_write;
3377
8c5873d6 3378 co = qemu_coroutine_create(bdrv_co_do_rw);
68485420
KW
3379 qemu_coroutine_enter(co, acb);
3380
3381 return &acb->common;
3382}
3383
07f07615 3384static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque)
b2e12bc6 3385{
07f07615
PB
3386 BlockDriverAIOCBCoroutine *acb = opaque;
3387 BlockDriverState *bs = acb->common.bs;
b2e12bc6 3388
07f07615
PB
3389 acb->req.error = bdrv_co_flush(bs);
3390 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
b2e12bc6 3391 qemu_bh_schedule(acb->bh);
b2e12bc6
CH
3392}
3393
07f07615 3394BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
016f5cf6
AG
3395 BlockDriverCompletionFunc *cb, void *opaque)
3396{
07f07615 3397 trace_bdrv_aio_flush(bs, opaque);
016f5cf6 3398
07f07615
PB
3399 Coroutine *co;
3400 BlockDriverAIOCBCoroutine *acb;
016f5cf6 3401
07f07615
PB
3402 acb = qemu_aio_get(&bdrv_em_co_aio_pool, bs, cb, opaque);
3403 co = qemu_coroutine_create(bdrv_aio_flush_co_entry);
3404 qemu_coroutine_enter(co, acb);
016f5cf6 3405
016f5cf6
AG
3406 return &acb->common;
3407}
3408
4265d620
PB
3409static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque)
3410{
3411 BlockDriverAIOCBCoroutine *acb = opaque;
3412 BlockDriverState *bs = acb->common.bs;
3413
3414 acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors);
3415 acb->bh = qemu_bh_new(bdrv_co_em_bh, acb);
3416 qemu_bh_schedule(acb->bh);
3417}
3418
3419BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
3420 int64_t sector_num, int nb_sectors,
3421 BlockDriverCompletionFunc *cb, void *opaque)
3422{
3423 Coroutine *co;
3424 BlockDriverAIOCBCoroutine *acb;
3425
3426 trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque);
3427
3428 acb = qemu_aio_get(&bdrv_em_co_aio_pool, bs, cb, opaque);
3429 acb->req.sector = sector_num;
3430 acb->req.nb_sectors = nb_sectors;
3431 co = qemu_coroutine_create(bdrv_aio_discard_co_entry);
3432 qemu_coroutine_enter(co, acb);
3433
3434 return &acb->common;
3435}
3436
ea2384d3
FB
3437void bdrv_init(void)
3438{
5efa9d5a 3439 module_call_init(MODULE_INIT_BLOCK);
ea2384d3 3440}
ce1a14dc 3441
eb852011
MA
3442void bdrv_init_with_whitelist(void)
3443{
3444 use_bdrv_whitelist = 1;
3445 bdrv_init();
3446}
3447
c16b5a2c
CH
3448void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
3449 BlockDriverCompletionFunc *cb, void *opaque)
ce1a14dc 3450{
ce1a14dc
PB
3451 BlockDriverAIOCB *acb;
3452
6bbff9a0
AL
3453 if (pool->free_aiocb) {
3454 acb = pool->free_aiocb;
3455 pool->free_aiocb = acb->next;
ce1a14dc 3456 } else {
7267c094 3457 acb = g_malloc0(pool->aiocb_size);
6bbff9a0 3458 acb->pool = pool;
ce1a14dc
PB
3459 }
3460 acb->bs = bs;
3461 acb->cb = cb;
3462 acb->opaque = opaque;
3463 return acb;
3464}
3465
3466void qemu_aio_release(void *p)
3467{
6bbff9a0
AL
3468 BlockDriverAIOCB *acb = (BlockDriverAIOCB *)p;
3469 AIOPool *pool = acb->pool;
3470 acb->next = pool->free_aiocb;
3471 pool->free_aiocb = acb;
ce1a14dc 3472}
19cb3738 3473
f9f05dc5
KW
3474/**************************************************************/
3475/* Coroutine block device emulation */
3476
3477typedef struct CoroutineIOCompletion {
3478 Coroutine *coroutine;
3479 int ret;
3480} CoroutineIOCompletion;
3481
3482static void bdrv_co_io_em_complete(void *opaque, int ret)
3483{
3484 CoroutineIOCompletion *co = opaque;
3485
3486 co->ret = ret;
3487 qemu_coroutine_enter(co->coroutine, NULL);
3488}
3489
3490static int coroutine_fn bdrv_co_io_em(BlockDriverState *bs, int64_t sector_num,
3491 int nb_sectors, QEMUIOVector *iov,
3492 bool is_write)
3493{
3494 CoroutineIOCompletion co = {
3495 .coroutine = qemu_coroutine_self(),
3496 };
3497 BlockDriverAIOCB *acb;
3498
3499 if (is_write) {
a652d160
SH
3500 acb = bs->drv->bdrv_aio_writev(bs, sector_num, iov, nb_sectors,
3501 bdrv_co_io_em_complete, &co);
f9f05dc5 3502 } else {
a652d160
SH
3503 acb = bs->drv->bdrv_aio_readv(bs, sector_num, iov, nb_sectors,
3504 bdrv_co_io_em_complete, &co);
f9f05dc5
KW
3505 }
3506
59370aaa 3507 trace_bdrv_co_io_em(bs, sector_num, nb_sectors, is_write, acb);
f9f05dc5
KW
3508 if (!acb) {
3509 return -EIO;
3510 }
3511 qemu_coroutine_yield();
3512
3513 return co.ret;
3514}
3515
3516static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs,
3517 int64_t sector_num, int nb_sectors,
3518 QEMUIOVector *iov)
3519{
3520 return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, false);
3521}
3522
3523static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs,
3524 int64_t sector_num, int nb_sectors,
3525 QEMUIOVector *iov)
3526{
3527 return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, true);
3528}
3529
07f07615 3530static void coroutine_fn bdrv_flush_co_entry(void *opaque)
e7a8a783 3531{
07f07615
PB
3532 RwCo *rwco = opaque;
3533
3534 rwco->ret = bdrv_co_flush(rwco->bs);
3535}
3536
3537int coroutine_fn bdrv_co_flush(BlockDriverState *bs)
3538{
eb489bb1
KW
3539 int ret;
3540
29cdb251 3541 if (!bs || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) {
07f07615 3542 return 0;
eb489bb1
KW
3543 }
3544
ca716364 3545 /* Write back cached data to the OS even with cache=unsafe */
eb489bb1
KW
3546 if (bs->drv->bdrv_co_flush_to_os) {
3547 ret = bs->drv->bdrv_co_flush_to_os(bs);
3548 if (ret < 0) {
3549 return ret;
3550 }
3551 }
3552
ca716364
KW
3553 /* But don't actually force it to the disk with cache=unsafe */
3554 if (bs->open_flags & BDRV_O_NO_FLUSH) {
3555 return 0;
3556 }
3557
eb489bb1 3558 if (bs->drv->bdrv_co_flush_to_disk) {
29cdb251 3559 ret = bs->drv->bdrv_co_flush_to_disk(bs);
07f07615
PB
3560 } else if (bs->drv->bdrv_aio_flush) {
3561 BlockDriverAIOCB *acb;
3562 CoroutineIOCompletion co = {
3563 .coroutine = qemu_coroutine_self(),
3564 };
3565
3566 acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co);
3567 if (acb == NULL) {
29cdb251 3568 ret = -EIO;
07f07615
PB
3569 } else {
3570 qemu_coroutine_yield();
29cdb251 3571 ret = co.ret;
07f07615 3572 }
07f07615
PB
3573 } else {
3574 /*
3575 * Some block drivers always operate in either writethrough or unsafe
3576 * mode and don't support bdrv_flush therefore. Usually qemu doesn't
3577 * know how the server works (because the behaviour is hardcoded or
3578 * depends on server-side configuration), so we can't ensure that
3579 * everything is safe on disk. Returning an error doesn't work because
3580 * that would break guests even if the server operates in writethrough
3581 * mode.
3582 *
3583 * Let's hope the user knows what he's doing.
3584 */
29cdb251 3585 ret = 0;
07f07615 3586 }
29cdb251
PB
3587 if (ret < 0) {
3588 return ret;
3589 }
3590
3591 /* Now flush the underlying protocol. It will also have BDRV_O_NO_FLUSH
3592 * in the case of cache=unsafe, so there are no useless flushes.
3593 */
3594 return bdrv_co_flush(bs->file);
07f07615
PB
3595}
3596
0f15423c
AL
3597void bdrv_invalidate_cache(BlockDriverState *bs)
3598{
3599 if (bs->drv && bs->drv->bdrv_invalidate_cache) {
3600 bs->drv->bdrv_invalidate_cache(bs);
3601 }
3602}
3603
3604void bdrv_invalidate_cache_all(void)
3605{
3606 BlockDriverState *bs;
3607
3608 QTAILQ_FOREACH(bs, &bdrv_states, list) {
3609 bdrv_invalidate_cache(bs);
3610 }
3611}
3612
07f07615
PB
3613int bdrv_flush(BlockDriverState *bs)
3614{
3615 Coroutine *co;
3616 RwCo rwco = {
3617 .bs = bs,
3618 .ret = NOT_DONE,
e7a8a783 3619 };
e7a8a783 3620
07f07615
PB
3621 if (qemu_in_coroutine()) {
3622 /* Fast-path if already in coroutine context */
3623 bdrv_flush_co_entry(&rwco);
3624 } else {
3625 co = qemu_coroutine_create(bdrv_flush_co_entry);
3626 qemu_coroutine_enter(co, &rwco);
3627 while (rwco.ret == NOT_DONE) {
3628 qemu_aio_wait();
3629 }
e7a8a783 3630 }
07f07615
PB
3631
3632 return rwco.ret;
e7a8a783
KW
3633}
3634
4265d620
PB
3635static void coroutine_fn bdrv_discard_co_entry(void *opaque)
3636{
3637 RwCo *rwco = opaque;
3638
3639 rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors);
3640}
3641
3642int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num,
3643 int nb_sectors)
3644{
3645 if (!bs->drv) {
3646 return -ENOMEDIUM;
3647 } else if (bdrv_check_request(bs, sector_num, nb_sectors)) {
3648 return -EIO;
3649 } else if (bs->read_only) {
3650 return -EROFS;
3651 } else if (bs->drv->bdrv_co_discard) {
3652 return bs->drv->bdrv_co_discard(bs, sector_num, nb_sectors);
3653 } else if (bs->drv->bdrv_aio_discard) {
3654 BlockDriverAIOCB *acb;
3655 CoroutineIOCompletion co = {
3656 .coroutine = qemu_coroutine_self(),
3657 };
3658
3659 acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors,
3660 bdrv_co_io_em_complete, &co);
3661 if (acb == NULL) {
3662 return -EIO;
3663 } else {
3664 qemu_coroutine_yield();
3665 return co.ret;
3666 }
4265d620
PB
3667 } else {
3668 return 0;
3669 }
3670}
3671
3672int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors)
3673{
3674 Coroutine *co;
3675 RwCo rwco = {
3676 .bs = bs,
3677 .sector_num = sector_num,
3678 .nb_sectors = nb_sectors,
3679 .ret = NOT_DONE,
3680 };
3681
3682 if (qemu_in_coroutine()) {
3683 /* Fast-path if already in coroutine context */
3684 bdrv_discard_co_entry(&rwco);
3685 } else {
3686 co = qemu_coroutine_create(bdrv_discard_co_entry);
3687 qemu_coroutine_enter(co, &rwco);
3688 while (rwco.ret == NOT_DONE) {
3689 qemu_aio_wait();
3690 }
3691 }
3692
3693 return rwco.ret;
3694}
3695
19cb3738
FB
3696/**************************************************************/
3697/* removable device support */
3698
3699/**
3700 * Return TRUE if the media is present
3701 */
3702int bdrv_is_inserted(BlockDriverState *bs)
3703{
3704 BlockDriver *drv = bs->drv;
a1aff5bf 3705
19cb3738
FB
3706 if (!drv)
3707 return 0;
3708 if (!drv->bdrv_is_inserted)
a1aff5bf
MA
3709 return 1;
3710 return drv->bdrv_is_inserted(bs);
19cb3738
FB
3711}
3712
3713/**
8e49ca46
MA
3714 * Return whether the media changed since the last call to this
3715 * function, or -ENOTSUP if we don't know. Most drivers don't know.
19cb3738
FB
3716 */
3717int bdrv_media_changed(BlockDriverState *bs)
3718{
3719 BlockDriver *drv = bs->drv;
19cb3738 3720
8e49ca46
MA
3721 if (drv && drv->bdrv_media_changed) {
3722 return drv->bdrv_media_changed(bs);
3723 }
3724 return -ENOTSUP;
19cb3738
FB
3725}
3726
3727/**
3728 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
3729 */
f36f3949 3730void bdrv_eject(BlockDriverState *bs, bool eject_flag)
19cb3738
FB
3731{
3732 BlockDriver *drv = bs->drv;
19cb3738 3733
822e1cd1
MA
3734 if (drv && drv->bdrv_eject) {
3735 drv->bdrv_eject(bs, eject_flag);
19cb3738 3736 }
6f382ed2
LC
3737
3738 if (bs->device_name[0] != '\0') {
3739 bdrv_emit_qmp_eject_event(bs, eject_flag);
3740 }
19cb3738
FB
3741}
3742
19cb3738
FB
3743/**
3744 * Lock or unlock the media (if it is locked, the user won't be able
3745 * to eject it manually).
3746 */
025e849a 3747void bdrv_lock_medium(BlockDriverState *bs, bool locked)
19cb3738
FB
3748{
3749 BlockDriver *drv = bs->drv;
3750
025e849a 3751 trace_bdrv_lock_medium(bs, locked);
b8c6d095 3752
025e849a
MA
3753 if (drv && drv->bdrv_lock_medium) {
3754 drv->bdrv_lock_medium(bs, locked);
19cb3738
FB
3755 }
3756}
985a03b0
TS
3757
3758/* needed for generic scsi interface */
3759
3760int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
3761{
3762 BlockDriver *drv = bs->drv;
3763
3764 if (drv && drv->bdrv_ioctl)
3765 return drv->bdrv_ioctl(bs, req, buf);
3766 return -ENOTSUP;
3767}
7d780669 3768
221f715d
AL
3769BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
3770 unsigned long int req, void *buf,
3771 BlockDriverCompletionFunc *cb, void *opaque)
7d780669 3772{
221f715d 3773 BlockDriver *drv = bs->drv;
7d780669 3774
221f715d
AL
3775 if (drv && drv->bdrv_aio_ioctl)
3776 return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque);
3777 return NULL;
7d780669 3778}
e268ca52 3779
7b6f9300
MA
3780void bdrv_set_buffer_alignment(BlockDriverState *bs, int align)
3781{
3782 bs->buffer_alignment = align;
3783}
7cd1e32a 3784
e268ca52
AL
3785void *qemu_blockalign(BlockDriverState *bs, size_t size)
3786{
3787 return qemu_memalign((bs && bs->buffer_alignment) ? bs->buffer_alignment : 512, size);
3788}
7cd1e32a 3789
3790void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable)
3791{
3792 int64_t bitmap_size;
a55eb92c 3793
aaa0eb75 3794 bs->dirty_count = 0;
a55eb92c 3795 if (enable) {
c6d22830
JK
3796 if (!bs->dirty_bitmap) {
3797 bitmap_size = (bdrv_getlength(bs) >> BDRV_SECTOR_BITS) +
3798 BDRV_SECTORS_PER_DIRTY_CHUNK * 8 - 1;
3799 bitmap_size /= BDRV_SECTORS_PER_DIRTY_CHUNK * 8;
a55eb92c 3800
7267c094 3801 bs->dirty_bitmap = g_malloc0(bitmap_size);
a55eb92c 3802 }
7cd1e32a 3803 } else {
c6d22830 3804 if (bs->dirty_bitmap) {
7267c094 3805 g_free(bs->dirty_bitmap);
c6d22830 3806 bs->dirty_bitmap = NULL;
a55eb92c 3807 }
7cd1e32a 3808 }
3809}
3810
3811int bdrv_get_dirty(BlockDriverState *bs, int64_t sector)
3812{
6ea44308 3813 int64_t chunk = sector / (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK;
a55eb92c 3814
c6d22830
JK
3815 if (bs->dirty_bitmap &&
3816 (sector << BDRV_SECTOR_BITS) < bdrv_getlength(bs)) {
6d59fec1
MT
3817 return !!(bs->dirty_bitmap[chunk / (sizeof(unsigned long) * 8)] &
3818 (1UL << (chunk % (sizeof(unsigned long) * 8))));
7cd1e32a 3819 } else {
3820 return 0;
3821 }
3822}
3823
a55eb92c
JK
3824void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
3825 int nr_sectors)
7cd1e32a 3826{
3827 set_dirty_bitmap(bs, cur_sector, nr_sectors, 0);
3828}
aaa0eb75
LS
3829
3830int64_t bdrv_get_dirty_count(BlockDriverState *bs)
3831{
3832 return bs->dirty_count;
3833}
f88e1a42 3834
db593f25
MT
3835void bdrv_set_in_use(BlockDriverState *bs, int in_use)
3836{
3837 assert(bs->in_use != in_use);
3838 bs->in_use = in_use;
3839}
3840
3841int bdrv_in_use(BlockDriverState *bs)
3842{
3843 return bs->in_use;
3844}
3845
28a7282a
LC
3846void bdrv_iostatus_enable(BlockDriverState *bs)
3847{
d6bf279e 3848 bs->iostatus_enabled = true;
58e21ef5 3849 bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
28a7282a
LC
3850}
3851
3852/* The I/O status is only enabled if the drive explicitly
3853 * enables it _and_ the VM is configured to stop on errors */
3854bool bdrv_iostatus_is_enabled(const BlockDriverState *bs)
3855{
d6bf279e 3856 return (bs->iostatus_enabled &&
28a7282a
LC
3857 (bs->on_write_error == BLOCK_ERR_STOP_ENOSPC ||
3858 bs->on_write_error == BLOCK_ERR_STOP_ANY ||
3859 bs->on_read_error == BLOCK_ERR_STOP_ANY));
3860}
3861
3862void bdrv_iostatus_disable(BlockDriverState *bs)
3863{
d6bf279e 3864 bs->iostatus_enabled = false;
28a7282a
LC
3865}
3866
3867void bdrv_iostatus_reset(BlockDriverState *bs)
3868{
3869 if (bdrv_iostatus_is_enabled(bs)) {
58e21ef5 3870 bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
28a7282a
LC
3871 }
3872}
3873
3874/* XXX: Today this is set by device models because it makes the implementation
3875 quite simple. However, the block layer knows about the error, so it's
3876 possible to implement this without device models being involved */
3877void bdrv_iostatus_set_err(BlockDriverState *bs, int error)
3878{
58e21ef5
LC
3879 if (bdrv_iostatus_is_enabled(bs) &&
3880 bs->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
28a7282a 3881 assert(error >= 0);
58e21ef5
LC
3882 bs->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
3883 BLOCK_DEVICE_IO_STATUS_FAILED;
28a7282a
LC
3884 }
3885}
3886
a597e79c
CH
3887void
3888bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie, int64_t bytes,
3889 enum BlockAcctType type)
3890{
3891 assert(type < BDRV_MAX_IOTYPE);
3892
3893 cookie->bytes = bytes;
c488c7f6 3894 cookie->start_time_ns = get_clock();
a597e79c
CH
3895 cookie->type = type;
3896}
3897
3898void
3899bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie)
3900{
3901 assert(cookie->type < BDRV_MAX_IOTYPE);
3902
3903 bs->nr_bytes[cookie->type] += cookie->bytes;
3904 bs->nr_ops[cookie->type]++;
c488c7f6 3905 bs->total_time_ns[cookie->type] += get_clock() - cookie->start_time_ns;
a597e79c
CH
3906}
3907
f88e1a42
JS
3908int bdrv_img_create(const char *filename, const char *fmt,
3909 const char *base_filename, const char *base_fmt,
3910 char *options, uint64_t img_size, int flags)
3911{
3912 QEMUOptionParameter *param = NULL, *create_options = NULL;
d220894e 3913 QEMUOptionParameter *backing_fmt, *backing_file, *size;
f88e1a42
JS
3914 BlockDriverState *bs = NULL;
3915 BlockDriver *drv, *proto_drv;
96df67d1 3916 BlockDriver *backing_drv = NULL;
f88e1a42
JS
3917 int ret = 0;
3918
3919 /* Find driver and parse its options */
3920 drv = bdrv_find_format(fmt);
3921 if (!drv) {
3922 error_report("Unknown file format '%s'", fmt);
4f70f249 3923 ret = -EINVAL;
f88e1a42
JS
3924 goto out;
3925 }
3926
3927 proto_drv = bdrv_find_protocol(filename);
3928 if (!proto_drv) {
3929 error_report("Unknown protocol '%s'", filename);
4f70f249 3930 ret = -EINVAL;
f88e1a42
JS
3931 goto out;
3932 }
3933
3934 create_options = append_option_parameters(create_options,
3935 drv->create_options);
3936 create_options = append_option_parameters(create_options,
3937 proto_drv->create_options);
3938
3939 /* Create parameter list with default values */
3940 param = parse_option_parameters("", create_options, param);
3941
3942 set_option_parameter_int(param, BLOCK_OPT_SIZE, img_size);
3943
3944 /* Parse -o options */
3945 if (options) {
3946 param = parse_option_parameters(options, create_options, param);
3947 if (param == NULL) {
3948 error_report("Invalid options for file format '%s'.", fmt);
4f70f249 3949 ret = -EINVAL;
f88e1a42
JS
3950 goto out;
3951 }
3952 }
3953
3954 if (base_filename) {
3955 if (set_option_parameter(param, BLOCK_OPT_BACKING_FILE,
3956 base_filename)) {
3957 error_report("Backing file not supported for file format '%s'",
3958 fmt);
4f70f249 3959 ret = -EINVAL;
f88e1a42
JS
3960 goto out;
3961 }
3962 }
3963
3964 if (base_fmt) {
3965 if (set_option_parameter(param, BLOCK_OPT_BACKING_FMT, base_fmt)) {
3966 error_report("Backing file format not supported for file "
3967 "format '%s'", fmt);
4f70f249 3968 ret = -EINVAL;
f88e1a42
JS
3969 goto out;
3970 }
3971 }
3972
792da93a
JS
3973 backing_file = get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
3974 if (backing_file && backing_file->value.s) {
3975 if (!strcmp(filename, backing_file->value.s)) {
3976 error_report("Error: Trying to create an image with the "
3977 "same filename as the backing file");
4f70f249 3978 ret = -EINVAL;
792da93a
JS
3979 goto out;
3980 }
3981 }
3982
f88e1a42
JS
3983 backing_fmt = get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
3984 if (backing_fmt && backing_fmt->value.s) {
96df67d1
SH
3985 backing_drv = bdrv_find_format(backing_fmt->value.s);
3986 if (!backing_drv) {
f88e1a42
JS
3987 error_report("Unknown backing file format '%s'",
3988 backing_fmt->value.s);
4f70f249 3989 ret = -EINVAL;
f88e1a42
JS
3990 goto out;
3991 }
3992 }
3993
3994 // The size for the image must always be specified, with one exception:
3995 // If we are using a backing file, we can obtain the size from there
d220894e
KW
3996 size = get_option_parameter(param, BLOCK_OPT_SIZE);
3997 if (size && size->value.n == -1) {
f88e1a42
JS
3998 if (backing_file && backing_file->value.s) {
3999 uint64_t size;
f88e1a42
JS
4000 char buf[32];
4001
f88e1a42
JS
4002 bs = bdrv_new("");
4003
96df67d1 4004 ret = bdrv_open(bs, backing_file->value.s, flags, backing_drv);
f88e1a42 4005 if (ret < 0) {
96df67d1 4006 error_report("Could not open '%s'", backing_file->value.s);
f88e1a42
JS
4007 goto out;
4008 }
4009 bdrv_get_geometry(bs, &size);
4010 size *= 512;
4011
4012 snprintf(buf, sizeof(buf), "%" PRId64, size);
4013 set_option_parameter(param, BLOCK_OPT_SIZE, buf);
4014 } else {
4015 error_report("Image creation needs a size parameter");
4f70f249 4016 ret = -EINVAL;
f88e1a42
JS
4017 goto out;
4018 }
4019 }
4020
4021 printf("Formatting '%s', fmt=%s ", filename, fmt);
4022 print_option_parameters(param);
4023 puts("");
4024
4025 ret = bdrv_create(drv, filename, param);
4026
4027 if (ret < 0) {
4028 if (ret == -ENOTSUP) {
4029 error_report("Formatting or formatting option not supported for "
4030 "file format '%s'", fmt);
4031 } else if (ret == -EFBIG) {
4032 error_report("The image size is too large for file format '%s'",
4033 fmt);
4034 } else {
4035 error_report("%s: error while creating %s: %s", filename, fmt,
4036 strerror(-ret));
4037 }
4038 }
4039
4040out:
4041 free_option_parameters(create_options);
4042 free_option_parameters(param);
4043
4044 if (bs) {
4045 bdrv_delete(bs);
4046 }
4f70f249
JS
4047
4048 return ret;
f88e1a42 4049}
eeec61f2
SH
4050
4051void *block_job_create(const BlockJobType *job_type, BlockDriverState *bs,
4052 BlockDriverCompletionFunc *cb, void *opaque)
4053{
4054 BlockJob *job;
4055
4056 if (bs->job || bdrv_in_use(bs)) {
4057 return NULL;
4058 }
4059 bdrv_set_in_use(bs, 1);
4060
4061 job = g_malloc0(job_type->instance_size);
4062 job->job_type = job_type;
4063 job->bs = bs;
4064 job->cb = cb;
4065 job->opaque = opaque;
4066 bs->job = job;
4067 return job;
4068}
4069
4070void block_job_complete(BlockJob *job, int ret)
4071{
4072 BlockDriverState *bs = job->bs;
4073
4074 assert(bs->job == job);
4075 job->cb(job->opaque, ret);
4076 bs->job = NULL;
4077 g_free(job);
4078 bdrv_set_in_use(bs, 0);
4079}
4080
4081int block_job_set_speed(BlockJob *job, int64_t value)
4082{
4083 if (!job->job_type->set_speed) {
4084 return -ENOTSUP;
4085 }
4086 return job->job_type->set_speed(job, value);
4087}
4088
4089void block_job_cancel(BlockJob *job)
4090{
4091 job->cancelled = true;
4092}
4093
4094bool block_job_is_cancelled(BlockJob *job)
4095{
4096 return job->cancelled;
4097}