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